class documentation

class CompositeParamType(ParamType):

Known subclasses: click.types.Tuple

View In Hierarchy

Undocumented

Class Variable is​_composite Undocumented
Property arity Undocumented

Inherited from ParamType:

Method __call__ Undocumented
Method convert Convert the value to the correct type. This is not called if the value is None (the missing value).
Method fail Helper method to fail with an invalid value message.
Method get​_metavar Returns the metavar default for this param if it provides one.
Method get​_missing​_message Optionally might return extra information about a missing parameter.
Method shell​_complete No summary
Method split​_envvar​_value Given a value from an environment variable this splits it up into small chunks depending on the defined envvar list splitter.
Method to​_info​_dict Gather information that could be useful for a tool generating user-facing documentation.
Class Variable envvar​_list​_splitter Undocumented
Class Variable name Undocumented
is_composite: bool =

Undocumented

@property
arity: int =
overridden in click.types.Tuple

Undocumented