acmecse.runtime.Importer.Importer

class documentation

class Importer: (source)

Importer class to import various objects, configurations etc.

It is mainly run before the CSE is actually started or restarted.

Method	`assignAttributePolicies`	Assign the imported attribute policies to each of the resources. This injects the imported attribute policies into all the Python Resource classes.
Method	`importAttributePolicies`	Import the resource attribute policies.
Method	`importConfigDocs`	Import the configuration documentation from the resource path.
Method	`importEnumPolicies`	Import the enumeration types policies.
Method	`importFlexContainerPolicies`	Import the attribute and hierarchy policies for flexContainer specializations. The policies are read from JSON files in the specified directory.
Method	`importPolicies`	Import the attribute, enum, flexContainer policies, and documentation.
Method	`importResourcePolicies`	Import the resource type policies from the internal init directory of the CSE. In addition, it will also import any resource type policies from the runtime init directory if available.
Method	`importScripts`	Import the scripts from the resource path and additional directories specified in the configuration.
Method	`initialize`	Initialization of an Importer instance.
Method	`readJSONFromFile`	Read and parse a JSON data structure from a file filename.
Method	`removePolicyImports`	Remove all previous imported scripts and definitions.
Method	`removeScripts`	Internally remove all imported scripts.
Method	`replaceMacro`	No summary
Class Variable	`__slots__`	Slots for Importer class.
Class Variable	`dispatcher`	Injected Dispatcher instance.
Class Variable	`factory`	Injected Factory instance.
Class Variable	`scriptManager`	ScriptManager instance.
Class Variable	`validator`	Injected Validator instance.
Instance Variable	`extendedScriptPaths`	Extended list of script paths, which is used for importing scripts.
Instance Variable	`isImporting`	Boolean flag to indicate whether the importer is currently importing resources.
Instance Variable	`macroMatch`	Regular expression to match macros in scripts.
Instance Variable	`resourcePath`	Path to the directory from where to import resources, policies, scripts etc.
Instance Variable	`rtDir`	Path to the directory from where to import additional resources, policies, scripts etc.
Method	`_expandEnumValues`	Expand an enum values list by parsing the range definitions and return a list of integer values.
Method	`_finishImporting`	Finish the importing process, e.g. re-enable access control.
Method	`_parseAttribute`	Parse a single attribute definitions for common as well as for flexContainer attributes.
Method	`_prepareImporting`	Prepare the importing process.
Class Variable	`_enumValues`	Imported enumeration values.
Instance Variable	`_oldEnabbleAcpChecks`	Used to store the old value of the enableAcpChecks configuration setting during importing.

def assignAttributePolicies(self) -> bool: (source) ¶

Assign the imported attribute policies to each of the resources. This injects the imported attribute policies into all the Python Resource classes.

Returns
`bool`	True if there were no errors during the assignment, False otherwise.

def importAttributePolicies(self, path: str) -> bool: (source) ¶

Import the resource attribute policies.

Parameters
path:`str`	Path to a directory from where to import attribute policies.

Returns
`bool`	True if the policies were successfully imported, False otherwise.

def importConfigDocs(self) -> bool: (source) ¶

Import the configuration documentation from the resource path.

Returns
`bool`	True if the documentation was successfully imported, False otherwise.

def importEnumPolicies(self, path: str) -> bool: (source) ¶

Import the enumeration types policies.

Parameters
path:`str`	Path to a directory from where to import enumeration policies.

Returns
`bool`	True if the policies were successfully imported, False otherwise.

def importFlexContainerPolicies(self, path: str) -> bool: (source) ¶

Import the attribute and hierarchy policies for flexContainer specializations. The policies are read from JSON files in the specified directory.

Parameters
path:`str`	Path to a directory from where to import flexContainer policies.

Returns
`bool`	True if the policies were successfully imported, False otherwise.

def importPolicies(self) -> bool: (source) ¶

Import the attribute, enum, flexContainer policies, and documentation.

Returns
`bool`	Boolean indicating success or failure

def importResourcePolicies(self): (source) ¶

Import the resource type policies from the internal init directory of the CSE. In addition, it will also import any resource type policies from the runtime init directory if available.

def importScripts(self) -> bool: (source) ¶

Import the scripts from the resource path and additional directories specified in the configuration.

def initialize(self): (source) ¶

Initialization of an Importer instance.

def readJSONFromFile(self, filename: str) -> JSON | JSONLIST | None: (source) ¶

Read and parse a JSON data structure from a file filename.

Parameters
filename:`str`	The full filename of the input file.

Returns
`JSON \| JSONLIST \| None`	Return the parsed structure, or None in case of an error.

def removePolicyImports(self): (source) ¶

Remove all previous imported scripts and definitions.

def removeScripts(self): (source) ¶

Internally remove all imported scripts.

def replaceMacro(self, macro: str, filename: str) -> str: (source) ¶

__slots__: tuple[str, ...] = (source) ¶

Slots for Importer class.

dispatcher: Dispatcher = (source) ¶

Injected Dispatcher instance.

factory: Factory = (source) ¶

Injected Factory instance.

scriptManager: ScriptManager = (source) ¶

ScriptManager instance.

validator: Validator = (source) ¶

Injected Validator instance.

extendedScriptPaths: list[str] = (source) ¶

Extended list of script paths, which is used for importing scripts.

isImporting: bool = (source) ¶

Boolean flag to indicate whether the importer is currently importing resources.

macroMatch = (source) ¶

Regular expression to match macros in scripts.

resourcePath = (source) ¶

Path to the directory from where to import resources, policies, scripts etc.

rtDir = (source) ¶

Path to the directory from where to import additional resources, policies, scripts etc.

def _expandEnumValues(self, evalues: list[int | str], typeShortname: str, fn: str) -> list[int] | None: (source) ¶

Expand an enum values list by parsing the range definitions and return a list of integer values.

Parameters
evalues:`list[int \| str]`	A list of integer values or range definitions (e.g. "1..10") to expand.
typeShortname:`str`	The type and attribute name (for logging purposes).
fn:`str`	The filename where the enum values are defined (for logging purposes).

Returns
`list[int] \| None`	A list of integer values, or None in case of an error.

def _finishImporting(self): (source) ¶

Finish the importing process, e.g. re-enable access control.

def _parseAttribute(self, attr: JSON, fn: str, typeShortname: str | None = None, sname: str | None = None, checkListType: bool | None = True) -> AttributePolicy | None: (source) ¶

Parse a single attribute definitions for common as well as for flexContainer attributes.

Parameters
attr:`JSON`	JSON dictionary with the attribute definition to parse.
fn:`str`	Filename that contains the attribute definition.
typeShortname:`str \| None`	Domain and attribute name. Mandatory for a flexContainer specialization, optional otherwise.
sname:`str \| None`	Shortname of the attribute.
checkListType:`bool \| None`	Undocumented

Returns
`AttributePolicy \| None`	The parsed definition in an `AttributePolicy`.

def _prepareImporting(self): (source) ¶

Prepare the importing process.

_enumValues: dict[str, dict[int, str]] = (source) ¶

Imported enumeration values.

_oldEnabbleAcpChecks: bool | None = (source) ¶

Used to store the old value of the enableAcpChecks configuration setting during importing.