click.exceptions.ClickException

class documentation

class ClickException(Exception): (source)

Known subclasses: click.exceptions.FileError, click.exceptions.UsageError

View In Hierarchy

An exception that Click can handle and show to the user.

Method __init__ Undocumented
Method __str__ Undocumented
Method format_message Undocumented
Method show Undocumented
Class Variable exit_code Undocumented
Instance Variable message Undocumented
def __init__(self, message): (source)
overridden in click.exceptions.FileError, click.exceptions.UsageError

Undocumented

Parameters
message:strUndocumented
def __str__(self): (source)
overridden in click.exceptions.MissingParameter

Undocumented

Returns
strUndocumented
def format_message(self): (source)
overridden in click.exceptions.BadParameter, click.exceptions.FileError, click.exceptions.NoSuchOption

Undocumented

Returns
strUndocumented
def show(self, file=None): (source)
overridden in click.exceptions.UsageError

Undocumented

Parameters
file:t.Optional[t.IO]Undocumented
exit_code: int = (source)
overridden in click.exceptions.UsageError

Undocumented

message = (source)

Undocumented