click.exceptions.BadOptionUsage Class Reference

Inheritance diagram for click.exceptions.BadOptionUsage:

Collaboration diagram for click.exceptions.BadOptionUsage:

Public Member Functions
None	__init__ (self, str option_name, str message, Context|None ctx=None)
Public Member Functions inherited from click.exceptions.UsageError
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
	option_name
Public Attributes inherited from click.exceptions.UsageError
	ctx
Public Attributes inherited from click.exceptions.ClickException
	message

Additional Inherited Members
Static Public Attributes inherited from click.exceptions.UsageError
int	exit_code = 2
Static Public Attributes inherited from click.exceptions.ClickException
int	exit_code = 1

Detailed Description

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.

.. versionadded:: 4.0

:param option_name: the name of the option being used incorrectly.

Constructor & Destructor Documentation

__init__()

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

Reimplemented from click.exceptions.UsageError.

---

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

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