dycw-utilities 0.129.6__py3-none-any.whl → 0.129.8__py3-none-any.whl

{dycw_utilities-0.129.6.dist-info → dycw_utilities-0.129.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dycw-utilities
-Version: 0.129.6
+Version: 0.129.8
 Author-email: Derek Wan <d.wan@icloud.com>
 License-File: LICENSE
 Requires-Python: >=3.12
@@ -93,12 +93,11 @@ Requires-Dist: polars-lts-cpu<1.31,>=1.30.0; extra == 'zzz-test-iterables'
 Requires-Dist: whenever<0.9,>=0.8.4; extra == 'zzz-test-iterables'
 Provides-Extra: zzz-test-jupyter
 Requires-Dist: jupyterlab<4.3,>=4.2.0; extra == 'zzz-test-jupyter'
-Requires-Dist: pandas<2.3,>=2.2.2; extra == 'zzz-test-jupyter'
+Requires-Dist: pandas<2.4,>=2.3.0; extra == 'zzz-test-jupyter'
 Requires-Dist: polars-lts-cpu<1.31,>=1.30.0; extra == 'zzz-test-jupyter'
 Provides-Extra: zzz-test-logging
 Requires-Dist: atomicwrites<1.5,>=1.4.1; extra == 'zzz-test-logging'
 Requires-Dist: coloredlogs<15.1,>=15.0.1; extra == 'zzz-test-logging'
-Requires-Dist: concurrent-log-handler<0.10,>=0.9.26; extra == 'zzz-test-logging'
 Requires-Dist: rich<14.1,>=14.0.0; extra == 'zzz-test-logging'
 Requires-Dist: tomlkit<0.14,>=0.13.2; extra == 'zzz-test-logging'
 Requires-Dist: tzlocal<5.4,>=5.3.1; extra == 'zzz-test-logging'
@@ -173,7 +172,7 @@ Requires-Dist: scipy<1.16,>=1.15.3; extra == 'zzz-test-scipy'
 Provides-Extra: zzz-test-sentinel
 Provides-Extra: zzz-test-shelve
 Provides-Extra: zzz-test-slack-sdk
-Requires-Dist: aiohttp<3.12.8,>=3.12.7; extra == 'zzz-test-slack-sdk'
+Requires-Dist: aiohttp<3.12.10,>=3.12.9; extra == 'zzz-test-slack-sdk'
 Requires-Dist: slack-sdk<3.36,>=3.35.0; extra == 'zzz-test-slack-sdk'
 Provides-Extra: zzz-test-socket
 Provides-Extra: zzz-test-sqlalchemy

{dycw_utilities-0.129.6.dist-info → dycw_utilities-0.129.8.dist-info}/RECORD

@@ -1,4 +1,4 @@
-utilities/__init__.py,sha256=Odk_y5HDH2OquSZJAdWdoTST_nZpx27fTwquoNg32dI,60
+utilities/__init__.py,sha256=nud8TbHJzm02w0ycVV5vCV-F8CpfmCs3mB9e6p4DrdQ,60
 utilities/altair.py,sha256=Gpja-flOo-Db0PIPJLJsgzAlXWoKUjPU1qY-DQ829ek,9156
 utilities/asyncio.py,sha256=3n5EIcSq2xtEF1i4oR0oY2JmBq3NyugeHKFK39Mt22s,37987
 utilities/atomicwrites.py,sha256=geFjn9Pwn-tTrtoGjDDxWli9NqbYfy3gGL6ZBctiqSo,5393
@@ -29,7 +29,7 @@ utilities/iterables.py,sha256=mDqw2_0MUVp-P8FklgcaVTi2TXduH0MxbhTDzzhSBho,44915
 utilities/jupyter.py,sha256=ft5JA7fBxXKzP-L9W8f2-wbF0QeYc_2uLQNFDVk4Z-M,2917
 utilities/libcst.py,sha256=Jto5ppzRzsxn4AD32IS8n0lbgLYXwsVJB6EY8giNZyY,4974
 utilities/lightweight_charts.py,sha256=0xNfcsrgFI0R9xL25LtSm-W5yhfBI93qQNT6HyaXAhg,2769
-utilities/logging.py,sha256=9vo6vz4sDMoF2nkc8eT-eWpymBb5QboIu0kMhEwPiqk,25206
+utilities/logging.py,sha256=dA54i2gmULBLuEJ2roGYWt9pW2NvNBmx0YxlMns347M,26126
 utilities/loguru.py,sha256=MEMQVWrdECxk1e3FxGzmOf21vWT9j8CAir98SEXFKPA,3809
 utilities/luigi.py,sha256=fpH9MbxJDuo6-k9iCXRayFRtiVbUtibCJKugf7ygpv0,5988
 utilities/math.py,sha256=-mQgbah-dPJwOEWf3SonrFoVZ2AVxMgpeQ3dfVa-oJA,26764
@@ -78,7 +78,7 @@ utilities/tenacity.py,sha256=1PUvODiBVgeqIh7G5TRt5WWMSqjLYkEqP53itT97WQc,4914
 utilities/text.py,sha256=ymBFlP_cA8OgNnZRVNs7FAh7OG8HxE6YkiLEMZv5g_A,11297
 utilities/threading.py,sha256=GvBOp4CyhHfN90wGXZuA2VKe9fGzMaEa7oCl4f3nnPU,1009
 utilities/timer.py,sha256=Rkc49KSpHuC8s7vUxGO9DU55U9I6yDKnchsQqrUCVBs,4075
-utilities/traceback.py,sha256=Jg7HS3AwQ-W-msdwHp22_PSHZcR54PbmsSf115B6TSM,27435
+utilities/traceback.py,sha256=Rf_4XIz6AQaBcTRr7Tiw7RCIv_O_bN7Hd-Cnr8SPXN4,28920
 utilities/types.py,sha256=gP04CcCOyFrG7BgblVCsrrChiuO2x842NDVW-GF7odo,18370
 utilities/typing.py,sha256=H6ysJkI830aRwLsMKz0SZIw4cpcsm7d6KhQOwr-SDh0,13817
 utilities/tzdata.py,sha256=yCf70NICwAeazN3_JcXhWvRqCy06XJNQ42j7r6gw3HY,1217
@@ -86,10 +86,10 @@ utilities/tzlocal.py,sha256=3upDNFBvGh1l9njmLR2z2S6K6VxQSb7QizYGUbAH3JU,960
 utilities/uuid.py,sha256=jJTFxz-CWgltqNuzmythB7iEQ-Q1mCwPevUfKthZT3c,611
 utilities/version.py,sha256=ufhJMmI6KPs1-3wBI71aj5wCukd3sP_m11usLe88DNA,5117
 utilities/warnings.py,sha256=un1LvHv70PU-LLv8RxPVmugTzDJkkGXRMZTE2-fTQHw,1771
-utilities/whenever.py,sha256=jS31ZAY5OMxFxLja_Yo5Fidi87Pd-GoVZ7Vi_teqVDA,16743
+utilities/whenever.py,sha256=QbXgFAPuUL7PCp2hajmIP-FFIfIR1J6Y0TxJbeoj60I,18434
 utilities/zipfile.py,sha256=24lQc9ATcJxHXBPc_tBDiJk48pWyRrlxO2fIsFxU0A8,699
 utilities/zoneinfo.py,sha256=-5j7IQ9nb7gR43rdgA7ms05im-XuqhAk9EJnQBXxCoQ,1874
-dycw_utilities-0.129.6.dist-info/METADATA,sha256=tC_nJcnk-38KjYuNvAhfUg4mKnytwE71-7ndZfBs0bQ,12803
-dycw_utilities-0.129.6.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-dycw_utilities-0.129.6.dist-info/licenses/LICENSE,sha256=gppZp16M6nSVpBbUBrNL6JuYfvKwZiKgV7XoKKsHzqo,1066
-dycw_utilities-0.129.6.dist-info/RECORD,,
+dycw_utilities-0.129.8.dist-info/METADATA,sha256=JaBYjbXepIOBDjYciDSC1_bSCE8VlzxhpOPAs22-nMI,12723
+dycw_utilities-0.129.8.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+dycw_utilities-0.129.8.dist-info/licenses/LICENSE,sha256=gppZp16M6nSVpBbUBrNL6JuYfvKwZiKgV7XoKKsHzqo,1066
+dycw_utilities-0.129.8.dist-info/RECORD,,

utilities/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.129.6"
+__version__ = "0.129.8"

utilities/logging.py

@@ -107,8 +107,9 @@ class SizeAndTimeRotatingFileHandler(BaseRotatingHandler):
         utc: bool = False,
         atTime: dt.time | None = None,
     ) -> None:
-        filename = str(Path(filename))
-        super().__init__(filename, mode, encoding=encoding, delay=delay, errors=errors)
+        path = Path(filename)
+        path.parent.mkdir(parents=True, exist_ok=True)
+        super().__init__(path, mode, encoding=encoding, delay=delay, errors=errors)
         self._max_bytes = maxBytes if maxBytes >= 1 else None
         self._backup_count = backupCount if backupCount >= 1 else None
         self._filename = Path(self.baseFilename)
@@ -117,7 +118,7 @@ class SizeAndTimeRotatingFileHandler(BaseRotatingHandler):
         self._suffix = self._filename.suffix
         self._patterns = _compute_rollover_patterns(self._stem, self._suffix)
         self._time_handler = TimedRotatingFileHandler(
-            filename,
+            path,
             when=when,
             interval=interval,
             backupCount=backupCount,
@@ -415,26 +416,53 @@ def add_filters(handler: Handler, /, *filters: _FilterType) -> None:
 
 def basic_config(
     *,
-    logger: LoggerOrName | None = None,
+    obj: LoggerOrName | Handler | None = None,
     format_: str = "{asctime} | {name} | {levelname:8} | {message}",
+    whenever: bool = False,
     level: LogLevel = "INFO",
+    plain: bool = False,
 ) -> None:
     """Do the basic config."""
+    if whenever:
+        format_ = format_.replace("{asctime}", "{zoned_datetime}")
     datefmt = maybe_sub_pct_y("%Y-%m-%d %H:%M:%S")
-    if logger is None:
-        basicConfig(format=format_, datefmt=datefmt, style="{", level=level)
-    else:
-        logger_use = get_logger(logger=logger)
-        logger_use.setLevel(level)
-        logger_use.addHandler(handler := StreamHandler())
-        handler.setLevel(level)
-        try:
-            from coloredlogs import ColoredFormatter
-        except ModuleNotFoundError:  # pragma: no cover
-            formatter = Formatter(fmt=format_, datefmt=datefmt, style="{")
-        else:
-            formatter = ColoredFormatter(fmt=format_, datefmt=datefmt, style="{")
-        handler.setFormatter(formatter)
+    match obj:
+        case None:
+            basicConfig(format=format_, datefmt=datefmt, style="{", level=level)
+        case Logger() as logger:
+            logger.setLevel(level)
+            logger.addHandler(handler := StreamHandler())
+            basic_config(
+                obj=handler,
+                format_=format_,
+                whenever=whenever,
+                level=level,
+                plain=plain,
+            )
+        case str() as name:
+            basic_config(
+                obj=get_logger(logger=name),
+                format_=format_,
+                whenever=whenever,
+                level=level,
+                plain=plain,
+            )
+        case Handler() as handler:
+            handler.setLevel(level)
+            if plain:
+                formatter = Formatter(fmt=format_, datefmt=datefmt, style="{")
+            else:
+                try:
+                    from coloredlogs import ColoredFormatter
+                except ModuleNotFoundError:  # pragma: no cover
+                    formatter = Formatter(fmt=format_, datefmt=datefmt, style="{")
+                else:
+                    formatter = ColoredFormatter(
+                        fmt=format_, datefmt=datefmt, style="{"
+                    )
+            handler.setFormatter(formatter)
+        case _ as never:
+            assert_never(never)
 
 
 ##

utilities/traceback.py

@@ -26,6 +26,7 @@ from typing import (
     runtime_checkable,
 )
 
+from utilities.datetime import get_datetime, get_now
 from utilities.errors import ImpossibleCaseError
 from utilities.functions import (
     ensure_not_none,
@@ -45,8 +46,9 @@ from utilities.reprlib import (
     yield_call_args_repr,
     yield_mapping_repr,
 )
-from utilities.types import TBaseException, TCallable
+from utilities.types import MaybeCallableDateTime, TBaseException, TCallable
 from utilities.version import get_version
+from utilities.whenever import serialize_duration
 
 if TYPE_CHECKING:
     from collections.abc import Callable, Iterable, Iterator
@@ -60,6 +62,7 @@ if TYPE_CHECKING:
 _T = TypeVar("_T")
 _CALL_ARGS = "_CALL_ARGS"
 _INDENT = 4 * " "
+_START = get_now()
 
 
 ##
@@ -78,6 +81,7 @@ class RichTracebackFormatter(Formatter):
         /,
         *,
         defaults: StrMapping | None = None,
+        start: MaybeCallableDateTime | None = _START,
         version: MaybeCallableVersionLike | None = None,
         max_width: int = RICH_MAX_WIDTH,
         indent_size: int = RICH_INDENT_SIZE,
@@ -89,7 +93,8 @@ class RichTracebackFormatter(Formatter):
         post: Callable[[str], str] | None = None,
     ) -> None:
         super().__init__(fmt, datefmt, style, validate, defaults=defaults)
-        self._version = version
+        self._start = get_datetime(datetime=start)
+        self._version = get_version(version=version)
         self._max_width = max_width
         self._indent_size = indent_size
         self._max_length = max_length
@@ -110,6 +115,7 @@ class RichTracebackFormatter(Formatter):
         exc_value = ensure_not_none(exc_value, desc="exc_value")
         error = get_rich_traceback(
             exc_value,
+            start=self._start,
             version=self._version,
             max_width=self._max_width,
             indent_size=self._indent_size,
@@ -263,6 +269,7 @@ class ExcChainTB(Generic[TBaseException]):
     errors: list[
         ExcGroupTB[TBaseException] | ExcTB[TBaseException] | TBaseException
     ] = field(default_factory=list)
+    start: MaybeCallableDateTime | None = field(default=_START, repr=False)
     version: MaybeCallableVersionLike | None = field(default=None, repr=False)
     max_width: int = RICH_MAX_WIDTH
     indent_size: int = RICH_INDENT_SIZE
@@ -292,7 +299,7 @@ class ExcChainTB(Generic[TBaseException]):
         """Format the traceback."""
         lines: list[str] = []
         if header:  # pragma: no cover
-            lines.extend(_yield_header_lines(version=self.version))
+            lines.extend(_yield_header_lines(start=self.start, version=self.version))
         total = len(self.errors)
         for i, errors in enumerate(self.errors, start=1):
             lines.append(f"Exception chain {i}/{total}:")
@@ -315,6 +322,7 @@ class ExcGroupTB(Generic[TBaseException]):
     errors: list[
         ExcGroupTB[TBaseException] | ExcTB[TBaseException] | TBaseException
     ] = field(default_factory=list)
+    start: MaybeCallableDateTime | None = field(default=_START, repr=False)
     version: MaybeCallableVersionLike | None = field(default=None, repr=False)
     max_width: int = RICH_MAX_WIDTH
     indent_size: int = RICH_INDENT_SIZE
@@ -333,7 +341,7 @@ class ExcGroupTB(Generic[TBaseException]):
         """Format the traceback."""
         lines: list[str] = []  # skipif-ci
         if header:  # pragma: no cover
-            lines.extend(_yield_header_lines(version=self.version))
+            lines.extend(_yield_header_lines(start=self.start, version=self.version))
         lines.append("Exception group:")  # skipif-ci
         match self.exc_group:  # skipif-ci
             case ExcTB() as exc_tb:
@@ -363,6 +371,7 @@ class ExcTB(Generic[TBaseException]):
 
     frames: list[_Frame] = field(default_factory=list)
     error: TBaseException
+    start: MaybeCallableDateTime | None = field(default=_START, repr=False)
     version: MaybeCallableVersionLike | None = field(default=None, repr=False)
     max_width: int = RICH_MAX_WIDTH
     indent_size: int = RICH_INDENT_SIZE
@@ -391,7 +400,7 @@ class ExcTB(Generic[TBaseException]):
         total = len(self)
         lines: list[str] = []
         if header:  # pragma: no cover
-            lines.extend(_yield_header_lines(version=self.version))
+            lines.extend(_yield_header_lines(start=self.start, version=self.version))
         for i, frame in enumerate(self.frames):
             is_head = i < total - 1
             lines.append(
@@ -485,6 +494,7 @@ def get_rich_traceback(
     error: TBaseException,
     /,
     *,
+    start: MaybeCallableDateTime | None = _START,
     version: MaybeCallableVersionLike | None = None,
     max_width: int = RICH_MAX_WIDTH,
     indent_size: int = RICH_INDENT_SIZE,
@@ -506,6 +516,7 @@ def get_rich_traceback(
             err_recast = cast("TBaseException", err)
             return _get_rich_traceback_non_chain(
                 err_recast,
+                start=start,
                 version=version,
                 max_width=max_width,
                 indent_size=indent_size,
@@ -520,6 +531,7 @@ def get_rich_traceback(
                 errors=[
                     _get_rich_traceback_non_chain(
                         e,
+                        start=start,
                         version=version,
                         max_width=max_width,
                         indent_size=indent_size,
@@ -530,6 +542,7 @@ def get_rich_traceback(
                     )
                     for e in errs_recast
                 ],
+                start=start,
                 version=version,
                 max_width=max_width,
                 indent_size=indent_size,
@@ -544,6 +557,7 @@ def _get_rich_traceback_non_chain(
     error: ExceptionGroup[Any] | TBaseException,
     /,
     *,
+    start: MaybeCallableDateTime | None = _START,
     version: MaybeCallableVersionLike | None = None,
     max_width: int = RICH_MAX_WIDTH,
     indent_size: int = RICH_INDENT_SIZE,
@@ -567,6 +581,7 @@ def _get_rich_traceback_non_chain(
             errors = [
                 _get_rich_traceback_non_chain(
                     e,
+                    start=start,
                     version=version,
                     max_width=max_width,
                     indent_size=indent_size,
@@ -580,6 +595,7 @@ def _get_rich_traceback_non_chain(
             return ExcGroupTB(
                 exc_group=exc_group_or_exc_tb,
                 errors=errors,
+                start=start,
                 version=version,
                 max_width=max_width,
                 indent_size=indent_size,
@@ -591,6 +607,7 @@ def _get_rich_traceback_non_chain(
         case BaseException() as base_exc:
             return _get_rich_traceback_base_one(
                 base_exc,
+                start=start,
                 version=version,
                 max_width=max_width,
                 indent_size=indent_size,
@@ -607,6 +624,7 @@ def _get_rich_traceback_base_one(
     error: TBaseException,
     /,
     *,
+    start: MaybeCallableDateTime | None = _START,
     version: MaybeCallableVersionLike | None = None,
     max_width: int = RICH_MAX_WIDTH,
     indent_size: int = RICH_INDENT_SIZE,
@@ -638,6 +656,7 @@ def _get_rich_traceback_base_one(
         return ExcTB(
             frames=frames,
             error=error,
+            start=start,
             version=version,
             max_width=max_width,
             indent_size=indent_size,
@@ -793,13 +812,25 @@ def _merge_frames(
 
 
 def _yield_header_lines(
-    *, version: MaybeCallableVersionLike | None = None
+    *,
+    start: MaybeCallableDateTime | None = _START,
+    version: MaybeCallableVersionLike | None = None,
 ) -> Iterator[str]:
     """Yield the header lines."""
-    from utilities.tzlocal import get_now_local
+    from utilities.tzlocal import get_local_time_zone, get_now_local
     from utilities.whenever import serialize_zoned_datetime
 
-    yield f"Date/time | {serialize_zoned_datetime(get_now_local())}"
+    now = get_now_local()
+    start_use = get_datetime(datetime=start)
+    start_use = (
+        None if start_use is None else start_use.astimezone(get_local_time_zone())
+    )
+    yield f"Date/time | {serialize_zoned_datetime(now)}"
+    start_str = "" if start_use is None else serialize_zoned_datetime(start_use)
+    yield f"Started   | {start_str}"
+    duration = None if start_use is None else (now - start_use)
+    duration_str = "" if duration is None else serialize_duration(duration)
+    yield f"Duration  | {duration_str}"
     yield f"User      | {getuser()}"
     yield f"Host      | {gethostname()}"
     version_use = "" if version is None else get_version(version=version)

utilities/whenever.py

@@ -4,7 +4,9 @@ import datetime as dt
 import re
 from contextlib import suppress
 from dataclasses import dataclass
-from typing import TYPE_CHECKING, override
+from functools import cache
+from logging import LogRecord
+from typing import TYPE_CHECKING, Any, override
 
 from whenever import (
     Date,
@@ -33,6 +35,8 @@ from utilities.re import (
 from utilities.zoneinfo import UTC, ensure_time_zone, get_time_zone_name
 
 if TYPE_CHECKING:
+    from zoneinfo import ZoneInfo
+
     from utilities.types import (
         DateLike,
         DateTimeLike,
@@ -561,6 +565,64 @@ class SerializeZonedDateTimeError(Exception):
 ##
 
 
+class WheneverLogRecord(LogRecord):
+    """Log record powered by `whenever`."""
+
+    zoned_datetime: str
+
+    @override
+    def __init__(
+        self,
+        name: str,
+        level: int,
+        pathname: str,
+        lineno: int,
+        msg: object,
+        args: Any,
+        exc_info: Any,
+        func: str | None = None,
+        sinfo: str | None = None,
+    ) -> None:
+        super().__init__(
+            name, level, pathname, lineno, msg, args, exc_info, func, sinfo
+        )
+        length = self._get_length()
+        plain = format(self._get_now().to_plain().format_common_iso(), f"{length}s")
+        time_zone = self._get_time_zone_key()
+        self.zoned_datetime = f"{plain}[{time_zone}]"
+
+    @classmethod
+    @cache
+    def _get_time_zone(cls) -> ZoneInfo:
+        """Get the local timezone."""
+        try:
+            from utilities.tzlocal import get_local_time_zone
+        except ModuleNotFoundError:  # pragma: no cover
+            return UTC
+        return get_local_time_zone()
+
+    @classmethod
+    @cache
+    def _get_time_zone_key(cls) -> str:
+        """Get the local timezone as a string."""
+        return cls._get_time_zone().key
+
+    @classmethod
+    @cache
+    def _get_length(cls) -> int:
+        """Get maximum length of a formatted string."""
+        now = cls._get_now().replace(nanosecond=1000).to_plain()
+        return len(now.format_common_iso())
+
+    @classmethod
+    def _get_now(cls) -> ZonedDateTime:
+        """Get the current zoned datetime."""
+        return ZonedDateTime.now(cls._get_time_zone().key)
+
+
+##
+
+
 def _to_datetime_delta(timedelta: dt.timedelta, /) -> DateTimeDelta:
     """Serialize a timedelta."""
     total_microseconds = datetime_duration_to_microseconds(timedelta)
@@ -610,6 +672,7 @@ __all__ = [
     "SerializePlainDateTimeError",
     "SerializeTimeDeltaError",
     "SerializeZonedDateTimeError",
+    "WheneverLogRecord",
     "check_valid_zoned_datetime",
     "ensure_date",
     "ensure_datetime",