bluemira.gen_params
===================

.. py:module:: bluemira.gen_params

.. autoapi-nested-parse::

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



Attributes
----------

.. autoapisummary::

   bluemira.gen_params.DEFAULT_PARAM


Functions
---------

.. autoapisummary::

   bluemira.gen_params.def_param
   bluemira.gen_params.add_to_dict
   bluemira.gen_params.create_parameterframe
   bluemira.gen_params.parse_args
   bluemira.gen_params.get_param_classes
   bluemira.gen_params.find_modules
   bluemira.gen_params._commonprefix
   bluemira.gen_params.main


Module Contents
---------------

.. py:function:: def_param() -> dict[str, str]

   Get the default parameter json skeleton

   :returns: The default parameter keys and types


.. py:data:: DEFAULT_PARAM

.. py:function:: 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


.. py:function:: create_parameterframe(params: dict, name: str | None = None, *, header: bool = True) -> str

   Create parameterframe python files as a string

   :param params: Dictionary of parameters to add to ParameterFrame
   :type params: Dict
   :param name: name of ParameterFrame
   :type name: Optional[str]
   :param header: add import header
   :type header: bool

   :returns: Python parameter frame as a string


.. py:function:: parse_args()

   Parse arguments

   :returns: Parsed argument namespace


.. py:function:: get_param_classes(module) -> dict

   Get all ParameterFrame classes

   :returns: All found ParameterFrames


.. py:function:: find_modules(path: str) -> set

   Recursively get modules from package

   :returns: All found modules


.. py:function:: _commonprefix(strings: collections.abc.Sequence[str]) -> str

.. py:function:: main()

   Generate python and json parameterframe files