cloup._params

Classes

GroupedOption(*args[, group])

A click.Option with an extra field group of type OptionGroup.

Functions

option(*param_decls[, cls, group])

Attaches an Option to the command.

Attributes

argument

Contents

class cloup._params.GroupedOption(*args, group=None, **attrs)

Bases: click.Option

A click.Option with an extra field group of type OptionGroup.

cloup._params.argument

cloup._params.option(*param_decls, cls=None, group=None, **kwargs)

Attaches an Option to the command. Refer to click.Option and click.Parameter for more info about the accepted parameters.

In your IDE, you won’t see arguments that has to do with shell completion, because they are different in Click 7 and 8 (both supported by Cloup):

• in Click 7, it’s autocompletion

• in Click 8, it’s shell_complete.

These arguments have different semantics, refer to Click’s docs.