helper module

Define generic utility functions.

get_classes(module_name: str, base_class: ABCMeta) dict[str, str]

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 – The name of a module.

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

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: Any, *, url_doc_override: str | None = None, **kwargs) str

Infer the link to the API documentation from object path.

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

flatten(nest: Iterable) Iterator

Flatten nested list of lists of…