Merge pull request #99 from DavidCEllis/cached-source

Cache generated methods for performance, pre-generate cached methods

Author: DavidCEllis

README.md

@@ -2,7 +2,7 @@
     add_methods,
     get_fields,
     make_unified_gatherer,
-    print_generated_code,
+    get_generated_code,
     GeneratedCode,
     MethodMaker,
 )
@@ -56,4 +56,8 @@ class ConverterEx(ConverterClass):
 
     ex = ConverterEx("42", "42")
     print(ex)
-    print_generated_code(ConverterEx)
+    print()
+    code = get_generated_code(ConverterEx)
+
+    for k in sorted(code):
+        print(code[k].source_code)

docs/code_examples/docs_ex08_converters.py

@@ -70,7 +70,6 @@ class Slotted(ducktools.classbuilder.prefab.Prefab)
  |                  (This does not prevent the modification of mutable attributes such as lists)
  |      :param replace: generate a __replace__ method
  |      :param dict_method: Include an as_dict method for faster dictionary creation
- |      :param recursive_repr: Safely handle repr in case of recursion
  |      :param ignore_annotations: Ignore type annotations when gathering fields, only look for
  |                              slots or attribute(...) values
  |      :param slots: automatically generate slots for this class's attributes

docs/code_examples/outputs/docs_ex01_basic.output

@@ -1,34 +1,31 @@
 ConverterEx(unconverted='42', converted=42)
-Source:
-    def __eq__(self, other):
-        if self is other:
-            return True
-        return (
-            self.unconverted == other.unconverted
-            and self.converted == other.converted
-        ) if self.__class__ is other.__class__ else NotImplemented
 
-    def __init__(self, unconverted, converted):
-        self.unconverted = unconverted
-        self.converted = converted
+def __eq__(self, other):
+    if self is other:
+        return True
+    return (
+        self.unconverted == other.unconverted
+        and self.converted == other.converted
+    ) if self.__class__ is other.__class__ else NotImplemented
 
-    def __replace__(self, /, **changes):
-        new_kwargs = {'unconverted': self.unconverted, 'converted': self.converted}
-        new_kwargs |= changes
-        return self.__class__(**new_kwargs)
+def __init__(self, unconverted, converted):
+    self.unconverted = unconverted
+    self.converted = converted
 
-    def __repr__(self):
-        return f'{type(self).__qualname__}(unconverted={self.unconverted!r}, converted={self.converted!r})'
+def __replace__(self, /, **changes):
+    new_kwargs = {
+        'unconverted': self.unconverted,
+        'converted': self.converted,
+    }
+    new_kwargs |= changes
+    return self.__class__(**new_kwargs)
 
-    def __setattr__(self, name, value):
-        if conv := _converters.get(name):
-            _object_setattr(self, name, conv(value))
-        else:
-            _object_setattr(self, name, value)
+def __repr__(self):
+    return f'{type(self).__qualname__}(unconverted={self.unconverted!r}, converted={self.converted!r})'
 
+def __setattr__(self, name, value):
+    if conv := _converters.get(name):
+        _object_setattr(self, name, conv(value))
+    else:
+        _object_setattr(self, name, value)
 
-Globals:
-    __setattr__: {'_converters': {'converted': <class 'int'>}, '_object_setattr': <slot wrapper '__setattr__' of 'object' objects>}
-
-Annotations:
-    __init__: {'unconverted': <class 'str'>, 'converted': <class 'int'>, 'return': None}

docs/code_examples/outputs/docs_ex08_converters.output

@@ -1,4 +1,4 @@
-<generated class X; x='Value of x', a='Not In __init__ signature', c=[], e='Value of e', f=42> 
+X(x='Value of x', a='Not In __init__ signature', c=[], e='Value of e', f=42) 
 
 {'x': Attribute(default=<NOTHING Sentinel>, default_factory=<NOTHING Sentinel>, type=<class 'str'>, doc=None, init=True, repr=True, compare=True, kw_only=False, iter=True, serialize=True, metadata={}),
  'a': Attribute(default='Not In __init__ signature', default_factory=<NOTHING Sentinel>, type=<class 'int'>, doc=None, init=False, repr=True, compare=True, kw_only=False, iter=True, serialize=True, metadata={}),
@@ -9,7 +9,7 @@
  'f': Attribute(default=42, default_factory=<NOTHING Sentinel>, type=ForwardRef('unknown'), doc=None, init=True, repr=True, compare=False, kw_only=False, iter=True, serialize=False, metadata={})}
 
 
-<generated class Y; x='Value of x', a='Not In __init__ signature', c=[], e='Value of e', f=42> 
+Y(x='Value of x', a='Not In __init__ signature', c=[], e='Value of e', f=42) 
 
 Slots: {'x': None, 'a': None, 'b': None, 'c': None, 'd': None, 'e': None, 'f': None}
 
@@ -33,10 +33,16 @@ def __init__(self, x, b='Not In Repr', c=None, f=42, *, e):
     self.f = f
 
 def __replace__(self, /, **changes):
-    new_kwargs = {'x': self.x, 'b': self.b, 'c': self.c, 'e': self.e, 'f': self.f}
+    new_kwargs = {
+        'x': self.x,
+        'b': self.b,
+        'c': self.c,
+        'e': self.e,
+        'f': self.f,
+    }
     new_kwargs |= changes
     return self.__class__(**new_kwargs)
 
 def __repr__(self):
-    return f'<generated class {type(self).__qualname__}; x={self.x!r}, a={self.a!r}, c={self.c!r}, e={self.e!r}, f={self.f!r}>'
+    return f'{type(self).__qualname__}(x={self.x!r}, a={self.a!r}, c={self.c!r}, e={self.e!r}, f={self.f!r})'
 

docs/code_examples/outputs/docs_ex09_annotated.output

@@ -7,7 +7,6 @@ Including:
 * Declaration by type hints, slots or `attribute(...)` assignment on the class
 * `__prefab_pre_init__` and `__prefab_post_init__` detection to allow for validation/conversion
 * Optional `as_dict` method generation to convert to a dictionary
-* Optional recursive `__repr__` handling (off by default)
 
 ## Usage ##
 

docs/prefab/index.md

@@ -72,6 +72,7 @@ testpaths = [
 
 [tool.coverage.run]
 plugins = ["coverage_simple_excludes"]
+omit = ["_cached_methods.py"]
 
 [tool.coverage.report]
 fail_under = 90

pyproject.toml

@@ -0,0 +1,4 @@
+from ducktools.classbuilder._create_precached_methods import write_precached_methods
+
+if __name__ == "__main__":
+    write_precached_methods()