Skip to content

module

frequenz.core.module ¤

Tools for dealing with Python modules.

Functions¤

frequenz.core.module.get_public_module_name ¤

get_public_module_name(module_name: str) -> str | None

Get the name of the public module containing the given module name.

  • Modules are considered private if they start with _.
  • All modules inside a private module are also considered private, even if they don't start with _.
  • If there is no leading public part, None is returned.
Example

Here are a few examples of how this function will resolve module names:

  • some.pub -> some.pub
  • some.pub._some._priv -> some.pub
  • some.pub._some._priv.public -> some.pub
  • some.pub._some._priv.public._private -> some.pub
  • _priv -> None
PARAMETER DESCRIPTION
module_name

The fully qualified name of the module to get the public name for (normally the __name__ built-in variable).

TYPE: str

RETURNS DESCRIPTION
str | None

The name of the public module containing the given module name.
Source code in frequenz/core/module.py 
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
def get_public_module_name(module_name: str) -> str | None:
    """Get the name of the public module containing the given module name.

    * Modules are considered private if they start with `_`.
    * All modules inside a private module are also considered private, even if they
      don't start with `_`.
    * If there is no leading public part, `None` is returned.

    Example:
        Here are a few examples of how this function will resolve module names:

        * `some.pub` -> `some.pub`
        * `some.pub._some._priv` -> `some.pub`
        * `some.pub._some._priv.public` -> `some.pub`
        * `some.pub._some._priv.public._private` -> `some.pub`
        * `_priv` -> `None`

    Args:
        module_name: The fully qualified name of the module to get the public name for
            (normally the `__name__` built-in variable).

    Returns:
        The name of the public module containing the given module name.
    """
    public_parts: list[str] = []
    for part in module_name.split("."):
        if part.startswith("_"):
            break
        public_parts.append(part)
    return ".".join(public_parts) or None