ddutils 0.2.2__tar.gz → 0.2.3__tar.gz

{ddutils-0.2.2 → ddutils-0.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ddutils
-Version: 0.2.2
+Version: 0.2.3
 Summary: Domain Driven Utils Library
 Keywords: python,ddutils
 Author: davyddd
@@ -138,6 +138,21 @@ get_annotation_without_optional(Optional[int])  # <class 'int'>
 get_annotation_without_optional(Optional[List[str]])  # typing.List[str]
 ```
 
+### get_annotation_name
+
+Returns a readable name of an annotation for error messages: a class, a union or a tuple of classes as
+`isinstance` takes it.
+
+```python
+from ddutils.annotation_helpers import get_annotation_name
+
+
+get_annotation_name(int)            # 'int'
+get_annotation_name((int, float))   # 'int | float'
+get_annotation_name(int | None)     # 'int | None'
+get_annotation_name(list[int])      # 'list[int]'
+```
+
 ## Class Helpers
 
 Helper functions for inspecting and extending class-level behavior
@@ -216,6 +231,36 @@ get_generic_base_argument(UserRepository, Repository)  # <class 'User'>
 get_generic_base_argument(Repository, Repository)      # None
 ```
 
+### require_class_attribute
+
+Returns a class attribute that subclasses are expected to declare, for `__init_subclass__` checks. A missing,
+`None` or empty value raises `AttributeError`, a value of the wrong type raises `TypeError`; both name the
+attribute and the class, so a misconfigured subclass fails at definition rather than on first use.
+
+```python
+from typing import ClassVar
+
+from ddutils.class_helpers import require_class_attribute
+
+
+class BaseConsumer:
+    topic: ClassVar[str]
+    batch_size: ClassVar[int] = 100
+
+    def __init_subclass__(cls, **kwargs):
+        super().__init_subclass__(**kwargs)
+        require_class_attribute(cls, 'topic', str)
+        require_class_attribute(cls, 'batch_size', int)
+
+
+class EventConsumer(BaseConsumer):
+    topic = 'events'
+
+
+class BrokenConsumer(BaseConsumer):  # AttributeError: `topic` class attribute of BrokenConsumer must be set
+    pass
+```
+
 ## Function Helpers
 
 Tools for creating and modifying Python functions at runtime.

{ddutils-0.2.2 → ddutils-0.2.3}/README.md

@@ -120,6 +120,21 @@ get_annotation_without_optional(Optional[int])  # <class 'int'>
 get_annotation_without_optional(Optional[List[str]])  # typing.List[str]
 ```
 
+### get_annotation_name
+
+Returns a readable name of an annotation for error messages: a class, a union or a tuple of classes as
+`isinstance` takes it.
+
+```python
+from ddutils.annotation_helpers import get_annotation_name
+
+
+get_annotation_name(int)            # 'int'
+get_annotation_name((int, float))   # 'int | float'
+get_annotation_name(int | None)     # 'int | None'
+get_annotation_name(list[int])      # 'list[int]'
+```
+
 ## Class Helpers
 
 Helper functions for inspecting and extending class-level behavior
@@ -198,6 +213,36 @@ get_generic_base_argument(UserRepository, Repository)  # <class 'User'>
 get_generic_base_argument(Repository, Repository)      # None
 ```
 
+### require_class_attribute
+
+Returns a class attribute that subclasses are expected to declare, for `__init_subclass__` checks. A missing,
+`None` or empty value raises `AttributeError`, a value of the wrong type raises `TypeError`; both name the
+attribute and the class, so a misconfigured subclass fails at definition rather than on first use.
+
+```python
+from typing import ClassVar
+
+from ddutils.class_helpers import require_class_attribute
+
+
+class BaseConsumer:
+    topic: ClassVar[str]
+    batch_size: ClassVar[int] = 100
+
+    def __init_subclass__(cls, **kwargs):
+        super().__init_subclass__(**kwargs)
+        require_class_attribute(cls, 'topic', str)
+        require_class_attribute(cls, 'batch_size', int)
+
+
+class EventConsumer(BaseConsumer):
+    topic = 'events'
+
+
+class BrokenConsumer(BaseConsumer):  # AttributeError: `topic` class attribute of BrokenConsumer must be set
+    pass
+```
+
 ## Function Helpers
 
 Tools for creating and modifying Python functions at runtime.

{ddutils-0.2.2 → ddutils-0.2.3}/ddutils/annotation_helpers.py

@@ -1,7 +1,7 @@
 import inspect
 from collections.abc import Sequence
 from types import UnionType
-from typing import Any, Union, get_args
+from typing import Any, Union, get_args, get_origin
 
 NON_COMPLEX_SEQUENCE_TYPES = (str, bytes, bytearray)
 
@@ -76,3 +76,34 @@ def get_annotation_without_optional(annotation: Any) -> Any:
             raise TypeError('Union types are not supported') from None
 
         return annotation_args[0]
+
+
+def _join_annotation_names(items: Any, separator: str) -> str:
+    return separator.join(get_annotation_name(item) for item in items)
+
+
+def get_annotation_name(annotation: Any) -> str:
+    """
+    Return a readable name of an annotation for messages: `int`, `int | float`, `list[int]`, `None`.
+
+    Accepts a class, a union (`int | None`, `Optional[int]`, `Union[int, str]`), a generic (`dict[str, int]`,
+    `Literal['a', 'b']`) or a tuple of classes as `isinstance` takes it, and renders them the way they are written.
+    """
+    if annotation is None or annotation is type(None):
+        return 'None'
+    if annotation is Ellipsis:
+        return '...'
+    if isinstance(annotation, (str, bytes, int, float)):  # a `Literal` value
+        return repr(annotation)
+    if isinstance(annotation, tuple):
+        return _join_annotation_names(annotation, ' | ')
+    if isinstance(annotation, UnionType) or get_origin(annotation) is Union:
+        return _join_annotation_names(get_args(annotation), ' | ')
+    if isinstance(annotation, list):  # the parameters of a `Callable`
+        return f'[{_join_annotation_names(annotation, ", ")}]'
+    origin, args = get_origin(annotation), get_args(annotation)
+    if origin is not None and args:
+        return f'{get_annotation_name(origin)}[{_join_annotation_names(args, ", ")}]'
+    if isinstance(annotation, type):
+        return annotation.__name__
+    return str(annotation).replace('typing.', '')

{ddutils-0.2.2 → ddutils-0.2.3}/ddutils/class_helpers.py

@@ -1,7 +1,9 @@
 import inspect
-from collections.abc import Callable
+from collections.abc import Callable, Sized
 from typing import Any, TypeVar, get_args, get_origin
 
+from ddutils.annotation_helpers import get_annotation_name
+
 _T = TypeVar('_T', bound=Any)
 
 
@@ -45,6 +47,53 @@ def get_generic_base_argument(cls: type, generic_base: type, position: int = 0)
     return None
 
 
+def require_class_attribute(
+    cls: type,
+    name: str,
+    expected_type: type | tuple[type, ...] | None = None,
+    *,
+    allow_empty: bool = False,
+) -> Any:
+    """
+    Return a class attribute that subclasses are expected to declare, for `__init_subclass__` checks.
+
+    A base class that reads its configuration from class attributes (`topic`, `bootstrap_servers`,
+    `serializer`, ...) wants a wrong or forgotten declaration to fail at class definition, with the
+    attribute and the class named, rather than deep inside the first call that uses it.
+
+    Args:
+        cls: The class being defined, as passed to `__init_subclass__`.
+        name: The attribute name.
+        expected_type: A class or tuple of classes the value must be an instance of; `None` skips the check.
+        allow_empty: Accept an empty value (`''`, `[]`, `{}`, ...). Numbers are never "empty", so `0` passes.
+
+    Raises:
+        AttributeError: The attribute is missing or `None`, or empty unless `allow_empty`.
+        TypeError: The value is not an instance of `expected_type`.
+
+    Example:
+        class BaseConsumer:
+            topic: ClassVar[str]
+            batch_size: ClassVar[int] = 100
+
+            def __init_subclass__(cls, **kwargs):
+                super().__init_subclass__(**kwargs)
+                require_class_attribute(cls, 'topic', str)
+                require_class_attribute(cls, 'batch_size', int)
+    """
+    value = getattr(cls, name, None)
+    if value is None:
+        raise AttributeError(f'`{name}` class attribute of {cls.__name__} must be set')
+    if not allow_empty and isinstance(value, Sized) and len(value) == 0:
+        raise AttributeError(f'`{name}` class attribute of {cls.__name__} must not be empty')
+    if expected_type is not None and not isinstance(value, expected_type):
+        raise TypeError(
+            f'`{name}` class attribute of {cls.__name__} must be {get_annotation_name(expected_type)}, '
+            f'got {type(value).__name__}'
+        )
+    return value
+
+
 class classproperty:  # noqa: N801
     """
     A descriptor that defines a read-only property at the class level.

{ddutils-0.2.2 → ddutils-0.2.3}/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = "ddutils"
 description = "Domain Driven Utils Library"
-version = "0.2.2"
+version = "0.2.3"
 license = "MIT"
 license-files = ["LICENSE"]
 readme = "README.md"

{ddutils-0.2.2 → ddutils-0.2.3}/pyproject.toml.orig

@@ -1,7 +1,7 @@
 [project]
 name = "ddutils"
 description = "Domain Driven Utils Library"
-version = "0.2.2"
+version = "0.2.3"
 authors = [{ name = "davyddd" }]
 license = "MIT"
 license-files = ["LICENSE"]