python Click Return the helper menu

Question

I just started using python click module and I would like to have it automatically bring up the '--help' function anytime click throws an error.

test.py

@click.command()
@click.option('--count', default=1, help='Number of greetings.')
@click.option('--name', default=Adam,
              help='The person to great.')
def test(name):
    print name

If I was to run the script from the command line as test.py --no_such_thing. Is there a way I could get the --help to come up instead of the normal :Error no Option --no_such_thing

R J · Accepted Answer · 2017-05-11 17:33:29Z

2

In short, you need to modify the method click.exceptions.UsageError.show. But, I have posted a more in-depth answer to this question, along with sample code, in the answer to this SO post.

answered May 11, 2017 at 17:33

R J

4,5633 gold badges24 silver badges30 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

rcmachado · Accepted Answer · 2016-06-29 02:16:30Z

0

If you're using Click 4.0+, you can disable automatic error handling for unknown options using Context.ignore_unknown_options and Context.allow_extra_args:

import click

@click.command(context_settings={
    'allow_extra_args': True,
    'ignore_unknown_options': True,
})
@click.pass_context
def hello(ctx):
    if ctx.args:
        print(hello.get_help(ctx))

if __name__ == "__main__":
    hello()

In that case, your command will receive the remaining arguments in ctx.args list. The disadvantage is that you need to handle errors yourself or the program will fail silently.

More information can be found at the docs in the Forwarding Unknown Options section.

answered Jun 29, 2016 at 2:16

rcmachado

1194 bronze badges

Collectives™ on Stack Overflow

python Click Return the helper menu

2 Answers 2

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related