Skip to content

Add back hidden CLI arguments for recent removals#1961

Open
rolandwalker wants to merge 1 commit into
mainfrom
RW/add-back-hidden-deprecated-cli-arguments
Open

Add back hidden CLI arguments for recent removals#1961
rolandwalker wants to merge 1 commit into
mainfrom
RW/add-back-hidden-deprecated-cli-arguments

Conversation

@rolandwalker

Copy link
Copy Markdown
Contributor

Description

click supports hidden+deprecated CLI arguments which are not advertised in the helpdoc.

To make breaking changes easier and clearer, we can accept the recently removed SSL and SSH CLI arguments in hidden+deprecated mode. If such an option is given, the user gets a message like the following, in red:

DeprecationWarning: The option 'ssl' is deprecated. No effect. See --ssl-mode.

We should still ultimately remove (or reimplement) these hidden arguments, since click's hidden property is incomplete: the hidden arguments are still advertised in spelling-correction mode.

xref #1948, #1947

Checklist

  • I added this contribution to the changelog.md file.
  • I added my name to the AUTHORS file (or it's already there).
  • To lint and format the code, I ran
    uv run ruff check && uv run ruff format && uv run mypy --install-types .

Click supports hidden+deprecated CLI arguments which are not advertised
in the helpdoc.

To make breaking changes easier and clearer, we can accept the recently
removed SSL and SSH CLI arguments in hidden+deprecated mode.  If such
an option is given, the user gets a message like the following, in red:

    DeprecationWarning: The option 'ssl' is deprecated. No effect. See --ssl-mode.

We should still ultimately remove (or reimplement) these hidden
arguments, since click's "hidden" property is incomplete: the hidden
arguments are still advertised in spelling-correction mode.
@rolandwalker rolandwalker self-assigned this Jun 23, 2026
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.

1 participant