geomancy.checks.CheckPath

class geomancy.checks.CheckPath(*args, type: str | None = None, **kwargs)

Check paths for valid files and directories

__init__(*args, type: str | None = None, **kwargs)

Methods

__init__(*args[, type])
check([executor, level])	Check paths
condition()	Return True if bool(x) is True for all values x in the iterable.
import_modules(*names)	Import and return modules given by the module name(s).
load(d, name[, level, max_level])	Load checks from a dict.
types()	The available types of Check classes, including aliases.

Attributes

aliases	Alternative names for the class (used by types())
available	Whether this check class is available for use.
condition_aliases	Alternative parameter names (__init__ kwarg names) used to specify the condition
count	The number of children, sub-children, etc, including self
desc	Description of the check
env_substitute_aliases	Alternative parameter names (__init__ kwarg names) for env_substitute
env_substitute_default	The default value for env_substitute
flatten	Return a flattened list of this check (first item) and children checks
h1_style	Default message and style of h1 headers
h2_style	Default message and style of h2 headers
h3_style	Default message and style of h3 headers
h4_style	Default message and style of h4 headers
h5_style	Default message and style of h5 headers
h6_style	Default message and style of h6 headers (and lower)
import_error_msg	The import_module() exception message to use if a module is missing (see the import_modules())
max_level	Maximum recursion depth of the load function
msg	The default message to include in results
type	(Optional) the type of path expected
type_options	The valid values of path types
value	Check's value with optional environment substitution
name	The name for the check
raw_value	Unprocessed value for the check
children	A list of children checks
env_substitute	Substitute environment variables in check values