Skip to content

Conversation

@renovate
Copy link
Contributor

@renovate renovate bot commented Dec 21, 2024

This PR contains the following updates:

Package Change Age Confidence
click (changelog) ==8.1.7 -> ==8.2.1 age confidence

Release Notes

pallets/click (click)

v8.2.1

Compare Source

Released 2025-05-20

  • Fix flag value handling for flag options with a provided type. :issue:2894
    :issue:2897 :pr:2930
  • Fix shell completion for nested groups. :issue:2906 :pr:2907
  • Flush sys.stderr at the end of CliRunner.invoke. :issue:2682
  • Fix EOF handling for stdin input in CliRunner. :issue:2787

v8.2.0

Compare Source

Released 2025-05-10

  • Drop support for Python 3.7, 3.8, and 3.9. :pr:2588 :pr:2893

  • Use modern packaging metadata with pyproject.toml instead of setup.cfg.
    :pr:2438

  • Use flit_core instead of setuptools as build backend. :pr:2543

  • Deprecate the __version__ attribute. Use feature detection, or
    importlib.metadata.version("click"), instead. :issue:2598

  • BaseCommand is deprecated. Command is the base class for all
    commands. :issue:2589

  • MultiCommand is deprecated. Group is the base class for all group
    commands. :issue:2590

  • The current parser and related classes and methods, are deprecated.
    :issue:2205

    • OptionParser and the parser module, which is a modified copy of
      optparse in the standard library.
    • Context.protected_args is unneeded. Context.args contains any
      remaining arguments while parsing.
    • Parameter.add_to_parser (on both Argument and Option) is
      unneeded. Parsing works directly without building a separate parser.
    • split_arg_string is moved from parser to shell_completion.
  • Enable deferred evaluation of annotations with
    from __future__ import annotations. :pr:2270

  • When generating a command's name from a decorated function's name, the
    suffixes _command, _cmd, _group, and _grp are removed.
    :issue:2322

  • Show the types.ParamType.name for types.Choice options within
    --help message if show_choices=False is specified.
    :issue:2356

  • Do not display default values in prompts when Option.show_default is
    False. :pr:2509

  • Add get_help_extra method on Option to fetch the generated extra
    items used in get_help_record to render help text. :issue:2516
    :pr:2517

  • Keep stdout and stderr streams independent in CliRunner. Always
    collect stderr output and never raise an exception. Add a new
    output stream to simulate what the user sees in its terminal. Removes
    the mix_stderr parameter in CliRunner. :issue:2522 :pr:2523

  • Option.show_envvar now also shows environment variable in error messages.
    :issue:2695 :pr:2696

  • Context.close will be called on exit. This results in all
    Context.call_on_close callbacks and context managers added via
    Context.with_resource to be closed on exit as well. :pr:2680

  • Add ProgressBar(hidden: bool) to allow hiding the progressbar. :issue:2609

  • A UserWarning will be shown when multiple parameters attempt to use the
    same name. :issue:2396

  • When using Option.envvar with Option.flag_value, the flag_value
    will always be used instead of the value of the environment variable.
    :issue:2746 :pr:2788

  • Add Choice.get_invalid_choice_message method for customizing the
    invalid choice message. :issue:2621 :pr:2622

  • If help is shown because no_args_is_help is enabled (defaults to True
    for groups, False for commands), the exit code is 2 instead of 0.
    :issue:1489 :pr:1489

  • Contexts created during shell completion are closed properly, fixing
    a ResourceWarning when using click.File. :issue:2644 :pr:2800
    :pr:2767

  • click.edit(filename) now supports passing an iterable of filenames in
    case the editor supports editing multiple files at once. Its return type
    is now also typed: AnyStr if text is passed, otherwise None.
    :issue:2067 :pr:2068

  • Specialized typing of progressbar(length=...) as ProgressBar[int].
    :pr:2630

  • Improve echo_via_pager behaviour in face of errors.
    :issue:2674

    • Terminate the pager in case a generator passed to echo_via_pager
      raises an exception.
    • Ensure to always close the pipe to the pager process and wait for it
      to terminate.
    • echo_via_pager will not ignore KeyboardInterrupt anymore. This
      allows the user to search for future output of the generator when
      using less and then aborting the program using ctrl-c.
  • deprecated: bool | str can now be used on options and arguments. This
    previously was only available for Command. The message can now also be
    customised by using a str instead of a bool. :issue:2263 :pr:2271

    • Command.deprecated formatting in --help changed from
      (Deprecated) help to help (DEPRECATED).
    • Parameters cannot be required nor prompted or an error is raised.
    • A warning will be printed when something deprecated is used.
  • Add a catch_exceptions parameter to CliRunner. If
    catch_exceptions is not passed to CliRunner.invoke, the value
    from CliRunner is used. :issue:2817 :pr:2818

  • Option.flag_value will no longer have a default value set based on
    Option.default if Option.is_flag is False. This results in
    Option.default not needing to implement __bool__. :pr:2829

  • Incorrect click.edit typing has been corrected. :pr:2804

  • Choice is now generic and supports any iterable value.
    This allows you to use enums and other non-str values. :pr:2796
    :issue:605

  • Fix setup of help option's defaults when using a custom class on its
    decorator. Removes HelpOption. :issue:2832 :pr:2840

v8.1.8

Compare Source

Released 2024-12-19

  • Fix an issue with type hints for click.open_file(). :issue:2717
  • Fix issue where error message for invalid click.Path displays on
    multiple lines. :issue:2697
  • Fixed issue that prevented a default value of "" from being displayed in
    the help for an option. :issue:2500
  • The test runner handles stripping color consistently on Windows.
    :issue:2705
  • Show correct value for flag default when using default_map.
    :issue:2632
  • Fix click.echo(color=...) passing color to coloroma so it can be
    forced on Windows. :issue:2606.
  • More robust bash version check, fixing problem on Windows with git-bash.
    :issue:2638
  • Cache the help option generated by the help_option_names setting to
    respect its eagerness. :pr:2811
  • Replace uses of os.system with subprocess.Popen. :issue:1476
  • Exceptions generated during a command will use the context's color
    setting when being displayed. :issue:2193
  • Error message when defining option with invalid name is more descriptive.
    :issue:2452
  • Refactor code generating default --help option to deduplicate code.
    :pr:2563
  • Test CLIRunner resets patched _compat.should_strip_ansi.
    :issue:2732

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Enabled.

Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

@renovate renovate bot enabled auto-merge (squash) December 21, 2024 18:43
@github-actions
Copy link
Contributor

github-actions bot commented Dec 21, 2024

🦙 MegaLinter status: ❌ ERROR

Descriptor Linter Files Fixed Errors Warnings Elapsed time
❌ ACTION actionlint 3 1 0 0.21s
✅ BASH shellcheck 3 0 0 0.12s
✅ BASH shfmt 3 0 0 0 0.01s
❌ COPYPASTE jscpd yes 1 no 1.82s
✅ JSON jsonlint 3 0 0 0.22s
✅ JSON prettier 3 0 0 0 0.38s
✅ JSON v8r 3 0 0 3.48s
⚠️ MARKDOWN markdownlint 2 1 26 0 0.65s
✅ MARKDOWN markdown-link-check 2 0 0 7.03s
✅ MARKDOWN markdown-table-formatter 2 1 0 0 0.18s
⚠️ PYTHON pyright 25 18 0 3.23s
✅ PYTHON ruff 25 0 0 0 0.03s
❌ REPOSITORY checkov yes 3 no 13.29s
❌ REPOSITORY devskim yes 1 1 1.06s
✅ REPOSITORY dustilock yes no no 2.67s
✅ REPOSITORY gitleaks yes no no 0.14s
✅ REPOSITORY git_diff yes no no 0.0s
❌ REPOSITORY grype yes 2 10 25.34s
❌ REPOSITORY kics yes 1 10 2.18s
✅ REPOSITORY secretlint yes no no 0.97s
✅ REPOSITORY syft yes no no 1.65s
❌ REPOSITORY trivy yes 1 10 7.12s
✅ REPOSITORY trivy-sbom yes no no 0.14s
✅ REPOSITORY trufflehog yes no no 4.55s
⚠️ SPELL cspell 43 178 0 7.07s
✅ SPELL lychee 11 0 0 1.67s
✅ YAML prettier 5 0 0 0 0.52s
✅ YAML v8r 5 0 0 2.11s
✅ YAML yamllint 5 0 0 0.46s

See detailed report in MegaLinter reports

You could have the same capabilities but better runtime performances if you use a MegaLinter flavor:

MegaLinter is graciously provided by OX Security

@renovate renovate bot changed the title chore(deps): update dependency click to v8.1.8 chore(deps): update dependency click to v8.2.0 May 10, 2025
@renovate renovate bot force-pushed the renovate/click-8.x branch from 448d513 to 1d6bb74 Compare May 10, 2025 22:38
@renovate renovate bot changed the title chore(deps): update dependency click to v8.2.0 chore(deps): update dependency click to v8.2.1 May 21, 2025
@renovate renovate bot force-pushed the renovate/click-8.x branch from 1d6bb74 to 5f0fce3 Compare May 21, 2025 02:52
@renovate renovate bot force-pushed the renovate/click-8.x branch from 5f0fce3 to 7e10248 Compare July 3, 2025 04:59
@renovate renovate bot force-pushed the renovate/click-8.x branch from 7e10248 to 7d05e67 Compare August 2, 2025 05:52
@renovate renovate bot changed the title chore(deps): update dependency click to v8.2.1 chore(deps): update dependency click to v8.2.2 Aug 2, 2025
@renovate renovate bot force-pushed the renovate/click-8.x branch from 7d05e67 to 2521cb1 Compare August 2, 2025 22:13
@renovate renovate bot changed the title chore(deps): update dependency click to v8.2.2 chore(deps): update dependency click to v8.2.1 Aug 2, 2025
@renovate renovate bot merged commit 5e95756 into main Aug 3, 2025
36 of 55 checks passed
@renovate renovate bot deleted the renovate/click-8.x branch August 3, 2025 14:07
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