Skip to content

MAINT BREAKING: Rename PromptConverter to Converter#2161

Merged
jsong468 merged 4 commits into
microsoft:mainfrom
jsong468:converter_rename
Jul 10, 2026
Merged

MAINT BREAKING: Rename PromptConverter to Converter#2161
jsong468 merged 4 commits into
microsoft:mainfrom
jsong468:converter_rename

Conversation

@jsong468

Copy link
Copy Markdown
Contributor

Description

Renames the converter base class and module namespace ahead of the 1.0 release. PromptConverter becomes Converter and the pyrit.prompt_converter package becomes pyrit.converter, applied consistently across code, tests, and documentation. No backward-compatibility aliases are provided as this is a breaking change for 1.0.

Changes

  • Base class: PromptConverterConverter; file prompt_converter.pyconverter.py.
  • Package: pyrit/prompt_converter/pyrit/converter/ (moved via git mv, history preserved).
  • Tests: tests/unit/prompt_converter/tests/unit/converter/.
  • Config class: PromptConverterConfigurationConverterConfiguration.
  • All references updated across imports, type hints, docstrings, and docs (.py / .ipynb pairs kept in sync).

Intentional exceptions (not renamed)

  • MathPromptConverter / math_prompt_converter — "MathPrompt" is the attack technique name, not the base class.
  • ImagePromptStyleConverter / image_prompt_style — unrelated identifier; does not contain the target token.

Tests and Documentation

  • git grep confirms zero remaining PromptConverter / prompt_converter references in committable files (excluding the intentional exceptions above).
  • Full package imports cleanly; pyrit.converter exposes Converter, ConverterResult, and all members.
  • Unit tests pass across all affected areas: converters (1,031), prompt_normalizer (53), executor + scenario (1,767), and remaining suites (7,269)
  • Notebook outputs are unchanged except doc/code/setup/1_configuration.ipynb, where one cached default_values line reflects the new class name (Converter.converter_target) — matching what a live re-run produces.
  • Note that the above notebook cell in 1_configuration.ipynb may be outdated/broken due to removal of SimpleInitializer and requires follow up for fix.

@rlundeen2 rlundeen2 self-assigned this Jul 10, 2026

@rlundeen2 rlundeen2 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved with nits on stale doc strings and things

Comment thread pyrit/converter/__init__.py Outdated
Comment thread pyrit/prompt_normalizer/converter_configuration.py Outdated

@rlundeen2 rlundeen2 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rich agrees with this comment but it is copilot generated: nit: one more cosmetic rename leftover I couldn't attach inline (GitHub sees converter.py as a rename so the line is unchanged context): pyrit/converter/converter.py line 96 — the __init__ docstring still says "Initialize the prompt converter." and should be "Initialize the converter." to match the rename.

@jsong468 jsong468 enabled auto-merge July 10, 2026 20:57
@jsong468 jsong468 added this pull request to the merge queue Jul 10, 2026
Merged via the queue into microsoft:main with commit 3acaaa6 Jul 10, 2026
53 checks passed
@jsong468 jsong468 deleted the converter_rename branch July 10, 2026 21:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants