Skip to content

Latest commit

 

History

History
280 lines (220 loc) · 11.4 KB

CHANGELOG.md

File metadata and controls

280 lines (220 loc) · 11.4 KB
Raw

Change Log

Unreleased

Features

  • GH-140, PR-147 Add rich_argparse.contrib module to provide additional non-standard formatters. The new module currently contains a single formatter ParagraphRichHelpFormatter that preserves paragraph breaks (\n\n) in the descriptions, epilog, and help text.

Fixes

  • GH-141, PR-142 Do not highlight --options inside backticks.

1.6.0 - 2024-11-02

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.

1.5.2 - 2024-06-15

Fixes

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

1.5.1 - 2024-06-06

Fixes

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

1.5.0 - 2024-06-01

Features

  • 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.

Fixes

  • GH-115, PR-116 Do not print group names suppressed with argparse.SUPPRESS

1.4.0 - 2023-10-21

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.

1.3.0 - 2023-08-19

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

1.2.0 - 2023-07-02

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.

1.1.1 - 2023-05-30

Fixes

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

1.1.0 - 2023-03-11

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.

1.0.0 - 2023-01-07

Fixes

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

0.7.0 - 2022-12-31

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.

0.6.0 - 2022-12-18

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.

0.5.0 - 2022-11-05

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.

0.4.0 - 2022-10-15

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.

0.3.1 - 2022-10-08

Fixes

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

0.3.0 - 2022-10-01

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

0.2.1 - 2022-09-25

Fixes

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

0.2.0 - 2022-09-17

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

0.1.1 - 2022-09-10

Fixes

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

0.1.0 - 2022-09-03

Initial release

Features

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