Merge pull request #123 from altendky/check_mypy

Author: altendky

.coveragerc

@@ -14,3 +14,24 @@ parallel = true
 show_missing = true
 precision = 2
 omit = *migrations*
+exclude_lines =
+  # Lines matching these regexes don't need to be covered
+  # https://coverage.readthedocs.io/en/coverage-5.5/excluding.html?highlight=exclude_lines#advanced-exclusion
+  
+  # this is the default but must be explicitly specified since
+  # we are overriding exclude_lines
+  pragma: no cover
+
+  # abstract methods won't ever be run
+  abc\.abstractmethod
+
+  # overloads won't ever be run
+  typing\.overload
+
+  # ellipses (...) are often used in type-hint related stub code
+  ^\s*\.\.\.\s*$
+
+  # TYPE_CHECKING guarded code won't be run
+  if typing.TYPE_CHECKING:
+  if t.TYPE_CHECKING:
+  if TYPE_CHECKING:

src/desert/__init__.py

@@ -8,6 +8,10 @@
 import desert._version
 
 
+if t.TYPE_CHECKING:
+    import attr._make
+
+
 def schema(
     cls: t.Type, many: bool = False, meta: t.Dict[str, t.Any] = {}
 ) -> marshmallow.Schema:
@@ -63,7 +67,10 @@ class A:
     """
     meta = metadata(marshmallow_field)
     meta.update(kw.pop("metadata", {}))
-    return dataclasses.field(**kw, metadata=meta)
+    # typeshed hints it as Mapping[str, Any] without any obvious reason
+    # https://github.com/python/typeshed/blob/95a45eb4abd0c25849268983cb614e3bf6b9b264/stdlib/dataclasses.pyi#L81
+    # https://github.com/python/typeshed/pull/5823
+    return dataclasses.field(**kw, metadata=meta)  # type: ignore[arg-type]
 
 
 def ib(marshmallow_field: marshmallow.fields.Field, **kw) -> attr._make._CountingAttr:

src/desert/_make.py

@@ -54,8 +54,6 @@ class User:
       Schema: t.ClassVar[Type[Schema]] = Schema # For the type checker
 """
 
-__all__ = ("schema_class", "schema")
-
 import dataclasses
 import datetime
 import decimal
@@ -99,7 +97,7 @@ def class_schema(
     ``marshmallow_field`` key in the metadata dictionary.
     """
 
-    fields: t.Union[t.Tuple[dataclasses.Field], t.Tuple[attr.Attribute]]
+    fields: t.Union[t.Tuple[dataclasses.Field, ...], t.Tuple[attr.Attribute, ...]]
 
     if not isinstance(clazz, type):
         raise desert.exceptions.UnknownType(
@@ -118,12 +116,8 @@ def class_schema(
     else:
         raise desert.exceptions.NotAnAttrsClassOrDataclass(clazz)
 
-    # Copy all public fields of the dataclass to the schema
-    attributes = {
-        field.name: field for field in fields if not field.name.startswith("_")
-    }
-
     # Update the schema members to contain marshmallow fields instead of dataclass fields.
+    attributes: t.Dict[str, marshmallow.fields.Field] = {}
     hints = t.get_type_hints(clazz)
     for field in fields:
         if field.init:
@@ -133,16 +127,23 @@ def class_schema(
                 field.metadata,
             )
 
+    class_attributes: t.Dict[str, t.Any] = {
+        **attributes,
+        "Meta": type("Meta", (), meta),
+    }
+
     cls_schema = type(
         clazz.__name__,
         (_base_schema(clazz),),
-        {**attributes, "Meta": type("Meta", (), meta)},
+        class_attributes,
     )
 
     return t.cast(t.Type[marshmallow.Schema], cls_schema)
 
 
-_native_to_marshmallow: t.Dict[type, t.Type[marshmallow.fields.Field]] = {
+_native_to_marshmallow: t.Dict[
+    t.Union[type, t.Any], t.Type[marshmallow.fields.Field]
+] = {
     int: marshmallow.fields.Integer,
     float: marshmallow.fields.Float,
     str: marshmallow.fields.String,
@@ -171,7 +172,7 @@ def only(items: t.Iterable[T]) -> T:
 
 
 def field_for_schema(
-    typ: type, default=marshmallow.missing, metadata: t.Mapping[str, t.Any] = None
+    typ: type, default=marshmallow.missing, metadata: t.Mapping[t.Any, t.Any] = None
 ) -> marshmallow.fields.Field:
     """
     Get a marshmallow Field corresponding to the given python type.
@@ -319,25 +320,30 @@ def _get_field_default(field: t.Union[dataclasses.Field, attr.Attribute]):
     <marshmallow.missing>
     """
     if isinstance(field, dataclasses.Field):
-        if field.default_factory != dataclasses.MISSING:
+        # https://github.com/python/mypy/issues/10750
+        if field.default_factory != dataclasses.MISSING:  # type: ignore[misc]
             return dataclasses.MISSING
         if field.default is dataclasses.MISSING:
             return marshmallow.missing
         return field.default
     elif isinstance(field, attr.Attribute):
         if field.default == attr.NOTHING:
             return marshmallow.missing
-        if isinstance(field.default, attr.Factory):
-            if field.default.takes_self:
+        if isinstance(field.default, attr.Factory):  # type: ignore[arg-type]
+            # attrs specifically doesn't support this so as to support the
+            # primary use case.
+            # https://github.com/python-attrs/attrs/blob/38580632ceac1cd6e477db71e1d190a4130beed4/src/attr/__init__.pyi#L63-L65
+            if field.default.takes_self:  # type: ignore[union-attr]
                 return attr.NOTHING
-            return field.default.factory
+            return field.default.factory  # type: ignore[union-attr]
         return field.default
     else:
         raise TypeError(field)
 
 
-def sentinel(name):
-    return attr.make_class(name, [], frozen=True)()
+@attr.frozen
+class _DesertSentinel:
+    pass
 
 
-_DESERT_SENTINEL = sentinel("_DesertSentinel")
+_DESERT_SENTINEL = _DesertSentinel()

tox.ini

@@ -43,6 +43,7 @@ commands =
     check-manifest {toxinidir}
     black --check {toxinidir}
     isort --verbose --check-only --diff src tests setup.py
+    mypy src/desert/
 
 [testenv:spell]
 setenv =