click.exceptions.UsageError

class documentation

class UsageError(ClickException):

Known subclasses: click.exceptions.BadArgumentUsage, click.exceptions.BadOptionUsage, click.exceptions.BadParameter, click.exceptions.NoSuchOption

View In Hierarchy

An internal exception that signals a usage error. This typically aborts any further handling.
Parameters
messagethe error message to display.
ctxoptionally the context that caused this error. Click will fill in the context automatically in some situations.
Method __init__ Undocumented
Method show Undocumented
Class Variable exit​_code Undocumented
Instance Variable cmd Undocumented
Instance Variable ctx Undocumented

Inherited from ClickException:

Method __str__ Undocumented
Method format​_message Undocumented
Instance Variable message Undocumented
def __init__(self, message, ctx=None):
overrides click.exceptions.ClickException.__init__
overridden in click.exceptions.BadOptionUsage, click.exceptions.BadParameter, click.exceptions.NoSuchOption

Undocumented

Parameters
message:strUndocumented
ctx:t.Optional[Context]Undocumented
def show(self, file=None):
overrides click.exceptions.ClickException.show

Undocumented

Parameters
file:t.Optional[t.IO]Undocumented
exit_code: int =
overrides click.exceptions.ClickException.exit_code

Undocumented

cmd =

Undocumented

ctx =

Undocumented