Attempt to fix mypy issues that are failing on CI

.github/workflows/unit_tests.yml

@@ -14,9 +14,7 @@ jobs:
           - 3.3.1
           - 3.4.3
           - 3.5.4
-          - git+https://github.com/sphinx-doc/sphinx.git@4.0.x
-          # enable 4.x again when 4.0.x has been merged into it
-          #- git+https://github.com/sphinx-doc/sphinx.git@4.x
+          - git+https://github.com/sphinx-doc/sphinx.git@4.x
           - git+https://github.com/sphinx-doc/sphinx.git@master
 
     steps:

breathe/directive/base.py

@@ -53,6 +53,12 @@ def create_warning(project_info: Optional[ProjectInfo], state, lineno: int,
 
 
 class BaseDirective(SphinxDirective):
+    required_arguments: int
+    optional_arguments: int
+    option_spec: Dict[str, Any]
+    has_content: bool
+    final_argument_whitespace: bool
+
     def __init__(self, finder_factory: FinderFactory,
                  project_info_factory: ProjectInfoFactory,
                  parser_factory: DoxygenParserFactory,

breathe/directive/file.py

@@ -7,7 +7,7 @@
 from breathe.renderer.sphinxrenderer import SphinxRenderer
 from breathe.renderer.target import create_target_handler
 
-from docutils.parsers.rst.directives import unchanged_required, flag
+from docutils.parsers.rst.directives import unchanged_required, flag  # type: ignore
 
 
 class BaseFileDirective(BaseDirective):

breathe/directive/index.py

@@ -8,7 +8,7 @@
 from breathe.renderer.sphinxrenderer import SphinxRenderer
 from breathe.renderer.target import create_target_handler
 
-from docutils.parsers.rst.directives import unchanged_required, flag
+from docutils.parsers.rst.directives import unchanged_required, flag  # type: ignore
 
 
 class RootDataObject(object):

breathe/directives.py

@@ -22,7 +22,7 @@
 
 from docutils import nodes
 from docutils.nodes import Node
-from docutils.parsers.rst.directives import unchanged_required, unchanged, flag
+from docutils.parsers.rst.directives import unchanged_required, unchanged, flag  # type: ignore
 
 import os
 import re

breathe/file_state_cache.py

@@ -35,7 +35,9 @@ def update(app: Sphinx, source_file: str) -> None:
     mtime, docnames = app.env.breathe_file_state.setdefault(  # type: ignore
         source_file, (new_mtime, set()))
 
+    assert app.env is not None
     docnames.add(app.env.docname)
+
     app.env.breathe_file_state[source_file] = (new_mtime, docnames)  # type: ignore
 
 

breathe/renderer/sphinxrenderer.py

@@ -583,6 +583,7 @@ def run_directive(self, obj_type: str, declaration: str, contentCallback: Conten
         for k, v in options.items():
             directive.options[k] = v
 
+        assert self.app.env is not None
         config = self.app.env.config
 
         if config.breathe_debug_trace_directives:
@@ -635,6 +636,8 @@ def content(contentnode):
             content_callback = content
         declaration = declaration.replace('\n', ' ')
         nodes_ = self.run_directive(obj_type, declaration, content_callback, options)
+
+        assert self.app.env is not None
         if self.app.env.config.breathe_debug_trace_doxygen_ids:
             target = self.create_doxygen_target(node)
             if len(target) == 0:
@@ -696,6 +699,7 @@ def get_qualification(self) -> List[str]:
         if self.nesting_level > 0:
             return []
 
+        assert self.app.env is not None
         config = self.app.env.config
         if config.breathe_debug_trace_qualification:
             def debug_print_node(n):
@@ -1722,6 +1726,8 @@ def visit_compoundref(self, node) -> List[Node]:
         return nodelist
 
     def visit_docxrefsect(self, node) -> List[Node]:
+        assert self.app.env is not None
+
         signode = addnodes.desc_signature()
         title = node.xreftitle[0] + ':'
         titlenode = nodes.emphasis(text=title)
@@ -1897,6 +1903,8 @@ def visit_function(self, node) -> List[Node]:
             self.context.directive_args[1] = [signature]
 
             nodes = self.run_domain_directive(node.kind, self.context.directive_args[1])
+
+            assert self.app.env is not None
             if self.app.env.config.breathe_debug_trace_doxygen_ids:
                 target = self.create_doxygen_target(node)
                 if len(target) == 0:

requirements/development.txt

@@ -1,5 +1,8 @@
 -r production.txt
 
+flake8
 pip-tools>=0.3.5
 pytest
-mypy
+
+mypy>=0.900
+types-docutils>=0.17.0