Skip to content

Constants

Soft coded centalized constants

filter_buses(names)

Filter bus names to include only those in PROV_NAMES.

Parameters:

Name Type Description Default
names

Iterable of bus names to filter

 required

Returns:

Name Type Description
list list

List of names that are present in PROV_NAMES
Source code in workflow/scripts/constants.py 
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
def filter_buses(names) -> list:
    """Filter bus names to include only those in PROV_NAMES.

    Args:
        names: Iterable of bus names to filter

    Returns:
        list: List of names that are present in PROV_NAMES
    """
    return [name for name in names if name in PROV_NAMES]

get_province_names()

HACK to make it possible for pytest to generate a smaller network

Raises:

Type Description
ValueError

if the PROV_NAMES is not a list or str

Returns:

Name Type Description
list list

the province node names to build the network
Source code in workflow/scripts/constants.py 
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
def get_province_names() -> list:
    """HACK to make it possible for pytest to generate a smaller network

    Raises:
        ValueError: if the PROV_NAMES is not a list or str

    Returns:
        list: the province node names to build the network
    """
    default_prov_names = list(REGIONAL_GEO_TIMEZONES_DEFAULT)
    _provs = os.getenv("PROV_NAMES", default_prov_names)
    if isinstance(_provs, str):
        _provs = re.findall(r"[\w']+", _provs)
        if not _provs:
            xpected = '["region1", ...]'
            err = f"Environment var PROV_NAMES {_provs} for tests did not have expected format: "
            raise ValueError(err + xpected)
    elif not isinstance(_provs, list):
        raise ValueError("PROV_NAMES must be a list or str")
    return _provs