rich-argparse

Fixes

• PR-171 Fix colors overlapping with Python 3.14.0+ which enabled colors by default in the help formatter.

This is the last release to support Python 3.8

Introducing auto-rich-argparse 🚀

Improve the help output of your favorite argparse command line tool by simply installing auto-rich-argparse in its environment. Try it out with your favorite tool using:

uvx --with auto-rich-argparse <YOUR_FAVORITE_TOOL> --help

Read more at https://github.com/hamdanal/auto-rich-argparse.

Incoming Change in Version 2.0

In rich-argparse 2.0, rich markup will become opt in instead of opt out. This means usages like this:

parser.add_argument("--foo", help="[red]This text is in red[/]")

Will need to set the option RichHelpFormatter.help_markup = True to work as expected. Please see #151 for context and to give feedback.

What's Changed

This release adds new features and fixes a few bugs.

Features

• Add support for django commands in the new rich_argparse.django module. Read more at https://github.com/hamdanal/rich-argparse#django-support. Contributed in https://github.com/hamdanal/rich-argparse/pull/149
• Add ParagraphRichHelpFormatter, a formatter that preserves paragraph breaks, in the new rich_argparse.contrib module. Read more at https://github.com/hamdanal/rich-argparse#additional-formatters. Contributed in https://github.com/hamdanal/rich-argparse/pull/147

Fixes

• Fix ValueError when using %(default)s inside square brackets and help_markup is enabled. Contributed in https://github.com/hamdanal/rich-argparse/pull/153 and https://github.com/hamdanal/rich-argparse/pull/154
• Do not highlight --options inside backticks. Contributed in https://github.com/hamdanal/rich-argparse/pull/142

Other Changes

• Start testing on Python 3.14 by @hamdanal in https://github.com/hamdanal/rich-argparse/pull/137
• Use native toml for tox configuration by @hamdanal in https://github.com/hamdanal/rich-argparse/pull/138
• sdist: include the tests by @mr-c in https://github.com/hamdanal/rich-argparse/pull/139
• Reorganize the project modules by @hamdanal in https://github.com/hamdanal/rich-argparse/pull/144
• Run skipped test on Python 3.13 by @hamdanal in https://github.com/hamdanal/rich-argparse/pull/145
• Replace tox by uv by @hamdanal in https://github.com/hamdanal/rich-argparse/pull/146
• Bump astral-sh/setup-uv from 4 to 5 by @dependabot in https://github.com/hamdanal/rich-argparse/pull/148
• Add python nightly workflow by @hamdanal in https://github.com/hamdanal/rich-argparse/pull/150

New Contributors

• @mr-c made their first contribution in https://github.com/hamdanal/rich-argparse/pull/139

Full Changelog: https://github.com/hamdanal/rich-argparse/compare/v1.6.0...v1.7.0

Features

• PR-149 Add support for django commands in the new rich_argparse.django module. Read more at https://github.com/hamdanal/rich-argparse#django-support
• GH-140, PR-147 Add ParagraphRichHelpFormatter, a formatter that preserves paragraph breaks, in the new rich_argparse.contrib module. Read more at https://github.com/hamdanal/rich-argparse#additional-formatters

Fixes

• GH-152, PR-153, PR-154 Fix ValueError when using %(default)s inside square brackets and help_markup is enabled.
• GH-141, PR-142 Do not highlight --options inside backticks.

What's Changed

• Improved way to create metavars coloured strings by @atteggiani in https://github.com/hamdanal/rich-argparse/pull/128
• Do not wrap long group titles by @hamdanal in https://github.com/hamdanal/rich-argparse/pull/131
• [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in https://github.com/hamdanal/rich-argparse/pull/132
• Fix help preview generation with newer releases of rich by @hamdanal in https://github.com/hamdanal/rich-argparse/pull/135
• Update RichHelpFormatter.add_text() type hint to reflect its ability to take a Rich renderable. by @kmvanbrunt in https://github.com/hamdanal/rich-argparse/pull/134

New Contributors

• @atteggiani made their first contribution in https://github.com/hamdanal/rich-argparse/pull/128
• @kmvanbrunt made their first contribution in https://github.com/hamdanal/rich-argparse/pull/134

Full Changelog: https://github.com/hamdanal/rich-argparse/compare/v1.5.2...v1.6.0

Fixes

• GH-133, PR-135 Fix help preview generation with newer releases of rich.
• GH-130, PR-131 Fix a bug that caused long group titles to wrap.
• GH-125, GH-127, PR-128 Redesign metavar styling to fix broken colors of usage when some metavars are wrapped to multiple lines. The brackets and spaces of metavars are no longer colored.

Fixes

• PR-124 Fix a regression in %(default)s style that was introduced in #123.

What's Changed

• Fix %(default)s style when help markup is deactivated by @hamdanal in https://github.com/hamdanal/rich-argparse/pull/123

Full Changelog: https://github.com/hamdanal/rich-argparse/compare/v1.5.0...v1.5.1

Fixes

• GH-121, PR-123 Fix %(default)s style when help markup is deactivated.

Highlights of the release

• PR-103 Python 3.13 is now officially supported
• GH-95, PR-103 Python 3.7 is no longer supported (EOL since 27/6/2023)
• GH-120, GH-121, PR-122 Add options help_markup and text_markup to disable console markup in the help text and the description text respectively.
• GH-115, PR-116 Do not print group names suppressed with argparse.SUPPRESS

---

What's Changed

• Drop support for python 3.7 and add 3.13 to CI by @hamdanal in https://github.com/hamdanal/rich-argparse/pull/103
• Use the ruff formatter by @hamdanal in https://github.com/hamdanal/rich-argparse/pull/104
• [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in https://github.com/hamdanal/rich-argparse/pull/105
• [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in https://github.com/hamdanal/rich-argparse/pull/106
• Bump actions/setup-python from 4 to 5 by @dependabot in https://github.com/hamdanal/rich-argparse/pull/107
• Update dependencies and fix CI by @hamdanal in https://github.com/hamdanal/rich-argparse/pull/108
• Bump actions/upload-artifact from 3 to 4 by @dependabot in https://github.com/hamdanal/rich-argparse/pull/109
• [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in https://github.com/hamdanal/rich-argparse/pull/110
• Update dev tools by @hamdanal in https://github.com/hamdanal/rich-argparse/pull/113
• New README preview by @hamdanal in https://github.com/hamdanal/rich-argparse/pull/114
• Do not print suppressed group names by @hamdanal in https://github.com/hamdanal/rich-argparse/pull/116
• Add options to disable console markup by @hamdanal in https://github.com/hamdanal/rich-argparse/pull/122

New Contributors

• @dependabot made their first contribution in https://github.com/hamdanal/rich-argparse/pull/107

Full Changelog: https://github.com/hamdanal/rich-argparse/compare/v1.4.0...v1.5.0

Highlights of the release

• Add HelpPreviewAction to generate a preview of the help output in SVG, HTML, or TXT formats.
• Allow arbitrary renderables like Markdown and Table in the descriptions and epilog.

What's Changed

• Update pre-commit and github actions by @hamdanal in https://github.com/hamdanal/rich-argparse/pull/89
• Make RichHelpFormatter itself renderable with rich by @hamdanal in https://github.com/hamdanal/rich-argparse/pull/90
• Allow passing a custom console to the formatter by @hamdanal in https://github.com/hamdanal/rich-argparse/pull/92
• [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in https://github.com/hamdanal/rich-argparse/pull/94
• Add action to generate SVG, HTML, or TXT help preview by @hamdanal in https://github.com/hamdanal/rich-argparse/pull/93
• Add links to the changelog by @hamdanal in https://github.com/hamdanal/rich-argparse/pull/96
• Avoid importing typing to improve startup time 35% by @hamdanal in https://github.com/hamdanal/rich-argparse/pull/97
• Add a style for default values when using %(default)s by @hamdanal in https://github.com/hamdanal/rich-argparse/pull/98
• Allow arbitrary renderables in the descriptions and epilog by @hamdanal in https://github.com/hamdanal/rich-argparse/pull/99
• Fix color of brackets surrounding positional arguments in the usage by @hamdanal in https://github.com/hamdanal/rich-argparse/pull/101

Full Changelog: https://github.com/hamdanal/rich-argparse/compare/v1.3.0...v1.4.0

Features

• PR-90 Make RichHelpFormatter itself a rich renderable with rich console.
• GH-91, PR-92 Allow passing custom console to RichHelpFormatter.
• GH-91, PR-93 Add HelpPreviewAction to generate a preview of the help output in SVG, HTML, or TXT formats.
• PR-97 Avoid importing typing to improve startup time by about 35%.
• GH-84, PR-98 Add a style for default values when using %(default)s in the help text.
• PR-99 Allow arbitrary renderables in the descriptions and epilog.

Fixes

• GH-100, PR-101 Fix color of brackets surrounding positional arguments in the usage.

Highlights of the release

• Experimental support for optparse now includes auto generation of usage string from options (similar to argparse). See https://github.com/hamdanal/rich-argparse#optparse-support for more.
• Fix ansi codes not correctly displayed on legacy Windows consoles

What's Changed

• Use strip_control_codes from rich by @hamdanal in https://github.com/hamdanal/rich-argparse/pull/75
• [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in https://github.com/hamdanal/rich-argparse/pull/76
• Fix ansi escape codes on legacy windows console by @hamdanal in https://github.com/hamdanal/rich-argparse/pull/80
• Improve the README by @hamdanal in https://github.com/hamdanal/rich-argparse/pull/83
• Support older windows with colorama by @hamdanal in https://github.com/hamdanal/rich-argparse/pull/85
• Fix typos by @kianmeng in https://github.com/hamdanal/rich-argparse/pull/86
• Improve optparse by @hamdanal in https://github.com/hamdanal/rich-argparse/pull/87

New Contributors

• @kianmeng made their first contribution in https://github.com/hamdanal/rich-argparse/pull/86

Full Changelog: https://github.com/hamdanal/rich-argparse/compare/v1.2.0...v1.3.0

Features

• PR-87 Add optparse.GENERATE_USAGE to auto generate a usage similar to argparse.
• PR-87 Add rich_format_* methods to optparse formatters. These return a rich.text.Text object.

Fixes

• GH-79, PR-80, PR-85 Fix ansi escape codes on legacy Windows console

Features

• PR-73 Add experimental support for optparse. Import optparse formatters from rich_argparse.optparse.

Changes

• PR-72 The project now uses ruff for linting and import sorting.
• PR-71 rich_argparse is now a package instead of a module. This should not affect users.

Fixes

• PR-74 Fix crash when a metavar following a long option contains control codes.

Fixes

• GH-67, PR-69 Fix % not being escaped properly
• PR-68 Restore lazy loading of rich. Delay its import until it is needed.

Features

• GH-55, PR-56 Add a new style for %(prog)s in the usage. The style is applied in argparse-generated usage and in user defined usage whether the user usage is plain text or rich markup.

Fixes

• GH-49, PR-50 RichHelpFormatter now respects format conversion types in help strings

Features

• GH-47, PR-48 The default group_name_formatter has changed from str.upper to str.title. This renders better with long group names and follows the convention of popular CLI tools and programs. Please note that if you test the output of your CLI verbatim and rely on the default behavior of rich_argparse, you will have to either set the formatter explicitly or update the tests.

Features

• PR-43 Support type checking for users. Bundle type information in the wheel and sdist.

Fixes

• PR-43 Fix annotations of class variables previously typed as instance variables.

Features

• PR-38 Support console markup in custom usage messages. Note that this feature is not activated by default. To enable it, set RichHelpFormatter.usage_markup = True.

Fixes

• PR-35 Use soft_wrap in console.print instead of a large fixed console width for wrapping
• GH-36, PR-37 Fix a regression in highlight regexes that caused the formatter to crash when using the same style multiple times.

Features

• PR-31 Add support for all help formatters of argparse. Now there are five formatter classes defined in rich_argparse:

  RichHelpFormatter:                 the equivalent of argparse.HelpFormatter
  RawDescriptionRichHelpFormatter:   the equivalent of argparse.RawDescriptionHelpFormatter
  RawTextRichHelpFormatter:          the equivalent of argparse.RawTextHelpFormatter
  ArgumentDefaultsRichHelpFormatter: the equivalent of argparse.ArgumentDefaultsHelpFormatter
  MetavarTypeRichHelpFormatter:      the equivalent of argparse.MetavarTypeHelpFormatter
  

  Note that this changes the default behavior of RichHelpFormatter to no longer respect line breaks in the description and help text. It now behaves similarly to the original HelpFormatter. You have now to use the appropriate subclass for this to happen.

Fixes

• GH-28, PR-30 Fix required options not coloured in the usage

Features

• GH-16, PR-17 A new custom usage lexer that is consistent with the formatter styles

Fixes

• GH-16, PR-17 Fix inconsistent coloring of args in the top usage panel
• GH-12, PR-20 Fix incorrect line breaks that put metavars on a alone on a new line
• GH-19, PR-21 Do not print help output, return it instead

Changes

• PR-17 The default styles have been changed to be more in line with the new usage coloring
• PR-20 The default max_help_position is now set to 24 (the default used in argparse) as line breaks are no longer an issue

Removed

• PR-20 The RichHelpFormatter.renderables property has been removed, it was never documented

Tests

• PR-22 Run windows tests in CI

Fixes

• GH-13, PR-14 Fix compatibility with argparse.ArgumentDefaultsHelpFormatter

Features

• GH-4, PR-9 Metavars now have their own style argparse.metavar which defaults to 'bold cyan'

Fixes

• GH-4, PR-10 Add missing ":" after the group name similar to the default HelpFormatter
• PR-11 Fix padding of long options or metavars
• PR-11 Fix overflow of text in help that was truncated
• PR-11 Escape parameters that get substituted with % such as %(prog)s and %(default)s
• PR-11 Fix flaky wrapping of long lines

Fixes

• GH-5, PR-6 Fix RichHelpFormatter does not replace %(prog)s in text
• GH-7, PR-8 Fix extra newline at the end

Initial release

Features

• First upload to PyPI, pip install rich-argparse now supported