pyrit.cli.pyrit_shell

PyRIT Shell - Interactive REPL for PyRIT.

This module provides an interactive shell where PyRIT modules are loaded once at startup, making subsequent commands instant.

Functions¶

main¶

main() → int

Entry point for pyrit_shell.

Returns:

• int — Exit code.

merge_config_scenario_args¶

merge_config_scenario_args(config_scenario: Optional[ScenarioConfig], effective_scenario_name: str, cli_args: dict[str, Any]) → dict[str, Any]

Merge config-file scenario args with CLI scenario args (CLI wins per-key).

When config_scenario.name does not match effective_scenario_name, the config args are skipped with a warning so users are not silently surprised. Mutable values are deep-copied so they don’t leak across runs.

Returns:

• dict[str, Any] — dict[str, Any]: The merged scenario-args dict to pass to set_params_from_args.

print_deprecation_message¶

print_deprecation_message(old_item: type | Callable[..., Any] | str, new_item: type | Callable[..., Any] | str, removed_in: str) → None

Emit a deprecation warning.

PyRITShell¶

Bases: cmd.Cmd

Interactive shell for PyRIT.

Constructor Parameters:

Methods:

cmdloop¶

cmdloop(intro: Optional[str] = None) → None

Override cmdloop to play animated banner before starting the REPL.

default¶

default(line: str) → None

Handle unknown commands and convert hyphens to underscores.

do_clear¶

do_clear(arg: str) → None

Clear the screen.

do_exit¶

do_exit(arg: str) → bool

Exit the shell. Aliases: quit, q.

Returns:

• bool — True to exit the shell.

do_help¶

do_help(arg: str) → None

Show help. Usage: help [command].

do_list_initializers¶

do_list_initializers(arg: str) → None

List all available initializers.

Raises:

• RuntimeError — If initialization has not completed.

do_list_scenarios¶

do_list_scenarios(arg: str) → None

List all available scenarios.

Raises:

• RuntimeError — If initialization has not completed.

do_list_targets¶

do_list_targets(arg: str) → None

List all available targets from the TargetRegistry.

Raises:

• RuntimeError — If initialization has not completed.

do_print_scenario¶

do_print_scenario(arg: str) → None

Print detailed results for scenario runs.

do_run¶

do_run(line: str) → None

Run a scenario.

Raises:

• RuntimeError — If initialization has not completed.

do_scenario_history¶

do_scenario_history(arg: str) → None

Shows a numbered list of all scenario runs with the commands used.

emptyline¶

emptyline() → bool

Don’t repeat last command on empty line.

Returns:

• bool — False to prevent repeating the last command.

ScenarioRegistry¶

Bases: BaseClassRegistry['Scenario', ScenarioMetadata]

Registry for discovering and managing available scenario classes.

This class discovers all Scenario subclasses from:

1. Built-in scenarios in pyrit.scenario.scenarios module

2. User-defined scenarios from initialization scripts (set via globals)

Scenarios are identified by their dotted name (e.g., “garak.encoding”, “foundry.red_team_agent”).

Constructor Parameters:

Methods:

discover_user_scenarios¶

discover_user_scenarios() → None

Discover user-defined scenarios from global variables.

After initialization scripts are executed, they may define Scenario subclasses and store them in globals. This method searches for such classes.

User scenarios will override built-in scenarios with the same name.

ScenarioResult¶

Scenario result class for aggregating scenario results.

Constructor Parameters:

Methods:

get_display_groups¶

get_display_groups() → dict[str, list[AttackResult]]

Aggregate attack results by display group.

When a display_group_map was provided, results from multiple atomic_attack_name keys that share the same display group are merged into a single list. When no map was provided, this returns the same structure as attack_results (identity mapping).

Returns:

• dict[str, list[AttackResult]] — dict[str, list[AttackResult]]: Results grouped by display label.

get_objectives¶

get_objectives(atomic_attack_name: Optional[str] = None) → list[str]

Get the list of unique objectives for this scenario.

Returns:

• list[str] — List[str]: Deduplicated list of objectives.

get_scorer_evaluation_metrics¶

get_scorer_evaluation_metrics() → Optional[ScorerMetrics]

Get the evaluation metrics for the scenario’s scorer from the scorer evaluation registry.

Returns:

• Optional[ScorerMetrics] — The evaluation metrics object, or None if not found.

get_strategies_used¶

get_strategies_used() → list[str]

Get the list of strategies used in this scenario.

Returns:

• list[str] — List[str]: Atomic attack strategy names present in the results.

normalize_scenario_name¶

normalize_scenario_name(scenario_name: str) → str

Normalize a scenario name to match the stored class name format.

Converts CLI-style snake_case names (e.g., “foundry” or “content_harms”) to PascalCase class names (e.g., “Foundry” or “ContentHarms”) for database queries. If the input is already in PascalCase or doesn’t match the snake_case pattern, it is returned unchanged.

This is the inverse of ScenarioRegistry._class_name_to_scenario_name().

Returns:

• str — The normalized scenario name suitable for database queries.

objective_achieved_rate¶

objective_achieved_rate(atomic_attack_name: Optional[str] = None) → int

Get the success rate of this scenario.

Returns:

• int — Success rate as a percentage (0-100).