click.exceptions.BadParameter Class Reference

Inheritance diagram for click.exceptions.BadParameter:

Collaboration diagram for click.exceptions.BadParameter:

Public Member Functions
None	__init__ (self, str message, Context|None ctx=None, Parameter|None param=None, cabc.Sequence[str]|str|None param_hint=None)
str	format_message (self)
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	__str__ (self)

Public Attributes
	param
	param_hint
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

An exception that formats out a standardized error message for a
bad parameter.  This is useful when thrown from a callback or type as
Click will attach contextual information to it (for instance, which
parameter it is).

.. versionadded:: 2.0

:param param: the parameter object that caused this error.  This can
              be left out, and Click will attach this info itself
              if possible.
:param param_hint: a string that shows up as parameter name.  This
                   can be used as alternative to `param` in cases
                   where custom validation should happen.  If it is
                   a string it's used as such, if it's a list then
                   each item is quoted and separated.

Constructor & Destructor Documentation

__init__()

None click.exceptions.BadParameter.__init__	(		self,
		str	message,
		Context | None	ctx = None,
		Parameter | None	param = None,
		cabc.Sequence[str] | str | None	param_hint = None
	)

Reimplemented from click.exceptions.UsageError.

Member Function Documentation

format_message()

str click.exceptions.BadParameter.format_message

(

self

)

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