Skip to content

ModuleBuilder

Import and run a Python module as a builder.

Use this to integrate reusable external scripts that define the model logic. Helpful for sharing build logic across multiple projects.

Bases: BaseBuilder

Builder that dynamically imports a module and calls a specified function.

This allows you to build HFSS models using external, version-controlled scripts. Especially useful for reusable templates and team collaboration.

The imported function must have the following signature:

def build(hfss: Hfss, **kwargs) -> dict:
    ...
  • hfss: The active HFSS session object.
  • **kwargs: Arbitrary keyword arguments, typically containing build parameters.
  • The function must return a dictionary with any results or output parameters.
Example 
def build(hfss, name_to_value):
    for name, value in name_to_value.items():
        hfss[name] = value
    return {"status": "ok"}

Attributes:

Name Type Description
type Literal['module_builder']

Identifier for this builder type.
module str

Python module path (e.g., 'mypkg.submodule').
function str

Name of the function in the module to call (default: 'build').
args dict

Static arguments passed to the function.

build 

build(hfss: Hfss, parameters: dict | None = None) -> dict

Import the specified module, call its build function with merged arguments.

Parameters:

Name Type Description Default
hfss Hfss

Active HFSS session.

 required
parameters dict | None

Runtime arguments to merge with predefined args.

 None

Returns:

Name Type Description
dict dict

Output of the module's function call.

Raises:

Type Description
ImportError

If the module or function cannot be imported.
Exception

Any exception raised by the user-supplied function will propagate up.
Source code in src/quansys/workflow/builder/module_builder.py 
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
def build(self,
          hfss: Hfss,
          parameters: dict | None = None) -> dict:
    """
    Import the specified module, call its build function with merged arguments.

    Args:
        hfss: Active HFSS session.
        parameters: Runtime arguments to merge with predefined `args`.

    Returns:
        dict: Output of the module's function call.

    Raises:
        ImportError: If the module or function cannot be imported.
        Exception: Any exception raised by the user-supplied function will propagate up.
    """
    # Merge any runtime parameters with the builder's predefined arguments
    parameters = parameters or {}
    combined_args = merge_dicts(self.args, parameters)

    # Dynamically import the specified module
    imported_module = importlib.import_module(self.module)

    # Retrieve the function (default is "build") from the imported module
    try:
        build_func = getattr(imported_module, self.function)
    except AttributeError:
        raise AttributeError(
            f"Function '{self.function}' not found in module '{self.module}'."
        )

    # Call the function, passing in the HFSS object plus merged arguments
    result = build_func(hfss, **combined_args)
    return result