iker-python-common 1.0.47__tar.gz → 1.0.49__tar.gz

{iker_python_common-1.0.47 → iker_python_common-1.0.49}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: iker-python-common
-Version: 1.0.47
+Version: 1.0.49
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12

{iker_python_common-1.0.47 → iker_python_common-1.0.49}/src/iker/common/utils/dtutils.py

@@ -22,6 +22,8 @@ __all__ = [
     "dt_utc_infinity",
     "dt_utc_now",
     "dt_utc",
+    "td_to_us",
+    "td_from_us",
     "dt_to_ts",
     "dt_to_ts_us",
     "dt_from_ts",
@@ -44,16 +46,16 @@ def basic_date_format() -> str:
 
 
 @memorized
-def basic_time_format(with_ms: bool = False, with_tz: bool = False) -> str:
+def basic_time_format(with_us: bool = False, with_tz: bool = False) -> str:
     """
-    Returns the basic time format string, with optional milliseconds and timezone.
+    Returns the basic time format string, with optional microseconds and timezone.
 
-    :param with_ms: If ``True``, include milliseconds in the format.
+    :param with_us: If ``True``, include microseconds in the format.
     :param with_tz: If ``True``, include timezone in the format.
     :return: The basic time format string.
     """
     fmt_str = "T%H%M%S"
-    if with_ms:
+    if with_us:
         fmt_str = fmt_str + ".%f"
     if with_tz:
         fmt_str = fmt_str + "%z"
@@ -61,15 +63,15 @@ def basic_time_format(with_ms: bool = False, with_tz: bool = False) -> str:
 
 
 @memorized
-def basic_format(with_ms: bool = False, with_tz: bool = False) -> str:
+def basic_format(with_us: bool = False, with_tz: bool = False) -> str:
     """
-    Returns the basic combined date and time format string, with optional milliseconds and timezone.
+    Returns the basic combined date and time format string, with optional microseconds and timezone.
 
-    :param with_ms: If ``True``, include milliseconds in the time format.
+    :param with_us: If ``True``, include microseconds in the time format.
     :param with_tz: If ``True``, include timezone in the time format.
     :return: The basic combined date and time format string.
     """
-    return basic_date_format() + basic_time_format(with_ms, with_tz)
+    return basic_date_format() + basic_time_format(with_us, with_tz)
 
 
 @singleton
@@ -83,16 +85,16 @@ def extended_date_format() -> str:
 
 
 @memorized
-def extended_time_format(with_ms: bool = False, with_tz: bool = False) -> str:
+def extended_time_format(with_us: bool = False, with_tz: bool = False) -> str:
     """
-    Returns the extended time format string, with optional milliseconds and timezone.
+    Returns the extended time format string, with optional microseconds and timezone.
 
-    :param with_ms: If ``True``, include milliseconds in the format.
+    :param with_us: If ``True``, include microseconds in the format.
     :param with_tz: If ``True``, include timezone in the format.
     :return: The extended time format string.
     """
     fmt_str = "T%H:%M:%S"
-    if with_ms:
+    if with_us:
         fmt_str = fmt_str + ".%f"
     if with_tz:
         fmt_str = fmt_str + "%:z"
@@ -100,15 +102,15 @@ def extended_time_format(with_ms: bool = False, with_tz: bool = False) -> str:
 
 
 @memorized
-def extended_format(with_ms: bool = False, with_tz: bool = False) -> str:
+def extended_format(with_us: bool = False, with_tz: bool = False) -> str:
     """
-    Returns the extended combined date and time format string, with optional milliseconds and timezone.
+    Returns the extended combined date and time format string, with optional microseconds and timezone.
 
-    :param with_ms: If ``True``, include milliseconds in the time format.
+    :param with_us: If ``True``, include microseconds in the time format.
     :param with_tz: If ``True``, include timezone in the time format.
     :return: The extended combined date and time format string.
     """
-    return extended_date_format() + extended_time_format(with_ms, with_tz)
+    return extended_date_format() + extended_time_format(with_us, with_tz)
 
 
 iso_date_format = extended_date_format
@@ -120,7 +122,7 @@ iso_format = extended_format
 def iso_formats() -> list[str]:
     """
     Returns a list of supported ISO 8601 date and time format strings, including both basic and extended forms, with
-    optional milliseconds and timezone.
+    optional microseconds and timezone.
 
     :return: A list of ISO 8601 format strings.
     """
@@ -207,6 +209,26 @@ def dt_utc(
     return datetime.datetime(year, month, day, hour, minute, second, microsecond, tzinfo=datetime.timezone.utc)
 
 
+def td_to_us(td: datetime.timedelta) -> int:
+    """
+    Returns the total number of microseconds in the given ``timedelta``.
+
+    :param td: The ``timedelta`` to convert.
+    :return: The total number of microseconds in ``td``.
+    """
+    return (td.days * 86400 + td.seconds) * 1000000 + td.microseconds
+
+
+def td_from_us(us: int) -> datetime.timedelta:
+    """
+    Returns a ``timedelta`` representing the given number of microseconds.
+
+    :param us: The number of microseconds.
+    :return: The corresponding ``timedelta``.
+    """
+    return datetime.timedelta(microseconds=us)
+
+
 def dt_to_td(dt: datetime.datetime) -> datetime.timedelta:
     """
     Returns the ``timedelta`` between the given ``datetime`` and the POSIX epoch.
@@ -234,8 +256,7 @@ def dt_to_ts_us(dt: datetime.datetime) -> int:
     :param dt: The ``datetime`` to convert.
     :return: The timestamp in microseconds from the POSIX epoch.
     """
-    td = dt_to_td(dt)
-    return (td.days * 86400 + td.seconds) * 1000000 + td.microseconds
+    return td_to_us(dt_to_td(dt))
 
 
 def dt_from_td(td: datetime.timedelta) -> datetime.datetime:
@@ -265,7 +286,7 @@ def dt_from_ts_us(ts: int) -> datetime.datetime:
     :param ts: Timestamp in microseconds from the POSIX epoch.
     :return: The corresponding UTC datetime.
     """
-    return dt_from_td(datetime.timedelta(microseconds=ts))
+    return dt_from_td(td_from_us(ts))
 
 
 basic_date_regex: re.Pattern[str] = re.compile(r"(\d{4})(\d{2})(\d{2})")

{iker_python_common-1.0.47 → iker_python_common-1.0.49}/src/iker_python_common.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: iker-python-common
-Version: 1.0.47
+Version: 1.0.49
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12

{iker_python_common-1.0.47 → iker_python_common-1.0.49}/test/iker_tests/common/utils/dtutils_test.py

@@ -2,7 +2,7 @@ import unittest
 
 import ddt
 
-from iker.common.utils.dtutils import basic_format, extended_format, iso_format
+from iker.common.utils.dtutils import basic_format, extended_format, iso_format, td_from_us, td_to_us
 from iker.common.utils.dtutils import dt_format, dt_format_iso, dt_parse, dt_parse_iso
 from iker.common.utils.dtutils import dt_from_ts, dt_from_ts_us, dt_to_ts, dt_to_ts_us
 from iker.common.utils.dtutils import dt_utc
@@ -35,6 +35,24 @@ class DtUtilsTest(unittest.TestCase):
         self.assertEqual(dt_parse_iso("1970-01-01T00:00:00.000000+00:00"), dt_utc_epoch())
         self.assertEqual(dt_parse_iso("1970-01-01T00:00:00.000000"), dt_utc_epoch())
 
+    data_td_us_roundtrip = [
+        (0,),
+        (1,),
+        (999,),
+        (1000,),
+        (999999,),
+        (1000000,),
+        (60000000,),
+        (3600000000,),
+        (86400000000,),
+        (31536000000000,),
+    ]
+
+    @ddt.idata(data_td_us_roundtrip)
+    @ddt.unpack
+    def test_td_us_roundtrip(self, data):
+        self.assertEqual(data, td_to_us(td_from_us(data)))
+
     data_dt_to_ts = [
         (dt_utc(1970, 1, 1), 0.0),
         (dt_utc(1969, 12, 31, 23, 59, 59), -1.0),
@@ -149,45 +167,45 @@ class DtUtilsTest(unittest.TestCase):
 
     data_dt_parse = [
         ("00010101T000000", basic_format(), dt_utc(1, 1, 1, 0, 0, 0)),
-        ("00010101T000000.000000", basic_format(with_ms=True), dt_utc(1, 1, 1, 0, 0, 0)),
+        ("00010101T000000.000000", basic_format(with_us=True), dt_utc(1, 1, 1, 0, 0, 0)),
         ("00010101T000000+0000", basic_format(with_tz=True), dt_utc(1, 1, 1, 0, 0, 0)),
-        ("00010101T000000.000000+0000", basic_format(with_ms=True, with_tz=True), dt_utc(1, 1, 1, 0, 0, 0)),
+        ("00010101T000000.000000+0000", basic_format(with_us=True, with_tz=True), dt_utc(1, 1, 1, 0, 0, 0)),
         ("19700101T000000", basic_format(), dt_utc(1970, 1, 1, 0, 0, 0)),
-        ("19700101T000000.000000", basic_format(with_ms=True), dt_utc(1970, 1, 1, 0, 0, 0)),
+        ("19700101T000000.000000", basic_format(with_us=True), dt_utc(1970, 1, 1, 0, 0, 0)),
         ("19700101T000000+0000", basic_format(with_tz=True), dt_utc(1970, 1, 1, 0, 0, 0)),
-        ("19700101T000000.000000+0000", basic_format(with_ms=True, with_tz=True), dt_utc(1970, 1, 1, 0, 0, 0)),
+        ("19700101T000000.000000+0000", basic_format(with_us=True, with_tz=True), dt_utc(1970, 1, 1, 0, 0, 0)),
         ("99991231T235959",
          basic_format(),
          dt_utc(9999, 12, 31, 23, 59, 59)),
         ("99991231T235959.000000",
-         basic_format(with_ms=True),
+         basic_format(with_us=True),
          dt_utc(9999, 12, 31, 23, 59, 59)),
         ("99991231T235959+0000",
          basic_format(with_tz=True),
          dt_utc(9999, 12, 31, 23, 59, 59)),
         ("99991231T235959.000000+0000",
-         basic_format(with_ms=True, with_tz=True),
+         basic_format(with_us=True, with_tz=True),
          dt_utc(9999, 12, 31, 23, 59, 59)),
 
         ("0001-01-01T00:00:00", extended_format(), dt_utc(1, 1, 1, 0, 0, 0)),
-        ("0001-01-01T00:00:00.000000", extended_format(with_ms=True), dt_utc(1, 1, 1, 0, 0, 0)),
+        ("0001-01-01T00:00:00.000000", extended_format(with_us=True), dt_utc(1, 1, 1, 0, 0, 0)),
         ("0001-01-01T00:00:00+00:00", extended_format(with_tz=True), dt_utc(1, 1, 1, 0, 0, 0)),
-        ("0001-01-01T00:00:00.000000+00:00", extended_format(with_ms=True, with_tz=True), dt_utc(1, 1, 1, 0, 0, 0)),
+        ("0001-01-01T00:00:00.000000+00:00", extended_format(with_us=True, with_tz=True), dt_utc(1, 1, 1, 0, 0, 0)),
         ("1970-01-01T00:00:00", extended_format(), dt_utc(1970, 1, 1, 0, 0, 0)),
-        ("1970-01-01T00:00:00.000000", extended_format(with_ms=True), dt_utc(1970, 1, 1, 0, 0, 0)),
+        ("1970-01-01T00:00:00.000000", extended_format(with_us=True), dt_utc(1970, 1, 1, 0, 0, 0)),
         ("1970-01-01T00:00:00+00:00", extended_format(with_tz=True), dt_utc(1970, 1, 1, 0, 0, 0)),
-        ("1970-01-01T00:00:00.000000+00:00", extended_format(with_ms=True, with_tz=True), dt_utc(1970, 1, 1, 0, 0, 0)),
+        ("1970-01-01T00:00:00.000000+00:00", extended_format(with_us=True, with_tz=True), dt_utc(1970, 1, 1, 0, 0, 0)),
         ("9999-12-31T23:59:59",
          extended_format(),
          dt_utc(9999, 12, 31, 23, 59, 59)),
         ("9999-12-31T23:59:59.000000",
-         extended_format(with_ms=True),
+         extended_format(with_us=True),
          dt_utc(9999, 12, 31, 23, 59, 59)),
         ("9999-12-31T23:59:59+00:00",
          extended_format(with_tz=True),
          dt_utc(9999, 12, 31, 23, 59, 59)),
         ("9999-12-31T23:59:59.000000+00:00",
-         extended_format(with_ms=True, with_tz=True),
+         extended_format(with_us=True, with_tz=True),
          dt_utc(9999, 12, 31, 23, 59, 59)),
 
         ("0001-01-01T00:00:00", "%Y-%m-%dT%H:%M:%S", dt_utc(1, 1, 1, 0, 0, 0)),
@@ -230,45 +248,45 @@ class DtUtilsTest(unittest.TestCase):
 
     data_dt_format = [
         (dt_utc(1, 1, 1, 0, 0, 0), basic_format(), "00010101T000000"),
-        (dt_utc(1, 1, 1, 0, 0, 0), basic_format(with_ms=True), "00010101T000000.000000"),
+        (dt_utc(1, 1, 1, 0, 0, 0), basic_format(with_us=True), "00010101T000000.000000"),
         (dt_utc(1, 1, 1, 0, 0, 0), basic_format(with_tz=True), "00010101T000000+0000"),
-        (dt_utc(1, 1, 1, 0, 0, 0), basic_format(with_ms=True, with_tz=True), "00010101T000000.000000+0000"),
+        (dt_utc(1, 1, 1, 0, 0, 0), basic_format(with_us=True, with_tz=True), "00010101T000000.000000+0000"),
         (dt_utc(1970, 1, 1, 0, 0, 0), basic_format(), "19700101T000000"),
-        (dt_utc(1970, 1, 1, 0, 0, 0), basic_format(with_ms=True), "19700101T000000.000000"),
+        (dt_utc(1970, 1, 1, 0, 0, 0), basic_format(with_us=True), "19700101T000000.000000"),
         (dt_utc(1970, 1, 1, 0, 0, 0), basic_format(with_tz=True), "19700101T000000+0000"),
-        (dt_utc(1970, 1, 1, 0, 0, 0), basic_format(with_ms=True, with_tz=True), "19700101T000000.000000+0000"),
+        (dt_utc(1970, 1, 1, 0, 0, 0), basic_format(with_us=True, with_tz=True), "19700101T000000.000000+0000"),
         (dt_utc(9999, 12, 31, 23, 59, 59),
          basic_format(),
          "99991231T235959"),
         (dt_utc(9999, 12, 31, 23, 59, 59),
-         basic_format(with_ms=True),
+         basic_format(with_us=True),
          "99991231T235959.000000"),
         (dt_utc(9999, 12, 31, 23, 59, 59),
          basic_format(with_tz=True),
          "99991231T235959+0000"),
         (dt_utc(9999, 12, 31, 23, 59, 59),
-         basic_format(with_ms=True, with_tz=True),
+         basic_format(with_us=True, with_tz=True),
          "99991231T235959.000000+0000"),
 
         (dt_utc(1, 1, 1, 0, 0, 0), extended_format(), "0001-01-01T00:00:00"),
-        (dt_utc(1, 1, 1, 0, 0, 0), extended_format(with_ms=True), "0001-01-01T00:00:00.000000"),
+        (dt_utc(1, 1, 1, 0, 0, 0), extended_format(with_us=True), "0001-01-01T00:00:00.000000"),
         (dt_utc(1, 1, 1, 0, 0, 0), extended_format(with_tz=True), "0001-01-01T00:00:00+00:00"),
-        (dt_utc(1, 1, 1, 0, 0, 0), extended_format(with_ms=True, with_tz=True), "0001-01-01T00:00:00.000000+00:00"),
+        (dt_utc(1, 1, 1, 0, 0, 0), extended_format(with_us=True, with_tz=True), "0001-01-01T00:00:00.000000+00:00"),
         (dt_utc(1970, 1, 1, 0, 0, 0), extended_format(), "1970-01-01T00:00:00"),
-        (dt_utc(1970, 1, 1, 0, 0, 0), extended_format(with_ms=True), "1970-01-01T00:00:00.000000"),
+        (dt_utc(1970, 1, 1, 0, 0, 0), extended_format(with_us=True), "1970-01-01T00:00:00.000000"),
         (dt_utc(1970, 1, 1, 0, 0, 0), extended_format(with_tz=True), "1970-01-01T00:00:00+00:00"),
-        (dt_utc(1970, 1, 1, 0, 0, 0), extended_format(with_ms=True, with_tz=True), "1970-01-01T00:00:00.000000+00:00"),
+        (dt_utc(1970, 1, 1, 0, 0, 0), extended_format(with_us=True, with_tz=True), "1970-01-01T00:00:00.000000+00:00"),
         (dt_utc(9999, 12, 31, 23, 59, 59),
          extended_format(),
          "9999-12-31T23:59:59"),
         (dt_utc(9999, 12, 31, 23, 59, 59),
-         extended_format(with_ms=True),
+         extended_format(with_us=True),
          "9999-12-31T23:59:59.000000"),
         (dt_utc(9999, 12, 31, 23, 59, 59),
          extended_format(with_tz=True),
          "9999-12-31T23:59:59+00:00"),
         (dt_utc(9999, 12, 31, 23, 59, 59),
-         extended_format(with_ms=True, with_tz=True),
+         extended_format(with_us=True, with_tz=True),
          "9999-12-31T23:59:59.000000+00:00"),
 
         (dt_utc(9999, 12, 31, 23, 59, 59), "%Y-%m-%dT%H:%M:%S", "9999-12-31T23:59:59"),