:mod:`cloup.constraints.exceptions`
===================================

.. py:module:: cloup.constraints.exceptions





                              

Functions
---------

.. autosummary::

   ~cloup.constraints.exceptions.default_constraint_error


                                           
Contents
--------
.. py:function:: default_constraint_error(params, desc)


.. py:exception:: ConstraintViolated(message, ctx, constraint, params)

   Bases: :py:obj:`click.UsageError`

   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.

   Initialize self.  See help(type(self)) for accurate signature.

   .. py:method:: default(cls, desc, ctx, constraint, params)
      :classmethod:



.. py:exception:: UnsatisfiableConstraint(constraint, params, reason)

   Bases: :py:obj:`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.

   Initialize self.  See help(type(self)) for accurate signature.