gridpool

frequenz.gridpool

High-level interface to grid pools for the Frequenz platform..

TODO(cookiecutter): Add a more descriptive module description.

Functions

frequenz.gridpool.delete_me

delete_me(*, blow_up: bool = False) -> bool

Do stuff for demonstration purposes.

PARAMETER	DESCRIPTION
blow_up	If True, raise an exception. TYPE: bool DEFAULT: False

RETURNS	DESCRIPTION
bool	True if no exception was raised.

RAISES	DESCRIPTION
RuntimeError	if blow_up is True.

Source code in src/frequenz/gridpool/__init__.py

def delete_me(*, blow_up: bool = False) -> bool:
    """Do stuff for demonstration purposes.

    Args:
        blow_up: If True, raise an exception.

    Returns:
        True if no exception was raised.

    Raises:
        RuntimeError: if blow_up is True.
    """
    if blow_up:
        raise RuntimeError("This function should be removed!")
    return True