Update typing on msgpack and yaml codecs

Author: timsavage

src/odin/codecs/msgpack_codec.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.

src/odin/codecs/yaml_codec.py

@@ -1,3 +1,5 @@
+"""Codec to load/save Yaml documents."""
+from typing import TextIO, Union
 from io import StringIO
 
 from odin import bases
@@ -26,8 +28,8 @@ class OdinDumper(SafeDumper):
     def __init__(
         self,
         stream,
-        include_virtual_fields=True,
-        include_type_field=True,
+        include_virtual_fields: bool = True,
+        include_type_field: bool = True,
         *args,
         **kwargs
     ):
@@ -48,9 +50,13 @@ def represent_resource(self, data):
 OdinDumper.add_multi_representer(bases.ResourceIterable, OdinDumper.represent_list)
 
 
-def load(fp, resource=None, full_clean=True, default_to_not_supplied=False):
-    """
-    Load a resource from a YAML encoded file.
+def load(
+    fp: Union[TextIO, str],
+    resource: resources.ResourceBase = None,
+    full_clean: bool = True,
+    default_to_not_supplied: bool = False,
+):
+    """Load a resource from a YAML encoded file.
 
     If a ``resource`` value is supplied it is used as the base resource for the supplied YAML. I one is not supplied a
     resource type field ``$`` is used to obtain the type represented by the dictionary. A ``ValidationError`` will be
@@ -79,9 +85,8 @@ def load(fp, resource=None, full_clean=True, default_to_not_supplied=False):
 loads = load
 
 
-def dump(resource, fp, dumper=OdinDumper, **kwargs):
-    """
-    Dump to a YAML encoded file.
+def dump(resource: resources.ResourceBase, fp: TextIO, dumper=OdinDumper, **kwargs):
+    """Dump to a YAML encoded file.
 
     :param resource: The root resource to dump to a YAML encoded file.
     :param dumper: Dumper to use serializing to a string; default is the :py:class:`OdinDumper`.
@@ -94,9 +99,8 @@ def dump(resource, fp, dumper=OdinDumper, **kwargs):
         raise CodecEncodeError(str(ex))
 
 
-def dumps(resource, dumper=OdinDumper, **kwargs):
-    """
-    Dump to a YAML encoded string.
+def dumps(resource: resources.ResourceBase, dumper=OdinDumper, **kwargs) -> str:
+    """Dump to a YAML encoded string.
 
     :param resource: The root resource to dump to a YAML encoded file.
     :param dumper: Dumper to use serializing to a string; default is the :py:class:`OdinDumper`.