helper module

Define generic utility functions.

get_classes(module_name, base_class)

In module_path, get every class inheriting from class_type.

Used by the GUI to dynamically keep track of the Loader, Model and Plotter that are implemented.

Parameters:

  • module_name (str) – The name of a module.

  • base_class (ABCMeta) – The mother object that classes should inherit from.

Return type:

dict[str, str]

Returns:

Keys are the name of the objects inheriting from base_class found in module_name. Values are the path leading to them.

documentation_url(obj, *, url_doc_override=None, **kwargs)

Infer the link to the API documentation from object path.

If doc_override is provided, will return the URL corresponding to this path instead.

Return type:

str

flatten(nest)

Flatten nested list of lists of…

Return type:

Iterator[TypeVar(T)]