click.core.Context

Undocumented

Undocumented

Undocumented

Register a function to be called when the context tears down.

This can be used to close resources opened during the script execution. Resources that support Python's context manager protocol which would be used in a with statement should be registered with with_resource instead.

Similar to invoke but fills in default keyword arguments from the current context if the other command expects it. This cannot invoke callbacks directly, only other commands.

Get the source of a parameter. This indicates the location from which the value of the parameter was obtained.

This can be useful for determining when a user specified a value on the command line that is the same as the default value. It will be ~click.core.ParameterSource.DEFAULT only if the value was actually taken from the default.

Invokes a command callback in exactly the way it expects. There are two ways to invoke this method:

1. the first argument can be a callback and all other arguments and keyword arguments are forwarded directly to the function.
2. the first argument is a click command object. In that case all arguments are forwarded as well but proper click parameters (options and click arguments) must be keyword arguments and Click will fill in defaults.

Note that before Click 3.2 keyword arguments were not properly filled in against the intention of this code and no context was created. For more information about this change and why it was done in a bugfix release see :ref:`upgrade-to-3.2`.

Get the default for a parameter from default_map.

Creates the ~click.HelpFormatter for the help and usage output.

To quickly customize the formatter class used without overriding this method, set the formatter_class attribute.

This helper method can be used with the context object to promote it to the current thread local (see get_current_context). The default behavior of this is to invoke the cleanup functions which can be disabled by setting cleanup to False. The cleanup functions are typically used for things such as closing file handles.

If the cleanup is intended the context object can also be directly used as a context manager.

Example usage:

with ctx.scope():
    assert get_current_context() is ctx

This is equivalent:

with ctx:
    assert get_current_context() is ctx

Gather information that could be useful for a tool generating user-facing documentation. This traverses the entire CLI structure.

with Context(cli) as ctx:
    info = ctx.to_info_dict()

Register a resource as if it were used in a with statement. The resource will be cleaned up when the context is popped.

Uses contextlib.ExitStack.enter_context. It calls the resource's __enter__() method and returns the result. When the context is popped, it closes the stack, which calls the resource's __exit__() method.

To register a cleanup function for something that isn't a context manager, use call_on_close. Or use something from contextlib to turn it into a context manager first.

@click.group()
@click.option("--name")
@click.pass_context
def cli(ctx):
    ctx.obj = ctx.with_resource(connect_db(name))