ducktools-classbuilder 0.8.4__tar.gz → 0.9.1__tar.gz

{ducktools_classbuilder-0.8.4 → ducktools_classbuilder-0.9.1}/.github/workflows/auto_test.yml

@@ -14,7 +14,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest]
-        python-version: ["3.14-dev", "3.13", "3.12", "3.11", "3.10", "pypy-3.10", "3.9", "3.8"]
+        python-version: ["3.14-dev", "3.13", "3.12", "3.11", "pypy-3.11", "3.10", "3.9", "3.8"]
 
     steps:
     - uses: actions/checkout@v4

{ducktools_classbuilder-0.8.4 → ducktools_classbuilder-0.9.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ducktools-classbuilder
-Version: 0.8.4
+Version: 0.9.1
 Summary: Toolkit for creating class boilerplate generators
 Author: David C Ellis
 Project-URL: Homepage, https://github.com/davidcellis/ducktools-classbuilder
@@ -11,6 +11,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Operating System :: OS Independent
 Classifier: License :: OSI Approved :: MIT License
 Requires-Python: >=3.8

{ducktools_classbuilder-0.8.4 → ducktools_classbuilder-0.9.1}/pyproject.toml

@@ -21,6 +21,7 @@ classifiers = [
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
     "Operating System :: OS Independent",
     "License :: OSI Approved :: MIT License",
 ]
@@ -37,7 +38,10 @@ where = ["src"]
 
 [tool.setuptools_scm]
 version_file = "src/ducktools/classbuilder/_version.py"
-version_file_template = "__version__ = \"{version}\"\n__version_tuple__ = {version_tuple}\n"
+version_file_template = """
+__version__ = "{version}"
+__version_tuple__ = {version_tuple}
+"""
 
 [project.urls]
 "Homepage" = "https://github.com/davidcellis/ducktools-classbuilder"

{ducktools_classbuilder-0.8.4 → ducktools_classbuilder-0.9.1}/src/ducktools/classbuilder/__init__.py

@@ -47,7 +47,7 @@ _UNDER_TESTING = os.environ.get("PYTEST_VERSION") is not None
 # Obtain types the same way types.py does in pypy
 # See: https://github.com/pypy/pypy/blob/19d9fa6be11165116dd0839b9144d969ab426ae7/lib-python/3/types.py#L61-L73
 class _C: __slots__ = 's'  # noqa
-_MemberDescriptorType = type(_C.s)  # noqa
+_MemberDescriptorType = type(_C.s)  # type: ignore
 _MappingProxyType = type(type.__dict__)
 del _C
 
@@ -385,6 +385,36 @@ def eq_generator(cls, funcname="__eq__"):
     return GeneratedCode(code, globs)
 
 
+def replace_generator(cls, funcname="__replace__"):
+    # Generate the replace method for built classes
+    # unlike the dataclasses implementation this is generated
+    attribs = get_fields(cls)
+    
+    # This is essentially the as_dict generator for prefabs
+    # except based on attrib.init instead of .serialize
+    vals = ", ".join(
+        f"'{name}': self.{name}"
+        for name, attrib in attribs.items()
+        if attrib.init
+    )
+    init_dict = f"{{{vals}}}"
+
+    code = (
+        f"def {funcname}(self, /, **changes):\n"
+        f"    new_kwargs = {init_dict}\n"
+        f"    for name, value in changes.items():\n"
+        f"        if name not in new_kwargs:\n"    
+        f"            raise TypeError(\n"
+        f"                f\"{{name!r}} is not a valid replacable \"\n"
+        f"                f\"field on {{self.__class__.__name__!r}}\"\n"
+        f"            )\n"
+        f"        new_kwargs[name] = value\n"
+        f"    return self.__class__(**new_kwargs)\n"
+    )
+    globs = {}
+    return GeneratedCode(code, globs)
+
+
 def frozen_setattr_generator(cls, funcname="__setattr__"):
     globs = {}
     field_names = set(get_fields(cls))
@@ -433,6 +463,7 @@ def frozen_delattr_generator(cls, funcname="__delattr__"):
 init_maker = MethodMaker("__init__", init_generator)
 repr_maker = MethodMaker("__repr__", repr_generator)
 eq_maker = MethodMaker("__eq__", eq_generator)
+replace_maker = MethodMaker("__replace__", replace_generator)
 frozen_setattr_maker = MethodMaker("__setattr__", frozen_setattr_generator)
 frozen_delattr_maker = MethodMaker("__delattr__", frozen_delattr_generator)
 default_methods = frozenset({init_maker, repr_maker, eq_maker})
@@ -961,24 +992,6 @@ def slotclass(cls=None, /, *, methods=default_methods, syntax_check=True):
     return cls
 
 
-class AnnotationClass(metaclass=SlotMakerMeta):
-    __slots__ = {}
-
-    def __init_subclass__(
-            cls,
-            methods=default_methods,
-            gatherer=unified_gatherer,
-            **kwargs
-    ):
-        # Check class dict otherwise this will always be True as this base
-        # class uses slots.
-        slots = "__slots__" in cls.__dict__
-
-        builder(cls, gatherer=gatherer, methods=methods, flags={"slotted": slots})
-        check_argument_order(cls)
-        super().__init_subclass__(**kwargs)
-
-
 @slotclass
 class GatheredFields:
     """

{ducktools_classbuilder-0.8.4 → ducktools_classbuilder-0.9.1}/src/ducktools/classbuilder/__init__.pyi

@@ -5,7 +5,6 @@ import inspect
 
 from collections.abc import Callable
 from types import MappingProxyType
-from typing_extensions import dataclass_transform
 
 _py_type = type | str  # Alias for type hint values
 _CopiableMappings = dict[str, typing.Any] | MappingProxyType[str, typing.Any]
@@ -74,6 +73,7 @@ def get_repr_generator(
 ) -> _CodegenType: ...
 def repr_generator(cls: type, funcname: str = "__repr__") -> GeneratedCode: ...
 def eq_generator(cls: type, funcname: str = "__eq__") -> GeneratedCode: ...
+def replace_generator(cls: type, funcname: str = "__replace__") -> GeneratedCode: ...
 
 def frozen_setattr_generator(cls: type, funcname: str = "__setattr__") -> GeneratedCode: ...
 
@@ -82,6 +82,7 @@ def frozen_delattr_generator(cls: type, funcname: str = "__delattr__") -> Genera
 init_maker: MethodMaker
 repr_maker: MethodMaker
 eq_maker: MethodMaker
+replace_maker: MethodMaker
 frozen_setattr_maker: MethodMaker
 frozen_delattr_maker: MethodMaker
 default_methods: frozenset[MethodMaker]
@@ -244,18 +245,6 @@ def slotclass(
 
 _gatherer_type = Callable[[type | _CopiableMappings], tuple[dict[str, Field], dict[str, typing.Any]]]
 
-
-@dataclass_transform(field_specifiers=(Field,))
-class AnnotationClass(metaclass=SlotMakerMeta):
-    __slots__: dict
-
-    def __init_subclass__(
-        cls,
-        methods: frozenset[MethodMaker] | set[MethodMaker] = default_methods,
-        gatherer: _gatherer_type = unified_gatherer,
-        **kwargs,
-    ) -> None: ...
-
 class GatheredFields:
     __slots__: dict[str, None]
 

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

@@ -0,0 +1,2 @@
+__version__ = "0.9.1"
+__version_tuple__ = (0, 9, 1)

{ducktools_classbuilder-0.8.4 → ducktools_classbuilder-0.9.1}/src/ducktools/classbuilder/annotations.py

@@ -25,7 +25,7 @@ import sys
 class _LazyAnnotationLib:
     def __getattr__(self, item):
         global _lazyannotationlib
-        import annotationlib  # type: ignore - this is a Python 3.14 library
+        import annotationlib  # type: ignore
         _lazyannotationlib = annotationlib
         return getattr(annotationlib, item)
 

{ducktools_classbuilder-0.8.4 → ducktools_classbuilder-0.9.1}/src/ducktools/classbuilder/prefab.py

@@ -30,7 +30,7 @@ from . import (
     Field, MethodMaker, GatheredFields, GeneratedCode, SlotMakerMeta,
     builder, get_flags, get_fields,
     make_unified_gatherer,
-    frozen_setattr_maker, frozen_delattr_maker, eq_maker,
+    eq_maker, frozen_setattr_maker, frozen_delattr_maker, replace_maker,
     get_repr_generator,
 )
 
@@ -294,7 +294,7 @@ class Attribute(Field):
     """
     iter: bool = True
     serialize: bool = True
-    metadata: dict = Field(default=FIELD_NOTHING, default_factory=dict)
+    metadata: dict = Field(default=FIELD_NOTHING, default_factory=dict)  # type: ignore
 
 
 # noinspection PyShadowingBuiltins
@@ -441,6 +441,8 @@ def _make_prefab(
     if dict_method:
         methods.add(asdict_maker)
 
+    methods.add(replace_maker)
+
     flags = {
         "kw_only": kw_only,
         "slotted": slotted,
@@ -551,7 +553,7 @@ def _make_prefab(
 
 class Prefab(metaclass=SlotMakerMeta):
     _meta_gatherer = prefab_gatherer
-    __slots__ = {}
+    __slots__ = {}  # type: ignore
 
     # noinspection PyShadowingBuiltins
     def __init_subclass__(
@@ -779,3 +781,8 @@ def as_dict(o):
         for name, attrib in flds.items()
         if attrib.serialize
     }
+
+def replace(obj, /, **changes):
+    if not is_prefab_instance(obj):
+        raise TypeError("replace() should be called on prefab instances")
+    return obj.__replace__(**changes)

{ducktools_classbuilder-0.8.4 → ducktools_classbuilder-0.9.1}/src/ducktools/classbuilder/prefab.pyi

@@ -4,7 +4,8 @@ from typing_extensions import dataclass_transform
 
 import inspect
 
-from collections.abc import Callable
+# Suppress weird pylance error
+from collections.abc import Callable  # type: ignore
 
 from . import (
     NOTHING,
@@ -58,36 +59,73 @@ class Attribute(Field):
         default: typing.Any | _NothingType = NOTHING,
         default_factory: typing.Any | _NothingType = NOTHING,
         type: type | _NothingType = NOTHING,
-        doc: str | None = None,
-        init: bool = True,
-        repr: bool = True,
-        compare: bool = True,
-        iter: bool = True,
-        kw_only: bool = False,
-        serialize: bool = True,
-        metadata: dict | None = None,
+        doc: str | None = ...,
+        init: bool = ...,
+        repr: bool = ...,
+        compare: bool = ...,
+        iter: bool = ...,
+        kw_only: bool = ...,
+        serialize: bool = ...,
+        metadata: dict | None = ...,
     ) -> None: ...
 
     def __repr__(self) -> str: ...
     def __eq__(self, other: Attribute | object) -> bool: ...
     def validate_field(self) -> None: ...
 
+@typing.overload
 def attribute(
     *,
-    default: typing.Any | _NothingType = NOTHING,
-    default_factory: typing.Any | _NothingType = NOTHING,
-    init: bool = True,
-    repr: bool = True,
-    compare: bool = True,
-    iter: bool = True,
-    kw_only: bool = False,
-    serialize: bool = True,
-    exclude_field: bool = False,
-    private: bool = False,
-    doc: str | None = None,
-    metadata: dict | None = None,
-    type: type | _NothingType = NOTHING,
-) -> Attribute: ...
+    default: _T,
+    default_factory: _NothingType = NOTHING,
+    init: bool = ...,
+    repr: bool = ...,
+    compare: bool = ...,
+    iter: bool = ...,
+    kw_only: bool = ...,
+    serialize: bool = ...,
+    exclude_field: bool = ...,
+    private: bool = ...,
+    doc: str | None = ...,
+    metadata: dict | None = ...,
+    type: type | _NothingType = ...,
+) -> _T: ...
+
+@typing.overload
+def attribute(
+    *,
+    default: _NothingType = NOTHING,
+    default_factory: Callable[[], _T],
+    init: bool = ...,
+    repr: bool = ...,
+    compare: bool = ...,
+    iter: bool = ...,
+    kw_only: bool = ...,
+    serialize: bool = ...,
+    exclude_field: bool = ...,
+    private: bool = ...,
+    doc: str | None = ...,
+    metadata: dict | None = ...,
+    type: type | _NothingType = ...,
+) -> _T: ...
+
+@typing.overload
+def attribute(
+    *,
+    default: _NothingType = NOTHING,
+    default_factory: _NothingType = NOTHING,
+    init: bool = ...,
+    repr: bool = ...,
+    compare: bool = ...,
+    iter: bool = ...,
+    kw_only: bool = ...,
+    serialize: bool = ...,
+    exclude_field: bool = ...,
+    private: bool = ...,
+    doc: str | None = ...,
+    metadata: dict | None = ...,
+    type: type | _NothingType = ...,
+) -> typing.Any: ...
 
 def prefab_gatherer(cls_or_ns: type | MappingProxyType) -> tuple[dict[str, Attribute], dict[str, typing.Any]]: ...
 
@@ -111,7 +149,8 @@ _T = typing.TypeVar("_T")
 # noinspection PyUnresolvedReferences
 @dataclass_transform(field_specifiers=(Attribute, attribute))
 class Prefab(metaclass=SlotMakerMeta):
-    _meta_gatherer: Callable[[type | _CopiableMappings], tuple[dict[str, Field], dict[str, typing.Any]]]
+    _meta_gatherer: Callable[[type | _CopiableMappings], tuple[dict[str, Field], dict[str, typing.Any]]] = ...
+    __slots__: dict[str, typing.Any] = ...
     def __init_subclass__(
         cls,
         init: bool = True,
@@ -199,3 +238,5 @@ def is_prefab(o: typing.Any) -> bool: ...
 def is_prefab_instance(o: object) -> bool: ...
 
 def as_dict(o) -> dict[str, typing.Any]: ...
+
+def replace(obj: _T, /, **changes: typing.Any) -> _T: ...

{ducktools_classbuilder-0.8.4 → ducktools_classbuilder-0.9.1}/src/ducktools_classbuilder.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ducktools-classbuilder
-Version: 0.8.4
+Version: 0.9.1
 Summary: Toolkit for creating class boilerplate generators
 Author: David C Ellis
 Project-URL: Homepage, https://github.com/davidcellis/ducktools-classbuilder
@@ -11,6 +11,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Operating System :: OS Independent
 Classifier: License :: OSI Approved :: MIT License
 Requires-Python: >=3.8

{ducktools_classbuilder-0.8.4 → ducktools_classbuilder-0.9.1}/src/ducktools_classbuilder.egg-info/SOURCES.txt

@@ -49,6 +49,7 @@ tests/test_slotmakermeta.py
 tests/annotations/test_annotated.py
 tests/annotations/test_annotations_module.py
 tests/annotations/test_future_annotations.py
+tests/prefab/test_replace.py
 tests/prefab/dynamic/test_compare_attrib.py
 tests/prefab/dynamic/test_construction.py
 tests/prefab/dynamic/test_frozen.py

{ducktools_classbuilder-0.8.4 → ducktools_classbuilder-0.9.1}/tests/annotations/test_annotated.py

@@ -4,14 +4,13 @@ does not interfere when wrapping ClassVar
 """
 
 import sys
-import pytest
 
 from typing import ClassVar
 from typing_extensions import Annotated
 
 from ducktools.classbuilder import (
     Field, SlotFields, NOTHING,
-    AnnotationClass, annotation_gatherer, make_annotation_gatherer
+    annotation_gatherer, make_annotation_gatherer
 )
 
 from ducktools.classbuilder.annotations import (
@@ -102,43 +101,3 @@ def test_make_annotation_gatherer():
     for key in "defgh":
         assert key not in annos
         assert key not in modifications
-
-
-def test_annotationclass():
-    class ExampleAnnotated(AnnotationClass, slots=False):
-        a: str = "a"
-        b: "list[str]" = "b"
-        c: Annotated[str, ""] = Field(default="c")
-
-        d: ClassVar[str] = "d"
-        e: Annotated[ClassVar[str], ""] = "e"
-        f: "Annotated[ClassVar[str], '']" = "f"
-        g: Annotated[Annotated[ClassVar[str], ""], ""] = "g"
-        h: Annotated[CV[str], ''] = "h"
-
-    for key in "abc":
-        assert key not in ExampleAnnotated.__dict__
-
-    for key in "defgh":
-        assert key in ExampleAnnotated.__dict__
-
-    ex = ExampleAnnotated()
-    for char in "abcdefgh":
-        assert getattr(ex, char) == char
-
-    ex2 = ExampleAnnotated()
-    ex3 = ExampleAnnotated("i", "j", "k")
-
-    assert ex == ex2
-    assert ex != ex3
-
-    prefix = "test_annotationclass.<locals>."
-    assert repr(ex) == f"{prefix}ExampleAnnotated(a='a', b='b', c='c')"
-
-
-def test_annotated_syntax_error():
-    with pytest.raises(SyntaxError):
-        class ExampleAnnotated(AnnotationClass):
-            a: str = "a"  # noqa: the error being highlighted is the error we are testing.
-            b: "list[str]"
-            c: Annotated[str, ""] = Field(default="c")

{ducktools_classbuilder-0.8.4 → ducktools_classbuilder-0.9.1}/tests/prefab/dynamic/test_subclass_implementation.py

@@ -2,7 +2,7 @@ import inspect
 
 import pytest
 
-from ducktools.classbuilder.prefab import Prefab, Attribute, SlotFields
+from ducktools.classbuilder.prefab import Prefab, Attribute, SlotFields, get_attributes
 
 
 class TestConstructionForms:
@@ -178,3 +178,49 @@ class TestClassArguments:
         assert params['a'].kind == inspect.Parameter.KEYWORD_ONLY
         assert params['b'].kind == inspect.Parameter.KEYWORD_ONLY
         assert params['b'].default == 1
+
+
+def test_slots_weakref():
+    import weakref
+
+    class WeakrefClass(Prefab):
+        a: int = 1
+        b: int = 2
+        __weakref__: dict
+
+    flds = get_attributes(WeakrefClass)
+    assert 'a' in flds
+    assert 'b' in flds
+    assert '__weakref__' not in flds
+
+    slots = WeakrefClass.__slots__
+    assert 'a' in slots
+    assert 'b' in slots
+    assert '__weakref__' in slots
+
+    # Test weakrefs can be created
+    inst = WeakrefClass()
+    ref = weakref.ref(inst)
+    assert ref == inst.__weakref__
+
+
+def test_has_dict():
+    class DictClass(Prefab):
+        a: int = 1
+        b: int = 2
+        __dict__: dict
+
+    flds = get_attributes(DictClass)
+    assert 'a' in flds
+    assert 'b' in flds
+    assert '__dict__' not in flds
+
+    slots = DictClass.__slots__
+    assert 'a' in slots
+    assert 'b' in slots
+    assert '__dict__' in slots
+
+    # Test if __dict__ is included new values can be added
+    inst = DictClass()
+    inst.c = 42
+    assert inst.__dict__ == {"c": 42}

ducktools_classbuilder-0.9.1/tests/prefab/test_replace.py

@@ -0,0 +1,65 @@
+from __future__ import annotations
+
+import copy
+import sys
+
+import pytest
+
+from ducktools.classbuilder.prefab import (
+    Prefab, 
+    attribute, 
+    prefab, 
+    replace as prefab_replace,
+)
+
+
+replace_funcs = [prefab_replace]
+if sys.version_info >= (3, 13):  # 3.13 test against the copy version too
+    replace_funcs.append(copy.replace)  # type: ignore
+
+
+def ex_classes() -> tuple[type, type]:
+    @prefab
+    class ExDecorator:
+        a: int = 1
+        b: str = "Why?"
+        c: str = attribute(default="Non-replacable", init=False)
+
+    class ExBaseClass(Prefab):
+        a: int = 1
+        b: str = "Why?"
+        c: str = attribute(default="Non-replacable", init=False)
+
+    return ExDecorator, ExBaseClass
+
+example_classes = ex_classes()
+
+
+@pytest.mark.parametrize("replace", replace_funcs)
+@pytest.mark.parametrize("ex_class", example_classes)
+def test_replace_decorator(ex_class, replace):
+    ex = ex_class()
+
+    assert ex.a == 1
+    assert ex.b == "Why?"
+    assert ex.c == "Non-replacable"
+
+    ex_r = replace(ex, a=42)
+
+    assert ex != ex_r
+
+    assert ex_r.a == 42
+    assert ex_r.b == "Why?"
+    assert ex_r.c == "Non-replacable"
+
+
+@pytest.mark.parametrize("replace", replace_funcs)
+@pytest.mark.parametrize("ex_class", example_classes)
+def test_replace_fail(ex_class, replace):
+    ex = ex_class()
+
+    with pytest.raises(TypeError):
+        replace(ex, c="Fails")
+
+    with pytest.raises(TypeError):
+        replace(ex, d="Does Not Exist")

{ducktools_classbuilder-0.8.4 → ducktools_classbuilder-0.9.1}/tests/test_core.py

@@ -19,7 +19,6 @@ from ducktools.classbuilder import (
     slot_gatherer,
     slotclass,
 
-    AnnotationClass,
     Field,
     GatheredFields,
     GeneratedCode,
@@ -371,30 +370,6 @@ def test_slotclass_weakref():
     assert ref == inst.__weakref__
 
 
-def test_annotationclass_weakref():
-    import weakref
-
-    class WeakrefClass(AnnotationClass):
-        a: int = 1
-        b: int = 2
-        __weakref__: dict
-
-    flds = get_fields(WeakrefClass)
-    assert 'a' in flds
-    assert 'b' in flds
-    assert '__weakref__' not in flds
-
-    slots = WeakrefClass.__slots__
-    assert 'a' in slots
-    assert 'b' in slots
-    assert '__weakref__' in slots
-
-    # Test weakrefs can be created
-    inst = WeakrefClass()
-    ref = weakref.ref(inst)
-    assert ref == inst.__weakref__
-
-
 def test_slotclass_dict():
     @slotclass
     class DictClass:
@@ -420,28 +395,6 @@ def test_slotclass_dict():
     assert inst.__dict__ == {"c": 42}
 
 
-def test_annotationclass_dict():
-    class DictClass(AnnotationClass):
-        a: int = 1
-        b: int = 2
-        __dict__: dict
-
-    flds = get_fields(DictClass)
-    assert 'a' in flds
-    assert 'b' in flds
-    assert '__dict__' not in flds
-
-    slots = DictClass.__slots__
-    assert 'a' in slots
-    assert 'b' in slots
-    assert '__dict__' in slots
-
-    # Test if __dict__ is included new values can be added
-    inst = DictClass()
-    inst.c = 42
-    assert inst.__dict__ == {"c": 42}
-
-
 def test_fieldclass():
     class NewField(Field):
         serialize: bool = True

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

@@ -1,2 +0,0 @@
-__version__ = "0.8.4"
-__version_tuple__ = (0, 8, 4)