Contents

cloup.constraints.exceptions

Functions Summary

default_constraint_error(params, desc)

Contents

cloup.constraints.exceptions.default_constraint_error(params: Iterable[Parameter], desc: str) → str[source]
Parameters

  • params (Iterable[click.core.Parameter]) –

  • desc (str) –

Return type

str

exception cloup.constraints.exceptions.ConstraintViolated(message: str, ctx: Optional[Context] = None)[source]

Bases: click.UsageError

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

Parameters

  • message – the error message to display.

  • ctx – optionally the context that caused this error. Click will fill in the context automatically in some situations.

classmethod default(cls, params: Iterable[Parameter], desc: str, ctx: Optional[Context] = None) → cloup.constraints.exceptions.ConstraintViolated[source]
exception cloup.constraints.exceptions.UnsatisfiableConstraint(constraint: cloup.constraints._core.Constraint, params: Iterable[Parameter], reason: str)[source]

Bases: Exception

Raised if a constraint cannot be satisfied by a group of parameters independently from their values at runtime; e.g. mutually_exclusive cannot be satisfied if multiple of the parameters are required.

cloup.constraints.conditions Contributing