dycw-utilities 0.125.21__tar.gz → 0.125.23__tar.gz

{dycw_utilities-0.125.21 → dycw_utilities-0.125.23}/PKG-INFO

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

{dycw_utilities-0.125.21 → dycw_utilities-0.125.23}/pyproject.toml

@@ -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,7 +94,7 @@ dependencies = [
 name = "dycw-utilities"
 readme = "README.md"
 requires-python = ">= 3.12"
-version = "0.125.21"
+version = "0.125.23"
 
 [project.optional-dependencies]
 test = [
@@ -334,7 +335,7 @@ zzz-test-zoneinfo = [
 # bump-my-version
 [tool.bumpversion]
 allow_dirty = true
-current_version = "0.125.21"
+current_version = "0.125.23"
 
 [[tool.bumpversion.files]]
 filename = "src/utilities/__init__.py"

dycw_utilities-0.125.23/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.21 → dycw_utilities-0.125.23}/src/utilities/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.125.21"
+__version__ = "0.125.23"

{dycw_utilities-0.125.21 → dycw_utilities-0.125.23}/src/utilities/asyncio.py

@@ -895,6 +895,8 @@ class Looper(Generic[_T]):
         backoff: Duration | Sentinel = sentinel,
         logger: str | None | Sentinel = sentinel,
         timeout: Duration | None | Sentinel = sentinel,
+        timeout_error: type[Exception] | Sentinel = sentinel,
+        _debug: bool | Sentinel = sentinel,
     ) -> Self:
         """Replace elements of the looper."""
         return replace_non_sentinel(
@@ -904,6 +906,8 @@ class Looper(Generic[_T]):
             backoff=backoff,
             logger=logger,
             timeout=timeout,
+            timeout_error=timeout_error,
+            _debug=_debug,
         )
 
     def request_restart(self) -> None:

dycw_utilities-0.125.23/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"]