cloup.types
¶
Parameter types and “shortcuts” for creating commonly used types.
Functions¶
|
Shortcut for |
|
Shortcut for |
|
Shortcut for |
Contents¶
- cloup.types.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)[source]¶
Shortcut for
click.Path
withpath_type=pathlib.Path
.- Parameters:
path_type (Type[Any])
exists (bool)
file_okay (bool)
dir_okay (bool)
readable (bool)
writable (bool)
executable (bool)
resolve_path (bool)
allow_dash (bool)
- Return type:
Path
- cloup.types.dir_path(*, path_type=pathlib.Path, exists=False, readable=True, writable=False, executable=False, resolve_path=False, allow_dash=False)[source]¶
Shortcut for
click.Path
withfile_okay=False, path_type=pathlib.Path
.- Parameters:
path_type (Type[Any])
exists (bool)
readable (bool)
writable (bool)
executable (bool)
resolve_path (bool)
allow_dash (bool)
- Return type:
Path
- cloup.types.file_path(*, path_type=pathlib.Path, exists=False, readable=True, writable=False, executable=False, resolve_path=False, allow_dash=False)[source]¶
Shortcut for
click.Path
withdir_okay=False, path_type=pathlib.Path
.- Parameters:
path_type (Type[Any])
exists (bool)
readable (bool)
writable (bool)
executable (bool)
resolve_path (bool)
allow_dash (bool)
- Return type:
Path