geomancy.checks.CheckPythonPackage#
- class geomancy.checks.CheckPythonPackage(name: str, value: str | None = None, desc: str = '', children: list[geomancy.checks.base.Check] | None = None, **kwargs)#
Check the availability and version of a python package
- __init__(name: str, value: str | None = None, desc: str = '', children: list[geomancy.checks.base.Check] | None = None, **kwargs)#
Methods
__init__(name[, value, desc, children])check([executor, level])Check whether the current version is compatible with the version specified in the value.
condition()Return True if bool(x) is True for all values x in the iterable.
get_current_version()Get the current version as a tuple of integers, or None if it can't be found.
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
aliasesAlternative names for the class (used by
types())availableWhether this check class is available for use.
condition_aliasesAlternative parameter names (__init__ kwarg names) used to specify the condition
countThe number of children, sub-children, etc, including self
descDescription of the check
env_substitute_aliasesAlternative parameter names (__init__ kwarg names) for env_substitute
env_substitute_defaultThe default value for env_substitute
flattenReturn a flattened list of this check (first item) and children checks
h1_styleDefault message and style of h1 headers
h2_styleDefault message and style of h2 headers
h3_styleDefault message and style of h3 headers
h4_styleDefault message and style of h4 headers
h5_styleDefault message and style of h5 headers
h6_styleDefault message and style of h6 headers (and lower)
import_error_msgThe import_module() exception message to use if a module is missing (see the
import_modules())max_levelMaximum recursion depth of the load function
msgThe default message to include in results
require_current_versionIf true, the result of get_current_version must not be None Set to True if get_current_version should return a version if the command or package exists Set to False if get_current_version may not be able to return the version, even if the command or package is installed or present
valueGet the package name, comparison operator and version tuple.
nameThe name for the check
raw_valueUnprocessed value for the check
childrenA list of children checks
env_substituteSubstitute environment variables in check values