pyutilkit 0.8.0__tar.gz → 0.9.0__tar.gz

{pyutilkit-0.8.0 → pyutilkit-0.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pyutilkit
-Version: 0.8.0
+Version: 0.9.0
 Summary: python's missing batteries
 Home-page: https://pyutilkit.readthedocs.io/en/stable/
 License: BSD-3-Clause

{pyutilkit-0.8.0 → pyutilkit-0.9.0}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "phosphorus.construction.api"
 
 [project]
 name = "pyutilkit"
-version = "0.8.0"
+version = "0.9.0"
 
 authors = [
     { name = "Stephanos Kuma", email = "stephanos@kuma.ai" },
@@ -67,7 +67,7 @@ target-version = [
 check_untyped_defs = true
 disallow_any_decorated = true
 disallow_any_explicit = true
-disallow_any_expr = true
+disallow_any_expr = false          # many builtins are Any
 disallow_any_generics = true
 disallow_any_unimported = true
 disallow_incomplete_defs = true
@@ -102,6 +102,7 @@ select = [
     "ALL",
 ]
 ignore = [
+    "C901",   # Adding a limit to complexity is too arbitrary
     "COM812", # Avoid magic trailing commas
     "D10",    # Not everything needs a docstring
     "D203",   # Prefer `no-blank-line-before-class` (D211)
@@ -146,7 +147,7 @@ data_file = ".cov_cache/coverage.dat"
 exclude_also = [
     "if TYPE_CHECKING:",
 ]
-fail_under = 75
+fail_under = 90
 precision = 2
 show_missing = true
 skip_covered = true

{pyutilkit-0.8.0 → pyutilkit-0.9.0}/src/pyutilkit/subprocess.py

@@ -34,12 +34,12 @@ def run_command(
         )
 
         for line in process.stdout or []:
-            sys.stdout.buffer.write(line)  # type: ignore[misc]
+            sys.stdout.buffer.write(line)
             sys.stdout.flush()
             stdout.append(line)
 
         for line in process.stderr or []:
-            sys.stderr.buffer.write(line)  # type: ignore[misc]
+            sys.stderr.buffer.write(line)
             sys.stderr.flush()
             stderr.append(line)
 
@@ -50,6 +50,6 @@ def run_command(
         stdout=b"".join(stdout),
         stderr=b"".join(stderr),
         pid=process.pid,
-        returncode=process.returncode,  # type: ignore[misc]
+        returncode=process.returncode,
         elapsed=stopwatch.elapsed,
     )

{pyutilkit-0.8.0 → pyutilkit-0.9.0}/src/pyutilkit/term.py

@@ -2,6 +2,7 @@ from __future__ import annotations
 
 import os
 import sys
+from dataclasses import dataclass
 from enum import IntEnum, unique
 from math import ceil, floor
 from typing import TYPE_CHECKING
@@ -66,36 +67,50 @@ class SGRCodes(IntEnum):
         return f"\033[{self.value}m"
 
 
-class SGRString(str):
-    _sgr: tuple[SGRCodes, ...]
+@dataclass(frozen=True, order=True)
+class SGRString:
+    __slots__ = (  # py3.9: remove this line
+        "_force_prefix",
+        "_force_sgr",
+        "_is_error",
+        "_prefix",
+        "_sgr",
+        "_string",
+        "_suffix",
+    )
+
     _string: str
+    _sgr: tuple[SGRCodes, ...]
     _prefix: str
     _suffix: str
-    __slots__ = ("_prefix", "_sgr", "_string", "_suffix")
+    _force_prefix: bool
+    _force_sgr: bool
+    _is_error: bool
 
-    def __new__(
-        cls,
+    def __init__(
+        self,
         obj: object,
         *,
         prefix: str = "",
         suffix: str = "",
         params: Iterable[SGRCodes] = (),
-    ) -> Self:
-        string = super().__new__(cls, obj)
+        force_prefix: bool = False,
+        force_sgr: bool = False,
+        is_error: bool = False,
+    ) -> None:
         params = tuple(params)
-        object.__setattr__(string, "_prefix", prefix)
-        object.__setattr__(string, "_string", str(obj))
-        object.__setattr__(string, "_sgr", params)
-        object.__setattr__(string, "_suffix", suffix)
-        return string
-
-    def __setattr__(self, name: str, value: object) -> None:
-        msg = "SGRString is immutable"
-        raise AttributeError(msg)
+        force_prefix = (
+            force_prefix or os.getenv("PY_UTIL_FORCE_PREFIX", "").lower() in TRUE_VAR
+        )
+        force_sgr = force_sgr or os.getenv("PY_UTIL_FORCE_SGR", "").lower() in TRUE_VAR
 
-    def __delattr__(self, name: str) -> None:
-        msg = "SGRString is immutable"
-        raise AttributeError(msg)
+        object.__setattr__(self, "_prefix", prefix)
+        object.__setattr__(self, "_string", str(obj))
+        object.__setattr__(self, "_sgr", params)
+        object.__setattr__(self, "_suffix", suffix)
+        object.__setattr__(self, "_force_prefix", force_prefix)
+        object.__setattr__(self, "_force_sgr", force_sgr)
+        object.__setattr__(self, "_is_error", is_error)
 
     def __str__(self) -> str:
         sgr_prefix = "".join(code.sequence for code in self._sgr)
@@ -113,6 +128,9 @@ class SGRString(str):
             prefix=self._prefix,
             suffix=self._suffix,
             params=self._sgr,
+            force_prefix=self._force_prefix,
+            force_sgr=self._force_sgr,
+            is_error=self._is_error,
         )
 
     def __rmul__(self, other: object) -> Self:
@@ -123,16 +141,12 @@ class SGRString(str):
             prefix=self._prefix,
             suffix=self._suffix,
             params=self._sgr,
+            force_prefix=self._force_prefix,
+            force_sgr=self._force_sgr,
+            is_error=self._is_error,
         )
 
-    def print(
-        self,
-        end: str = "\n",
-        *,
-        force_prefix: bool = False,
-        force_sgr: bool = False,
-        is_error: bool = False,
-    ) -> None:
+    def print(self, end: str = "\n", *, full_color: bool = False) -> None:
         """Print the command output.
 
         The command will be printed to stdout if it's not the output of an error,
@@ -141,8 +155,8 @@ class SGRString(str):
         If the output stream isn't a tty, it will strip the SGR codes and the prefix,
         unless forced to keep them.
         """
-        file = sys.stderr if is_error else sys.stdout
-        if file.isatty():  # type: ignore[misc]
+        file = sys.stderr if self._is_error else sys.stdout
+        if file.isatty():
             prefix = self._prefix
             sgr_prefix = "".join(code.sequence for code in self._sgr)
             sgr_suffix = SGRCodes.RESET.sequence
@@ -152,16 +166,17 @@ class SGRString(str):
             sgr_prefix = ""
             sgr_suffix = ""
             suffix = ""
-            if force_sgr or os.getenv("PY_UTIL_FORCE_SGR", "").lower() in TRUE_VAR:
+            if self._force_sgr:
                 sgr_prefix = "".join(code.sequence for code in self._sgr)
                 sgr_suffix = SGRCodes.RESET.sequence if self._sgr else ""
-            if (
-                force_prefix
-                or os.getenv("PY_UTIL_FORCE_OUTFIX", "").lower() in TRUE_VAR
-            ):
+            if self._force_prefix:
                 prefix = self._prefix
                 suffix = self._suffix
 
+        if full_color:
+            prefix, sgr_prefix = sgr_prefix, prefix
+            suffix, sgr_suffix = sgr_suffix, suffix
+
         print(
             prefix,
             sgr_prefix,
@@ -180,23 +195,98 @@ class SGRString(str):
         left_spaces: int = 1,
         right_spaces: int = 1,
         space: str = " ",
-        force_sgr: bool = False,
-        is_error: bool = False,
     ) -> None:
         try:
             terminal_size = os.get_terminal_size()
         except OSError:
             # in pseudo-terminals an OSError is thrown
-            self.print(force_prefix=True, force_sgr=force_sgr, is_error=is_error)
+            self.print()
             return
 
         columns = terminal_size.columns
         title_length = left_spaces + len(self) + right_spaces
         if title_length >= columns:
-            self.print(is_error=is_error)
+            self.print()
             return
 
         half = (columns - title_length) / 2
         prefix = f"{padding * ceil(half)}{space * left_spaces}{self._prefix}"
         suffix = f"{self._suffix}{space * right_spaces}{padding * floor(half)}"
         type(self)(self._string, prefix=prefix, suffix=suffix, params=self._sgr).print()
+
+
+@dataclass(frozen=True, order=True)
+class SGROutput:
+    __slots__ = ("_strings",)  # py3.9: remove this line
+    _strings: tuple[SGRString, ...]
+
+    def __init__(
+        self,
+        strings: Iterable[SGRString],
+        force_prefix: bool | None = None,
+        force_sgr: bool | None = None,
+        is_error: bool | None = None,
+    ) -> None:
+        strings = tuple(
+            self._clean_string(
+                string,
+                force_prefix=force_prefix,
+                force_sgr=force_sgr,
+                is_error=is_error,
+            )
+            for string in strings
+        )
+
+        object.__setattr__(self, "_strings", strings)
+
+    @staticmethod
+    def _clean_string(
+        string: SGRString,
+        force_prefix: bool | None,
+        force_sgr: bool | None,
+        is_error: bool | None,
+    ) -> SGRString:
+        force_prefix = (
+            string._force_prefix  # noqa: SLF001
+            if force_prefix is None
+            else force_prefix
+        )
+        force_sgr = (
+            string._force_sgr if force_sgr is None else force_sgr  # noqa: SLF001
+        )
+        is_error = string._is_error if is_error is None else is_error  # noqa: SLF001
+        return SGRString(
+            string._string,  # noqa: SLF001
+            prefix=string._prefix,  # noqa: SLF001
+            suffix=string._suffix,  # noqa: SLF001
+            params=string._sgr,  # noqa: SLF001
+            force_prefix=force_prefix,
+            force_sgr=force_sgr,
+            is_error=is_error,
+        )
+
+    def print(self, sep: str = "", end: str = "\n") -> None:
+        n = len(self._strings)
+        for index, string in enumerate(self._strings, start=1):
+            current_end = end if index == n else sep
+            string.print(end=current_end)
+
+    def header(
+        self,
+        *,
+        padding: str = " ",
+        left_spaces: int = 1,
+        right_spaces: int = 1,
+        space: str = " ",
+    ) -> None:
+        n = len(self._strings)
+        if n > 1:
+            msg = "Only one string is allowed for the header"
+            raise ValueError(msg)
+
+        self._strings[0].header(
+            padding=padding,
+            left_spaces=left_spaces,
+            right_spaces=right_spaces,
+            space=space,
+        )

{pyutilkit-0.8.0 → pyutilkit-0.9.0}/src/pyutilkit/timing.py

@@ -91,7 +91,7 @@ class Timing:
     def __truediv__(self, other: object) -> Timing:
         if not isinstance(other, int):
             return NotImplemented
-        return Timing(nanoseconds=self.nanoseconds // other)
+        return Timing(nanoseconds=round(self.nanoseconds / other))
 
 
 class Stopwatch: