Add pylint check (#40)

Update code to be compatible with newer pylint checks

Author: speedyleion

.pylintrc

@@ -16,7 +16,7 @@ persistent=yes
 
 # List of plugins (as comma separated values of python modules names) to load,
 # usually to register additional checkers.
-load-plugins=pylint.extensions.check_docs
+# load-plugins=
 
 
 [MESSAGES CONTROL]

src/sphinx_c_autodoc/__init__.py

@@ -138,7 +138,9 @@ def parse_name(self) -> bool:
             fullname, _, path, base = match.groups()  # type: ignore
         except AttributeError:
             logger.warning(
-                "invalid signature for auto%s (%r)" % (self.objtype, self.name),
+                "invalid signature for auto%s (%r)",
+                self.objtype,
+                self.name,
                 type="c_autodoc",
             )
             return False
@@ -213,8 +215,10 @@ def import_object(self, raiseerror: bool = False) -> bool:
         else:
             logger.warning(
                 "Unable to find file, %s, in any of the directories %s "
-                "all directories are relative to the top documentation source directory"
-                % (self.get_real_modname(), self.env.config.c_autodoc_roots),
+                "all directories are relative to the top documentation source "
+                "directory",
+                self.get_real_modname(),
+                self.env.config.c_autodoc_roots,
                 location=(self.env.docname, self.directive.lineno),
             )
             return False
@@ -230,7 +234,7 @@ def import_object(self, raiseerror: bool = False) -> bool:
         modules_dict = self.env.temp_data.setdefault("c:loaded_modules", {})
 
         if filename not in modules_dict:
-            with open(filename) as f:
+            with open(filename, encoding="utf-8") as f:
                 contents = [f.read()]
 
             # let extensions preprocess files
@@ -280,7 +284,8 @@ def get_compilation_database(self) -> Optional[str]:
             return filename
 
         logger.warning(
-            'Compilation database "%s" not found.' % (filename,),
+            'Compilation database "%s" not found.',
+            filename,
             location=(self.env.docname, self.directive.lineno),
         )
 
@@ -312,7 +317,9 @@ def get_object_members(self, want_all: bool) -> Tuple[bool, List[Tuple[str, Any]
                 object_members.append((member, self.object.children[member]))
             else:
                 logger.warning(
-                    'Missing member "%s" in object "%s"' % (member, self.fullname),
+                    'Missing member "%s" in object "%s"',
+                    member,
+                    self.fullname,
                     type="c_autodoc",
                 )
 
@@ -422,7 +429,8 @@ def __init__(
         """
         super().__init__(directive, name, indent)
 
-        # Sphinx 3.1 compatibility. 4.0 deprecated the "reporter" attribute. 5.0 removes it.
+        # Sphinx 3.1 compatibility. 4.0 deprecated the "reporter" attribute. 5.0
+        # removes it.
         reporter = getattr(self.directive, "reporter", None)
 
         self._original_directive = self.directive

src/sphinx_c_autodoc/clang/patches.py

@@ -143,6 +143,8 @@ def override_methods() -> None:
     pythonic and or more efficient.
     """
     cindex.Cursor._raw_comment = None
+    # Not sure why pylint chokes here
+    # pylint: disable=assignment-from-no-return,too-many-function-args
     cindex.Cursor.raw_comment = property(Cursor_cached_raw_comment).setter(
         Cursor_set_raw_comment
     )
@@ -154,6 +156,8 @@ def add_new_methods() -> None:
     """
     cindex.SourceLocation.isFromMainFile = SourceLocation_isFromMainFile
     cindex.Cursor._comment_extent = None
+    # Not sure why pylint chokes here
+    # pylint: disable=assignment-from-no-return,too-many-function-args
     cindex.Cursor.comment_extent = property(Cursor_comment_extent).setter(
         Cursor_set_comment_extent
     )

src/sphinx_c_autodoc/loader.py

@@ -342,7 +342,7 @@ def get_parsed_declaration(self) -> str:
             i.spelling for i in ident_iter if i.kind == cindex.TokenKind.IDENTIFIER
         ]
 
-        return "{}({})".format(self.name, ", ".join(tokens))
+        return f"{self.name}({', '.join(tokens)})"
 
 
 class DocumentedEnumerator(DocumentedMacro):
@@ -521,7 +521,7 @@ def get_parsed_declaration(self) -> str:
             t.spelling for t in cindex.TokenGroup.get_tokens(tu, extent=extent)
         )
 
-        return "{} {}({})".format(return_type, func.spelling, args)
+        return f"{return_type} {func.spelling}({args})"
 
     def is_public(self) -> bool:
         """

src/sphinx_c_autodoc/viewcode/__init__.py

@@ -155,7 +155,7 @@ def add_source_listings(app: Sphinx) -> Iterator[Tuple[str, Dict[str, Any], str]
         context = {
             "title": module,
             "body": (
-                "<h1>Source code for %s</h1>" % module + "\n".join(highlighted_source)
+                f"<h1>Source code for {module}</h1>" + "\n".join(highlighted_source)
             ),
         }
         yield (_get_source_page_name(module), context, "page.html")

tox.ini

@@ -12,10 +12,9 @@ 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-{pycodestyle,black}, docs, sphinx-{three, four},
+envlist = py{37, 38, 39, 310, 311}{,-cov}, check-{pylint,pycodestyle,black}, docs, sphinx-{three, four},
 
 [testenv]
-changedir = {toxinidir}/tests
 deps =
     poetry
 commands =