cinnamon.utility package

Submodules

cinnamon.utility.configuration module

cinnamon.utility.configuration.batched(iterable, chunk_size)

cinnamon.utility.exceptions module

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

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

class cinnamon.utility.exceptions.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]) – describes which condition failed during the evaluation process.

error_message: Optional[str] = None

passed: bool

source: str

property stack_trace

cinnamon.utility.inquirer module

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.import_class_from_string(path)

Return type:: type

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

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.time_it(func)