iker-python-common 1.0.47__py3-none-any.whl → 1.0.49__py3-none-any.whl

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.dist-info → iker_python_common-1.0.49.dist-info}/METADATA

@@ -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.dist-info → iker_python_common-1.0.49.dist-info}/RECORD

@@ -5,7 +5,7 @@ iker/common/utils/config.py,sha256=z8rLqli961A-qAV9EaELp-pKuhNUNaq1Btdv-uwG7_I,4
 iker/common/utils/csv.py,sha256=_V9OUrKcojec2L-hWagEIVnL2uvGjyJAFTrD7tHNr48,7573
 iker/common/utils/dbutils.py,sha256=lUcYKP26y4FGygMPs8SlW-PjDSZcvZO0e-cOkT2XqCY,11076
 iker/common/utils/dockerutils.py,sha256=n2WuzXaZB6_WocSljvPOnfExSIjIHRUbuWp2oBbaPKQ,8004
-iker/common/utils/dtutils.py,sha256=SFaBDXv0HAs8kSQqeyE6BfH9V6_LWPXzPhLh-4GKRQ8,11367
+iker/common/utils/dtutils.py,sha256=fY7nVb0UBX5f4P8s_dHBv3vL0hTDbr3jlV3OjU89sxs,11908
 iker/common/utils/funcutils.py,sha256=A08f5wjoLgLQKyRJcYeWJnqVm2QcerIx0l-Se2600bc,5869
 iker/common/utils/jsonutils.py,sha256=xYKimWtsqQKiQDQr3EMIhpGrmWSNPzgZR1Sdz60CxSo,16536
 iker/common/utils/logger.py,sha256=FJaai6Sbchy4wKHcUMUCrrkBcXvIxq4qByERZ_TJBps,3881
@@ -19,7 +19,7 @@ iker/common/utils/span.py,sha256=yiXqk86cLKxkMdkO3pAHEfU5bUvHsGo3p--pAWo_yfM,599
 iker/common/utils/strutils.py,sha256=Tu_qFeH3K-SfwvMxdrZAc9iLPV8ZmtX4ntyyFGNslf8,5094
 iker/common/utils/testutils.py,sha256=60c3DAZxj0D6EKOhDRQdcBiqV4kMBJGXFpbnyKkfgvg,5554
 iker/common/utils/typeutils.py,sha256=RVkYkFRgDrx77OHFH7PavMV0AIB0S8ly40rs4g7JWE4,8220
-iker_python_common-1.0.47.dist-info/METADATA,sha256=gHgD7cbGPthAhGsQvtZ_VZy74fRP9RSUOhApTC7UCyQ,1001
-iker_python_common-1.0.47.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-iker_python_common-1.0.47.dist-info/top_level.txt,sha256=4_B8Prfc_lxFafFYTQThIU1ZqOYQ4pHHHnJ_fQ_oHs8,5
-iker_python_common-1.0.47.dist-info/RECORD,,
+iker_python_common-1.0.49.dist-info/METADATA,sha256=2UvkILO7DuIVXXS-pLIHJmeHOZ-ZcxZc892J8jNUO5k,1001
+iker_python_common-1.0.49.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+iker_python_common-1.0.49.dist-info/top_level.txt,sha256=4_B8Prfc_lxFafFYTQThIU1ZqOYQ4pHHHnJ_fQ_oHs8,5
+iker_python_common-1.0.49.dist-info/RECORD,,