Skip to content

Time

netutils.time

Functions for working with time.

uptime_seconds_to_string(uptime_seconds)

Converts uptime in seconds to uptime in string format.

Parameters:

Name Type Description Default
uptime_seconds int

Uptime in seconds.

 required

Returns:

Type Description
str

Uptime in string format.

Examples:

>>> from netutils.time import uptime_seconds_to_string
>>> uptime_seconds_to_string(7250)
'2 hours, 50 seconds'
Source code in netutils/time.py 
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
def uptime_seconds_to_string(uptime_seconds: int) -> str:
    """Converts uptime in seconds to uptime in string format.

    Args:
        uptime_seconds: Uptime in seconds.

    Returns:
        Uptime in string format.

    Examples:
        >>> from netutils.time import uptime_seconds_to_string
        >>> uptime_seconds_to_string(7250)
        '2 hours, 50 seconds'
    """
    result = []
    for interval, count in TIME_MAPPINGS:
        value = uptime_seconds // count
        if value:
            uptime_seconds -= value * count
            if value == 1:
                interval = interval.rstrip("s")
            result.append(f"{value} {interval}")

    return ", ".join(result)

uptime_string_to_seconds(uptime_string)

Converts uptime string seconds.

Parameters:

Name Type Description Default
uptime_string str

Uptime in string format

 required

Returns:

Type Description
int

Uptime string converted to seconds.

Examples:

>>> from netutils.time import uptime_string_to_seconds
>>> uptime_string_to_seconds("58 minutes")
3480
>>> from netutils.time import uptime_string_to_seconds
>>> uptime_string_to_seconds("4m15s")
255

Raises:

Type Description
ValueError

When uptime_string is unable to be parsed by regex.
Source code in netutils/time.py 
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
def uptime_string_to_seconds(uptime_string: str) -> int:
    """Converts uptime string seconds.

    Args:
        uptime_string: Uptime in string format

    Returns:
        Uptime string converted to seconds.

    Examples:
        >>> from netutils.time import uptime_string_to_seconds
        >>> uptime_string_to_seconds("58 minutes")
        3480
        >>> from netutils.time import uptime_string_to_seconds
        >>> uptime_string_to_seconds("4m15s")
        255

    Raises:
        ValueError: When uptime_string is unable to be parsed by regex.
    """
    compiled_regex_list = [re.compile(reg_pattern) for reg_pattern in UPTIME_REGEX_PATTERNS]

    uptime_dict: t.Dict[str, str] = {}
    for regex in compiled_regex_list:
        match = regex.search(uptime_string)

        if match:
            uptime_dict = match.groupdict()
            break

    if not match:
        raise ValueError("Unable to parse uptime string.")

    uptime_seconds = 0
    for time_interval, value in TIME_MAPPINGS:
        time_interval_as_int = uptime_dict.get(time_interval)
        if time_interval_as_int:
            uptime_seconds += int(time_interval_as_int) * value
    return uptime_seconds