Merge pull request #134 from python-odin/development

Release 2.1

Author: timsavage

HISTORY

@@ -1,3 +1,17 @@
+2.1
+===
+
+Annotated Resources
+-------------------
+
+- Final fields are now mapped to ConstantField and require a default value.
+- Fix issue where the Toml codec did not recognise annotated resources in dump and dumps functions.
+
+Breaking changes
+----------------
+
+- Virtual fields ConstantField and CalculatedField now require keyword arguments for options.
+
 2.0
 ===
 

poetry.lock

@@ -1,3 +1,4 @@
+"""Type aliases for string formatted types."""
 from typing import Callable, Union, Any, Sequence, Tuple
 
 __all__ = (
@@ -19,40 +20,30 @@
 
 
 class Email(str):
-    """
-    Alias for use defining email entries
-    """
+    """Alias for use defining email entries."""
 
     __slots__ = ()
 
 
 class IPv4(str):
-    """
-    Alias for use defining IPv4 entries
-    """
+    """Alias for use defining IPv4 entries."""
 
     __slots__ = ()
 
 
 class IPv6(str):
-    """
-    Alias for use defining IPv6 entries
-    """
+    """Alias for use defining IPv6 entries."""
 
     __slots__ = ()
 
 
 class IPv46(str):
-    """
-    Alias for use defining IPv4 or IPv6 entries
-    """
+    """Alias for use defining IPv4 or IPv6 entries."""
 
     __slots__ = ()
 
 
 class Url(str):
-    """
-    Alias for use defining IPv4 or IPv6 entries
-    """
+    """Alias for use defining URL entries."""
 
     __slots__ = ()

src/odin/annotated_resource/type_aliases.py

@@ -1,9 +1,10 @@
+"""Methods for resolving types to fields."""
 import datetime
 import enum
 import pathlib
 import re
 import uuid
-from typing import Any, Sequence, Dict, Type, Union, get_origin, List
+from typing import Any, Sequence, Dict, Type, Union, get_origin, List, Final
 
 try:
     # Handle the change in typing between 3.8 and later releases
@@ -27,13 +28,12 @@
     ListField,
     DictField,
 )
+from ..fields.virtual import ConstantField
 from ..resources import ResourceBase
 
 
 class Options:
-    """
-    Define options for a field
-    """
+    """Define options for a field"""
 
     __slots__ = (
         "field_type",
@@ -78,18 +78,14 @@ def __init__(
         }
 
     def _kwargs(self):
-        """
-        Build kwargs used to instantiate field
-        """
+        """Build kwargs used to instantiate field"""
         final_args = self.base_args
         if issubclass(self.field_type, Field):
             final_args.update(self.field_args)
         return final_args
 
     def _improve_error(self, ex: TypeError):
-        """
-        Attempt to provide more context for the error
-        """
+        """Attempt to provide more context for the error"""
         message = str(ex)
 
         for check in (
@@ -103,16 +99,16 @@ def _improve_error(self, ex: TypeError):
                 )
 
     def init_field(self):
-        """
-        Instantiate field object
-        """
+        """Instantiate field object"""
         if self.field_type:
             try:
                 return self.field_type(**self._kwargs())
             except TypeError as ex:
                 self._improve_error(ex)
                 raise
-        raise ResourceDefError("Field type could not be resolved")
+        raise ResourceDefError(
+            f"Field type `{self.base_args.get('name', 'Unknown!')}` could not be resolved"
+        )
 
 
 SIMPLE_TYPE_MAP = {
@@ -138,9 +134,7 @@ def init_field(self):
 
 
 def _resolve_field_from_type(options: Options, type_: type):
-    """
-    Resolve a field from a basic type
-    """
+    """Resolve a field from a basic type"""
     if field_type := SIMPLE_TYPE_MAP.get(type_, None):
         options.field_type = field_type
 
@@ -159,19 +153,15 @@ def _resolve_field_from_type(options: Options, type_: type):
 
 
 def is_optional(type_: Union) -> bool:
-    """
-    Field is an optional type
-    """
+    """Field is an optional type"""
     args = type_.__args__
     return (
         len(args) == 2 and type(None) in args
     )  # pylint: disable=unidiomatic-typecheck
 
 
 def _resolve_list_from_sub_scripted_type(args: Sequence[Any], options: Options):
-    """
-    Handle the various types of sequence type
-    """
+    """Handle the various types of sequence type"""
     options.field_args["default"] = list
 
     (field,) = args
@@ -189,9 +179,7 @@ def _resolve_list_from_sub_scripted_type(args: Sequence[Any], options: Options):
 
 
 def _resolve_dict_from_sub_scripted_type(args: Sequence[Any], options: Options):
-    """
-    Handle the various types of sequence type
-    """
+    """Handle the various types of sequence type"""
     options.field_args["default"] = dict
 
     key_field, value_field = args
@@ -214,9 +202,7 @@ def _resolve_dict_from_sub_scripted_type(args: Sequence[Any], options: Options):
 
 
 def _resolve_field_from_sub_scripted_type(origin: Type, options: Options, type_):
-    """
-    Resolve a field from a generic type
-    """
+    """Resolve a field from a generic type"""
     args = getattr(type_, "__args__", None)
     if not args:
         # This occurs with the plain List and Dict types which are essentially
@@ -229,6 +215,17 @@ def _resolve_field_from_sub_scripted_type(origin: Type, options: Options, type_)
         if is_optional(type_):
             options.field_args["null"] = True
             return _resolve_field_from_annotation(options, args[0])
+        else:
+            pass  # Resolve
+
+    elif origin is Final:
+        # Constant
+        options.field_type = ConstantField
+        value = options.field_args["default"]
+        if value is NotProvided:
+            raise ResourceDefError(f"Final fields require a value")
+        options.base_args["value"] = value
+        return
 
     elif issubclass(origin, List):
         return _resolve_list_from_sub_scripted_type(args, options)
@@ -267,9 +264,7 @@ def process_attribute(
     *,
     _base_field: Type[BaseField] = BaseField,
 ) -> BaseField:
-    """
-    Process an individual attribute and generate a field based off values passed
-    """
+    """Process an individual attribute and generate a field based off values passed"""
 
     # Attribute is already a field object
     if isinstance(value, _base_field):

src/odin/annotated_resource/type_resolution.py

@@ -1,3 +1,4 @@
+"""Codec to load/save Message Pack (msgpack) documents."""
 import datetime
 import uuid
 from typing import TextIO
@@ -9,7 +10,7 @@
         "odin.codecs.msgpack_codec requires the 'msgpack-python' package."
     )  # noqa
 
-from odin import bases, Resource
+from odin import bases
 from odin import serializers, resources, ResourceAdapter
 from odin.utils import getmeta
 
@@ -24,11 +25,9 @@
 
 
 class OdinPacker(msgpack.Packer):
-    """
-    Encoder for Odin resources.
-    """
+    """Encoder for Odin resources."""
 
-    def __init__(self, include_virtual_fields=True, *args, **kwargs):
+    def __init__(self, include_virtual_fields: bool = True, *args, **kwargs):
         kwargs.setdefault("default", self.default)
         super().__init__(*args, **kwargs)
         self.include_virtual_fields = include_virtual_fields
@@ -45,9 +44,13 @@ def default(self, o):
             return TYPE_SERIALIZERS[o.__class__](o)
 
 
-def load(fp, resource=None, full_clean=True, default_to_not_supplied=False):
-    """
-    Load a from a MessagePack encoded file.
+def load(
+    fp: TextIO,
+    resource: resources.ResourceBase = None,
+    full_clean: bool = True,
+    default_to_not_supplied: bool = False,
+):
+    """Load a from a MessagePack encoded file.
 
     See :py:meth:`loads` for more details of the loading operation.
 
@@ -62,9 +65,13 @@ def load(fp, resource=None, full_clean=True, default_to_not_supplied=False):
     )
 
 
-def loads(s, resource=None, full_clean=True, default_to_not_supplied=False):
-    """
-    Load from a MessagePack encoded string/bytes.
+def loads(
+    s: str,
+    resource: resources.ResourceBase = None,
+    full_clean: bool = True,
+    default_to_not_supplied: bool = False,
+):
+    """Load from a MessagePack encoded string/bytes.
 
     If a ``resource`` value is supplied it is used as the base resource for the supplied MessagePack data. I one is not
     supplied a resource type field ``$`` is used to obtain the type represented by the dictionary. A ``ValidationError``
@@ -83,14 +90,13 @@ def loads(s, resource=None, full_clean=True, default_to_not_supplied=False):
 
 
 def dump(
-    resource,  # type: Resource
-    fp,  # type: TextIO,
+    resource: resources.ResourceBase,
+    fp: TextIO,
     cls=OdinPacker,
-    include_virtual_fields=True,  # type: bool
+    include_virtual_fields: bool = True,
     **kwargs
 ):
-    """
-    Dump to a MessagePack encoded file.
+    """Dump to a MessagePack encoded file.
 
     :param include_virtual_fields:
     :param resource: The root resource to dump to a MessagePack encoded file.
@@ -101,13 +107,12 @@ def dump(
 
 
 def dumps(
-    resource,  # type: Resource
+    resource: resources.ResourceBase,
     cls=OdinPacker,
-    include_virtual_fields=True,  # type: bool
+    include_virtual_fields: bool = True,
     **kwargs
 ):
-    """
-    Dump to a MessagePack encoded string.
+    """Dump to a MessagePack encoded string.
 
     :param include_virtual_fields:
     :param resource: The root resource to dump to a MessagePack encoded file.