bluemira.gen_params

A helper script to generate ParameterFrames as a python file and json file

Attributes

DEFAULT_PARAM

Functions

def_param(→ dict[str, str])	Get the default parameter json skeleton
add_to_dict(pf, json_dict, params)	Add each parameter to the json dict and params dict
create_parameterframe(→ str)	Create parameterframe python files as a string
parse_args()	Parse arguments
get_param_classes(→ dict)	Get all ParameterFrame classes
find_modules(→ set)	Recursively get modules from package
_commonprefix(→ str)
main()	Generate python and json parameterframe files

Module Contents

bluemira.gen_params.def_param() → dict[str, str]

Get the default parameter json skeleton

Returns:

The default parameter keys and types

Return type:

dict[str, str]

bluemira.gen_params.DEFAULT_PARAM

bluemira.gen_params.add_to_dict(pf: bluemira.base.parameter_frame._frame.ParameterFrame, json_dict: dict, params: dict)

Add each parameter to the json dict and params dict

Parameters:

• pf (bluemira.base.parameter_frame._frame.ParameterFrame)

• json_dict (dict)

• params (dict)

bluemira.gen_params.create_parameterframe(params: dict, name: str | None = None, *, header: bool = True) → str

Create parameterframe python files as a string

Parameters:

• params (Dict) – Dictionary of parameters to add to ParameterFrame

• name (Optional[str]) – name of ParameterFrame

• header (bool) – add import header

Returns:

Python parameter frame as a string

Return type:

str

bluemira.gen_params.parse_args()

Parse arguments

Returns:

Parsed argument namespace

bluemira.gen_params.get_param_classes(module) → dict

Get all ParameterFrame classes

Returns:

All found ParameterFrames

Return type:

dict

bluemira.gen_params.find_modules(path: str) → set

Recursively get modules from package

Returns:

All found modules

Parameters:

path (str)

Return type:

set

bluemira.gen_params._commonprefix(strings: collections.abc.Sequence[str]) → str

Parameters:

strings (collections.abc.Sequence[str])

Return type:

str

bluemira.gen_params.main()

Generate python and json parameterframe files