:orphan:

:mod:`cloup.constraints._support`
=================================

.. py:module:: cloup.constraints._support





                              

Classes summary
---------------

.. autosummary::

   ~cloup.constraints._support.BoundConstraintSpec
   ~cloup.constraints._support.BoundConstraint
   ~cloup.constraints._support.ConstraintMixin

Functions Summary
-----------------

.. autosummary::

   ~cloup.constraints._support.constraint


                                           
Contents
--------
.. class:: BoundConstraintSpec

   Bases: :class:`typing.NamedTuple`

   A NamedTuple storing a ``Constraint`` and the **names of the parameters**
   if has check.

   .. attribute:: constraint
      :annotation: :Constraint

      

   .. attribute:: params
      :annotation: :Sequence[str]

      


.. function:: constraint(constr: cloup.constraints._core.Constraint, params: Iterable[str])

   Registers a constraint.


.. class:: BoundConstraint

   Bases: :class:`typing.NamedTuple`

   Internal utility ``NamedTuple`` that represents a ``Constraint``
   bound to a collection of ``Parameter`` instances.
   Note: this is not a subclass of Constraint.

   .. attribute:: constraint
      :annotation: :Constraint

      

   .. attribute:: params
      :annotation: :Sequence[Parameter]

      

   .. method:: check_consistency(self)


   .. method:: check_values(self, ctx: click.Context)


   .. method:: get_help_record(self, ctx: click.Context) -> Optional[Tuple[str, str]]



.. class:: ConstraintMixin(*args, constraints: Sequence[BoundConstraintSpec] = (), show_constraints: bool = False, **kwargs)


   Provides support to constraints.

   .. method:: parse_args(self, ctx, args)


   .. method:: get_param_by_name(self, name: str) -> click.Parameter


   .. method:: get_params_by_name(self, names: Iterable[str]) -> List[Parameter]


   .. method:: format_constraints(self, ctx, formatter) -> None


   .. method:: format_help(self, ctx, formatter: click.HelpFormatter) -> None