ducktools-classbuilder 0.2.0__py3-none-any.whl → 0.3.0__py3-none-any.whl

ducktools/classbuilder/__init__.py

@@ -19,34 +19,12 @@
 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
-__version__ = "v0.2.0"
+__version__ = "v0.3.0"
 
 # Change this name if you make heavy modifications
 INTERNALS_DICT = "__classbuilder_internals__"
 
 
-def get_internals(cls):
-    """
-    Utility function to get the internals dictionary
-    or return None.
-
-    As generated classes will always have 'fields'
-    and 'local_fields' attributes this will always
-    evaluate as 'truthy' if this is a generated class.
-
-    Generally you should use the helper get_flags and
-    get_fields methods.
-
-    Usage:
-       if internals := get_internals(cls):
-           ...
-
-    :param cls: generated class
-    :return: internals dictionary of the class or None
-    """
-    return getattr(cls, INTERNALS_DICT, None)
-
-
 def get_fields(cls, *, local=False):
     """
     Utility function to gather the fields dictionary
@@ -71,7 +49,9 @@ def get_flags(cls):
     return getattr(cls, INTERNALS_DICT)["flags"]
 
 
-def get_inst_fields(inst):
+def _get_inst_fields(inst):
+    # This is an internal helper for constructing new
+    # 'Field' instances from existing ones.
     return {
         k: getattr(inst, k)
         for k in get_fields(type(inst))
@@ -105,7 +85,7 @@ class MethodMaker:
         self.code_generator = code_generator
 
     def __repr__(self):
-        return f"<MethodMaker for {self.funcname} method>"
+        return f"<MethodMaker for {self.funcname!r} method>"
 
     def __get__(self, instance, cls):
         local_vars = {}
@@ -122,7 +102,7 @@ class MethodMaker:
         return method.__get__(instance, cls)
 
 
-def init_maker(cls, *, null=NOTHING):
+def init_maker(cls, *, null=NOTHING, extra_code=None):
     fields = get_fields(cls)
     flags = get_flags(cls)
 
@@ -150,8 +130,17 @@ def init_maker(cls, *, null=NOTHING):
         assignments.append(assignment)
 
     args = ", ".join(arglist)
-    assigns = "\n    ".join(assignments)
-    code = f"def __init__(self, {args}):\n" f"    {assigns}\n"
+    assigns = "\n    ".join(assignments) if assignments else "pass\n"
+    code = (
+        f"def __init__(self, {args}):\n" 
+        f"    {assigns}\n"
+    )
+    # Handle additional function calls
+    # Used for validate_field on fieldclasses
+    if extra_code:
+        for line in extra_code:
+            code += f"    {line}\n"
+
     return code, globs
 
 
@@ -300,7 +289,7 @@ class Field:
         :param kwargs: Additional keyword arguments for subclasses
         :return: new field subclass instance
         """
-        argument_dict = {**get_inst_fields(fld), **kwargs}
+        argument_dict = {**_get_inst_fields(fld), **kwargs}
 
         return cls(**argument_dict)
 
@@ -407,6 +396,14 @@ def slotclass(cls=None, /, *, methods=default_methods, syntax_check=True):
     return cls
 
 
+def _field_init_func(cls):
+    # Fields need a different Nothing for their __init__ generation
+    # And an extra call to validate_field
+    field_nothing = _NothingType()
+    extra_calls = ["self.validate_field()"]
+    return init_maker(cls, null=field_nothing, extra_code=extra_calls)
+
+
 def fieldclass(cls):
     """
     This is a special decorator for making Field subclasses using __slots__.
@@ -417,18 +414,7 @@ def fieldclass(cls):
     :return: Modified subclass
     """
 
-    # Fields need a way to call their validate method
-    # So append it to the code from __init__.
-    def field_init_func(cls_):
-        code, globs = init_maker(cls_, null=field_nothing)
-        code += "    self.validate_field()\n"
-        return code, globs
-
-    field_nothing = _NothingType()
-    field_init_desc = MethodMaker(
-        "__init__",
-        field_init_func,
-    )
+    field_init_desc = MethodMaker("__init__", _field_init_func)
     field_methods = frozenset({field_init_desc, repr_desc, eq_desc})
 
     cls = builder(

ducktools/classbuilder/__init__.pyi

@@ -6,13 +6,11 @@ _py_type = type  # Alias for type where it is used as a name
 __version__: str
 INTERNALS_DICT: str
 
-def get_internals(cls) -> dict[str, typing.Any] | None: ...
-
 def get_fields(cls: type, *, local: bool = False) -> dict[str, Field]: ...
 
 def get_flags(cls:type) -> dict[str, bool]: ...
 
-def get_inst_fields(inst: typing.Any) -> dict[str, typing.Any]: ...
+def _get_inst_fields(inst: typing.Any) -> dict[str, typing.Any]: ...
 
 class _NothingType:
     ...
@@ -32,6 +30,7 @@ def init_maker(
     cls: type,
     *,
     null: _NothingType = NOTHING,
+    extra_code: None | list[str] = None
 ) -> tuple[str, dict[str, typing.Any]]: ...
 def repr_maker(cls: type) -> tuple[str, dict[str, typing.Any]]: ...
 def eq_maker(cls: type) -> tuple[str, dict[str, typing.Any]]: ...

ducktools/classbuilder/prefab.py

@@ -398,7 +398,7 @@ def get_asdict_maker():
         vals = ", ".join(
             f"'{name}': self.{name}"
             for name, attrib in fields.items()
-            if attrib.in_dict and not attrib.exclude_field
+            if attrib.serialize and not attrib.exclude_field
         )
         out_dict = f"{{{vals}}}"
         code = f"def as_dict(self): return {out_dict}"
@@ -428,7 +428,7 @@ class Attribute(Field):
         compare=True,
         iter=True,
         kw_only=False,
-        in_dict=True,
+        serialize=True,
         exclude_field=False,
     )
 
@@ -450,7 +450,7 @@ def attribute(
     compare=True,
     iter=True,
     kw_only=False,
-    in_dict=True,
+    serialize=True,
     exclude_field=False,
     doc=None,
     type=NOTHING,
@@ -466,7 +466,7 @@ def attribute(
     :param compare: Include this attribute in the class __eq__
     :param iter: Include this attribute in the class __iter__ if generated
     :param kw_only: Make this argument keyword only in init
-    :param in_dict: Include this attribute in methods that serialise to dict
+    :param serialize: Include this attribute in methods that serialize to dict
     :param exclude_field: Exclude this field from all magic method generation
                           apart from __init__ signature
                           and do not include it in PREFAB_FIELDS
@@ -484,7 +484,7 @@ def attribute(
         compare=compare,
         iter=iter,
         kw_only=kw_only,
-        in_dict=in_dict,
+        serialize=serialize,
         exclude_field=exclude_field,
         doc=doc,
         type=type,
@@ -906,7 +906,7 @@ def is_prefab_instance(o):
 
 def as_dict(o):
     """
-    Get the valid fields from a prefab respecting the in_dict
+    Get the valid fields from a prefab respecting the serialize
     values of attributes
 
     :param o: instance of a prefab class
@@ -927,5 +927,5 @@ def as_dict(o):
     return {
         name: getattr(o, name)
         for name, attrib in flds.items()
-        if attrib.in_dict and not attrib.exclude_field
+        if attrib.serialize and not attrib.exclude_field
     }

ducktools/classbuilder/prefab.pyi

@@ -6,7 +6,7 @@ from collections.abc import Callable
 from . import (
     INTERNALS_DICT, NOTHING,
     Field, MethodMaker, SlotFields as SlotFields,
-    builder, fieldclass, get_internals, slot_gatherer
+    builder, fieldclass, get_flags, get_fields, slot_gatherer
 )
 
 # noinspection PyUnresolvedReferences
@@ -63,7 +63,7 @@ class Attribute(Field):
     compare: bool
     iter: bool
     kw_only: bool
-    in_dict: bool
+    serialize: bool
     exclude_field: bool
 
     def __init__(
@@ -78,7 +78,7 @@ class Attribute(Field):
         compare: bool = True,
         iter: bool = True,
         kw_only: bool = False,
-        in_dict: bool = True,
+        serialize: bool = True,
         exclude_field: bool = False,
     ) -> None: ...
 
@@ -97,7 +97,7 @@ def attribute(
     compare: bool = True,
     iter: bool = True,
     kw_only: bool = False,
-    in_dict: bool = True,
+    serialize: bool = True,
     exclude_field: bool = False,
 ) -> Attribute: ...
 

{ducktools_classbuilder-0.2.0.dist-info → ducktools_classbuilder-0.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ducktools-classbuilder
-Version: 0.2.0
+Version: 0.3.0
 Summary: Toolkit for creating class boilerplate generators
 Author: David C Ellis
 License: MIT License

ducktools_classbuilder-0.3.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+ducktools/classbuilder/__init__.py,sha256=Vw5RjzzIkXGYXKOmFWTxPsIAM4ceg74Q1Oku4fwF0ek,13505
+ducktools/classbuilder/__init__.pyi,sha256=hgcEylMAHgfonOt2fH9OCE3gU60mYkiOUe7e8mTwNVs,2857
+ducktools/classbuilder/prefab.py,sha256=gJJCtTAbQLgIoo79jRWVp09r3u8kJjcqXp4G4FTu9j8,29887
+ducktools/classbuilder/prefab.pyi,sha256=vcaEpBxyVsOTwkGBkVgmbpn8DPqQqFnAU4xTKPnpOd8,3977
+ducktools/classbuilder/py.typed,sha256=la67KBlbjXN-_-DfGNcdOcjYumVpKG_Tkw-8n5dnGB4,8
+ducktools_classbuilder-0.3.0.dist-info/LICENSE.md,sha256=6Thz9Dbw8R4fWInl6sGl8Rj3UnKnRbDwrc6jZerpugQ,1070
+ducktools_classbuilder-0.3.0.dist-info/METADATA,sha256=sAWw76LgN3HruCS-SXURrrAj2A6MmhsyDJwMSvnWW2w,9280
+ducktools_classbuilder-0.3.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+ducktools_classbuilder-0.3.0.dist-info/top_level.txt,sha256=uSDLtio3ZFqdwcsMJ2O5yhjB4Q3ytbBWbA8rJREganc,10
+ducktools_classbuilder-0.3.0.dist-info/RECORD,,

ducktools_classbuilder-0.2.0.dist-info/RECORD

@@ -1,10 +0,0 @@
-ducktools/classbuilder/__init__.py,sha256=OOVk-E6UBi8-68bEy9pqCiKbn9oQ1y4tRGnZ3LGsGYg,13747
-ducktools/classbuilder/__init__.pyi,sha256=-QHJhPn4EjI4XW4OI74MKNg2tGKJiM3w0ELSOvPstAw,2877
-ducktools/classbuilder/prefab.py,sha256=yUa_yoPKU1hzI4klqWJOwTZEXtNOmUU1fQnLuHkVACw,29871
-ducktools/classbuilder/prefab.pyi,sha256=4cyXYqTXtCJv4gPOSNtkBrjORj2jt1bvX6p_sCOzoXw,3963
-ducktools/classbuilder/py.typed,sha256=la67KBlbjXN-_-DfGNcdOcjYumVpKG_Tkw-8n5dnGB4,8
-ducktools_classbuilder-0.2.0.dist-info/LICENSE.md,sha256=6Thz9Dbw8R4fWInl6sGl8Rj3UnKnRbDwrc6jZerpugQ,1070
-ducktools_classbuilder-0.2.0.dist-info/METADATA,sha256=LmHMIhj4jJ9WlmHOac4lBVgW4l6cdNUjG8cEvIULVko,9280
-ducktools_classbuilder-0.2.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-ducktools_classbuilder-0.2.0.dist-info/top_level.txt,sha256=uSDLtio3ZFqdwcsMJ2O5yhjB4Q3ytbBWbA8rJREganc,10
-ducktools_classbuilder-0.2.0.dist-info/RECORD,,