
:mod:`cloup.types`
==================

.. py:module:: cloup.types

.. autoapi-nested-parse::

   Parameter types and "shortcuts" for creating commonly used types.





                              

Functions
---------

.. autosummary::

   ~cloup.types.path
   ~cloup.types.dir_path
   ~cloup.types.file_path


                                           
Contents
--------
.. py:function:: path(*, path_type = pathlib.Path, exists = False, file_okay = True, dir_okay = True, readable = True, writable = False, executable = False, resolve_path = False, allow_dash = False)

   Shortcut for :class:`click.Path` with ``path_type=pathlib.Path``.


.. py:function:: dir_path(*, path_type = pathlib.Path, exists = False, readable = True, writable = False, executable = False, resolve_path = False, allow_dash = False)

   Shortcut for :class:`click.Path` with
   ``file_okay=False, path_type=pathlib.Path``.


.. py:function:: file_path(*, path_type = pathlib.Path, exists = False, readable = True, writable = False, executable = False, resolve_path = False, allow_dash = False)

   Shortcut for :class:`click.Path` with
   ``dir_okay=False, path_type=pathlib.Path``.



                                         