pyrit.prompt_converter.CaesarConverter

class CaesarConverter(*, caesar_offset: int, append_description: bool = False)

Bases: PromptConverter

Encodes text using the Caesar cipher with a specified offset.

Using offset=1, ‘Hello 123’ would encode to ‘Ifmmp 234’, as each character would shift by 1. Shifts for digits 0-9 only work if the offset is less than 10, if the offset is equal to or greather than 10, any numeric values will not be shifted.

__init__(*, caesar_offset: int, append_description: bool = False) → None

Initializes the converter with a Caesar cipher offset and an option to append a description.

Parameters:

• caesar_offset (int) – Offset for caesar cipher, range 0 to 25 (inclusive). Can also be negative for shifting backwards.

• append_description (bool) – If True, appends plaintext “expert” text to the prompt. This includes instructions to only communicate using the cipher, a description of the cipher, and an example encoded using the cipher.

Raises:

ValueError – If caesar_offset is not in the range -25 to 25 inclusive.

Methods

__init__(*, caesar_offset[, append_description])	Initializes the converter with a Caesar cipher offset and an option to append a description.
convert_async(*, prompt[, input_type])	Converts the given prompt using the Caesar cipher.
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

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.

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

Converts the given prompt using the Caesar cipher.

input_supported(input_type: Literal['text', 'image_path', 'audio_path', 'video_path', 'url', 'reasoning', 'error']) → 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']) → 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