chore: enable type testing

We run mypy in non-strict mode, for now. But we should strive to
annotate the entire codebase.

Author: regisb

Makefile

@@ -76,6 +76,9 @@ requirements: ## install development environment requirements
 test: clean ## run tests in the current virtualenv
 	pytest
 
+test-types: ## run mypy tests on the whole codebase
+	mypy --ignore-missing-imports code_annotations/ tests/ test_utils/ setup.py
+
 diff_cover: test ## find diff lines that need test coverage
 	diff-cover coverage.xml
 

code_annotations/annotation_errors.py

@@ -3,20 +3,20 @@
 """
 from collections import namedtuple
 
-AnnotationErrorType = namedtuple(
+AnnotationError = namedtuple(
     "AnnotationError", ["message", "symbol", "description"]
 )
 
-# The TYPES list should contain all AnnotationErrorType instances. This list can then be parsed by others, for instance
+# The TYPES list should contain all AnnotationError instances. This list can then be parsed by others, for instance
 # to expose errors to pylint.
 TYPES = []
 
 
 def add_error_type(message, symbol, description):
     """
-    Create an AnnotationErrorType instance and add it to TYPES.
+    Create an AnnotationError instance and add it to TYPES.
     """
-    error_type = AnnotationErrorType(
+    error_type = AnnotationError(
         message,
         symbol,
         description,

code_annotations/base.py

@@ -327,7 +327,7 @@ def __init__(self, config):
         self.echo = self.config.echo
         # errors contains formatted error messages
         self.errors = []
-        # annotation_errors contains (annotation, AnnotationErrorType, args) tuples
+        # annotation_errors contains (annotation, AnnotationError, args) tuples
         # This attribute may be parsed by 3rd-parties, such as edx-lint.
         self.annotation_errors = []
 
@@ -549,7 +549,7 @@ def _add_annotation_error(self, annotation, error_type, args=None):
 
         Args:
             annotation: A single annotation dict found in search()
-            error_type (annotation_errors.AnnotationErrorType): error type from which the error message will be
+            error_type (annotation_errors.AnnotationError): error type from which the error message will be
                 generated.
             args (tuple): arguments for error message formatting.
         """

code_annotations/contrib/sphinx/extensions/openedx_events.py

@@ -53,7 +53,6 @@ class OpenedxEvents(SphinxDirective):
 
     required_arguments = 0
     optional_arguments = 0
-    option_spec = {}
 
     def run(self):
         """

code_annotations/extensions/base.py

@@ -12,7 +12,7 @@ class AnnotationExtension(metaclass=ABCMeta):
     Abstract base class that annotation extensions will inherit from.
     """
 
-    extension_name = None
+    extension_name: str | None = None
 
     def __init__(self, config, echo):
         """
@@ -40,7 +40,7 @@ class SimpleRegexAnnotationExtension(AnnotationExtension, metaclass=ABCMeta):
 
     # These are the language-specific comment definitions that are defined in the child classes. See the
     # Javascript and Python extensions for examples.
-    lang_comment_definition = None
+    lang_comment_definition: dict[str, str] | None = None
 
     # This format string/regex finds all comments in the file. The format tokens will be replaced with the
     # language-specific comment definitions defined in the sub-classes.

code_annotations/py.typed

@@ -39,10 +39,10 @@ class FakeConfig:
     Simple config for testing without reading a config file.
     """
 
-    annotations = {}
-    annotation_regexes = []
-    annotation_tokens = []
-    groups = []
+    annotations: dict[str, str] = {}
+    annotation_regexes: list[str] = []
+    annotation_tokens: list[str] = []
+    groups: list[str] = []
     echo = VerboseEcho()
 
 

tests/helpers.py

@@ -51,6 +51,7 @@ deps =
     -r{toxinidir}/requirements/quality.txt
 commands =
     pylint code_annotations tests test_utils setup.py
+    make test-types
     pycodestyle code_annotations tests setup.py
     pydocstyle code_annotations tests setup.py
     isort --check-only --diff tests test_utils code_annotations setup.py