click.core

module documentation

Undocumented

Class ​Argument Arguments are positional parameters to a command. They generally provide fewer features than options but can have infinite nargs and are required by default.
Class ​Base​Command No summary
Class ​Command Commands are the basic building block of command line interfaces in Click. A basic command handles command line parsing and might dispatch more parsing to commands nested below it.
Class ​Command​Collection No summary
Class ​Context The context is a special internal object that holds state relevant for the script execution at every single level. It's normally invisible to commands unless they opt-in to getting access to it.
Class ​Group A group allows a command to have subcommands attached. This is the most common way to implement nesting in Click.
Class ​Multi​Command A multi command is the basic implementation of a command that dispatches to subcommands. The most common version is the Group.
Class ​Option Options are usually optional values on the command line and have some extra features that arguments don't have.
Class ​Parameter No summary
Class ​Parameter​Source This is an ~enum.Enum that indicates the source of a parameter's value.
Constant F Undocumented
Constant V Undocumented
Function ​_check​_iter Check if the value is iterable but not a string. Raises a type error, or return an iterator over the value.
Function ​_check​_multicommand Undocumented
Function ​_complete​_visible​_commands List all the subcommands of a group that start with the incomplete value and aren't hidden.
Function augment​_usage​_errors Context manager that attaches extra information to exceptions.
Function batch Undocumented
Function iter​_params​_for​_processing Given a sequence of parameters in the order as should be considered for processing and an iterable of parameters that exist, this returns a list in the correct order as they should be processed.
F =

Undocumented

Value
t.TypeVar('F',
          bound=t.Callable[..., t.Any])
V =

Undocumented

Value
t.TypeVar('V')
def _check_iter(value):
Check if the value is iterable but not a string. Raises a type error, or return an iterator over the value.
Parameters
value:t.AnyUndocumented
Returns
t.Iterator[t.Any]Undocumented
def _check_multicommand(base_command, cmd_name, cmd, register=False):

Undocumented

Parameters
base​_command:MultiCommandUndocumented
cmd​_name:strUndocumented
cmd:CommandUndocumented
register:boolUndocumented
def _complete_visible_commands(ctx, incomplete):
List all the subcommands of a group that start with the incomplete value and aren't hidden.
Parameters
ctx:ContextInvocation context for the group.
incomplete:strValue being completed. May be empty.
Returns
t.Iterator[t.Tuple[str, Command]]Undocumented
@contextmanager
def augment_usage_errors(ctx, param=None):
Context manager that attaches extra information to exceptions.
Parameters
ctx:ContextUndocumented
param:t.Optional[Parameter]Undocumented
Returns
t.Iterator[None]Undocumented
def batch(iterable, batch_size):

Undocumented

Parameters
iterable:t.Iterable[V]Undocumented
batch​_size:intUndocumented
Returns
t.List[t.Tuple[V, ...]]Undocumented
def iter_params_for_processing(invocation_order, declaration_order):
Given a sequence of parameters in the order as should be considered for processing and an iterable of parameters that exist, this returns a list in the correct order as they should be processed.
Parameters
invocation​_order:t.Sequence[Parameter]Undocumented
declaration​_order:t.Sequence[Parameter]Undocumented
Returns
t.List[Parameter]Undocumented