dycw-utilities 0.125.20__tar.gz → 0.125.22__tar.gz

{dycw_utilities-0.125.20 → dycw_utilities-0.125.22}/PKG-INFO

@@ -1,12 +1,12 @@
 Metadata-Version: 2.4
 Name: dycw-utilities
-Version: 0.125.20
+Version: 0.125.22
 Author-email: Derek Wan <d.wan@icloud.com>
 License-File: LICENSE
 Requires-Python: >=3.12
 Requires-Dist: typing-extensions<4.14,>=4.13.1
 Provides-Extra: test
-Requires-Dist: hypothesis<6.132,>=6.131.30; extra == 'test'
+Requires-Dist: hypothesis<6.132,>=6.131.32; extra == 'test'
 Requires-Dist: pytest-asyncio<1.1,>=1.0.0; extra == 'test'
 Requires-Dist: pytest-cov<6.2,>=6.1.1; extra == 'test'
 Requires-Dist: pytest-instafail<0.6,>=0.5.0; extra == 'test'
@@ -78,7 +78,7 @@ Provides-Extra: zzz-test-hypothesis
 Requires-Dist: aiosqlite<0.22,>=0.21.0; extra == 'zzz-test-hypothesis'
 Requires-Dist: asyncpg<0.31,>=0.30.0; extra == 'zzz-test-hypothesis'
 Requires-Dist: greenlet<3.3,>=3.2.0; extra == 'zzz-test-hypothesis'
-Requires-Dist: hypothesis<6.132,>=6.131.30; extra == 'zzz-test-hypothesis'
+Requires-Dist: hypothesis<6.132,>=6.131.32; extra == 'zzz-test-hypothesis'
 Requires-Dist: luigi<3.7,>=3.6.0; extra == 'zzz-test-hypothesis'
 Requires-Dist: numpy<2.3,>=2.2.6; extra == 'zzz-test-hypothesis'
 Requires-Dist: pathvalidate<3.3,>=3.2.3; extra == 'zzz-test-hypothesis'

{dycw_utilities-0.125.20 → dycw_utilities-0.125.22}/pyproject.toml

@@ -25,7 +25,7 @@ dev = [
   "fpdf2 >= 2.8.3, < 2.9",
   "greenlet >= 3.2.0, < 3.3",  # for sqlalchemy async
   "httpx >= 0.28.1, < 0.29",  # for fastapi
-  "hypothesis >= 6.131.30, < 6.132",
+  "hypothesis >= 6.131.32, < 6.132",
   "img2pdf >= 0.6.0, < 0.7",
   "lightweight-charts >= 2.1, < 2.2",
   "loguru >= 0.7.3, < 0.8",
@@ -43,6 +43,7 @@ dev = [
   "polars-ols >= 0.3.5, < 0.4",
   "pqdm >= 0.2.0, < 0.3",
   "psycopg2-binary >= 2.9.10, < 2.10",  # for sqlalchemy
+  "psutil >= 7.0.0, < 7.1",
   "pydantic >= 2.11.4, < 2.12",
   "pyinstrument >= 5.0.2, < 5.1",
   "pyright[nodejs] >= 1.1.401, < 1.2",
@@ -93,11 +94,11 @@ dependencies = [
 name = "dycw-utilities"
 readme = "README.md"
 requires-python = ">= 3.12"
-version = "0.125.20"
+version = "0.125.22"
 
 [project.optional-dependencies]
 test = [
-  "hypothesis >= 6.131.30, < 6.132",
+  "hypothesis >= 6.131.32, < 6.132",
   "pytest >= 8.3.5, < 8.4",
   "pytest-asyncio >= 1.0.0, < 1.1",
   "pytest-cov >= 6.1.1, < 6.2",
@@ -174,7 +175,7 @@ zzz-test-hypothesis = [
   "aiosqlite >= 0.21.0, < 0.22",
   "asyncpg >= 0.30.0, < 0.31",  # for sqlalchemy async
   "greenlet >= 3.2.0, < 3.3",  # for sqlalchemy async
-  "hypothesis >= 6.131.30, < 6.132",
+  "hypothesis >= 6.131.32, < 6.132",
   "luigi >= 3.6.0, < 3.7",
   "numpy >= 2.2.6, < 2.3",
   "pathvalidate >= 3.2.3, < 3.3",
@@ -334,7 +335,7 @@ zzz-test-zoneinfo = [
 # bump-my-version
 [tool.bumpversion]
 allow_dirty = true
-current_version = "0.125.20"
+current_version = "0.125.22"
 
 [[tool.bumpversion.files]]
 filename = "src/utilities/__init__.py"

dycw_utilities-0.125.22/src/tests/test_contextlib.py

@@ -0,0 +1,75 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+from typing import override
+
+from pytest import raises
+
+from utilities.contextlib import (
+    NoOpContextManager,
+    suppress_super_object_attribute_error,
+)
+
+
+class TestNoOpContextManager:
+    def test_main(self) -> None:
+        with NoOpContextManager():
+            pass
+
+    def test_error(self) -> None:
+        with raises(RuntimeError), NoOpContextManager():
+            raise RuntimeError
+
+
+class TestSuppressSuperObjectAttributeError:
+    def test_main(self) -> None:
+        inits: list[str] = []
+
+        @dataclass(kw_only=True)
+        class A:
+            def __post_init__(self) -> None:
+                with suppress_super_object_attribute_error():
+                    super().__post_init__()  # pyright:ignore [reportAttributeAccessIssue]
+                nonlocal inits
+                inits.append("A")
+
+        @dataclass(kw_only=True)
+        class B: ...
+
+        @dataclass(kw_only=True)
+        class C:
+            def __post_init__(self) -> None:
+                with suppress_super_object_attribute_error():
+                    super().__post_init__()  # pyright:ignore [reportAttributeAccessIssue]
+                nonlocal inits
+                inits.append("C")
+
+        @dataclass(kw_only=True)
+        class D: ...
+
+        @dataclass(kw_only=True)
+        class E(A, B, C, D):
+            @override
+            def __post_init__(self) -> None:
+                super().__post_init__()
+                nonlocal inits
+                inits.append("E")
+
+        _ = E()
+        assert inits == ["C", "A", "E"]
+
+    def test_error(self) -> None:
+        @dataclass(kw_only=True)
+        class Parent:
+            def __post_init__(self) -> None:
+                with suppress_super_object_attribute_error():
+                    _ = self.error  # pyright:ignore [reportAttributeAccessIssue]
+
+        @dataclass(kw_only=True)
+        class Child(Parent):
+            @override
+            def __post_init__(self) -> None:
+                super().__post_init__()
+
+        with raises(AttributeError, match="'Child' object has no attribute 'error'"):
+            _ = Child()

dycw_utilities-0.125.22/src/tests/test_psutil.py

@@ -0,0 +1,50 @@
+from __future__ import annotations
+
+from math import isfinite, isnan
+from typing import TYPE_CHECKING
+
+from pytest import approx, mark, param
+
+from utilities.datetime import MILLISECOND, SECOND
+from utilities.psutil import MemoryMonitorService, MemoryUsage
+
+if TYPE_CHECKING:
+    from pathlib import Path
+
+
+class TestMemoryUsage:
+    def test_main(self) -> None:
+        memory = MemoryUsage.new()
+        assert memory.virtual_total >= 0
+        assert memory.virtual_total_mb >= 0
+        assert memory.virtual_total >= 0
+        assert memory.virtual_total_mb >= 0
+        assert (
+            isfinite(memory.virtual_pct) and (0.0 <= memory.virtual_pct <= 1.0)
+        ) or isnan(memory.virtual_pct)
+        assert memory.swap_total >= 0
+        assert memory.swap_total_mb >= 0
+        assert memory.swap_total >= 0
+        assert memory.swap_total_mb >= 0
+        assert (isfinite(memory.swap_pct) and (0.0 <= memory.swap_pct <= 1.0)) or isnan(
+            memory.swap_pct
+        )
+
+
+class TestMemoryMonitorService:
+    @mark.parametrize("console", [param(True), param(False)])
+    async def test_main(self, *, console: bool, tmp_path: Path) -> None:
+        path = tmp_path.joinpath("memory.txt")
+        service = MemoryMonitorService(
+            freq=100 * MILLISECOND,
+            backoff=100 * MILLISECOND,
+            timeout=SECOND,
+            path=path,
+            console=str(tmp_path) if console else None,
+        )
+        async with service.with_auto_start:
+            ...
+        assert path.exists()
+        with path.open() as fh:
+            lines = fh.readlines()
+        assert len(lines) == approx(10, rel=0.5)

{dycw_utilities-0.125.20 → dycw_utilities-0.125.22}/src/utilities/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.125.20"
+__version__ = "0.125.22"

dycw_utilities-0.125.22/src/utilities/contextlib.py

@@ -0,0 +1,44 @@
+from __future__ import annotations
+
+import re
+from contextlib import contextmanager
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from collections.abc import Iterator
+    from types import TracebackType
+
+
+class NoOpContextManager:
+    """Context-manager for no-op."""
+
+    def __enter__(self) -> None:
+        return None
+
+    def __exit__(
+        self,
+        exc_type: type[BaseException] | None,
+        exc_val: BaseException | None,
+        traceback: TracebackType | None,
+    ) -> bool:
+        _ = (exc_type, exc_val, traceback)
+        return False
+
+
+##
+
+
+_SUPER_OBJECT_HAS_NO_ATTRIBUTE = re.compile(r"'super' object has no attribute '\w+'")
+
+
+@contextmanager
+def suppress_super_object_attribute_error() -> Iterator[None]:
+    """Suppress the super() attribute error, for mix-ins."""
+    try:
+        yield
+    except AttributeError as error:
+        if not _SUPER_OBJECT_HAS_NO_ATTRIBUTE.search(error.args[0]):
+            raise
+
+
+__all__ = ["NoOpContextManager", "suppress_super_object_attribute_error"]

{dycw_utilities-0.125.20 → dycw_utilities-0.125.22}/src/utilities/errors.py

@@ -15,6 +15,7 @@ class ImpossibleCaseError(Exception):
     def __str__(self) -> str:
         desc = ", ".join(self.case)
         return f"Case must be possible: {desc}."
+        ##
 
 
 ##

dycw_utilities-0.125.22/src/utilities/psutil.py

@@ -0,0 +1,115 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+from json import dumps
+from logging import getLogger
+from math import isclose, nan
+from pathlib import Path
+from typing import TYPE_CHECKING, Self, override
+
+from psutil import swap_memory, virtual_memory
+
+from utilities.asyncio import Looper
+from utilities.contextlib import suppress_super_object_attribute_error
+from utilities.datetime import SECOND, get_now
+
+if TYPE_CHECKING:
+    import datetime as dt
+    from logging import Logger
+
+    from utilities.types import Duration, PathLike
+
+
+@dataclass(kw_only=True)
+class MemoryMonitorService(Looper[None]):
+    """Service to monitor memory usage."""
+
+    # base
+    freq: Duration = field(default=10 * SECOND, repr=False)
+    backoff: Duration = field(default=10 * SECOND, repr=False)
+    # self
+    console: str | None = field(default=None, repr=False)
+    path: PathLike = "memory.txt"
+    _console: Logger | None = field(init=False, repr=False)
+    _max_age: int | None = field(default=None, init=False, repr=False)
+    _path: Path = field(init=False, repr=False)
+
+    @override
+    def __post_init__(self) -> None:
+        super().__post_init__()
+        if self.console is not None:
+            self._console = getLogger(self.console)
+        self._path = Path(self.path)
+
+    @override
+    async def core(self) -> None:
+        await super().core()
+        memory = MemoryUsage.new()
+        mapping = {
+            "datetime": memory.datetime.strftime("%Y-%m-%d %H:%M:%S"),
+            "virtual used (mb)": memory.virtual_used_mb,
+            "virtual total (mb)": memory.virtual_total_mb,
+            "virtual (%)": memory.virtual_pct,
+            "swap used (mb)": memory.swap_used_mb,
+            "swap total (mb)": memory.swap_total_mb,
+            "swap (%)": memory.swap_pct,
+        }
+        ser = dumps(mapping)
+        with self._path.open(mode="a") as fh:
+            _ = fh.write(f"{ser}\n")
+        if self._console is not None:
+            self._console.info("%s", mapping)
+
+
+##
+
+
+@dataclass(kw_only=True)
+class MemoryUsage:
+    """A memory usage."""
+
+    datetime: dt.datetime = field(default_factory=get_now)
+    virtual_used: int = field(repr=False)
+    virtual_used_mb: int = field(init=False)
+    virtual_total: int = field(repr=False)
+    virtual_total_mb: int = field(init=False)
+    virtual_pct: float = field(init=False)
+    swap_used: int = field(repr=False)
+    swap_used_mb: int = field(init=False)
+    swap_total: int = field(repr=False)
+    swap_total_mb: int = field(init=False)
+    swap_pct: float = field(init=False)
+
+    def __post_init__(self) -> None:
+        with suppress_super_object_attribute_error():
+            super().__post_init__()  # pyright: ignore[reportAttributeAccessIssue]
+        self.virtual_used_mb = self._to_mb(self.virtual_used)
+        self.virtual_total_mb = self._to_mb(self.virtual_total)
+        self.virtual_pct = (
+            nan
+            if isclose(self.virtual_total, 0.0)
+            else self.virtual_used / self.virtual_total
+        )
+        self.swap_used_mb = self._to_mb(self.swap_used)
+        self.swap_total_mb = self._to_mb(self.swap_total)
+        self.swap_pct = (
+            nan if isclose(self.swap_total, 0.0) else self.swap_used / self.swap_total
+        )
+
+    @classmethod
+    def new(cls) -> Self:
+        virtual = virtual_memory()
+        virtual_total = virtual.total
+        swap = swap_memory()
+        return cls(
+            virtual_used=virtual_total - virtual.available,
+            virtual_total=virtual_total,
+            swap_used=swap.used,
+            swap_total=swap.total,
+        )
+
+    def _to_mb(self, bytes_: int) -> int:
+        return round(bytes_ / (1024**2))
+
+
+__all__ = ["MemoryMonitorService", "MemoryUsage"]

dycw_utilities-0.125.20/src/tests/test_contextlib.py

@@ -1,15 +0,0 @@
-from __future__ import annotations
-
-from pytest import raises
-
-from utilities.contextlib import NoOpContextManager
-
-
-class TestNoOpContextManager:
-    def test_main(self) -> None:
-        with NoOpContextManager():
-            pass
-
-    def test_error(self) -> None:
-        with raises(RuntimeError), NoOpContextManager():
-            raise RuntimeError

dycw_utilities-0.125.20/src/utilities/contextlib.py

@@ -1,23 +0,0 @@
-from __future__ import annotations
-
-from typing import TYPE_CHECKING
-
-if TYPE_CHECKING:
-    from types import TracebackType
-
-
-class NoOpContextManager:
-    def __enter__(self) -> None:
-        return None
-
-    def __exit__(
-        self,
-        exc_type: type[BaseException] | None,
-        exc_val: BaseException | None,
-        traceback: TracebackType | None,
-    ) -> bool:
-        _ = (exc_type, exc_val, traceback)
-        return False
-
-
-__all__ = ["NoOpContextManager"]