.rst .pdf

repository open issue suggest edit

Contents

cloup._commands

Classes summary

Command(*click_args[, constraints, …])	A click.Command supporting option groups and constraints.
MultiCommand(*args[, commands, sections, …])	A click.MultiCommand that allows to organize its subcommands in multiple help sections and and whose subcommands are, by default, of type cloup.Command.
Group([name, commands, sections, align_sections])	A click.Group that allows to organize its subcommands in multiple help sections and and whose subcommands are, by default, of type cloup.Command.

Functions Summary

group([name, cls])	Decorator for creating a new Group.
command([name, cls])	Decorator that creates a new command using the wrapped function as callback.

Contents

class cloup._commands.Command(*click_args, constraints=(), show_constraints=False, align_option_groups=True, **click_kwargs)

Bases: cloup.constraints.ConstraintMixin, cloup._option_groups.OptionGroupMixin, click.Command

A click.Command supporting option groups and constraints.

Parameters

• constraints (Sequence[cloup.constraints._support.BoundConstraintSpec]) –

• show_constraints (bool) –

• align_option_groups (bool) –

class cloup._commands.MultiCommand(*args, commands=None, sections=(), align_sections=True, **kwargs)

Bases: cloup._sections.SectionMixin, click.MultiCommand

A click.MultiCommand that allows to organize its subcommands in multiple help sections and and whose subcommands are, by default, of type cloup.Command.

This class is just a click.MultiCommand mixed with SectionMixin. See the docstring of the two superclasses for more details.

Parameters

• commands (Optional[Dict[str, click.core.Command]]) –

• sections (Iterable[cloup._sections.Section]) –

• align_sections (bool) –

class cloup._commands.Group(name=None, commands=None, sections=(), align_sections=True, **attrs)

Bases: cloup._sections.SectionMixin, click.Group

A click.Group that allows to organize its subcommands in multiple help sections and and whose subcommands are, by default, of type cloup.Command.

This class is just a click.Group mixed with SectionMixin that overrides the decorators command() and group() so that a section for the created subcommand can be specified.

See the docstring of the two superclasses for more details.

Parameters

• name (Optional[str]) –

• commands (Optional[Dict[str, click.core.Command]]) –

• sections (Iterable[cloup._sections.Section]) –

• align_sections (bool) –

command(self, name=None, cls=None, section=None, **kwargs)

Creates a new command and adds it to this group.

Parameters

• name (Optional[str]) –

• cls (Optional[Type[click.Command]]) –

• section (Optional[cloup._sections.Section]) –

Return type

Callable[[Callable], click.Command]

group(self, name=None, cls=None, section=None, **kwargs)

A shortcut decorator for declaring and attaching a group to the group. This takes the same arguments as group() but immediately registers the created command with this instance by calling into add_command().

Parameters

• name (Optional[str]) –

• cls (Optional[Type[click.Group]]) –

• section (Optional[cloup._sections.Section]) –

cloup._commands.group(name=None, cls=Group, **attrs)

Decorator for creating a new Group.

Note

If you use static type checking, note that the cls optional argument of this function must be of type cloup.Group, not click.Group.

Parameters

• name (Optional[str]) – name of the command

• cls (Type[cloup._commands.Group]) – type of cloup.Group

• attrs – any argument you can pass to click.group()

Return type

Callable[[Callable], cloup._commands.Group]

cloup._commands.command(name=None, cls=Command, **attrs)

Decorator that creates a new command using the wrapped function as callback.

The only differences with respect to click.commands are:

• this decorator creates a cloup.Command by default;

• this decorator supports @constraint.

Parameters

• name (Optional[str]) – name of the command

• cls (Type[click.core.Command]) – type of click.Command

• attrs – any argument you can pass to click.command()

Return type

Callable[[Callable], click.core.Command]