Skip to content

conversion

frequenz.client.base.conversion ¤

Helper functions to convert to/from common python types.

Functions¤

frequenz.client.base.conversion.to_datetime ¤

to_datetime(ts: Timestamp, tz: timezone = utc) -> datetime

Convert a protobuf Timestamp to a datetime.

PARAMETER DESCRIPTION
ts

Timestamp object to convert

TYPE: Timestamp

tz

Timezone to use for the datetime

TYPE: timezone DEFAULT: utc

RETURNS DESCRIPTION
datetime

Timestamp converted to datetime
Source code in src/frequenz/client/base/conversion.py 
58
59
60
61
62
63
64
65
66
67
68
69
70
def to_datetime(ts: Timestamp, tz: timezone = timezone.utc) -> datetime:
    """Convert a protobuf Timestamp to a datetime.

    Args:
        ts: Timestamp object to convert
        tz: Timezone to use for the datetime

    Returns:
        Timestamp converted to datetime
    """
    # Add microseconds and add nanoseconds converted to microseconds
    microseconds = int(ts.nanos / 1000)
    return datetime.fromtimestamp(ts.seconds + microseconds * 1e-6, tz=tz)

frequenz.client.base.conversion.to_timestamp ¤

to_timestamp(dt: datetime) -> Timestamp

to_timestamp(dt: None) -> None

to_timestamp(dt: datetime | None) -> Timestamp | None

Convert a datetime to a protobuf Timestamp.

Returns None if dt is None.

PARAMETER DESCRIPTION
dt

datetime object to convert

TYPE: datetime | None

RETURNS DESCRIPTION
Timestamp | None

datetime converted to Timestamp
Source code in src/frequenz/client/base/conversion.py 
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
def to_timestamp(dt: datetime | None) -> Timestamp | None:
    """Convert a datetime to a protobuf Timestamp.

    Returns None if dt is None.

    Args:
        dt: datetime object to convert

    Returns:
        datetime converted to Timestamp
    """
    if dt is None:
        return None

    ts = Timestamp()
    ts.FromDatetime(dt)
    return ts