Upstream

Click Extra was born as a collection of patches for unmaintained or slow-moving click-contrib addons. Over time, many of these fixes were contributed back upstream, and the project grew into a significant contributor to the Click ecosystem.

This page tracks click-extra’s relationship with its upstream dependencies: code contributed back, issues reported, workarounds provided, and features that upstream declined.

Code contributed upstream

PRs authored by the click-extra maintainer and merged into upstream projects.

click

Default and sentinel handling:

• #3137 - Provide altered context to callbacks to hide UNSET values as None

• #3068 - Hide Sentinel.UNSET values for defaults processed by Context.invoke

• #3048 - Regroup sentinels

• #3030 - Differentiate absence of value and value of absence for default and flag_value arguments

• #2956 - Fix reconciliation of envvar with default, flag_value and type parameters for flag options

• #3225 - Fix callable flag_value being instantiated when used as a default

• #3224 - Hide Sentinel.UNSET values as None in lookup_default()

• #3299 - Fix speculative empty string check

• #3240 - Reduce blast-radius of UNSET in default_map

Help system:

• #2811 - Fix eagerness of help option generated by help_option_names

• #2840 - Move --help option defaults from its class to its decorator

• #2563 - Deduplicate --help option definition

• #2517 - Split generation of help extra items and rendering

Enum and Choice support:

• #3004 - Fix rendering of Enum choices’ default

• #3053 - Add more tests on Enum rendering

Testing:

• #2523 - Keep track of <stderr> and <stdout> mix in CliRunner results

• #3151 - Randomized and parallel tests

• #3238 - Fix pager test leaks

• #3235 - Allow debugger interactions in tests

• #3012 - Add two new tests for Parameter.__init__

• #3223 - Add cross-reference to tests from test_defaults.py

• #2680 - Fix closing of callbacks on CLI exit

Documentation:

• #3330 - Path normalization documentation clean-up + shlex.split extensive tests

• #3245 - Document and fix command sanitizing with shlex.split

• #3049 - Tone-down the case of default=True for flags in documentation

• #2815 - Add links to third-party projects enhancing Click

• #2534 - Remove Python 2 compatibility code from docs

python-tabulate

• #151 - Add new rounded/simple/double _grid/_outline formats

• #183 - Implement heavy/mixed _grid/_outline formats

• #204 - Fix multiline folding of table formats rendering unseparated cells

• #410 - Fix alignments in github tables

pygments

• #1529 - Add missing prompt color for Solarized style

furo

• #657 - Use the reference HtmlFormatter class defined on PygmentsBridge

• #426 - Allow GitHub edit link without Read the Docs

cloup

• #153 - Use the same (Deprecated) label as in Click

pallets-sphinx-themes

• #62 - Render .. click:run:: code blocks with shell-session lexer

• #69 - Remove Python 2 compatibility code

click-contrib/sphinx-click

• #117 - Add reference to complementary Click CLI documentation helpers

• #118 - Typo fix

click-contrib/click-log

• #24 - Add missing string interpolation in error message

• #4 - Add Trove classifiers

• #2 - Fix parsing of unicode logs

Upstreamed from click-extra

Issues that click-extra solved with local workarounds first. The fix was later contributed upstream and the workaround removed from click-extra.

click

• #2811 / #2563 - Help option eagerness and deduplication. click-extra had custom HelpOption fixes; contributed upstream and removed locally.

• #2680 - Callbacks not properly closed on CLI exit. click-extra patched Option to force-close; contributed the fix upstream.

• #2523 / #2522 - CliRunner conflating stderr and stdout. click-extra backported the fix before the Click release.

• #2516 / #2517 - Help extra items (default, envvar, required) were computed and rendered together. click-extra needed them split to inject colorization; contributed the refactor upstream.

cloup

• #160 / #162 - cloup.Group ignored command_class for subcommands. click-extra worked around it; Cloup fixed it in a later release.

• #177 - cloup.Color could not be rendered by Sphinx. click-extra had an exception handler; Cloup fixed the import.

Addressed by click-extra

Issues that remain open or unfixed upstream. click-extra provides the solution.

Color and terminal support

click-extra implements NO_COLOR, FORCE_COLOR, and full help colorization with a theme system, addressing long-standing Click gaps:

• click#558 - Support FORCE_COLOR in click.echo

• click#1090 - Color output from CI jobs

• click#1498 - Support for NO_COLOR proposal

• click#2207 - Support NO_COLOR environment variable

• click#2111 - Context.color = False doesn’t override echo(color=True)

• click#2110 - testing.CliRunner.invoke cannot pass color for Context instantiation

• click-help-colors#17 - Highlighting of options, choices and metavars

• cloup#95 - Highlights options, choices and metavars

• cloup#97 - Styling metavars, default values, env var, choices

Configuration files

click-extra’s config module replaces the functionality of several unmaintained packages, with multi-format support (TOML, YAML, JSON, INI, XML), pyproject.toml integration, and a precedence chain:

• configmanager#164 - Should be used?

• configmanager#152 - XML format

• configmanager#139 - TOML format

• click_config_file#26 - Don’t require FILE for --config when implicit=False?

• click_config_file#11 - Warn when providing unsupported options in the config file?

• click_config_file#9 - Additional configuration providers

• click-configfile#9 - Inquiry on Repo Status

• click-configfile#8 - Exclude some options from config file

• click-configfile#5 - Interpolation

• click-configfile#2 - Order of configuration file and environment variable value

Version option

click-extra’s ExtraVersionOption adds template variables for git metadata (branch, hash, date, tag), environment info, and Python/OS details:

• click#2324 - Can’t pass click.version_option() to click.MultiCommand(params=)

• click#2331 - version_option module name and package name are not equivalent

• click#1756 - Path and Python version for version message formatting

Environment variables

click-extra auto-generates environment variables for all options and adds show_envvar as a global context setting:

• click#2483 - Missing auto-generated environment variables in help screen & case-sensitivity

• click#2313 - Add show_envvar as global setting via context_settings (like show_default)

Logging

click-extra’s logging module replaces the unmaintained click-log package:

• click-log#29 - Log level is leaking between invocations: hack to force-reset it

• click-log#30 - Add a no-color option, method or parameter to disable coloring globally

Normalized arguments

• click#1279 - Provide access to a normalized list of args that will result in the same params

ANSI rendering in documentation

click-extra provides AnsiSessionLexer and Sphinx integration for rendering ANSI-colored CLI output in documentation:

• pygments#1148 - Can’t format console/shell-session output that includes ANSI colors

• pygments#477 - Support ANSI (ECMA-48) color-coded text input

• nbsphinx#852 - Sphinx & Pygments integration for ANSI rendering

• kitty#5482 - ANSI shell sessions in Sphinx documentation

• sphinx-contrib/ansi#9 - ANSI Codes in output

• MyST-Parser#845 - Add an extension to support GitHub alerts

Sphinx click:source and click:run directives

click-extra maintains and extends the click:source/click:run directives originally from pallets-sphinx-themes:

• pallets-sphinx-themes#61 - Move .. click:example:: and .. click:run:: implementation to sphinx-click

• sphinx-click#110 - Supports .. click:example:: and .. click:run:: directives

• cloup#92 - Use sphinx directive to generate output of full examples in the docs

Declined by upstream

PRs and features rejected by upstream maintainers. click-extra provides the functionality regardless.

python-tabulate

• #261 - Add support for alignments in Markdown tables

• #260 - Renders GitHub-Flavored Markdown tables in canonical format

click-extra maintains a local patch for GitHub-Flavored Markdown table alignment.

dbcli/cli_helpers

• #79 - Replace local tabulate formats with those available upstream

Open upstream

PRs and issues still pending upstream.

click

• #3333 - Click-specific contribution guidelines

• #3328 - Show default string in prompt

• #3250 - Mark make_default_short_help as private API

• #3248 - Reorder ParameterSource

• #3244 - Expose original file descriptor in CliRunner

• #3239 - Reconcile default value passing and default activation

• #3036 - Add support for set and frozenset as native Click types

pygments

• #2716 - Add examples to all lexers

• #2415 - Mermaid syntax highlighting

• #2414 - Pure-CSS line numbering

python-tabulate

• #426 - Respect padding in pipe/github separator rows

executablebooks/MyST-Parser

• #1048 - Aligns directive’s block_text content to rST’s

• #1119 - Batch syntax for consecutive same-type directives

click-contrib/click-log

• #18 - Add trailing dot to help text