Add mypy check to CI and tox (#42)

Update code to be compatible with newest mypy

Author: speedyleion

src/sphinx_c_autodoc/__init__.py

@@ -452,9 +452,12 @@ def generate(
         """
         generate stuff
         """
+        # The autodoc::Documenter is using the implied optional
+        # `real_modname: str = None` and mypy complains that this shouldn't be
+        # optional
         super().generate(
             more_content=more_content,
-            real_modname=real_modname,
+            real_modname=real_modname,  # type: ignore
             check_module=check_module,
             all_members=all_members,
         )
@@ -749,7 +752,7 @@ class CModule(CObject):
 
     object_type = "module"
 
-    def run(self) -> nodes.Node:
+    def run(self) -> List[nodes.Node]:
         """
         Not sure yet
         """

src/sphinx_c_autodoc/loader.py

@@ -43,6 +43,9 @@ class DocumentedObject:
     """
     A representation of a c object for documentation purposes.
 
+    Arguments:
+        node (:class:`~clang.cindex.Cursor`): The node representing this object.
+
     Attributes:
         type_ (str): The type of this item one of:
 
@@ -69,15 +72,15 @@ class DocumentedObject:
             the type as well as the name.
         _line_range (Tuple[int, int]): The line range of the C construct,
             this will include any leading or trailing comments that may be
-            part of the constructs documentation.
+            part of the construct's documentation.
     """
 
     type_ = "object"
 
-    def __init__(self) -> None:
+    def __init__(self, node: Cursor) -> None:
         self.doc = ""
         self.name = ""
-        self.node: Cursor = None
+        self.node = node
         self._children: Optional[OrderedDict] = None
         self._soup: Optional[BeautifulSoup] = None
         self._declaration: Optional[str] = None
@@ -88,7 +91,7 @@ def line_range(self) -> Tuple[int, int]:
         The lines in the source file that this object covers.
 
         This will include any leading or trailing comments that may be part
-        of the constructs documentation.
+        of the construct's documentation.
         """
         if self._line_range is None:
             node_extent = self.node.extent
@@ -554,9 +557,9 @@ def get_parsed_declaration(self) -> str:
         # Function prototypes need to be handled different. When clang can't
         # successfully parse the file it falls back to naming the return type
         # as the display name.
-        # Unfortunatly some versions of clang behave a little differently, some
-        # will return a POINTER while others will return FUNCITONNOPROTO. The
-        # POINTER's are easy to derive the real type from, but the test
+        # Unfortunately some versions of clang behave a little differently, some
+        # will return a `POINTER` while others will return `FUNCITONNOPROTO`. The
+        # `POINTER`s are easy to derive the real type from, but the test
         # environment doesn't use that version of clang.
         type_ = self.node.underlying_typedef_type
         if type_.kind == cindex.TypeKind.POINTER:  # pragma: no cover
@@ -753,14 +756,13 @@ def object_from_cursor(cursor: Cursor) -> Optional[DocumentedObject]:
 
     nested_cursor = get_nested_node(cursor)
     class_ = CURSORKIND_TO_OBJECT_CLASS.get(nested_cursor.kind, DocumentedObject)
-    doc = class_()
+    doc = class_(nested_cursor)
 
     doc.name = name
     psuedo_comment = PsuedoToken(
         nested_cursor.raw_comment, nested_cursor.comment_extent
     )
     doc.doc = parse_comment(psuedo_comment)
-    doc.node = nested_cursor
 
     return doc
 
@@ -821,7 +823,9 @@ def get_file_comment(cursor: Cursor, child: Optional[Cursor]) -> str:
     return ""
 
 
-def get_compilation_args(filename: str, compilation_database: str = None) -> List[str]:
+def get_compilation_args(
+    filename: str, compilation_database: Optional[str] = None
+) -> List[str]:
     """
     Get the compilation args for `filename` for the compilation database found in
     `compilation_db_dir`
@@ -857,8 +861,8 @@ def get_compilation_args(filename: str, compilation_database: str = None) -> Lis
 def load(
     filename: str,
     contents: str,
-    compilation_database: str = None,
-    compilation_args: Sequence[str] = None,
+    compilation_database: Optional[str] = None,
+    compilation_args: Optional[Sequence[str]] = None,
 ) -> DocumentedObject:
     """
     Load a C file into a tree of :class:`DocumentedObject`\'s
@@ -881,12 +885,14 @@ def load(
     tu = cindex.TranslationUnit.from_source(
         filename,
         args=args,
-        unsaved_files=((filename, contents),),
+        unsaved_files=[
+            (filename, contents),
+        ],
         options=cindex.TranslationUnit.PARSE_DETAILED_PROCESSING_RECORD,
     )
     cursor = tu.cursor
 
-    root_document = DocumentedFile()
+    root_document = DocumentedFile(cursor)
 
     # Some nodes show up from header includes as well as compiler defines, so
     # skip those. Macro instantiations are the locations where macros are
@@ -903,7 +909,7 @@ def load(
     ]
 
     # Macro definitions always come first in the child list, but that may not
-    # be their location in the file, so sort all of the nodes by location
+    # be their location in the file, so sort all the nodes by location
     sorted_nodes = sorted(child_nodes, key=lambda x: x.extent.start.offset)
 
     comment_nodes(cursor, sorted_nodes)

src/sphinx_c_autodoc/napoleon/__init__.py

@@ -33,7 +33,17 @@ def __init__(
         if not hasattr(self, "_sections"):
             self._sections = self.get_default_sections()
 
-        super().__init__(docstring, config, app, what, name, obj, options)
+        # The GoogleDocstring is using the implied optional `config: Config = None`
+        # and mypy complains that these shouldn't be optional
+        super().__init__(
+            docstring,
+            config,  # type: ignore
+            app,  # type: ignore
+            what,
+            name,
+            obj,
+            options,
+        )
 
     def get_default_sections(self) -> Dict[str, Callable]:
         """

src/sphinx_c_autodoc/viewcode/__init__.py

@@ -391,7 +391,7 @@ def doctree_read(app: Sphinx, doctree: Node) -> None:
 
 
 def _add_pending_source_cross_reference(
-    app: Sphinx, signode: Node, fullname: str
+    app: Sphinx, signode: addnodes.desc, fullname: str
 ) -> None:
     """
     Adds a pending source cross reference to the signature in the doctree, `signode`.
@@ -441,7 +441,9 @@ def _add_pending_source_cross_reference(
     signode += html_node
 
 
-def _add_pending_back_reference(app: Sphinx, signode: Node, fullname: str) -> None:
+def _add_pending_back_reference(
+    app: Sphinx, signode: addnodes.desc, fullname: str
+) -> None:
     """
     Updates the ``doc_links`` entry of the modules stored in
     ``_viewcode_c_modules`` so that they can later be added to the source

tox.ini

@@ -12,7 +12,7 @@ mintoxversion = 3.4
 # e.g.: tox -e py37-cov
 # Note: the sphinx versions are spelled out so tox doesn't try to resolve them
 # as python versions
-envlist = py{37, 38, 39, 310, 311}{,-cov}, check-{pylint,pycodestyle,black}, docs, sphinx-{three, four},
+envlist = py{37, 38, 39, 310, 311}{,-cov}, check-{pylint,pycodestyle,black,mypy}, docs, sphinx-{three, four},
 
 [testenv]
 deps =
@@ -23,7 +23,7 @@ commands =
     pycodestyle: pycodestyle {toxinidir}/src/sphinx_c_autodoc
     flake8: flake8 {toxinidir}/src/sphinx_c_autodoc
     black: black --check {toxinidir}/src/sphinx_c_autodoc {toxinidir}/tests {posargs}
-    mypy: mypy {toxinidir}/src/sphinx_c_autodoc {posargs}
+    mypy: poetry run mypy {toxinidir}/src/sphinx_c_autodoc {posargs}
     cov: poetry run pytest --cov=sphinx_c_autodoc --cov-config={[coverage]file} --cov-report=xml --cov-fail-under=100 {posargs}
     docs: python -m sphinx {toxinidir}/docs {toxinidir}/docs/_build