v0.28.0: Minor Performance and QoL Change: Dynamically exec Dataclass Load and Dump Functions

HISTORY.rst

@@ -2,6 +2,31 @@
 History
 =======
 
+0.28.0 (2024-11-15)
+-------------------
+
+**Features and Improvements**
+
+* Added :class:`TOMLWizard`.
+* Introduced new (pre-process) serializer hooks:
+    * :meth:`_pre_from_dict`
+    * :meth:`_pre_dict`
+* Added ``debug`` parameter to :meth:`JSONWizard.__init_subclass__`.
+* Added ``*.pyi`` stub files for better Type Hinting and Autocompletion in IDEs (e.g., PyCharm):
+    * :file:`abstractions.pyi`
+    * :file:`serial_json.pyi`
+* Introduced utility class :class:`FunctionBuilder` to help build and dynamically ``exec`` a function.
+* Documentation/tests on the new and updated features.
+
+**Changes**
+
+* The returned parser for a dataclass is now the original load/dump function itself (which takes a single argument)
+  rather than a :class:`Parser` instance.
+* Minor optimization and quality-of-life improvement: dynamically ``exec`` dataclass load and dump functions.
+* Improved performance: if a class defines a :meth:`from_dict` method - equivalent to :func:`fromdict` - and a :meth:`to_dict` method
+  - equivalent to :func:`asdict` - replace them with dynamically generated load/dump functions.
+* Deprecated the pre-process hook :meth:`DumpMixin.__pre_as_dict__`.
+
 0.27.0 (2024-11-10)
 -------------------
 

README.rst

@@ -111,6 +111,7 @@ In addition to the ``JSONWizard``, here are a few extra Mixin_ classes that migh
 
 * `JSONListWizard`_ -- Extends ``JSONWizard`` to return `Container`_ -- instead of *list* -- objects where possible.
 * `JSONFileWizard`_ -- Makes it easier to convert dataclass instances from/to JSON files on a local drive.
+* `TOMLWizard`_ -- Provides support to convert dataclass instances to/from TOML.
 * `YAMLWizard`_ -- Provides support to convert dataclass instances to/from YAML, using the default ``PyYAML`` parser.
 
 
@@ -961,6 +962,7 @@ This package was created with Cookiecutter_ and the `rnag/cookiecutter-pypackage
 .. _`open an issue`: https://github.com/rnag/dataclass-wizard/issues
 .. _`JSONListWizard`: https://dataclass-wizard.readthedocs.io/en/latest/common_use_cases/wizard_mixins.html#jsonlistwizard
 .. _`JSONFileWizard`: https://dataclass-wizard.readthedocs.io/en/latest/common_use_cases/wizard_mixins.html#jsonfilewizard
+.. _`TOMLWizard`: https://dataclass-wizard.readthedocs.io/en/latest/common_use_cases/wizard_mixins.html#tomlwizard
 .. _`YAMLWizard`: https://dataclass-wizard.readthedocs.io/en/latest/common_use_cases/wizard_mixins.html#yamlwizard
 .. _`Container`: https://dataclass-wizard.readthedocs.io/en/latest/dataclass_wizard.html#dataclass_wizard.Container
 .. _`Supported Types`: https://dataclass-wizard.readthedocs.io/en/latest/overview.html#supported-types

dataclass_wizard/__init__.py

@@ -78,6 +78,7 @@
     # Wizard Mixins
     'JSONListWizard',
     'JSONFileWizard',
+    'TOMLWizard',
     'YAMLWizard',
     # Helper serializer functions + meta config
     'fromlist',
@@ -104,7 +105,7 @@
                      Pattern, DatePattern, TimePattern, DateTimePattern)
 from .property_wizard import property_wizard
 from .serial_json import JSONSerializable
-from .wizard_mixins import JSONListWizard, JSONFileWizard, YAMLWizard
+from .wizard_mixins import JSONListWizard, JSONFileWizard, TOMLWizard, YAMLWizard
 
 
 # Set up logging to ``/dev/null`` like a library is supposed to.

dataclass_wizard/abstractions.py

@@ -119,7 +119,7 @@ class AbstractParser(ABC, Generic[T, TT]):
     # This is usually the underlying base type of the annotation (for example,
     # for `List[str]` it will be `list`), though in some cases this will be
     # the annotation itself.
-    base_type: T
+    base_type: type[T]
 
     def __contains__(self, item) -> bool:
         """
@@ -356,24 +356,3 @@ def get_parser_for_annotation(cls, ann_type: Type[T],
 
 class AbstractDumper(ABC):
     __slots__ = ()
-
-    def __pre_as_dict__(self):
-        """
-        Optional hook that runs before the dataclass instance is processed and
-        before it is converted to a dictionary object via :meth:`to_dict`.
-
-        To override this, subclasses need to extend from :class:`DumpMixIn`
-        and implement this method. A simple example is shown below:
-
-        >>> from dataclasses import dataclass
-        >>> from dataclass_wizard import JSONSerializable, DumpMixin
-        >>>
-        >>>
-        >>> @dataclass
-        >>> class MyClass(JSONSerializable, DumpMixin):
-        >>>     my_str: str
-        >>>
-        >>>     def __pre_as_dict__(self):
-        >>>         self.my_str = self.my_str.swapcase()
-
-        """