module documentation

Undocumented

Class ​Abort An internal signalling exception that signals Click to abort.
Class ​Bad​Argument​Usage Raised if an argument is generally supplied but the use of the argument was incorrect. This is for instance raised if the number of values for an argument is not correct.
Class ​Bad​Option​Usage Raised if an option is generally supplied but the use of the option was incorrect. This is for instance raised if the number of arguments for an option is not correct.
Class ​Bad​Parameter No summary
Class ​Click​Exception An exception that Click can handle and show to the user.
Class ​File​Error Raised if a file cannot be opened.
Class ​No​Such​Option Raised if click attempted to handle an option that does not exist.
Class ​Usage​Error An internal exception that signals a usage error. This typically aborts any further handling.
Class ​Exit An exception that indicates that the application should exit with some status code.
Class ​Missing​Parameter Raised if click required an option or argument but it was not provided when invoking the script.
Function ​_join​_param​_hints Undocumented
def _join_param_hints(param_hint):

Undocumented

Parameters
param​_hint:t.Optional[t.Union[t.Sequence[str], str]]Undocumented
Returns
t.Optional[str]Undocumented