:orphan:

:mod:`cloup._params`
====================

.. py:module:: cloup._params





                              
Classes
-------

.. autosummary::

   ~cloup._params.Argument
   ~cloup._params.Option

Functions
---------

.. autosummary::

   ~cloup._params.argument
   ~cloup._params.option

Attributes
----------

.. autoapisummary::

   cloup._params.GroupedOption

                                           
Contents
--------
.. py:class:: Argument(*args, help=None, **attrs)

   Bases: :py:obj:`click.Argument`

   Arguments are positional parameters to a command.  They generally
   provide fewer features than options but can have infinite ``nargs``
   and are required by default.

   All parameters are passed onwards to the parameter constructor.

   .. py:method:: get_help_record(self, ctx)



.. py:class:: Option(*args, group=None, **attrs)

   Bases: :py:obj:`click.Option`

   A click.Option with an extra field ``group`` of type ``OptionGroup``.


.. py:data:: GroupedOption
   

   Alias of ``Option``.


.. py:function:: argument(*param_decls, cls=None, **attrs)


.. py:function:: option(*param_decls, cls=None, group=None, **attrs)

   Attaches an ``Option`` to the command.
   Refer to :class:`click.Option` and :class:`click.Parameter` for more info
   about the accepted parameters.

   In your IDE, you won't see arguments relating to shell completion,
   because they are different in Click 7 and 8 (both supported by Cloup):

   - in Click 7, it's ``autocompletion``
   - in Click 8, it's ``shell_complete``.

   These arguments have different semantics, refer to Click's docs.