cinnamon.utility package

Submodules

cinnamon.utility.configuration module

cinnamon.utility.configuration.get_dict_values_combinations(params_dict)

Builds parameters combinations

Parameters:: params_dict (Dict) – dictionary that has parameter names as keys and the list of possible values as values
Returns:: A List of all possible key:value dict combinations of parameters that have variants. index_combinations: A List of all possible key:index dict combinations of parameters that have variants. Indexes refer to variant index in variants list.
Return type:: value_combinations

cinnamon.utility.exceptions module

exception cinnamon.utility.exceptions.AlreadyExistingParameterException(param): Bases: Exception

exception cinnamon.utility.exceptions.AlreadyExpandedException: Bases: Exception

exception cinnamon.utility.exceptions.AlreadyRegisteredException(registration_key): Bases: Exception

exception cinnamon.utility.exceptions.DisconnectedGraphException(nodes): Bases: Exception

exception cinnamon.utility.exceptions.InvalidDirectoryException(directory): Bases: Exception

exception cinnamon.utility.exceptions.NamespaceNotFoundException(registration_key, namespaces): Bases: Exception

exception cinnamon.utility.exceptions.NotADAGException(edges)

Bases: Exception

build_edge_view(edges)

exception cinnamon.utility.exceptions.NotBoundException(registration_key): Bases: Exception

exception cinnamon.utility.exceptions.NotExpandedException: Bases: Exception

exception cinnamon.utility.exceptions.NotRegisteredException(registration_key): Bases: Exception

cinnamon.utility.inquirer module

cinnamon.utility.inquirer.filter_keys(keys)

cinnamon.utility.inquirer.select_keys(keys, selected_tags=None)

cinnamon.utility.inquirer.select_name(keys)

cinnamon.utility.inquirer.select_namespace(keys)

cinnamon.utility.inquirer.select_tags(keys)

cinnamon.utility.registration module

class cinnamon.utility.registration.NamespaceExtractor

Bases: NodeVisitor

Static code analyzer that parses cinnamon-compliant scripts for registrations.

process(filename)

Return type:: List[str]

visit_Call(node)

visit_FunctionDef(node)

cinnamon.utility.registration.match_name(name, names=None)

cinnamon.utility.registration.match_namespace(namespace, namespaces=None)

cinnamon.utility.registration.match_tags(a_tags, b_tags)

cinnamon.utility.sanity module

exception cinnamon.utility.sanity.ValidationFailureException(validation_result): Bases: Exception

class cinnamon.utility.sanity.ValidationResult(passed, source, error_message=None)

Bases: object

Stores conditions evaluation result (see Configuration.validate()).

Parameters:

passed (bool) – True if all conditions are True
error_message (Optional[str]) – a string message reporting which condition failed during the evaluation process.

error_message: Optional[str] = None

passed: bool

source: str

property stack_trace

cinnamon.utility.sanity.allowed_range_cond(config, name)

Return type:: bool

cinnamon.utility.sanity.check_directory(directory_path=None)

Return type:: Path

cinnamon.utility.sanity.check_external_json_path(jsonpath)

Return type:: List[Path]

cinnamon.utility.sanity.is_required_cond(config, name)

Return type:: bool