ducktools-classbuilder 0.6.3__py3-none-any.whl → 0.7.1__py3-none-any.whl

ducktools/classbuilder/__init__.py

@@ -30,11 +30,10 @@
 # but is also the metaclass used to construct 'Field'.
 # Field itself sidesteps this by defining __slots__ to avoid that branch.
 
-import sys
+import os
 
 from .annotations import get_ns_annotations, is_classvar
-
-__version__ = "v0.6.3"
+from ._version import __version__, __version_tuple__
 
 # Change this name if you make heavy modifications
 INTERNALS_DICT = "__classbuilder_internals__"
@@ -43,7 +42,7 @@ META_GATHERER_NAME = "_meta_gatherer"
 
 # If testing, make Field classes frozen to make sure attributes are not
 # overwritten. When running this is a performance penalty so it is not required.
-_UNDER_TESTING = "pytest" in sys.modules
+_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
@@ -708,10 +707,6 @@ def make_slot_gatherer(field_type=Field):
                 "in order to generate a slotclass"
             )
 
-        # Don't want to mutate original annotations so make a copy if it exists
-        # Looking at the dict is a Python3.9 or earlier requirement
-        cls_annotations = get_ns_annotations(cls_dict)
-
         cls_fields = {}
         slot_replacement = {}
 
@@ -725,8 +720,6 @@ def make_slot_gatherer(field_type=Field):
 
             if isinstance(v, field_type):
                 attrib = v
-                if attrib.type is not NOTHING:
-                    cls_annotations[k] = attrib.type
             else:
                 # Plain values treated as defaults
                 attrib = field_type(default=v)
@@ -739,7 +732,6 @@ def make_slot_gatherer(field_type=Field):
         # In this case, slots with documentation and new annotations.
         modifications = {
             "__slots__": slot_replacement,
-            "__annotations__": cls_annotations,
         }
 
         return cls_fields, modifications

ducktools/classbuilder/__init__.pyi

@@ -11,6 +11,7 @@ _py_type = type | str  # Alias for type hint values
 _CopiableMappings = dict[str, typing.Any] | MappingProxyType[str, typing.Any]
 
 __version__: str
+__version_tuple__: tuple[str | int, ...]
 INTERNALS_DICT: str
 META_GATHERER_NAME: str
 

ducktools/classbuilder/_version.py

@@ -0,0 +1,2 @@
+__version__ = "0.7.1"
+__version_tuple__ = (0, 7, 1)

ducktools/classbuilder/annotations.py

@@ -24,6 +24,19 @@ import sys
 import builtins
 
 
+# Evil stuff from types.py
+def _cell_factory():
+    a = 1
+
+    def f():
+        nonlocal a
+    return f.__closure__[0]
+_FunctionType = type(_cell_factory)
+_CellType = type(_cell_factory())
+del _cell_factory
+# End evil stuff from types.py
+
+
 class _StringGlobs(dict):
     """
     Based on the fake globals dictionary used for annotations
@@ -99,6 +112,62 @@ def eval_hint(hint, context=None, *, recursion_limit=2):
     return hint
 
 
+def call_annotate_func(annotate):
+    # Python 3.14 breaks the old methods of getting annotations
+    # The new annotationlib currently relies on 'ast' and 'functools'
+    # that this project tries to avoid importing.
+
+    # The basic logic is copied from there, however, replacing ForwardRef
+    # with a more basic class.
+    # While `annotationlib` is trying to return ForwardRef objects that can
+    # be evaluated later, this module only cares about annotations that can
+    # be evaluated at the point this function is called.
+    # As such we throw away the other information and just return strings
+    # instead of forwardrefs.
+
+    try:
+        raw_annotations = annotate(1)
+    except NameError:
+        pass
+    else:
+        return raw_annotations
+
+    # The annotate func may support forwardref natively
+    try:
+        raw_annotations = annotate(2)
+    except NotImplementedError:
+        pass
+    else:
+        return raw_annotations
+
+    # Not supported so we have to implement our own deferred handling
+    # Some modified logic from annotationlib
+    namespace = {**annotate.__builtins__, **annotate.__globals__}
+    globs = _StringGlobs(namespace)
+
+    # This handles closures where the variable is defined after get annotations is called.
+    if annotate.__closure__:
+        freevars = annotate.__code__.co_freevars
+        new_closure = []
+        for i, cell in enumerate(annotate.__closure__):
+            try:
+                cell.cell_contents
+            except ValueError:
+                if i < len(freevars):
+                    name = freevars[i]
+                else:
+                    name = "__cell__"
+                new_closure.append(_CellType(name))
+            else:
+                new_closure.append(cell)
+        closure = tuple(new_closure)
+    else:
+        closure = None
+
+    new_annotate = _FunctionType(annotate.__code__, globs, closure=closure)
+    return new_annotate(1)
+
+
 def get_ns_annotations(ns, eval_str=True):
     """
     Given a class namespace, attempt to retrieve the
@@ -112,36 +181,50 @@ def get_ns_annotations(ns, eval_str=True):
     :param eval_str: Attempt to evaluate string annotations (default to True)
     :return: dictionary of evaluated annotations
     """
-    raw_annotations = ns.get("__annotations__", {})
 
-    if not eval_str:
-        return raw_annotations.copy()
+    # In 3.14 the 'canonical' method of getting annotations is to use __annotate__
+    # If this doesn't exist, check __annotations__ and treat as 3.13 or earlier.
+    annotate = ns.get("__annotate__")
 
-    try:
-        obj_modulename = ns["__module__"]
-    except KeyError:
-        obj_module = None
+    if annotate is not None:
+        raw_annotations = call_annotate_func(annotate)
     else:
-        obj_module = sys.modules.get(obj_modulename, None)
+        raw_annotations = ns.get("__annotations__", {})
 
-    if obj_module:
-        obj_globals = vars(obj_module)
-    else:
-        obj_globals = {}
+    # Unlike annotationlib we still try to evaluate string annotations
+    # This will catch cases where someone has used a literal string for a
+    # single attribute.
+    if eval_str:
+        try:
+            obj_modulename = ns["__module__"]
+        except KeyError:
+            obj_module = None
+        else:
+            obj_module = sys.modules.get(obj_modulename, None)
+
+        if obj_module:
+            obj_globals = vars(obj_module)
+        else:
+            obj_globals = {}
 
-    # Type parameters should be usable in hints without breaking
-    # This is for Python 3.12+
-    type_params = {
-        repr(param): param
-        for param in ns.get("__type_params__", ())
-    }
+        # Type parameters should be usable in hints without breaking
+        # This is for Python 3.12+
+        type_params = {
+            repr(param): param
+            for param in ns.get("__type_params__", ())
+        }
 
-    context = {**vars(builtins), **obj_globals, **type_params, **ns}
+        context = {**vars(builtins), **obj_globals, **type_params, **ns}
+
+        annotations = {
+            k: eval_hint(v, context)
+            for k, v in raw_annotations.items()
+        }
+
+    else:
+        annotations = raw_annotations.copy()
 
-    return {
-        k: eval_hint(v, context)
-        for k, v in raw_annotations.items()
-    }
+    return annotations
 
 
 def is_classvar(hint):

ducktools/classbuilder/annotations.pyi

@@ -1,3 +1,4 @@
+from collections.abc import Callable
 import typing
 import types
 
@@ -8,6 +9,11 @@ class _StringGlobs(dict):
     def __missing__(self, key: _T) -> _T: ...
 
 
+def call_annotate_func(
+        annotate: Callable[[int], dict[str, type | typing.ForwardRef]]
+) -> dict[str, type | str]: ...
+
+
 def eval_hint(
     hint: type | str,
     context: None | dict[str, typing.Any] = None,

ducktools/classbuilder/prefab.py

@@ -241,12 +241,24 @@ def as_dict_generator(cls, funcname="as_dict"):
         if attrib.serialize
     )
     out_dict = f"{{{vals}}}"
-    code = f"def {funcname}(self): return {out_dict}"
+    code = f"def {funcname}(self): return {out_dict}\n"
 
     globs = {}
     return GeneratedCode(code, globs)
 
 
+def hash_generator(cls, funcname="__hash__"):
+    fields = get_attributes(cls)
+    vals = ", ".join(
+        f"self.{name}"
+        for name, attrib in fields.items()
+        if attrib.compare
+    )
+    code = f"def {funcname}(self): return hash(({vals}))\n"
+    globs = {}
+    return GeneratedCode(code, globs)
+
+
 init_maker = MethodMaker("__init__", init_generator)
 prefab_init_maker = MethodMaker(PREFAB_INIT_FUNC, init_generator)
 repr_maker = MethodMaker(
@@ -259,6 +271,7 @@ recursive_repr_maker = MethodMaker(
 )
 iter_maker = MethodMaker("__iter__", iter_generator)
 asdict_maker = MethodMaker("as_dict", as_dict_generator)
+hash_maker = MethodMaker("__hash__", hash_generator)
 
 
 # Updated field with additional attributes
@@ -419,6 +432,7 @@ def _make_prefab(
     if frozen:
         methods.add(frozen_setattr_maker)
         methods.add(frozen_delattr_maker)
+        methods.add(hash_maker)
     if dict_method:
         methods.add(asdict_maker)
 

ducktools/classbuilder/prefab.pyi

@@ -33,6 +33,7 @@ def get_attributes(cls: type) -> dict[str, Attribute]: ...
 def init_generator(cls: type, funcname: str = "__init__") -> GeneratedCode: ...
 def iter_generator(cls: type, funcname: str = "__iter__") -> GeneratedCode: ...
 def as_dict_generator(cls: type, funcname: str = "as_dict") -> GeneratedCode: ...
+def hash_generator(cls: type, funcname: str = "__hash__") -> GeneratedCode: ...
 
 init_maker: MethodMaker
 prefab_init_maker: MethodMaker
@@ -41,6 +42,7 @@ recursive_repr_maker: MethodMaker
 eq_maker: MethodMaker
 iter_maker: MethodMaker
 asdict_maker: MethodMaker
+hash_maker: MethodMaker
 
 class Attribute(Field):
     __slots__: dict

{ducktools_classbuilder-0.6.3.dist-info → ducktools_classbuilder-0.7.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ducktools-classbuilder
-Version: 0.6.3
+Version: 0.7.1
 Summary: Toolkit for creating class boilerplate generators
 Author: David C Ellis
 License: MIT License
@@ -32,6 +32,7 @@ Classifier: Programming Language :: Python :: 3.9
 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: Operating System :: OS Independent
 Classifier: License :: OSI Approved :: MIT License
 Requires-Python: >=3.8
@@ -45,7 +46,7 @@ Provides-Extra: performance_tests
 Requires-Dist: attrs ; extra == 'performance_tests'
 Requires-Dist: pydantic ; extra == 'performance_tests'
 Provides-Extra: testing
-Requires-Dist: pytest ; extra == 'testing'
+Requires-Dist: pytest >=8.2 ; extra == 'testing'
 Requires-Dist: pytest-cov ; extra == 'testing'
 Requires-Dist: mypy ; extra == 'testing'
 Requires-Dist: typing-extensions ; extra == 'testing'

ducktools_classbuilder-0.7.1.dist-info/RECORD

@@ -0,0 +1,13 @@
+ducktools/classbuilder/__init__.py,sha256=oT-U127MZ2xVXTaaCmH02Mxh1JhnQ65pkydcd2otqhc,32517
+ducktools/classbuilder/__init__.pyi,sha256=NCLMWT3G0Z5lJky8EV_N6XcW8smScti6y2p163nZ8rM,7965
+ducktools/classbuilder/_version.py,sha256=GkzZtP41uShUoMdcKAWBkfQEBwmWhBFNXQ0WU1xWj5c,52
+ducktools/classbuilder/annotations.py,sha256=x-3936HcJzv04rga8k0fFTbu1656yDglVN6kCan4hiw,8203
+ducktools/classbuilder/annotations.pyi,sha256=vW3YQIiKYYQJll9_B4oTkBwIh4nOy1AnU9Ny8_a0dRY,686
+ducktools/classbuilder/prefab.py,sha256=6YOVVYYeuMF5gv9DnK-sCvNKxBaBoqDXNLUQ22-xINk,24097
+ducktools/classbuilder/prefab.pyi,sha256=x2ioTpkhNjQXFeKABFOzE0xNeZ8f_W5vusmuAzE19mc,4491
+ducktools/classbuilder/py.typed,sha256=la67KBlbjXN-_-DfGNcdOcjYumVpKG_Tkw-8n5dnGB4,8
+ducktools_classbuilder-0.7.1.dist-info/LICENSE.md,sha256=6Thz9Dbw8R4fWInl6sGl8Rj3UnKnRbDwrc6jZerpugQ,1070
+ducktools_classbuilder-0.7.1.dist-info/METADATA,sha256=Jo1LiPtmH3i5Z5N4QpjZkqtXAf59jYGbs1uVzMSCmLQ,10968
+ducktools_classbuilder-0.7.1.dist-info/WHEEL,sha256=R0nc6qTxuoLk7ShA2_Y-UWkN8ZdfDBG2B6Eqpz2WXbs,91
+ducktools_classbuilder-0.7.1.dist-info/top_level.txt,sha256=uSDLtio3ZFqdwcsMJ2O5yhjB4Q3ytbBWbA8rJREganc,10
+ducktools_classbuilder-0.7.1.dist-info/RECORD,,

{ducktools_classbuilder-0.6.3.dist-info → ducktools_classbuilder-0.7.1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (70.3.0)
+Generator: setuptools (72.1.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

ducktools_classbuilder-0.6.3.dist-info/RECORD

@@ -1,12 +0,0 @@
-ducktools/classbuilder/__init__.py,sha256=cU3AdLjUWlYA_yUo5uMv2CyrzYNbnnZogsOVAmCn-Dw,32820
-ducktools/classbuilder/__init__.pyi,sha256=JaAfc6y4Jj920y4lm9peduNXeb9XUJwKN-QqFpqG5pw,7924
-ducktools/classbuilder/annotations.py,sha256=17g1WnWfyMWBHKQp2HD_hvV-n7CKXy_zv8NTODpOsuU,5437
-ducktools/classbuilder/annotations.pyi,sha256=cTZQ-pp2IkfdvwHiU3pIySUzzBKxfOtO-e5PkA8TNwo,520
-ducktools/classbuilder/prefab.py,sha256=C70mxApT6pOe18Clz9sCajWWdhHTJjMAyjx2zVZPJew,23696
-ducktools/classbuilder/prefab.pyi,sha256=iZsrju2sU_5_rOoNFrG4-vNTRrZr3dSxWNzmHd2BuYw,4387
-ducktools/classbuilder/py.typed,sha256=la67KBlbjXN-_-DfGNcdOcjYumVpKG_Tkw-8n5dnGB4,8
-ducktools_classbuilder-0.6.3.dist-info/LICENSE.md,sha256=6Thz9Dbw8R4fWInl6sGl8Rj3UnKnRbDwrc6jZerpugQ,1070
-ducktools_classbuilder-0.6.3.dist-info/METADATA,sha256=Qxqxy6400PNSK2wb1pEHx_99rKVSym70110QesZtdnc,10911
-ducktools_classbuilder-0.6.3.dist-info/WHEEL,sha256=Z4pYXqR_rTB7OWNDYFOm1qRk0RX6GFP2o8LgvP453Hk,91
-ducktools_classbuilder-0.6.3.dist-info/top_level.txt,sha256=uSDLtio3ZFqdwcsMJ2O5yhjB4Q3ytbBWbA8rJREganc,10
-ducktools_classbuilder-0.6.3.dist-info/RECORD,,