pyutilkit 0.2.0__tar.gz → 0.4.0__tar.gz

{pyutilkit-0.2.0 → pyutilkit-0.4.0}/PKG-INFO

@@ -1,18 +1,17 @@
 Metadata-Version: 2.1
 Name: pyutilkit
-Version: 0.2.0
+Version: 0.4.0
 Summary: python's missing batteries
 Home-page: https://pyutilkit.readthedocs.io/en/stable/
 License: LGPL-3.0+
 Keywords: utils
 Author: Stephanos Kuma
 Author-email: stephanos@kuma.ai
-Requires-Python: >=3.8,<4.0
+Requires-Python: >=3.9,<4.0
 Classifier: Development Status :: 4 - Beta
 Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
@@ -31,7 +30,11 @@ Description-Content-Type: text/markdown
 [![build automation: yam][yam_badge]][yam_url]
 [![Lint: ruff][ruff_badge]][ruff_url]
 
-Long project description and tldr goes here
+The Python has long maintained the philosophy of "batteries included", giving the user
+a rich standard library, avoiding the need for third party tools for most work. Some packages
+are so common, that the have a similar status to the standard library. Still, some code seems
+to be written time and again, with every project. This small library, with minimal requirements,
+hopes to stop this repetition.
 
 ## Links
 

{pyutilkit-0.2.0 → pyutilkit-0.4.0}/docs/README.md

@@ -8,7 +8,11 @@
 [![build automation: yam][yam_badge]][yam_url]
 [![Lint: ruff][ruff_badge]][ruff_url]
 
-Long project description and tldr goes here
+The Python has long maintained the philosophy of "batteries included", giving the user
+a rich standard library, avoiding the need for third party tools for most work. Some packages
+are so common, that the have a similar status to the standard library. Still, some code seems
+to be written time and again, with every project. This small library, with minimal requirements,
+hopes to stop this repetition.
 
 ## Links
 

{pyutilkit-0.2.0 → pyutilkit-0.4.0}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.black]
 target-version = [
-    "py38",
+    "py39",
 ]
 
 [tool.mypy]
@@ -32,7 +32,7 @@ warn_unused_configs = true
 src = [
     "src",
 ]
-target-version = "py38"
+target-version = "py39"
 
 [tool.ruff.lint]
 select = [
@@ -126,7 +126,7 @@ skip_empty = true
 
 [tool.poetry]
 name = "pyutilkit"
-version = "0.2.0"
+version = "0.4.0"
 description = "python's missing batteries"
 authors = [
     "Stephanos Kuma <stephanos@kuma.ai>",
@@ -149,7 +149,7 @@ classifiers = [
 
 [tool.poetry.dependencies]
 # python version
-python = "^3.8"
+python = "^3.9"
 
 [tool.poetry.group.dev.dependencies]
 ipdb = { version = "^0.13", python = "^3.10" }

{pyutilkit-0.2.0 → pyutilkit-0.4.0}/src/pyutilkit/date_utils.py

@@ -1,7 +1,6 @@
 from __future__ import annotations
 
 from datetime import datetime, tzinfo
-
 from zoneinfo import ZoneInfo, available_timezones
 
 from pyutilkit.data.timezones import UNAVAILABLE_TIMEZONES

pyutilkit-0.4.0/src/pyutilkit/timing.py

@@ -0,0 +1,123 @@
+from __future__ import annotations  # py3.9: remove this line
+
+from dataclasses import dataclass
+from time import perf_counter_ns
+from types import TracebackType
+from typing import TYPE_CHECKING, Any
+
+if TYPE_CHECKING:
+    from typing_extensions import Self  # py3.10: import Self from typing
+
+
+@dataclass(frozen=True, order=True)
+class Timing:
+    __slots__ = ("nanoseconds",)  # py3.9: remove this line
+
+    nanoseconds: int
+
+    def __init__(
+        self,
+        *,
+        days: int = 0,
+        seconds: int = 0,
+        milliseconds: int = 0,
+        microseconds: int = 0,
+        nanoseconds: int = 0,
+    ) -> None:
+        total_nanoseconds = (
+            nanoseconds
+            + 1000 * microseconds
+            + 1_000_000 * milliseconds
+            + 1_000_000_000 * seconds
+            + 86_400_000_000_000 * days
+        )
+        object.__setattr__(self, "nanoseconds", total_nanoseconds)
+
+    def __str__(self) -> str:
+        if self.nanoseconds < 1000:
+            return f"{self.nanoseconds}ns"
+        microseconds = self.nanoseconds / 1000
+        if microseconds < 1000:
+            return f"{microseconds:.1f}µs"
+        milliseconds = microseconds / 1000
+        if milliseconds < 1000:
+            return f"{milliseconds:.1f}ms"
+        seconds = milliseconds / 1000
+        if seconds < 60:
+            return f"{seconds:.2f}s"
+        round_seconds = int(seconds)
+        minutes, seconds = divmod(round_seconds, 60)
+        hours, minutes = divmod(minutes, 60)
+        if hours < 24:
+            return f"{hours:02d}:{minutes:02d}:{seconds:02d}"
+        days, hours = divmod(hours, 24)
+        return f"{days:,}d {hours:02d}:{minutes:02d}:{seconds:02d}"
+
+    def __bool__(self) -> bool:
+        return bool(self.nanoseconds)
+
+    def __add__(self, other: Any) -> Timing:
+        if not isinstance(other, Timing):
+            return NotImplemented
+        return Timing(nanoseconds=self.nanoseconds + other.nanoseconds)
+
+    def __radd__(self, other: Any) -> Timing:
+        if not isinstance(other, Timing):
+            return NotImplemented
+        return Timing(nanoseconds=self.nanoseconds + other.nanoseconds)
+
+    def __mul__(self, other: Any) -> Timing:
+        if not isinstance(other, int):
+            return NotImplemented
+        return Timing(nanoseconds=self.nanoseconds * other)
+
+    def __rmul__(self, other: Any) -> Timing:
+        if not isinstance(other, int):
+            return NotImplemented
+        return Timing(nanoseconds=self.nanoseconds * other)
+
+    def __floordiv__(self, other: Any) -> Timing:
+        if not isinstance(other, int):
+            return NotImplemented
+        return Timing(nanoseconds=self.nanoseconds // other)
+
+    def __truediv__(self, other: Any) -> Timing:
+        if not isinstance(other, int):
+            return NotImplemented
+        return Timing(nanoseconds=self.nanoseconds // other)
+
+
+class Stopwatch:
+    _start: int
+    laps: list[Timing]
+
+    def __init__(self) -> None:
+        self._start = 0
+        self.laps: list[Timing] = []
+
+    def __enter__(self) -> Self:
+        self._start = perf_counter_ns()
+        return self
+
+    def __exit__(
+        self,
+        exc_type: type[Exception] | None,
+        exc_value: Exception | None,
+        traceback: TracebackType | None,
+    ) -> None:
+        _end = perf_counter_ns()
+        self.laps.append(Timing(nanoseconds=_end - self._start))
+
+    def __bool__(self) -> bool:
+        return bool(self.elapsed)
+
+    @property
+    def elapsed(self) -> Timing:
+        return sum(self.laps, Timing())
+
+    @property
+    def average(self) -> Timing:
+        if not self.laps:
+            msg = "No laps recorded"
+            raise ZeroDivisionError(msg)
+        return self.elapsed // len(self.laps)

pyutilkit-0.2.0/src/pyutilkit/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.2.0"

pyutilkit-0.2.0/src/pyutilkit/timing.py

@@ -1,38 +0,0 @@
-from dataclasses import dataclass
-
-
-@dataclass(frozen=True, order=True)
-class Timing:
-    __slots__ = ("nanoseconds",)  # py3.9: remove this line
-
-    nanoseconds: int
-
-    def __init__(
-        self,
-        *,
-        days: int = 0,
-        seconds: int = 0,
-        milliseconds: int = 0,
-        microseconds: int = 0,
-        nanoseconds: int = 0,
-    ) -> None:
-        total_nanoseconds = (
-            nanoseconds
-            + 1000 * microseconds
-            + 1_000_000 * milliseconds
-            + 1_000_000_000 * seconds
-            + 86_400_000_000_000 * days
-        )
-        object.__setattr__(self, "nanoseconds", total_nanoseconds)
-
-    def __str__(self) -> str:
-        if self.nanoseconds < 1000:
-            return f"{self.nanoseconds}ns"
-        microseconds = self.nanoseconds / 1000
-        if microseconds < 1000:
-            return f"{microseconds:.1f}µs"
-        milliseconds = microseconds / 1000
-        if milliseconds < 1000:
-            return f"{milliseconds:.1f}ms"
-        seconds = milliseconds / 1000
-        return f"{seconds:,.2f}s"