lezargus.initialize module#

Module, file, and data initialization routines of Lezargus.

Everything and anything which initializes Lezargus, that is separate from Python loading this module, is done here. After the program is run, we clean up using terminate.py.

lezargus.initialize.initialize(*args: tuple, **kwargs: object) None[source]#

Initialize the Lezargus module and all its parts.

This initialization function should be the very first thing that is done when the module is loaded. However, we create this function (as opposed to doing it on load) to be explicit on the load times for the module, to avoid circular dependencies, and to prevent logging when only importing the module.

The order of the initialization is important and we take care of it here. If you want to want to initialize smaller sections independently, you may use the functions within the lezargus.initialize module.

Parameters:
  • *args (tuple) – Positional arguments. There should be no positional arguments. This serves to catch them.

  • **kwargs (dict) – Keyword arguments to be passed to all other initialization functions.

Return type:

None

lezargus.initialize.initialize_logging_outputs(*args: tuple, **kwargs: object) None[source]#

Initialize the default logging console and file outputs.

This function initializes the logging outputs based on configured parameters. Additional logging outputs may be provided.

Parameters:
  • *args (tuple) – Positional arguments. There should be no positional arguments. This serves to catch them.

  • **kwargs (dict) – A catch-all keyword argument, used to catch arguments which are not relevant or are otherwise passed to other internal functions.

Return type:

None

lezargus.initialize.initialize_temporary_directory(*args: tuple, **kwargs: object) None[source]#

Initialize the temporary directory.

We create the temporary directory based on the configured paths.

Parameters:
  • *args (tuple) – Positional arguments. There should be no positional arguments. This serves to catch them.

  • **kwargs (dict) – A catch-all keyword argument, used to catch arguments which are not relevant or are otherwise passed to other internal functions.

Return type:

None