click.exceptions.UsageError Class Reference

Inheritance diagram for click.exceptions.UsageError:

Collaboration diagram for click.exceptions.UsageError:

Public Member Functions
None	__init__ (self, str message, Context|None ctx=None)
None	show (self, t.IO[t.Any]|None file=None)
Public Member Functions inherited from click.exceptions.ClickException
str	format_message (self)
str	__str__ (self)

Public Attributes
	ctx
Public Attributes inherited from click.exceptions.ClickException
	message

Static Public Attributes
int	exit_code = 2
Static Public Attributes inherited from click.exceptions.ClickException
int	exit_code = 1

Detailed Description

An internal exception that signals a usage error.  This typically
aborts any further handling.

:param message: the error message to display.
:param ctx: optionally the context that caused this error.  Click will
            fill in the context automatically in some situations.

Constructor & Destructor Documentation

__init__()

None click.exceptions.UsageError.__init__	(		self,
		str	message,
		Context | None	ctx = None
	)

Reimplemented from click.exceptions.ClickException.

Member Function Documentation

show()

None click.exceptions.UsageError.show	(		self,
		t.IO[t.Any] | None	file = None
	)

Reimplemented from click.exceptions.ClickException.

---

The documentation for this class was generated from the following file:

• docs/help/help-venv/lib/python3.12/site-packages/click/exceptions.py