Helpers

Utility functions and logging configuration used by the core modules.

Diagram helpers

Thin wrappers that delegate node/connection creation to Model/View instances.

Diagram helper wrappers exposed as module-level utilities.

pyArchimate.helpers.diagram.apply_profile_styles(view: View, mapping: dict[str, str | dict[str, str]]) → None

Apply fill colours to view nodes based on their element’s profile name.

Walks all nodes recursively, including nodes nested inside other nodes. mapping keys are profile names; values are either a hex colour string (applied to fill_color) or a dict with any of fill_color, line_color, font_color keys.

pyArchimate.helpers.diagram.get_or_create_connection(owner, *args, **kwargs)

Delegate connection creation to View helper methods.

pyArchimate.helpers.diagram.get_or_create_node(owner, *args, **kwargs)

Delegate node creation to Model/View helper methods.

Property helpers

Wrappers that delegate embed_props / expand_props and validation calls to the Model implementation.

Property and validation helper wrappers for Model instances.

pyArchimate.helpers.properties.check_invalid_conn(model)

Delegate invalid relationship checks to the model implementation.

pyArchimate.helpers.properties.check_invalid_nodes(model)

Delegate orphan node checks to the model implementation.

pyArchimate.helpers.properties.check_invalid_relationships(model)

Delegate metamodel relationship checks to the model implementation.

pyArchimate.helpers.properties.embed_props(model, remove_props=False)

Delegate property embedding to the model implementation.

pyArchimate.helpers.properties.expand_props(model, clean_doc=True)

Delegate property expansion to the model implementation.

Logging helpers

Thin configuration layer around the standard logging module: sets a consistent formatter and exposes log_set_level, log_to_file, and log_to_stderr.

Logging helpers re-exported from the package logger module.

pyArchimate.helpers.logging.log_set_level(lvl)

Change the logging level for all handlers at once :param lvl: logging level :type lvl: logging.LEVEL enumeration

pyArchimate.helpers.logging.log_to_file(log_file)

Add a log handler to save log to file :param log_file: path to the log file :type log_file: str

pyArchimate.helpers.logging.log_to_stderr()

Add a logging handler to the standard error output