Merge pull request #114 from python-odin/release/1.7.0

Release/1.7.0

Author: timsavage

HISTORY

@@ -1,3 +1,10 @@
+1.7.0
+=====
+
+- Migrate from collections.Iterable to typeing.Iterable to remove a warning
+- Add user defined metadata to Resource.Meta object
+- Add a reserved word guard, starting with fields (using fields causes clean_fields to go into a infinite recursion loop)
+
 1.6.2
 =====
 

docs/ref/resources/options.rst

@@ -84,3 +84,15 @@ Meta Options
             class Meta:
                 field_sorting = sort_by_name
 
+
+``user_data``
+    Additional data that can be added to metadata. This can be used to provide additional
+    parameters beyond those supported by odin for a custom application use-case.
+
+    For example::
+
+        class MyResource(Resource):
+            class Meta:
+                user_data = {
+                    "custom": "my-custom-value",
+                }

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "odin"
-version = "1.6.2"
+version = "1.7.0"
 description = "Data-structure definition/validation/traversal, mapping and serialisation toolkit for Python"
 authors = ["Tim Savage <tim@savage.company>"]
 license = "BSD-3-Clause"

src/odin/exceptions.py

@@ -80,6 +80,12 @@ class ResourceException(ValidationError):
     """
 
 
+class ResourceDefError(Exception):
+    """
+    Exceptions raised if a resource definition contains errors.
+    """
+
+
 class MappingError(Exception):
     """
     Exceptions related to mapping, will typically be a more specific `MappingSetupError` or `MappingExecutionError`.

src/odin/mapping/__init__.py

@@ -1,6 +1,7 @@
 # -*- coding: utf-8 -*-
 import collections
 import six
+import typing
 from odin import bases
 from odin import registration
 from odin.fields import NotProvided
@@ -624,7 +625,7 @@ def _apply_rule(self, mapping_rule):
                 )
 
         if to_list:
-            if isinstance(to_values, collections.Iterable):
+            if isinstance(to_values, typing.Iterable):
                 to_values = (list(to_values),)
         else:
             to_values = force_tuple(to_values)

src/odin/resources.py

@@ -5,7 +5,7 @@
 
 from odin import bases
 from odin import exceptions, registration
-from odin.exceptions import ValidationError
+from odin.exceptions import ValidationError, ResourceDefError
 from odin.fields import NotProvided
 from odin.utils import (
     lazy_property,
@@ -17,6 +17,11 @@
 
 DEFAULT_TYPE_FIELD = "$"
 
+# Set of field names that cannot be used
+RESERVED_FIELD_NAMES = {
+    "fields",  # Causes a infinite-recursion with clean_fields being a builtin method
+}
+
 
 class ResourceOptions(object):
     META_OPTION_NAMES = (
@@ -31,6 +36,7 @@ class ResourceOptions(object):
         "key_field_name",
         "key_field_names",
         "field_sorting",
+        "user_data",
     )
 
     def __init__(self, meta):
@@ -51,6 +57,7 @@ def __init__(self, meta):
         self.type_field = DEFAULT_TYPE_FIELD
         self.key_field_names = None
         self.field_sorting = NotProvided
+        self.user_data = None
 
         self._cache = {}
 
@@ -110,6 +117,11 @@ def add_field(self, field):
         """
         Dynamically add a field.
         """
+        if field.attname in RESERVED_FIELD_NAMES:
+            raise ResourceDefError(
+                "`{}` is a reserved name. Use the `name` argument to specify "
+                "the name used for serialisation.".format(field.attname)
+            )
         self.fields.append(field)
         if field.key:
             self._add_key_field(field)