cloup._params

Classes

Argument(*args[, help])

Option(*args[, group])

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

Functions

argument(*args[, help, cls])

option(*param_decls[, cls, group])

Attaches an Option to the command.

Attributes

GroupedOption

Alias of Option.

Contents

class cloup._params.Argument(*args, help=None, **attrs)[source]

Bases: click.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.

All parameters are passed onwards to the parameter constructor.

help_record(self, ctx)[source]
class cloup._params.Option(*args, group=None, **attrs)[source]

Bases: click.Option

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

cloup._params.GroupedOption

Alias of Option.

cloup._params.argument(*args, help=None, cls=Argument, **kwargs)[source]
cloup._params.option(*param_decls, cls=None, group=None, **kwargs)[source]

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.