pyutilkit 0.5.0__tar.gz → 0.7.0__tar.gz

LICENSE.md

@@ -0,0 +1,11 @@
+# BSD 3-Clause License
+
+Copyright © 2024 Stephanos Kuma.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pyutilkit
-Version: 0.5.0
+Version: 0.7.0
 Summary: python's missing batteries
 Home-page: https://pyutilkit.readthedocs.io/en/stable/
 License: BSD-3-Clause
@@ -9,8 +9,10 @@ Author: Stephanos Kuma
 Author-email: "Stephanos Kuma" <stephanos@kuma.ai>
 Requires-Python: >=3.9
 Classifier: Development Status :: 4 - Beta
+Classifier: License :: OSI Approved :: BSD License
 Classifier: Operating System :: OS Independent
-Requires-Dist: pyutilkit (~=0.4)
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Dist: tzdata ; os_name == 'nt'
 Project-URL: Documentation, https://pyutilkit.readthedocs.io/en/stable/
 Project-URL: Repository, https://github.com/spapanik/pyutilkit
 Description-Content-Type: text/markdown
@@ -36,6 +38,10 @@ hopes to stop this repetition.
 -   [Documentation]
 -   [Changelog]
 
+[build_badge]: https://github.com/spapanik/pyutilkit/actions/workflows/build.yml/badge.svg
+[build_url]: https://github.com/spapanik/pyutilkit/actions/workflows/build.yml
+[lint_badge]: https://github.com/spapanik/pyutilkit/actions/workflows/lint.yml/badge.svg
+[lint_url]: https://github.com/spapanik/pyutilkit/actions/workflows/lint.yml
 [test_badge]: https://github.com/spapanik/pyutilkit/actions/workflows/tests.yml/badge.svg
 [test_url]: https://github.com/spapanik/pyutilkit/actions/workflows/tests.yml
 [licence_badge]: https://img.shields.io/pypi/l/pyutilkit

docs/README.md

@@ -19,6 +19,10 @@ hopes to stop this repetition.
 -   [Documentation]
 -   [Changelog]
 
+[build_badge]: https://github.com/spapanik/pyutilkit/actions/workflows/build.yml/badge.svg
+[build_url]: https://github.com/spapanik/pyutilkit/actions/workflows/build.yml
+[lint_badge]: https://github.com/spapanik/pyutilkit/actions/workflows/lint.yml/badge.svg
+[lint_url]: https://github.com/spapanik/pyutilkit/actions/workflows/lint.yml
 [test_badge]: https://github.com/spapanik/pyutilkit/actions/workflows/tests.yml/badge.svg
 [test_url]: https://github.com/spapanik/pyutilkit/actions/workflows/tests.yml
 [licence_badge]: https://img.shields.io/pypi/l/pyutilkit

pyproject.toml

@@ -1,12 +1,12 @@
 [build-system]
 requires = [
-    "phosphorus>=0.4",
+    "phosphorus>=0.8",
 ]
 build-backend = "phosphorus.construction.api"
 
 [project]
 name = "pyutilkit"
-version = "0.5.0"
+version = "0.7.0"
 
 authors = [
     { name = "Stephanos Kuma", email = "stephanos@kuma.ai" },
@@ -21,11 +21,13 @@ keywords = [
 classifiers = [
     "Development Status :: 4 - Beta",
     "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3 :: Only",
+    "License :: OSI Approved :: BSD License",
 ]
 
 requires-python = ">=3.9"
 dependencies = [
-    "pyutilkit~=0.4",
+    "tzdata; os_name == 'nt'",
 ]
 
 [project.urls]
@@ -35,26 +37,25 @@ documentation = "https://pyutilkit.readthedocs.io/en/stable/"
 
 [tool.phosphorus.dev-dependencies]
 dev = [
-    "ipdb~=0.13; python_version>='3.10'",
-    "ipython~=8.21; python_version>='3.10'",
+    "ipdb~=0.13",
+    "ipython~=8.18",
 ]
 lint = [
-    "black~=24.1",
-    "mypy~=1.8",
-    "ruff~=0.5",
-    "typing_extensions~=4.11",
+    "black~=24.10",
+    "mypy~=1.13",
+    "ruff~=0.7",
 ]
 test = [
     "freezegun~=1.5",
-    "pytest~=8.0",
-    "pytest-cov~=5.0",
+    "pytest~=8.3",
+    "pytest-cov~=6.0",
 ]
 docs = [
     "mkdocs~=1.6",
     "mkdocs-material~=9.5",
     "mkdocs-material-extensions~=1.3",
-    "Pygments~=2.17",
-    "pymdown-extensions~=10.8",
+    "pygments~=2.18",
+    "pymdown-extensions~=10.12",
 ]
 
 [tool.black]
@@ -118,11 +119,10 @@ select = [
     "PGH",
     "PERF",
     "PIE",
-    "PLC",
-    "PLE",
-    "PLW",
+    "PL",
     "PT",
     "PTH",
+    "PYI",
     "Q",
     "RET",
     "RSE",
@@ -147,6 +147,7 @@ ignore = [
     "COM812",
     "E501",
     "FIX002",
+    "PLR09",
     "TD002",
     "TD003",
     "TRY003",
@@ -155,6 +156,7 @@ ignore = [
 [tool.ruff.lint.per-file-ignores]
 "tests/**" = [
     "FBT001",
+    "PLR2004",
     "PT011",
     "S101",
 ]
@@ -174,16 +176,20 @@ forced-separate = [
 split-on-trailing-comma = false
 
 [tool.pytest.ini_options]
-addopts = "-vv"
+addopts = "-ra -v --cov"
 testpaths = "tests"
 
 [tool.coverage.run]
+branch = true
 source = [
     "src/",
 ]
 data_file = ".cov_cache/coverage.dat"
 
 [tool.coverage.report]
+exclude_also = [
+    "if TYPE_CHECKING:",
+]
 show_missing = true
 skip_covered = true
 skip_empty = true

src/pyutilkit/term.py

@@ -83,7 +83,7 @@ class SGRString(str):
         raise AttributeError(msg)
 
     def __str__(self) -> str:
-        if not self._sgr:
+        if not self._sgr or os.getenv("USE_SGR_CODES") in {"0", "false", "no"}:
             return self._string
         prefix = "".join(code.sequence for code in self._sgr)
         return f"{prefix}{self._string}{SGRCodes.RESET.sequence}"
@@ -106,7 +106,13 @@ class SGRString(str):
         right_spaces: int = 1,
         space: str = " ",
     ) -> None:
-        columns = os.get_terminal_size().columns
+        try:
+            # in pseudo-terminals it throws OSError
+            terminal_size = os.get_terminal_size()
+        except OSError:
+            columns = 80
+        else:
+            columns = terminal_size.columns
         text = f"{space * left_spaces}{self}{space * right_spaces}"
         title_length = left_spaces + len(self) + right_spaces
         if title_length >= columns:

src/pyutilkit/timing.py

@@ -9,6 +9,12 @@ if TYPE_CHECKING:
 
     from typing_extensions import Self  # py3.10: import Self from typing
 
+METRIC_MULTIPLIER = 1000
+SECONDS_PER_MINUTE = 60
+MINUTES_PER_HOUR = 60
+HOURS_PER_DAY = 24
+SECONDS_PER_DAY = SECONDS_PER_MINUTE * MINUTES_PER_HOUR * HOURS_PER_DAY
+
 
 @dataclass(frozen=True, order=True)
 class Timing:
@@ -27,31 +33,31 @@ class Timing:
     ) -> None:
         total_nanoseconds = (
             nanoseconds
-            + 1000 * microseconds
-            + 1_000_000 * milliseconds
-            + 1_000_000_000 * seconds
-            + 86_400_000_000_000 * days
+            + METRIC_MULTIPLIER * microseconds
+            + METRIC_MULTIPLIER**2 * milliseconds
+            + METRIC_MULTIPLIER**3 * seconds
+            + SECONDS_PER_DAY * METRIC_MULTIPLIER**3 * days
         )
         object.__setattr__(self, "nanoseconds", total_nanoseconds)
 
     def __str__(self) -> str:
-        if self.nanoseconds < 1000:
+        if self.nanoseconds < METRIC_MULTIPLIER:
             return f"{self.nanoseconds}ns"
-        microseconds = self.nanoseconds / 1000
-        if microseconds < 1000:
+        microseconds = self.nanoseconds / METRIC_MULTIPLIER
+        if microseconds < METRIC_MULTIPLIER:
             return f"{microseconds:.1f}µs"
-        milliseconds = microseconds / 1000
-        if milliseconds < 1000:
+        milliseconds = microseconds / METRIC_MULTIPLIER
+        if milliseconds < METRIC_MULTIPLIER:
             return f"{milliseconds:.1f}ms"
-        seconds = milliseconds / 1000
-        if seconds < 60:
+        seconds = milliseconds / METRIC_MULTIPLIER
+        if seconds < SECONDS_PER_MINUTE:
             return f"{seconds:.2f}s"
         round_seconds = int(seconds)
-        minutes, seconds = divmod(round_seconds, 60)
-        hours, minutes = divmod(minutes, 60)
-        if hours < 24:
+        minutes, seconds = divmod(round_seconds, SECONDS_PER_MINUTE)
+        hours, minutes = divmod(minutes, MINUTES_PER_HOUR)
+        if hours < HOURS_PER_DAY:
             return f"{hours:02d}:{minutes:02d}:{seconds:02d}"
-        days, hours = divmod(hours, 24)
+        days, hours = divmod(hours, HOURS_PER_DAY)
         return f"{days:,}d {hours:02d}:{minutes:02d}:{seconds:02d}"
 
     def __bool__(self) -> bool:
@@ -102,8 +108,8 @@ class Stopwatch:
 
     def __exit__(
         self,
-        exc_type: type[Exception] | None,
-        exc_value: Exception | None,
+        exc_type: type[BaseException] | None,
+        exc_value: BaseException | None,
         traceback: TracebackType | None,
     ) -> None:
         _end = perf_counter_ns()