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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dycw-utilities
-Version: 0.129.8
+Version: 0.129.9
 Author-email: Derek Wan <d.wan@icloud.com>
 License-File: LICENSE
 Requires-Python: >=3.12

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

@@ -1,4 +1,4 @@
-utilities/__init__.py,sha256=nud8TbHJzm02w0ycVV5vCV-F8CpfmCs3mB9e6p4DrdQ,60
+utilities/__init__.py,sha256=uFYFepkZNArEi_sHiw7tlOn88WgLGjxnMihyD4GzfOQ,60
 utilities/altair.py,sha256=Gpja-flOo-Db0PIPJLJsgzAlXWoKUjPU1qY-DQ829ek,9156
 utilities/asyncio.py,sha256=3n5EIcSq2xtEF1i4oR0oY2JmBq3NyugeHKFK39Mt22s,37987
 utilities/atomicwrites.py,sha256=geFjn9Pwn-tTrtoGjDDxWli9NqbYfy3gGL6ZBctiqSo,5393
@@ -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=Rf_4XIz6AQaBcTRr7Tiw7RCIv_O_bN7Hd-Cnr8SPXN4,28920
+utilities/traceback.py,sha256=EUm-5jhH1RICBmsG_H77-CXvD-IVErfkzGRSqnvR0dI,35782
 utilities/types.py,sha256=gP04CcCOyFrG7BgblVCsrrChiuO2x842NDVW-GF7odo,18370
 utilities/typing.py,sha256=H6ysJkI830aRwLsMKz0SZIw4cpcsm7d6KhQOwr-SDh0,13817
 utilities/tzdata.py,sha256=yCf70NICwAeazN3_JcXhWvRqCy06XJNQ42j7r6gw3HY,1217
@@ -89,7 +89,7 @@ utilities/warnings.py,sha256=un1LvHv70PU-LLv8RxPVmugTzDJkkGXRMZTE2-fTQHw,1771
 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.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,,
+dycw_utilities-0.129.9.dist-info/METADATA,sha256=c0KdCG0ORHKUnqbJ4eaGnDoZNUDbRtkjupd_8Oqg22c,12723
+dycw_utilities-0.129.9.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+dycw_utilities-0.129.9.dist-info/licenses/LICENSE,sha256=gppZp16M6nSVpBbUBrNL6JuYfvKwZiKgV7XoKKsHzqo,1066
+dycw_utilities-0.129.9.dist-info/RECORD,,

utilities/__init__.py

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

utilities/traceback.py

@@ -1,10 +1,14 @@
 from __future__ import annotations
 
+import re
+import sys
+from asyncio import run
 from collections.abc import Callable, Iterable
 from dataclasses import dataclass, field, replace
-from functools import wraps
+from functools import partial, wraps
 from getpass import getuser
 from inspect import iscoroutinefunction, signature
+from itertools import repeat
 from logging import Formatter, Handler, LogRecord
 from pathlib import Path
 from socket import gethostname
@@ -26,8 +30,8 @@ from typing import (
     runtime_checkable,
 )
 
-from utilities.datetime import get_datetime, get_now
-from utilities.errors import ImpossibleCaseError
+from utilities.datetime import get_datetime, get_now, serialize_compact
+from utilities.errors import ImpossibleCaseError, repr_error
 from utilities.functions import (
     ensure_not_none,
     ensure_str,
@@ -35,7 +39,8 @@ from utilities.functions import (
     get_func_name,
     get_func_qualname,
 )
-from utilities.iterables import always_iterable, one
+from utilities.iterables import OneEmptyError, always_iterable, one
+from utilities.pathlib import get_path
 from utilities.reprlib import (
     RICH_EXPAND_ALL,
     RICH_INDENT_SIZE,
@@ -46,12 +51,18 @@ from utilities.reprlib import (
     yield_call_args_repr,
     yield_mapping_repr,
 )
-from utilities.types import MaybeCallableDateTime, TBaseException, TCallable
+from utilities.types import (
+    MaybeCallableDateTime,
+    MaybeCallablePathLike,
+    PathLike,
+    TBaseException,
+    TCallable,
+)
 from utilities.version import get_version
 from utilities.whenever import serialize_duration
 
 if TYPE_CHECKING:
-    from collections.abc import Callable, Iterable, Iterator
+    from collections.abc import Callable, Iterable, Iterator, Sequence
     from logging import _FormatStyle
     from types import FrameType, TracebackType
 
@@ -68,6 +79,131 @@ _START = get_now()
 ##
 
 
+def format_exception_stack(
+    error: BaseException,
+    /,
+    *,
+    header: bool = False,
+    start: MaybeCallableDateTime | None = _START,
+    version: MaybeCallableVersionLike | None = None,
+    capture_locals: bool = False,
+    max_width: int = RICH_MAX_WIDTH,
+    indent_size: int = RICH_INDENT_SIZE,
+    max_length: int | None = RICH_MAX_LENGTH,
+    max_string: int | None = RICH_MAX_STRING,
+    max_depth: int | None = RICH_MAX_DEPTH,
+    expand_all: bool = RICH_EXPAND_ALL,
+) -> str:
+    """Format an exception stack."""
+    lines: Sequence[str] = []
+    if header:
+        lines.extend(_yield_header_lines(start=start, version=version))
+    lines.extend(
+        _yield_formatted_frame_summary(
+            error,
+            capture_locals=capture_locals,
+            max_width=max_width,
+            indent_size=indent_size,
+            max_length=max_length,
+            max_string=max_string,
+            max_depth=max_depth,
+            expand_all=expand_all,
+        )
+    )
+    return "\n".join(lines)
+
+
+##
+
+
+def make_except_hook(
+    *,
+    start: MaybeCallableDateTime | None = _START,
+    version: MaybeCallableVersionLike | None = None,
+    path: MaybeCallablePathLike | None = None,
+    max_width: int = RICH_MAX_WIDTH,
+    indent_size: int = RICH_INDENT_SIZE,
+    max_length: int | None = RICH_MAX_LENGTH,
+    max_string: int | None = RICH_MAX_STRING,
+    max_depth: int | None = RICH_MAX_DEPTH,
+    expand_all: bool = RICH_EXPAND_ALL,
+    slack_url: str | None = None,
+) -> Callable[
+    [type[BaseException] | None, BaseException | None, TracebackType | None], None
+]:
+    """Exception hook to log the traceback."""
+    return partial(
+        _make_except_hook_inner,
+        start=start,
+        version=version,
+        path=path,
+        max_width=max_width,
+        indent_size=indent_size,
+        max_length=max_length,
+        max_string=max_string,
+        max_depth=max_depth,
+        expand_all=expand_all,
+        slack_url=slack_url,
+    )
+
+
+def _make_except_hook_inner(
+    exc_type: type[BaseException] | None,
+    exc_val: BaseException | None,
+    traceback: TracebackType | None,
+    /,
+    *,
+    start: MaybeCallableDateTime | None = _START,
+    version: MaybeCallableVersionLike | None = None,
+    path: MaybeCallablePathLike | None = None,
+    max_width: int = RICH_MAX_WIDTH,
+    indent_size: int = RICH_INDENT_SIZE,
+    max_length: int | None = RICH_MAX_LENGTH,
+    max_string: int | None = RICH_MAX_STRING,
+    max_depth: int | None = RICH_MAX_DEPTH,
+    expand_all: bool = RICH_EXPAND_ALL,
+    slack_url: str | None = None,
+) -> None:
+    """Exception hook to log the traceback."""
+    _ = (exc_type, traceback)
+    if exc_val is None:
+        raise MakeExceptHookError
+    slim = format_exception_stack(exc_val, header=True, start=start, version=version)
+    _ = sys.stderr.write(f"{slim}\n")  # don't 'from sys import stderr'
+    if path is not None:
+        from utilities.atomicwrites import writer
+        from utilities.tzlocal import get_now_local
+
+        path = (
+            get_path(path=path)
+            .joinpath(serialize_compact(get_now_local()))
+            .with_suffix(".txt")
+        )
+        full = format_exception_stack(
+            exc_val,
+            header=True,
+            start=start,
+            version=version,
+            capture_locals=True,
+            max_width=max_width,
+            indent_size=indent_size,
+            max_length=max_length,
+            max_string=max_string,
+            max_depth=max_depth,
+            expand_all=expand_all,
+        )
+        with writer(path, overwrite=True) as temp:
+            _ = temp.write_text(full)
+    if slack_url is not None:  # pragma: no cover
+        from utilities.slack_sdk import send_to_slack
+
+        send = f"```{slim}```"
+        run(send_to_slack(slack_url, send))
+
+
+##
+
+
 class RichTracebackFormatter(Formatter):
     """Formatter for rich tracebacks."""
 
@@ -811,6 +947,9 @@ def _merge_frames(
     return values[::-1]
 
 
+##
+
+
 def _yield_header_lines(
     *,
     start: MaybeCallableDateTime | None = _START,
@@ -838,12 +977,108 @@ def _yield_header_lines(
     yield ""
 
 
+##
+
+
+def _yield_formatted_frame_summary(
+    error: BaseException,
+    /,
+    *,
+    capture_locals: bool = False,
+    max_width: int = RICH_MAX_WIDTH,
+    indent_size: int = RICH_INDENT_SIZE,
+    max_length: int | None = RICH_MAX_LENGTH,
+    max_string: int | None = RICH_MAX_STRING,
+    max_depth: int | None = RICH_MAX_DEPTH,
+    expand_all: bool = RICH_EXPAND_ALL,
+) -> Iterator[str]:
+    """Yield the formatted frame summary lines."""
+    stack = TracebackException.from_exception(
+        error, capture_locals=capture_locals
+    ).stack
+    n = len(stack)
+    for i, frame in enumerate(stack, start=1):
+        num = f"{i}/{n}"
+        first, *rest = _yield_frame_summary_lines(
+            frame,
+            max_width=max_width,
+            indent_size=indent_size,
+            max_length=max_length,
+            max_string=max_string,
+            max_depth=max_depth,
+            expand_all=expand_all,
+        )
+        yield f"{num} | {first}"
+        blank = "".join(repeat(" ", len(num)))
+        for rest_i in rest:
+            yield f"{blank} | {rest_i}"
+    yield repr_error(error)
+
+
+def _yield_frame_summary_lines(
+    frame: FrameSummary,
+    /,
+    *,
+    max_width: int = RICH_MAX_WIDTH,
+    indent_size: int = RICH_INDENT_SIZE,
+    max_length: int | None = RICH_MAX_LENGTH,
+    max_string: int | None = RICH_MAX_STRING,
+    max_depth: int | None = RICH_MAX_DEPTH,
+    expand_all: bool = RICH_EXPAND_ALL,
+) -> Iterator[str]:
+    module = _path_to_dots(frame.filename)
+    yield f"{module}:{frame.lineno} | {frame.name} | {frame.line}"
+    if frame.locals is not None:
+        yield from yield_mapping_repr(
+            frame.locals,
+            _max_width=max_width,
+            _indent_size=indent_size,
+            _max_length=max_length,
+            _max_string=max_string,
+            _max_depth=max_depth,
+            _expand_all=expand_all,
+        )
+
+
+def _path_to_dots(path: PathLike, /) -> str:
+    new_path: Path | None = None
+    for pattern in [
+        "site-packages",
+        ".venv",  # after site-packages
+        "src",
+        r"python\d+\.\d+",
+    ]:
+        if (new_path := _trim_path(path, pattern)) is not None:
+            break
+    path_use = Path(path) if new_path is None else new_path
+    return ".".join(path_use.with_suffix("").parts)
+
+
+def _trim_path(path: PathLike, pattern: str, /) -> Path | None:
+    parts = Path(path).parts
+    compiled = re.compile(f"^{pattern}$")
+    try:
+        i = one(i for i, p in enumerate(parts) if compiled.search(p))
+    except OneEmptyError:
+        return None
+    return Path(*parts[i + 1 :])
+
+
+@dataclass(kw_only=True, slots=True)
+class MakeExceptHookError(Exception):
+    @override
+    def __str__(self) -> str:
+        return "No exception to log"
+
+
 __all__ = [
     "ExcChainTB",
     "ExcGroupTB",
     "ExcTB",
     "RichTracebackFormatter",
+    "format_exception_stack",
     "get_rich_traceback",
+    "make_except_hook",
     "trace",
     "yield_exceptions",
     "yield_extended_frame_summaries",