errortools 2.1.0__tar.gz → 2.2.0__tar.gz

{errortools-2.1.0/errortools.egg-info → errortools-2.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: errortools
-Version: 2.1.0
+Version: 2.2.0
 Summary: errortools - a toolset for working with Python exceptions and warnings and logging.
 Home-page: https://github.com/more-abc/errortools
 Author: Evan Yang

errortools-2.2.0/_errortools/descriptor/__init__.py

@@ -0,0 +1,2 @@
+# Why add this file?
+# See https://github.com/more-abc/errortools/issues/27

errortools-2.2.0/_errortools/descriptor/errormsg.py

@@ -0,0 +1,37 @@
+from typing import Optional, NoReturn
+
+
+# NOTE: The attribute returns the preset message when accessed.
+# Any attempt to modify or delete it raises an ``AttributeError``.
+class ErrorMsg:
+    """Descriptor that creates a read-only attribute with a fixed message.
+
+    Args:
+        message: The fixed string returned when the attribute is accessed.
+
+    Example:
+
+        >>> class MyClass:
+        ...     status = ErrorMsg("This attribute is read-only")
+        >>> obj = MyClass()
+        >>> obj.status
+        'This attribute is read-only'
+        >>> obj.status = "new"  # doctest: +SKIP
+        AttributeError: Modification of this attribute is not allowed!
+        >>> del obj.status  # doctest: +SKIP
+        AttributeError: Deletion of this attribute is not allowed!
+    """
+
+    __slots__ = ("_message",)
+
+    def __init__(self, message: str) -> None:
+        self._message = message
+
+    def __get__(self, instance: Optional[object], owner: type[object]) -> str:
+        return self._message
+
+    def __set__(self, instance: object, value: object) -> NoReturn:
+        raise AttributeError("Modification of this attribute is not allowed!")
+
+    def __delete__(self, instance: object) -> NoReturn:
+        raise AttributeError("Deletion of this attribute is not allowed!")

errortools-2.2.0/_errortools/descriptor/nonblankmsg.py

@@ -0,0 +1,52 @@
+from typing import Any, Optional
+
+
+# NOTE: Validates the value is a string and not empty
+# after trimming leading/trailing whitespace.
+# Stores the cleaned (stripped) value on the instance.
+class NonBlankErrorMsg:
+    """Descriptor that validates an attribute is a non-blank string after stripping whitespace.
+
+    Args:
+        message: Name/label used in error messages for validation failures.
+
+    Example:
+        >>> class ApiError:
+        ...     message = NonBlankErrorMsg("Error message")
+        ...     def __init__(self, msg: str):
+        ...         self.message = msg
+        >>> err = ApiError("Invalid token")
+        >>> err.message
+        'Invalid token'
+        >>> err = ApiError("   ")  # doctest: +SKIP
+        ValueError: Error message can't be blank, must provide a valid error message
+    """
+
+    __slots__ = ("_message",)
+
+    def __init__(self, message: str) -> None:
+        self._message = message
+
+    def __get__(self, instance: Optional[object], owner: type[object]) -> str:
+        if instance is None:
+            return self._message
+        return instance.__dict__[self._message]  # type: ignore
+
+    def __set__(self, instance: object, value: Any) -> None:
+        validated_value = self.validate(self._message, value)
+        instance.__dict__[self._message] = validated_value
+
+    def __delete__(self, instance: object) -> None:
+        raise AttributeError("Deletion of this attribute is not allowed!")
+
+    def validate(self, name: str, value: str) -> str:
+        if not isinstance(value, str):
+            raise ValueError(f"{name} must be a string type")
+
+        stripped_value = value.strip()
+        if not stripped_value:
+            raise ValueError(
+                f"{name} can't be blank, must provide a valid error message"
+            )
+
+        return stripped_value

{errortools-2.1.0 → errortools-2.2.0}/_errortools/version.py

@@ -1,5 +1,5 @@
-__version__: str = "2.1.0"
-__version_tuple__: tuple[int, int, int] = (2, 1, 0)
+__version__: str = "2.2.0"
+__version_tuple__: tuple[int, int, int] = (2, 2, 0)
 __commit_id__: str | None = None
 
 version = __version__

errortools-2.2.0/_errortools/wrappers/__init__.py

@@ -0,0 +1,2 @@
+# Why add this file?
+# See https://github.com/more-abc/errortools/issues/27

{errortools-2.1.0 → errortools-2.2.0/errortools.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: errortools
-Version: 2.1.0
+Version: 2.2.0
 Summary: errortools - a toolset for working with Python exceptions and warnings and logging.
 Home-page: https://github.com/more-abc/errortools
 Author: Evan Yang

{errortools-2.1.0 → errortools-2.2.0}/errortools.egg-info/SOURCES.txt

@@ -22,6 +22,9 @@ _errortools/classes/warn.py
 _errortools/decorator/__init__.py
 _errortools/decorator/cache.py
 _errortools/decorator/deprecated.py
+_errortools/descriptor/__init__.py
+_errortools/descriptor/errormsg.py
+_errortools/descriptor/nonblankmsg.py
 _errortools/logging/__init__.py
 _errortools/logging/base.py
 _errortools/logging/level.py

{errortools-2.1.0 → errortools-2.2.0}/setup.py

@@ -2,7 +2,7 @@ from setuptools import setup, find_packages
 
 setup(
     name="errortools",
-    version="2.1.0",
+    version="2.2.0",
     description="errortools - a toolset for working with Python exceptions and warnings and logging.",
     long_description=open("README.md", encoding="utf-8").read(),
     long_description_content_type="text/markdown",