Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mark parameter as deprecated #2263

Open
stmlange opened this issue Apr 28, 2022 · 3 comments · May be fixed by #2271
Open

Mark parameter as deprecated #2263

stmlange opened this issue Apr 28, 2022 · 3 comments · May be fixed by #2271
Assignees
Milestone

Comments

@stmlange
Copy link

Thanks for this great project!
Perhaps it's just me who feels that it is rather cumbersome mark a single parameter as deprecated (the closet I found was https://stackoverflow.com/a/50402799). Is there perhaps a more official method to mark a single parameter as deprecated?
That would somewhat be similar to #1507.

Possible scenarios:

  • the parameter was renamed (e.g. a previous version was using --name as option, but now a dev want's to make sure it's the --sur-name.
  • the parameter is not needed anymore

Perhaps as an example consider:

import click

@click.command()
@click.option('--count', default=1, help='Number of greetings.')
@click.option('--name', prompt='Your name',
              help='The person to greet.')
def hello(count, name):
    """Simple program that greets NAME for a total of COUNT times."""
    for x in range(count):
        click.echo(f"Hello {name}!")

if __name__ == '__main__':
    hello()

and I want to rename --count to --greetings-count.
However I don't want to remove --count instantly, instead when users use --count prompt a message that they should use the new --greetings-count. The usage of --count and --greetings-count should be forbidden.

Thanks.

@peacock0803sz
Copy link

I'll work on this

@peacock0803sz
Copy link

@davidism I just implemented to show the message with --help.
Is it better to show same message running without --help?

@peacock0803sz peacock0803sz linked a pull request May 2, 2022 that will close this issue
6 tasks
@adam-tokarski
Copy link

adam-tokarski commented Sep 30, 2022

Hi, @peacock0803sz, what's the status of this issue?

You've linked that PR which has to fix the issue, but it's not clear how exactly - I mean the PR is rather about printing the thing out in help, right?

Is the more appropriate PR maybe already merged? Or it's not created yet?


edited:
Or rather that PR is only for covering deprecated attrs when used in custom Option classes like it is in linked example from SO?

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 a pull request may close this issue.

4 participants