zstdlib 0.9.0__tar.gz → 0.10.0__tar.gz

{zstdlib-0.9.0 → zstdlib-0.10.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: zstdlib
-Version: 0.9.0
+Version: 0.10.0
 Summary: A set of useful python utilities
 License: GPLv3
 Project-URL: Homepage, https://github.com/zwimer/zstdlib

zstdlib-0.10.0/tests/test_exc_capture.py

@@ -0,0 +1,70 @@
+# pylint: disable=missing-module-docstring,missing-class-docstring,missing-function-docstring
+import unittest
+
+from zstdlib import ExcCapture, ExcDelay
+
+
+class TestLazy(unittest.TestCase):
+
+    def test_capture(self) -> None:
+        # Capture nothing
+        rt = ExcCapture(RuntimeError)
+        with rt.capture():
+            pass
+        self.assertEqual(len(rt.errors), 0)
+        # Capture only Runtime
+        with rt.capture():
+            raise RuntimeError()
+        self.assertEqual(len(rt.errors), 1)
+        with self.assertRaises(ValueError), rt.capture():
+            raise ValueError()
+        self.assertEqual(len(rt.errors), 1)
+        # capture's exc_t
+        rt = ExcCapture(RuntimeError)
+        with self.assertRaises(RuntimeError), rt.capture(ValueError):
+            raise RuntimeError()
+        self.assertEqual(len(rt.errors), 0)
+        with rt.capture(ValueError):
+            raise ValueError()
+        self.assertEqual(len(rt.errors), 1)
+        del rt
+        # exc_t = None
+        non = ExcCapture()
+        with self.assertRaises(RuntimeError), non.capture(ValueError):
+            raise RuntimeError()
+        self.assertEqual(len(non.errors), 0)
+        with self.assertRaises(ValueError), non.capture():
+            pass
+        self.assertEqual(len(non.errors), 0)
+        with non.capture(RuntimeError):
+            raise RuntimeError()
+        self.assertEqual(len(non.errors), 1)
+
+    def test_delay(self) -> None:
+        # No raise
+        with ExcDelay("msg", RuntimeError) as capture, capture():
+            pass
+        # Raise
+        ed = ExcDelay("msg", RuntimeError)
+        try:
+            with ed as capture:
+                with capture():
+                    raise RuntimeError()
+                with capture():
+                    raise RuntimeError()
+            self.assertTrue(False)
+        except BaseExceptionGroup as grp:
+            self.assertIsInstance(grp, ExceptionGroup)  # Test auto-conversion
+            self.assertEqual(len(grp.exceptions), 2)
+            self.assertEqual(len(ed.errors), 2)
+        # No block error
+        with self.assertRaises(ValueError), ExcDelay("msg", RuntimeError) as capture, capture():
+            raise ValueError()
+        with self.assertRaises(ValueError), ExcDelay("msg", RuntimeError) as capture:
+            with capture():
+                raise RuntimeError()
+            raise ValueError()
+
+
+if __name__ == "__main__":
+    unittest.main()

{zstdlib-0.9.0 → zstdlib-0.10.0}/zstdlib/__init__.py

@@ -1,5 +1,6 @@
-__version__ = "0.9.0"
+__version__ = "0.10.0"
 
+from .exc_capture import ExcCapture, ExcDelay
 from .not_set import NotSetType, NotSet
 from .frozen import Freezable, frozen
 from .singleton import Singleton
@@ -9,6 +10,8 @@ from . import macos, lazy, log, io
 
 __all__ = (
     "Enum",
+    "ExcCapture",
+    "ExcDelay",
     "Freezable",
     "NotSet",
     "NotSetType",

{zstdlib-0.9.0 → zstdlib-0.10.0}/zstdlib/ansi.py

@@ -117,7 +117,8 @@ class Color(metaclass=_ColorMeta):
             self.code = RawColor._parse_color(fmt) if isinstance(fmt, str) else fmt.code
 
     def __call__(self, string: str) -> str:
-        """Args:
+        """
+        Args:
             string: The string to color
 
         Returns:
@@ -126,7 +127,8 @@ class Color(metaclass=_ColorMeta):
         return f"{self.code}{string}{self.RESET}"
 
     def __add__(self, other: Self) -> Self:
-        """Args:
+        """
+        Args:
             other: The other string to color
 
         Returns:
@@ -137,7 +139,8 @@ class Color(metaclass=_ColorMeta):
         return type(self)(code=f"{self.code[:-1]};{other.code[len(_PREFIX):]}")
 
     def __eq__(self, other: object) -> bool:
-        """Args:
+        """
+        Args:
             other: The color to compare against
 
         Returns:
@@ -156,7 +159,8 @@ class Color(metaclass=_ColorMeta):
     def factory(
         cls, *, foreground: RawColor | None = None, background: RawColor | None = None, **modifiers: bool
     ) -> Self:
-        """Args:
+        """
+        Args:
             foreground: The foreground color
             background: The background color
             **modifiers: Color modifiers to apply
@@ -170,10 +174,11 @@ class Color(metaclass=_ColorMeta):
 def _generate_code(
     foreground: RawColor | None, background: RawColor | None, modifiers: dict[str, bool]
 ) -> str:
-    """Args:
+    """
+    Args:
         foreground: The foreground color
         background: The background color
-        **modifiers: Color modifiers to apply
+        modifiers: Color modifiers to apply
 
     Returns:
         The Ansi given the chosen color and various modifiers

{zstdlib-0.9.0 → zstdlib-0.10.0}/zstdlib/enum.py

@@ -136,7 +136,8 @@ class Enum(metaclass=EnumType, empty_ok=True):
 
 
 def entries(enum: EnumType) -> dict[str, tuple[type | None, Any]]:
-    """Args:
+    """
+    Args:
         enum: A class whose metaclass is EnumType
 
     Returns:
@@ -149,7 +150,8 @@ def entries(enum: EnumType) -> dict[str, tuple[type | None, Any]]:
 
 
 def values(enum: Any) -> tuple[Any, ...]:
-    """Args:
+    """
+    Args:
         enum: A class whose metaclass is EnumType
 
     Returns:

zstdlib-0.10.0/zstdlib/exc_capture.py

@@ -0,0 +1,69 @@
+from contextlib import AbstractContextManager, contextmanager
+from collections.abc import Iterator
+from typing import Protocol
+
+__all__ = ("ExcCapture", "ExcDelay")
+
+
+type EXC_T = type[BaseException] | tuple[type[BaseException]]
+
+
+class CaptureFType(Protocol):
+    """The type of the capture function (used for type checking)"""
+
+    def __call__(self, exc_t: EXC_T | None = None) -> AbstractContextManager[None]: ...
+
+
+class ExcCapture:
+    """A class that exposes a context manager which captures and suppresses any raised exception of a given type / tuple of types"""
+
+    __slots__ = ("errors", "exc_t")
+
+    def __init__(self, exc_t: EXC_T | None = None) -> None:
+        """
+        Args:
+            msg: The exception group message
+            exc_t: The exception type the capture function should capture, if None it must be passed to the capture function directly
+        """
+        self.exc_t: EXC_T | None = exc_t
+        self.errors: list[BaseException] = []
+
+    @contextmanager
+    def capture(self, exc_t: EXC_T | None = None) -> Iterator[None]:
+        """Capture and suppress any exception if type/tuple of types exc_t (self.exc_t if None)"""
+        exc_t = self.exc_t if exc_t is None else exc_t
+        if exc_t is None:
+            raise ValueError("No exception type provided here nor during construction")
+        try:
+            yield
+        except exc_t as e:
+            self.errors.append(e)
+
+
+class ExcDelay(ExcCapture):
+    """A context manager subclass of ExcCapture that raises on exit if errors are captured"""
+
+    __slots__ = ("_msg",)
+
+    def __init__(
+        self,
+        msg: str,
+        exc_t: type[BaseException] | None = None,
+    ) -> None:
+        """
+        Args:
+            exc_t: The exception type the capture function should capture, if None it must be passed to the capture function directly
+            msg: The exception group message
+        """
+        super().__init__(exc_t)
+        self._msg = msg
+
+    def __enter__(self) -> CaptureFType:
+        """Return the capture function to use"""
+        return self.capture
+
+    def __exit__(self, type_: type[BaseException] | None, *_: object) -> None:
+        """Raise an ExceptionGroup (or BaseExceptionGroup depending on exc_t) if self.errors"""
+        if type_ is None and self.errors:
+            # Auto-converts to ExceptionGroup if all items are Exceptions
+            raise BaseExceptionGroup(self._msg, self.errors)

{zstdlib-0.9.0 → zstdlib-0.10.0}/zstdlib/io.py

@@ -41,8 +41,8 @@ class _IOWrapperBase[T: (str, bytes)]:
     """
 
     __slots__ = ("_buffer", "_eof", "f", "lock")
-    _instances: WeakKeyDictionary[IOBase, Self] = WeakKeyDictionary()
-    _wr_lock = RLock()
+    _instances: WeakKeyDictionary[IOBase, Self] = WeakKeyDictionary()  # noqa: RUF012
+    _wr_lock: RLock = RLock()
 
     def __new__(cls, f: IOBase) -> Self:
         """Create a new instance of cls for raw, or return an existing instance if one exists"""

{zstdlib-0.9.0 → zstdlib-0.10.0}/zstdlib.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: zstdlib
-Version: 0.9.0
+Version: 0.10.0
 Summary: A set of useful python utilities
 License: GPLv3
 Project-URL: Homepage, https://github.com/zwimer/zstdlib

{zstdlib-0.9.0 → zstdlib-0.10.0}/zstdlib.egg-info/SOURCES.txt

@@ -4,6 +4,7 @@ pyproject.toml
 tests/__init__.py
 tests/test_ansi.py
 tests/test_enum.py
+tests/test_exc_capture.py
 tests/test_frozen.py
 tests/test_io.py
 tests/test_lazy.py
@@ -16,6 +17,7 @@ tests/log/test_trace.py
 zstdlib/__init__.py
 zstdlib/ansi.py
 zstdlib/enum.py
+zstdlib/exc_capture.py
 zstdlib/frozen.py
 zstdlib/io.py
 zstdlib/lazy.py