Merge pull request #67 from OpenNTI/typing

Add some static typing. This is particularly helpful for subclasses o…

Author: jamadden

.github/workflows/tests.yml

@@ -56,10 +56,12 @@ jobs:
         coverage combine || true
         coverage report -i || true
     - name: Lint
-      if: matrix.python-version == '3.12'
+      if: matrix.python-version == '3.14'
       run: |
         python -m pip install -U pylint
         pylint nti.schema
+        python -m pip install -U mypy
+        mypy --install-types --non-interactive src
     - name: Submit to Coveralls
       uses: coverallsapp/github-action@v2
       with:

CHANGES.rst

@@ -5,7 +5,8 @@
 1.20.1 (unreleased)
 ===================
 
-- Nothing changed yet.
+- Add some minimal typing information. In particular this makes
+  subclasses of ``SchemaConfigured`` for type-friendly.
 
 
 1.20.0 (2026-06-01)

pyproject.toml

@@ -3,3 +3,40 @@ requires = [
    "wheel",
    "setuptools>=75.3",
 ]
+
+[tool.mypy]
+# Must be present for mpypy to read this file.
+follow_imports = "normal"
+check_untyped_defs = true
+exclude = "tests/*"
+#ignore_missing_imports = true
+
+[[tool.mypy.overrides]]
+# third-party untyped code
+module = [
+  "Acquisition.*",
+  "ZODB",
+  "zope.*",
+  "persistent.*",
+  "cpuinfo",
+  "nti.*",
+  "botocore.*",
+  "fsspec.*",
+  "transaction",
+  "grpc",
+  "grpc_health.*",
+  "google.type.*",
+  "zc.*",
+  "z3c.*",
+  "netaddr.*",
+  "dnslib",
+  "cytoolz.*",
+  "toolz.*",
+  "boto3.*",
+  "pg8000",
+  "urllib3.*",
+  "indexed_gzip",
+  "dm.zope.schema.interfaces",
+
+]
+ignore_missing_imports = true

src/nti/schema/eqhash.py

@@ -6,10 +6,11 @@
 """
 
 import operator
+from collections import abc as abcs
 
 __docformat__ = "restructuredtext en"
 
-def _superhash_force(value):
+def _superhash_force(value) -> tuple:
     # Called when we know that we can't hash the value.
     # Dict?
     try:
@@ -41,11 +42,14 @@ def _superhash(value):
     except TypeError:
         return _superhash_force(value)
 
-def EqHash(*names,
-           **kwargs):
-    """
-    EqHash(*names, include_super=False, superhash=False, supereq=False, include_type=False)
 
+def EqHash[T: type](*names,
+                    include_super=False,
+                    superhash=False,
+                    supereq=False,
+                    include_type=False
+                    ) -> abcs.Callable[[T], T]:
+    """
     A class decorator factory for the common pattern of writing
     ``__eq__``/``__ne__`` and ``__hash__`` methods that check the same
     list of attributes on a given object.
@@ -104,13 +108,9 @@ def EqHash(*names,
        comparing mutable and immutable objects (tuple/list).
     """
 
-    _include_super = kwargs.pop('include_super', False)
-    superhash = kwargs.pop("superhash", False)
-    supereq = kwargs.pop('supereq', False)
-    _include_type = kwargs.pop('include_type', False)
+    _include_super = include_super
+    _include_type = include_type
 
-    if kwargs:
-        raise TypeError("Unexpected keyword args", kwargs)
     if not names and not _include_super and not _include_type:
         raise TypeError("Asking to hash/eq nothing, but not including super or type")
 

src/nti/schema/field.py

@@ -10,50 +10,45 @@
 .. TODO: This module is big enough it should be factored into a package and sub-modules.
 """
 
+import collections.abc as abcs
 # stdlib imports
 import numbers
 import re
+from typing import Any
 
-import collections.abc as abcs
-
-
+import zope.interface.common.idatetime
 from zope import interface
 from zope import schema
+from zope.cachedescriptors.property import Lazy
 from zope.deferredimport import deprecatedFrom
-
 from zope.event import notify
-import zope.interface.common.idatetime
-from zope.cachedescriptors.property import Lazy
-
-from zope.schema import interfaces as sch_interfaces
-from zope.schema.interfaces import IFromBytes
-from zope.schema.interfaces import IFromUnicode
-from zope.schema.interfaces import InvalidValue
-
 from zope.schema import Bool
 from zope.schema import Choice
+from zope.schema import Complex
 from zope.schema import Date
 from zope.schema import Datetime
 from zope.schema import Decimal
 from zope.schema import Dict
 from zope.schema import FrozenSet
+from zope.schema import Integral
 from zope.schema import Iterable
 from zope.schema import List
 from zope.schema import Mapping
 from zope.schema import MutableMapping
 from zope.schema import MutableSequence
+from zope.schema import Object as _ObjectBase
+from zope.schema import Rational
+from zope.schema import Real
 from zope.schema import Sequence
 from zope.schema import Set
 from zope.schema import Text
 from zope.schema import TextLine
 from zope.schema import Timedelta
 from zope.schema import Tuple
-from zope.schema import Object as _ObjectBase
-
-from zope.schema import Complex
-from zope.schema import Real
-from zope.schema import Rational
-from zope.schema import Integral
+from zope.schema import interfaces as sch_interfaces
+from zope.schema.interfaces import IFromBytes
+from zope.schema.interfaces import IFromUnicode
+from zope.schema.interfaces import InvalidValue
 
 from nti.schema import MessageFactory as _
 from nti.schema.interfaces import BeforeDictAssignedEvent
@@ -68,7 +63,6 @@
 from nti.schema.interfaces import IVariant
 from nti.schema.interfaces import VariantValidationError
 
-
 __docformat__ = "restructuredtext en"
 
 # Re-export some things as part of our public API so we can
@@ -286,7 +280,7 @@ def _fixup_too_long(self, e, value):
 
     def _validate(self, value):
         try:
-            super()._validate(value)
+            super()._validate(value) # type:ignore[misc]
         except sch_interfaces.WrongType as e:
             assert e.expected_type is not None, "The expected_type should be provided"
             raise
@@ -431,7 +425,7 @@ class Variant(FieldValidationMixin, schema.Field):
        would be raised. Now, constructing the variant will raise a ``RequiredMissing``.
     """
 
-    fields = ()
+    fields: abcs.Sequence[schema.Field] = ()
 
     def __init__(self, fields, variant_raise_when_schema_provided=False, **kwargs):
         """
@@ -510,7 +504,7 @@ def _validate(self, value):
             raise VariantValidationError(self, value, errors)
         finally:
             # break cycles
-            e = errors = None
+            del errors
 
     def fromObject(self, obj):
         """
@@ -561,7 +555,7 @@ def fromObject(self, obj):
             raise VariantValidationError(self, obj, errors)
         finally:
             # break cycles
-            ex = errors = None
+            del errors
 
     _EVENT_TYPES = (
         (str, BeforeTextAssignedEvent),
@@ -672,8 +666,9 @@ def fromBytes(self, value):
         return self.fromUnicode(value.decode('utf-8'))
 
 
-_not_stripped = r"^\s|\s$"  # space at either beginning or end
-_not_stripped = re.compile(_not_stripped).search
+_not_stripped = re.compile(
+     r"^\s|\s$"  # space at either beginning or end
+).search
 
 
 def _is_stripped(value):
@@ -764,7 +759,7 @@ class _ValueTypeAddingDocMixin(object):
     """
 
     def getExtraDocLines(self):
-        lines = super().getExtraDocLines()
+        lines = super().getExtraDocLines() # type:ignore[misc]
         accept_types = getattr(self, 'accept_types', None)
         if accept_types:
             # Private helper. If it goes away or changes, making sphinx docs will
@@ -799,8 +794,13 @@ class ListOrTuple(IndexedIterable):
 
 @interface.implementer(IFromObject)
 class _SequenceFromObjectMixin(object):
-    accept_types = None
+    accept_types: abcs.Sequence[type] | None = None
     _default_type = list
+    value_type: schema.Field
+    _type: type | abcs.Sequence[type] | None
+    missing_value: Any
+    required: bool
+    __name__: str
 
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
@@ -844,7 +844,7 @@ def fromObject(self, context):
             return context
 
         check_type = self.accept_types or self._type
-        if check_type is not None and not isinstance(context, check_type):
+        if check_type is not None and not isinstance(context, check_type): # type:ignore[arg-type]
             raise sch_interfaces.WrongType(context, check_type).with_field_and_value(self, context)
 
         result = self._do_fromObject(context)
@@ -864,6 +864,7 @@ def __getattr__(self, name):
 
 
 class _MapFromObjectMixin(_SequenceFromObjectMixin):
+    key_type: schema.Field
 
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
@@ -891,7 +892,7 @@ def __getattr__(self, name):
         return getattr(self.__field, name)
 
 
-class ListOrTupleFromObject(_SequenceFromObjectMixin, ListOrTuple):
+class ListOrTupleFromObject(_SequenceFromObjectMixin, ListOrTuple): # type:ignore[misc]
     """
     The ``value_type`` MUST be a :class:`Variant`, or more generally,
     something supporting :class:`IFromObject`, :class:`IFromUnicode`

src/nti/schema/fieldproperty.py

@@ -9,7 +9,7 @@
 # stdlib imports
 import sys
 
-
+from zope.interface import Attribute
 from zope.schema import interfaces as sch_interfaces
 from zope.schema.fieldproperty import FieldProperty
 from zope.schema.fieldproperty import FieldPropertyStoredThroughField
@@ -81,7 +81,7 @@ class AdaptingFieldProperty(FieldProperty):
     like strings.
     """
 
-    def __init__(self, field, name=None):
+    def __init__(self, field, name=None) -> None:
         self.schema = _find_schema_from_field(field)
         super().__init__(field, name=name)
 
@@ -94,14 +94,14 @@ class AdaptingFieldPropertyStoredThroughField(FieldPropertyStoredThroughField):
     like strings.
     """
 
-    def __init__(self, field, name=None):
+    def __init__(self, field, name=None) -> None:
         self.schema = _find_schema_from_field(field)
         super().__init__(field, name=name)
 
 AdaptingFieldPropertyStoredThroughField.__set__ = _make_adapter_set(
     AdaptingFieldPropertyStoredThroughField)
 
-def createDirectFieldProperties(__schema, omit=(), adapting=False):
+def createDirectFieldProperties(__schema, omit=(), adapting=False) -> None:
     """
     Like :func:`zope.schema.fieldproperty.createFieldProperties`, except
     only creates properties for fields directly contained within the
@@ -156,7 +156,7 @@ def createDirectFieldProperties(__schema, omit=(), adapting=False):
             __frame.f_locals[k] = v
 
 
-def field_name(field):
+def field_name(field: Attribute) -> str:
     """
     Produce a clean version of a field's name.
 

src/nti/schema/interfaces.py

@@ -6,23 +6,19 @@
 Also utility functions.
 """
 
-import warnings
 import traceback
+import warnings
+from collections import abc as abcs
 
 from zope.deprecation import deprecated
-
-from zope.schema import Text
-from zope.schema import TextLine
-from zope.interface import Interface
 from zope.interface import Attribute
-from zope.interface import providedBy
+from zope.interface import Interface
 from zope.interface import implementer
+from zope.interface import providedBy
+from zope.schema import Text
+from zope.schema import TextLine
 from zope.schema import interfaces as sch_interfaces
-try:
-    from zope.schema._bootstrapfields import BeforeObjectAssignedEvent
-except ImportError: # pragma: no cover
-    # BWC for older zope.schema.
-    from zope.schema._field import BeforeObjectAssignedEvent
+from zope.schema._bootstrapfields import BeforeObjectAssignedEvent
 
 __docformat__ = "restructuredtext en"
 
@@ -210,9 +206,9 @@ class VariantValidationError(sch_interfaces.ValidationError):
     """
 
     #: A sequence of validation errors
-    errors = ()
+    errors: abcs.Sequence[BaseException] = ()
 
-    def __init__(self, field, value, errors):
+    def __init__(self, field, value, errors: abcs.Sequence[BaseException]) -> None:
         super().__init__()
         self.with_field_and_value(field, value)
         self.errors = errors