How to access the main Context object of a Python Click application

Question

Consider the following minimal Click script mytool.py:

import click

@click.command()
@click.option('--name', help='The person to greet.')
def hello(name):
    """Simple program that greets NAME."""
    click.echo('Hello %s!' % name)

if __name__ == '__main__':
    hello()

How can I access the Context object Click generates for this script when I call it with

python mytool.py

In particular access to the the info_name attribute is important (so that, when I programmatically want to display the help message, the script name mytool.py is populated.(*)

(*) I know that I can generate a new Context object via click.Context(hello) but this context does not contain by itself the info_name property. Of course I can figure out the script name manually, but Click certainly creates a default context with the script name and I believe that one would be the best to access. (See also Does click lib provide a way to print the builtin help message?)

AirbusDriver · Accepted Answer · 2019-11-06 12:15:01Z

3

https://click.palletsprojects.com/en/7.x/complex/

Add @click.pass_context as the final decorator and it becomes the first parameter in your function.

answered Nov 6, 2019 at 12:15

AirbusDriver

1161 silver badge1 bronze badge

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

1 Comment

halloleo Over a year ago

That's exactly what I was after. Thanks.

Collectives™ on Stack Overflow

How to access the main Context object of a Python Click application

1 Answer 1

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related