ducktools-classbuilder 0.10.1__tar.gz → 0.10.2__tar.gz

{ducktools_classbuilder-0.10.1 → ducktools_classbuilder-0.10.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ducktools-classbuilder
-Version: 0.10.1
+Version: 0.10.2
 Summary: Toolkit for creating class boilerplate generators
 Author: David C Ellis
 Project-URL: Homepage, https://github.com/davidcellis/ducktools-classbuilder

{ducktools_classbuilder-0.10.1 → ducktools_classbuilder-0.10.2}/src/ducktools/classbuilder/__init__.py

@@ -31,8 +31,9 @@
 # Field itself sidesteps this by defining __slots__ to avoid that branch.
 
 import os
+import sys
 
-from .annotations import get_ns_annotations, is_classvar
+from .annotations import get_ns_annotations, is_classvar, make_annotate_func
 from ._version import __version__, __version_tuple__  # noqa: F401
 
 # Change this name if you make heavy modifications
@@ -131,19 +132,25 @@ class GeneratedCode:
     This class provides a return value for the generated output from source code
     generators.
     """
-    __slots__ = ("source_code", "globs")
+    __slots__ = ("source_code", "globs", "annotations")
 
-    def __init__(self, source_code, globs):
+    def __init__(self, source_code, globs, annotations=None):
         self.source_code = source_code
         self.globs = globs
+        self.annotations = annotations
 
     def __repr__(self):
         first_source_line = self.source_code.split("\n")[0]
-        return f"GeneratorOutput(source_code='{first_source_line} ...', globs={self.globs!r})"
+        return (
+            f"GeneratorOutput(source_code='{first_source_line} ...', "
+            f"globs={self.globs!r}, annotations={self.annotations!r})"
+        )
 
     def __eq__(self, other):
         if self.__class__ is other.__class__:
-            return (self.source_code, self.globs) == (other.source_code, other.globs)
+            return (self.source_code, self.globs, self.annotations) == (
+                other.source_code, other.globs, other.annotations
+            )
         return NotImplemented
 
 
@@ -199,6 +206,20 @@ class MethodMaker:
             # descriptor. Don't try to rename.
             pass
 
+        # Apply annotations
+        if gen.annotations is not None:
+            if sys.version_info >= (3, 14):
+                # If __annotations__ exists on the class, either they
+                # are user defined or they are using __future__ annotations.
+                # In this case, just write __annotations__
+                if "__annotations__" in gen_cls.__dict__:
+                    method.__annotations__ = gen.annotations
+                else:
+                    anno_func = make_annotate_func(gen.annotations)
+                    method.__annotate__ = anno_func
+            else:
+                method.__annotations__ = gen.annotations
+
         # Replace this descriptor on the class with the generated function
         setattr(gen_cls, self.funcname, method)
 

{ducktools_classbuilder-0.10.1 → ducktools_classbuilder-0.10.2}/src/ducktools/classbuilder/__init__.pyi

@@ -40,16 +40,20 @@ class KW_ONLY(metaclass=_KW_ONLY_META): ...
 class _CodegenType(typing.Protocol):
     def __call__(self, cls: type, funcname: str = ...) -> GeneratedCode: ...
 
-
 class GeneratedCode:
-    __slots__: tuple[str, str]
+    __slots__: tuple[str, ...]
     source_code: str
     globs: dict[str, typing.Any]
+    annotations: dict[str, typing.Any]
 
-    def __init__(self, source_code: str, globs: dict[str, typing.Any]) -> None: ...
+    def __init__(
+        self,
+        source_code: str,
+        globs: dict[str, typing.Any],
+        annotations: dict[str, typing.Any] | None = ...,
+    ) -> None: ...
     def __repr__(self) -> str: ...
 
-
 class MethodMaker:
     funcname: str
     code_generator: _CodegenType

ducktools_classbuilder-0.10.2/src/ducktools/classbuilder/_version.py

@@ -0,0 +1,2 @@
+__version__ = "0.10.2"
+__version_tuple__ = (0, 10, 2)

{ducktools_classbuilder-0.10.1 → ducktools_classbuilder-0.10.2}/src/ducktools/classbuilder/annotations.py

@@ -24,9 +24,9 @@ import sys
 
 class _LazyAnnotationLib:
     def __getattr__(self, item):
-        global _lazyannotationlib
+        global _lazy_annotationlib
         import annotationlib  # type: ignore
-        _lazyannotationlib = annotationlib
+        _lazy_annotationlib = annotationlib
         return getattr(annotationlib, item)
 
 
@@ -83,6 +83,36 @@ def get_ns_annotations(ns):
     return annotations
 
 
+def make_annotate_func(annos):
+    # Only used in 3.14 or later so no sys.version_info gate
+
+    type_repr = _lazy_annotationlib.type_repr
+    Format = _lazy_annotationlib.Format
+    ForwardRef = _lazy_annotationlib.ForwardRef
+    # Construct an annotation function from __annotations__
+    def annotate_func(format, /):
+        match format:
+            case Format.VALUE | Format.FORWARDREF:
+                return {
+                    k: v.evaluate(format=format)
+                    if isinstance(v, ForwardRef) else v
+                    for k, v in annos.items()
+                }
+            case Format.STRING:
+                string_annos = {}
+                for k, v in annos.items():
+                    if isinstance(v, str):
+                        string_annos[k] = v
+                    elif isinstance(v, ForwardRef):
+                        string_annos[k] = v.evaluate(format=Format.STRING)
+                    else:
+                        string_annos[k] = type_repr(v)
+                return string_annos
+            case _:
+                raise NotImplementedError(format)
+    return annotate_func
+
+
 def is_classvar(hint):
     if isinstance(hint, str):
         # String annotations, just check if the string 'ClassVar' is in there

{ducktools_classbuilder-0.10.1 → ducktools_classbuilder-0.10.2}/src/ducktools/classbuilder/annotations.pyi

@@ -1,3 +1,4 @@
+from collections.abc import Callable
 import typing
 import types
 
@@ -11,6 +12,10 @@ def get_ns_annotations(
     ns: _CopiableMappings,
 ) -> dict[str, typing.Any]: ...
 
+def make_annotate_func(
+    annos: dict[str, typing.Any]
+) -> Callable[[int], dict[str, typing.Any]]: ...
+
 def is_classvar(
     hint: object,
 ) -> bool: ...

{ducktools_classbuilder-0.10.1 → ducktools_classbuilder-0.10.2}/src/ducktools/classbuilder/prefab.py

@@ -64,6 +64,7 @@ def get_attributes(cls):
 # Method Generators
 def init_generator(cls, funcname="__init__"):
     globs = {}
+    annotations = {}
     # Get the internals dictionary and prepare attributes
     attributes = get_attributes(cls)
     flags = get_flags(cls)
@@ -106,41 +107,29 @@ def init_generator(cls, funcname="__init__"):
     kw_only_arglist = []
     for name, attrib in attributes.items():
         # post_init annotations can be used to broaden types.
-        if name in post_init_annotations:
-            globs[f"_{name}_type"] = post_init_annotations[name]
-        elif attrib.type is not NOTHING:
-            globs[f"_{name}_type"] = attrib.type
-
         if attrib.init:
+            if name in post_init_annotations:
+                annotations[name] = post_init_annotations[name]
+            elif attrib.type is not NOTHING:
+                annotations[name] = attrib.type
+
             if attrib.default is not NOTHING:
                 if isinstance(attrib.default, (str, int, float, bool)):
                     # Just use the literal in these cases
-                    if attrib.type is NOTHING:
-                        arg = f"{name}={attrib.default!r}"
-                    else:
-                        arg = f"{name}: _{name}_type = {attrib.default!r}"
+                    arg = f"{name}={attrib.default!r}"
                 else:
                     # No guarantee repr will work for other objects
                     # so store the value in a variable and put it
                     # in the globals dict for eval
-                    if attrib.type is NOTHING:
-                        arg = f"{name}=_{name}_default"
-                    else:
-                        arg = f"{name}: _{name}_type = _{name}_default"
+                    arg = f"{name}=_{name}_default"
                     globs[f"_{name}_default"] = attrib.default
             elif attrib.default_factory is not NOTHING:
                 # Use NONE here and call the factory later
                 # This matches the behaviour of compiled
-                if attrib.type is NOTHING:
-                    arg = f"{name}=None"
-                else:
-                    arg = f"{name}: _{name}_type = None"
+                arg = f"{name}=None"
                 globs[f"_{name}_factory"] = attrib.default_factory
             else:
-                if attrib.type is NOTHING:
-                    arg = name
-                else:
-                    arg = f"{name}: _{name}_type"
+                arg = name
             if attrib.kw_only or kw_only:
                 kw_only_arglist.append(arg)
             else:
@@ -206,13 +195,19 @@ def init_generator(cls, funcname="__init__"):
         post_init_call = ""
 
     code = (
-        f"def {funcname}(self, {args}) -> None:\n"
+        f"def {funcname}(self, {args}):\n"
         f"{pre_init_call}\n"
         f"{body}\n"
         f"{post_init_call}\n"
     )
 
-    return GeneratedCode(code, globs)
+    if annotations:
+        annotations["return"] = None
+    else:
+        # If there are no annotations, return an unannotated init function
+        annotations = None
+
+    return GeneratedCode(code, globs, annotations)
 
 
 def iter_generator(cls, funcname="__iter__"):

{ducktools_classbuilder-0.10.1 → ducktools_classbuilder-0.10.2}/src/ducktools_classbuilder.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ducktools-classbuilder
-Version: 0.10.1
+Version: 0.10.2
 Summary: Toolkit for creating class boilerplate generators
 Author: David C Ellis
 Project-URL: Homepage, https://github.com/davidcellis/ducktools-classbuilder

{ducktools_classbuilder-0.10.1 → ducktools_classbuilder-0.10.2}/src/ducktools_classbuilder.egg-info/SOURCES.txt

@@ -71,4 +71,6 @@ tests/prefab/test_slotted_class.py
 tests/prefab/test_subclass_implementation.py
 tests/py312_tests/test_generic_annotations.py
 tests/py314_tests/_test_support.py
-tests/py314_tests/test_forwardref_annotations.py
+tests/py314_tests/test_forwardref_annotations.py
+tests/py314_tests/test_init_signature.py
+tests/py314_tests/test_init_signature_future.py

ducktools_classbuilder-0.10.2/tests/py314_tests/test_init_signature.py

@@ -0,0 +1,122 @@
+from annotationlib import get_annotations, Format
+
+import pytest
+
+
+from ducktools.classbuilder.prefab import Prefab, prefab
+from _test_support import EqualToForwardRef
+
+
+# Aliases for alias test
+assign_int = int
+type type_str = str
+
+
+@pytest.mark.parametrize(
+    ["format", "expected"],
+    [
+        (Format.VALUE, {"return": None, "x": str, "y": int}),
+        (Format.FORWARDREF, {"return": None, "x": str, "y": int}),
+        (Format.STRING, {"return": "None", "x": "str", "y": "int"}),
+    ]
+)
+def test_resolvable_annotations(format, expected):
+    @prefab
+    class Example:
+        x: str
+        y: int
+
+    annos = get_annotations(Example.__init__, format=format)
+
+    assert annos == expected
+
+    class Example(Prefab):
+        x: str
+        y: int
+
+    annos = get_annotations(Example.__init__, format=format)
+
+    assert annos == expected
+
+
+@pytest.mark.parametrize(
+    ["format", "expected"],
+    [
+        (Format.VALUE, {"return": None, "x": str, "y": int}),
+        (Format.FORWARDREF, {"return": None, "x": str, "y": int}),
+        (Format.STRING, {"return": "None", "x": "str", "y": "late_definition"}),
+    ]
+)
+def test_late_defined_annotations(format, expected):
+    # Test where the annotation is a forwardref at processing time
+    @prefab
+    class Example:
+        x: str
+        y: late_definition
+
+    late_definition = int
+
+    annos = get_annotations(Example.__init__, format=format)
+
+    assert annos == expected
+
+
+@pytest.mark.parametrize(
+    ["format", "expected"],
+    [
+        (Format.VALUE, {"return": None, "x": int, "y": type_str}),
+        (Format.FORWARDREF, {"return": None, "x": int, "y": type_str}),
+        (Format.STRING, {"return": "None", "x": "int", "y": "type_str"}),
+    ]
+)
+def test_alias_defined_annotations(format, expected):
+    # Test the behaviour of type aliases and regular types
+    # Type Alias names should be kept while regular assignments will be lost
+
+    @prefab
+    class Example:
+        x: assign_int  # type: ignore
+        y: type_str
+
+    annos = get_annotations(Example.__init__, format=format)
+
+    assert annos == expected
+
+
+@pytest.mark.parametrize(
+    ["format", "expected"],
+    [
+        (Format.FORWARDREF, {"return": None, "x": str, "y": EqualToForwardRef("undefined")}),
+        (Format.STRING, {"return": "None", "x": "str", "y": "undefined"}),
+    ]
+)
+def test_forwardref_annotation(format, expected):
+    # Test where the annotation is a forwardref at processing and analysis
+    class Example(Prefab):
+        x: str
+        y: undefined
+
+    annos = get_annotations(Example.__init__, format=format)
+
+    assert annos == expected
+
+
+def test_forwardref_raises():
+    # Should still raise a NameError with VALUE annotations
+    @prefab
+    class Example:
+        x: str
+        y: undefined
+
+    with pytest.raises(NameError):
+        annos = get_annotations(Example.__init__, format=Format.VALUE)
+
+
+def test_raises_with_fake_globals():
+    @prefab
+    class Example:
+        x: str
+        y: undefined
+
+    with pytest.raises(NotImplementedError):
+        annos = Example.__init__.__annotate__(Format.VALUE_WITH_FAKE_GLOBALS)

ducktools_classbuilder-0.10.2/tests/py314_tests/test_init_signature_future.py

@@ -0,0 +1,105 @@
+# The same tests as test_init_signature but under the __future__ annotations import
+from __future__ import annotations
+
+from annotationlib import get_annotations, Format
+
+import pytest
+
+
+from ducktools.classbuilder.prefab import Prefab, prefab
+from _test_support import EqualToForwardRef
+
+
+# Aliases for alias test
+assign_int = int
+type type_str = str
+
+
+@pytest.mark.parametrize(
+    ["format", "expected"],
+    [
+        (Format.VALUE, {"return": None, "x": "str", "y": "int"}),
+        (Format.FORWARDREF, {"return": None, "x": "str", "y": "int"}),
+        (Format.STRING, {"return": "None", "x": "str", "y": "int"}),
+    ]
+)
+def test_resolvable_annotations(format, expected):
+    @prefab
+    class Example:
+        x: str
+        y: int
+
+    annos = get_annotations(Example.__init__, format=format)
+
+    assert annos == expected
+
+    class Example(Prefab):
+        x: str
+        y: int
+
+    annos = get_annotations(Example.__init__, format=format)
+
+    assert annos == expected
+
+
+@pytest.mark.parametrize(
+    ["format", "expected"],
+    [
+        (Format.VALUE, {"return": None, "x": "str", "y": "late_definition"}),
+        (Format.FORWARDREF, {"return": None, "x": "str", "y": "late_definition"}),
+        (Format.STRING, {"return": "None", "x": "str", "y": "late_definition"}),
+    ]
+)
+def test_late_defined_annotations(format, expected):
+    # Test where the annotation is a forwardref at processing time
+    @prefab
+    class Example:
+        x: str
+        y: late_definition
+
+    late_definition = int
+
+    annos = get_annotations(Example.__init__, format=format)
+
+    assert annos == expected
+
+
+@pytest.mark.parametrize(
+    ["format", "expected"],
+    [
+        (Format.VALUE, {"return": None, "x": "assign_int", "y": "type_str"}),
+        (Format.FORWARDREF, {"return": None, "x": "assign_int", "y": "type_str"}),
+        (Format.STRING, {"return": "None", "x": "assign_int", "y": "type_str"}),
+    ]
+)
+def test_alias_defined_annotations(format, expected):
+    # Test the behaviour of type aliases and regular types
+    # under __future__ annotations both should be kept
+
+    @prefab
+    class Example:
+        x: assign_int  # type: ignore
+        y: type_str
+
+    annos = get_annotations(Example.__init__, format=format)
+
+    assert annos == expected
+
+
+@pytest.mark.parametrize(
+    ["format", "expected"],
+    [
+        (Format.VALUE, {"return": None, "x": "str", "y": "undefined"}),
+        (Format.FORWARDREF, {"return": None, "x": "str", "y": "undefined"}),
+        (Format.STRING, {"return": "None", "x": "str", "y": "undefined"}),
+    ]
+)
+def test_forwardref_annotation(format, expected):
+    # Test where the annotation is a forwardref at processing and analysis
+    class Example(Prefab):
+        x: str
+        y: undefined
+
+    annos = get_annotations(Example.__init__, format=format)
+
+    assert annos == expected

ducktools_classbuilder-0.10.1/src/ducktools/classbuilder/_version.py

@@ -1,2 +0,0 @@
-__version__ = "0.10.1"
-__version_tuple__ = (0, 10, 1)