module documentation

Adapters and mask helpers for well-known protobuf types.

Function duration_mask Return a reset mask covering duration fields.
Function from_duration Convert a protobuf Duration to timedelta.
Function from_timestamp Convert a protobuf Timestamp to a timezone-aware datetime.
Function status_mask Return a reset mask covering status fields.
Function to_duration Convert a timedelta to a protobuf Duration.
Function to_timestamp Convert a datetime to a protobuf Timestamp.
Function ts_mask Return a reset mask covering timestamp fields.
Variable local_timezone Local timezone used when converting protobuf timestamps.
def duration_mask(_: Any) -> Mask: (source)

Return a reset mask covering duration fields.

Parameters
_:AnyUnused value placeholder.
Returns
MaskMask covering seconds and nanos.
def from_duration(d: Duration) -> timedelta: (source)

Convert a protobuf Duration to timedelta.

Parameters
d:DurationProtobuf duration.
Returns
timedeltatimedelta value.
def from_timestamp(t: Timestamp) -> datetime: (source)

Convert a protobuf Timestamp to a timezone-aware datetime.

Parameters
t:TimestampProtobuf timestamp.
Returns
datetimedatetime localized to the system timezone.
def status_mask(_: Any) -> Mask: (source)

Return a reset mask covering status fields.

Parameters
_:AnyUnused value placeholder.
Returns
MaskMask covering code, message, and details entries.
def to_duration(t: timedelta | Duration) -> Duration: (source)

Convert a timedelta to a protobuf Duration.

Parameters
t:timedelta | Durationtimedelta or already constructed Duration.
Returns
DurationProtobuf duration.
def to_timestamp(t: datetime | Timestamp) -> Timestamp: (source)

Convert a datetime to a protobuf Timestamp.

Parameters
t:datetime | Timestampdatetime or already constructed Timestamp.
Returns
TimestampProtobuf timestamp.
def ts_mask(_: Any) -> Mask: (source)

Return a reset mask covering timestamp fields.

Parameters
_:AnyUnused value placeholder.
Returns
MaskMask covering seconds and nanos.
local_timezone = (source)

Local timezone used when converting protobuf timestamps.