pyrit.prompt_converter.Base64Converter

class Base64Converter(*, encoding_func: Literal['b64encode', 'urlsafe_b64encode', 'standard_b64encode', 'b2a_base64', 'b16encode', 'b32encode', 'a85encode', 'b85encode'] = 'b64encode')

Bases: PromptConverter

Converter that encodes text to base64 format.

This converter takes input text and converts it to base64 encoding, which can be useful for obfuscating text or testing how systems handle encoded content.

__init__(*, encoding_func: Literal['b64encode', 'urlsafe_b64encode', 'standard_b64encode', 'b2a_base64', 'b16encode', 'b32encode', 'a85encode', 'b85encode'] = 'b64encode') → None

Initialize the Base64Converter.

Parameters:

encoding_func – The base64 encoding function to use. Defaults to “b64encode”.

Methods

__init__(*[, encoding_func])	Initialize the Base64Converter.
convert_async(*, prompt[, input_type])	Converts the given prompt to base64 encoding.
convert_tokens_async(*, prompt[, ...])	Converts substrings within a prompt that are enclosed by specified start and end tokens.
get_identifier()	Returns an identifier dictionary for the converter.
input_supported(input_type)	Checks if the input type is supported by the converter.
output_supported(output_type)	Checks if the output type is supported by the converter.

Attributes

EncodingFunc	alias of Literal['b64encode', 'urlsafe_b64encode', 'standard_b64encode', 'b2a_base64', 'b16encode', 'b32encode', 'a85encode', 'b85encode']
supported_input_types	Returns a list of supported input types for the converter.
supported_output_types	Returns a list of supported output types for the converter.

EncodingFunc

alias of Literal[‘b64encode’, ‘urlsafe_b64encode’, ‘standard_b64encode’, ‘b2a_base64’, ‘b16encode’, ‘b32encode’, ‘a85encode’, ‘b85encode’]

async convert_async(*, prompt: str, input_type: Literal['text', 'image_path', 'audio_path', 'video_path', 'url', 'reasoning', 'error', 'function_call', 'tool_call', 'function_call_output'] = 'text') → ConverterResult

Converts the given prompt to base64 encoding.

Parameters:

• prompt – The prompt to be converted.

• input_type – Type of data, unused for this converter.

Returns:

The converted text representation of the original prompt in base64.

Raises:

ValueError – If the input type is not supported.

input_supported(input_type: Literal['text', 'image_path', 'audio_path', 'video_path', 'url', 'reasoning', 'error', 'function_call', 'tool_call', 'function_call_output']) → bool

Checks if the input type is supported by the converter.

Parameters:

input_type (PromptDataType) – The input type to check.

Returns:

True if the input type is supported, False otherwise.

Return type:

bool

output_supported(output_type: Literal['text', 'image_path', 'audio_path', 'video_path', 'url', 'reasoning', 'error', 'function_call', 'tool_call', 'function_call_output']) → bool

Checks if the output type is supported by the converter.

Parameters:

output_type (PromptDataType) – The output type to check.

Returns:

True if the output type is supported, False otherwise.

Return type:

bool