1bddd25a85
This changes the arguments in clock functions to be `Duration` and converts call sites and constants into `Duration`. There are still some more functions around that should be converted (e.g. `timeout_deferred`), but we leave that to another PR. We also changes `.as_secs()` to return a float, as the rounding broke things subtly. The only reason to keep it (its the same as `timedelta.total_seconds()`) is for symmetry with `as_millis()`. Follows on from https://github.com/element-hq/synapse/pull/19223
118 lines
4.1 KiB
Python
118 lines
4.1 KiB
Python
#
|
|
# This file is licensed under the Affero General Public License (AGPL) version 3.
|
|
#
|
|
# Copyright (C) 2025 Element Creations Ltd
|
|
#
|
|
# This program is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU Affero General Public License as
|
|
# published by the Free Software Foundation, either version 3 of the
|
|
# License, or (at your option) any later version.
|
|
#
|
|
# See the GNU Affero General Public License for more details:
|
|
# <https://www.gnu.org/licenses/agpl-3.0.html>.
|
|
#
|
|
|
|
from datetime import timedelta
|
|
from typing import overload
|
|
|
|
# Constant so we don't keep creating new timedelta objects when calling
|
|
# `.as_millis()`.
|
|
_ONE_MILLISECOND = timedelta(milliseconds=1)
|
|
|
|
|
|
class Duration(timedelta):
|
|
"""A subclass of timedelta that adds a convenience method for getting
|
|
the duration in milliseconds.
|
|
|
|
Examples:
|
|
|
|
```
|
|
duration = Duration(hours=2)
|
|
print(duration.as_millis()) # Outputs: 7200000
|
|
```
|
|
"""
|
|
|
|
def as_millis(self) -> int:
|
|
"""Returns the duration in milliseconds."""
|
|
return int(self / _ONE_MILLISECOND)
|
|
|
|
def as_secs(self) -> float:
|
|
"""Returns the duration in seconds."""
|
|
return self.total_seconds()
|
|
|
|
# Override arithmetic operations to return Duration instances
|
|
|
|
def __add__(self, other: timedelta) -> "Duration":
|
|
"""Add two durations together, returning a Duration."""
|
|
result = super().__add__(other)
|
|
return Duration(seconds=result.total_seconds())
|
|
|
|
def __radd__(self, other: timedelta) -> "Duration":
|
|
"""Add two durations together (reversed), returning a Duration."""
|
|
result = super().__radd__(other)
|
|
return Duration(seconds=result.total_seconds())
|
|
|
|
def __sub__(self, other: timedelta) -> "Duration":
|
|
"""Subtract two durations, returning a Duration."""
|
|
result = super().__sub__(other)
|
|
return Duration(seconds=result.total_seconds())
|
|
|
|
def __rsub__(self, other: timedelta) -> "Duration":
|
|
"""Subtract two durations (reversed), returning a Duration."""
|
|
result = super().__rsub__(other)
|
|
return Duration(seconds=result.total_seconds())
|
|
|
|
def __mul__(self, other: float) -> "Duration":
|
|
"""Multiply a duration by a scalar, returning a Duration."""
|
|
result = super().__mul__(other)
|
|
return Duration(seconds=result.total_seconds())
|
|
|
|
def __rmul__(self, other: float) -> "Duration":
|
|
"""Multiply a duration by a scalar (reversed), returning a Duration."""
|
|
result = super().__rmul__(other)
|
|
return Duration(seconds=result.total_seconds())
|
|
|
|
@overload
|
|
def __truediv__(self, other: timedelta) -> float: ...
|
|
|
|
@overload
|
|
def __truediv__(self, other: float) -> "Duration": ...
|
|
|
|
def __truediv__(self, other: float | timedelta) -> "Duration | float":
|
|
"""Divide a duration by a scalar or another duration.
|
|
|
|
If dividing by a scalar, returns a Duration.
|
|
If dividing by a timedelta, returns a float ratio.
|
|
"""
|
|
result = super().__truediv__(other)
|
|
if isinstance(other, timedelta):
|
|
# Dividing by a timedelta gives a float ratio
|
|
assert isinstance(result, float)
|
|
return result
|
|
else:
|
|
# Dividing by a scalar gives a Duration
|
|
assert isinstance(result, timedelta)
|
|
return Duration(seconds=result.total_seconds())
|
|
|
|
@overload
|
|
def __floordiv__(self, other: timedelta) -> int: ...
|
|
|
|
@overload
|
|
def __floordiv__(self, other: int) -> "Duration": ...
|
|
|
|
def __floordiv__(self, other: int | timedelta) -> "Duration | int":
|
|
"""Floor divide a duration by a scalar or another duration.
|
|
|
|
If dividing by a scalar, returns a Duration.
|
|
If dividing by a timedelta, returns an int ratio.
|
|
"""
|
|
result = super().__floordiv__(other)
|
|
if isinstance(other, timedelta):
|
|
# Dividing by a timedelta gives an int ratio
|
|
assert isinstance(result, int)
|
|
return result
|
|
else:
|
|
# Dividing by a scalar gives a Duration
|
|
assert isinstance(result, timedelta)
|
|
return Duration(seconds=result.total_seconds())
|