pyrit.prompt_converter.CaesarConverter

pyrit.prompt_converter.CaesarConverter#

class CaesarConverter(*, caesar_offset: int, append_description: bool = False)[source]#

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 greater than 10, any numeric values will not be shifted.

__init__(*, caesar_offset: int, append_description: bool = False) → None[source]#

Initialize 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])

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

convert_async(*, prompt[, input_type])

Convert the given prompt using the Caesar cipher.

convert_tokens_async(*, prompt[, ...])

Convert substrings within a prompt that are enclosed by specified start and end tokens.

get_identifier()

Get the typed identifier for this object.

input_supported(input_type)

Check if the input type is supported by the converter.

output_supported(output_type)

Check if the output type is supported by the converter.

Attributes

SUPPORTED_INPUT_TYPES

Tuple of input modalities supported by this converter.

SUPPORTED_OUTPUT_TYPES

Tuple of output modalities supported by this converter.

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.
SUPPORTED_INPUT_TYPES: tuple[Literal['text', 'image_path', 'audio_path', 'video_path', 'binary_path', 'url', 'reasoning', 'error', 'function_call', 'tool_call', 'function_call_output'], ...] = ('text',)#

Tuple of input modalities supported by this converter. Subclasses must override this.

SUPPORTED_OUTPUT_TYPES: tuple[Literal['text', 'image_path', 'audio_path', 'video_path', 'binary_path', 'url', 'reasoning', 'error', 'function_call', 'tool_call', 'function_call_output'], ...] = ('text',)#

Tuple of output modalities supported by this converter. Subclasses must override this.

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

Convert the given prompt using the Caesar cipher.

Parameters:

  • prompt (str) – The input prompt to be converted.

  • input_type (PromptDataType) – The type of the input prompt. Must be “text”.

Returns:

The result containing the converted prompt and its type.

Return type:

ConverterResult

Raises:

ValueError – If the input type is not supported.

Contents