Switch to PyLint/Ruff from Prospector (#761)

chrisrink10 · web-flow · commit a26a51f76dda · 2023-12-29T12:47:17.000-05:00
Fixes #739
diff --git a/.github/workflows/run-tests.yml b/.github/workflows/run-tests.yml
@@ -27,7 +27,7 @@ jobs:
           - version: '3.11'
             tox-env: py311,py311-mypy,py311-lint,safety
           - version: '3.12'
-            tox-env: py312,py312-mypy,format,safety
+            tox-env: py312,py312-mypy,py312-lint,format,safety
           - os: windows-latest
             version: '3.12'
             tox-env: py312,safety
diff --git a/.prospector.yaml b/.prospector.yaml
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -38,6 +38,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
  * Removed `basilisp.__version__` in favor of using `importlib.metadata` for version info (#617)
  * Removed a shim to Python's `ast` module to support compatibility with Python 3.6 and 3.7 (#749)
 
+### Other
+ * Switch to PyLint and Ruff for linting from Prospector (#739)
+
 ## [v0.1.0a2]
 ### Added
  * Added support for fixtures in `basilisp.test` (#654)
diff --git a/docs/contributing.rst b/docs/contributing.rst
@@ -77,7 +77,7 @@ All three steps can be performed using a provided ``make`` target:
 
 Testing is performed using `PyTest <https://github.com/pytest-dev/pytest/>`_.
 Type checking is performed by `MyPy <http://mypy-lang.org/>`_.
-Linting is performed using `Prospector <https://prospector.landscape.io/en/master/>`_.
+Linting is performed using `PyLint <https://github.com/pylint-dev/pylint>`_ and `Ruff <https://github.com/astral-sh/ruff>`_.
 Formatting is performed using `Black <https://github.com/psf/black>`_.
 
 New *code* contributions should include test coverage covering all new branches unless otherwise directed by the project maintainers.
diff --git a/pyproject.toml b/pyproject.toml
@@ -138,6 +138,82 @@ skip = [
   "pip-wheel-metadata",
 ]
 
+[tool.pylint.main]
+ignore = [
+  ".cache",
+  ".env",
+  ".hg",
+  ".git",
+  ".mypy_cache",
+  ".pytest_cache",
+  ".tox",
+  ".venv",
+  "build",
+  "dist",
+  "docs",
+  "htmlcov",
+  "junit",
+  "pip-wheel-metadata",
+  "lispcore.py",
+]
+ignore-patterns = ["^\\.#"]
+load-plugins = [
+  "pylint.extensions.code_style",
+  "pylint.extensions.docstyle",
+  "pylint.extensions.private_import",
+  "pylint.extensions.redefined_loop_name",
+  "pylint.extensions.set_membership"
+]
+
+[tool.pylint.basic]
+docstring-min-length = 5
+no-docstring-rgx = "^_"
+
+[tool.pylint.logging]
+logging-format-style = "new"
+
+[tool.pylint."messages control"]
+disable = [
+  "bad-inline-option",
+  "consider-using-assignment-expr",
+  "deprecated-pragma",
+  "docstring-first-line-empty",
+  "duplicate-code",
+  "file-ignored",
+  "fixme",
+  "global-statement",
+  "implicit-str-concat",
+  "import-outside-toplevel",
+  "invalid-name",
+  "len-as-condition",
+  "line-too-long",
+  "locally-disabled",
+  "logging-format-interpolation",
+  "logging-fstring-interpolation",
+  "logging-too-many-args",
+  "missing-class-docstring",
+  "missing-function-docstring",
+  "missing-module-docstring",
+  "no-else-continue",
+  "no-else-raise",
+  "no-else-return",
+  "protected-access",
+  "raw-checker-failed",
+  "redefined-outer-name",
+  "redundant-keyword-arg",
+  "suppressed-message",
+  "too-few-public-methods",
+  "too-many-ancestors",
+  "too-many-public-methods",
+  "too-many-instance-attributes",
+  "trailing-whitespace",
+  "unnecessary-lambda-assignment",
+  "unspecified-encoding",
+  "useless-import-alias",
+  "useless-suppression",
+  "use-symbolic-message-instead"
+]
+
 [tool.mypy]
 check_untyped_defs = true
 mypy_path = "src/"
@@ -156,4 +232,26 @@ module = [
 ignore_missing_imports = true
 
 [tool.pytest.ini_options]
-junit_family = "legacy"
+junit_family = "legacy"
+
+[tool.ruff]
+exclude = [
+  ".cache",
+  ".env",
+  ".hg",
+  ".git",
+  ".mypy_cache",
+  ".pytest_cache",
+  ".tox",
+  ".venv",
+  "build",
+  "dist",
+  "docs",
+  "htmlcov",
+  "junit",
+  "pip-wheel-metadata",
+  "lispcore.py",
+]
+
+[tool.ruff.lint]
+ignore = ["E731", "E741"]
diff --git a/src/basilisp/cli.py b/src/basilisp/cli.py
@@ -368,7 +368,7 @@ def repl(
                 )
                 repl_module.mark_exception(e)
                 continue
-            except Exception as e:
+            except Exception as e:  # pylint: disable=broad-exception-caught
                 traceback.print_exception(Exception, e, e.__traceback__)
                 repl_module.mark_exception(e)
                 continue
diff --git a/src/basilisp/contrib/sphinx/autodoc.py b/src/basilisp/contrib/sphinx/autodoc.py
@@ -5,7 +5,7 @@
 import types
 from typing import Any, Dict, List, Optional, Tuple, cast
 
-from sphinx.ext.autodoc import (
+from sphinx.ext.autodoc import (  # pylint: disable=no-name-in-module
     ClassDocumenter,
     Documenter,
     ObjectMember,
diff --git a/src/basilisp/contrib/sphinx/domain.py b/src/basilisp/contrib/sphinx/domain.py
@@ -130,7 +130,7 @@ def run(self) -> List[Node]:
         return ret
 
 
-class BasilispObject(PyObject):
+class BasilispObject(PyObject):  # pylint: disable=abstract-method
     def handle_signature(self, sig: str, signode: desc_signature) -> Tuple[str, str]:
         """Subclasses should implement this themselves."""
         return NotImplemented
@@ -196,7 +196,7 @@ def get_index_text(self, modname: str, name: Tuple[str, str]) -> str:
         return f"{sig} ({prefix} in {modname})"
 
 
-class BasilispFunctionLike(BasilispObject):
+class BasilispFunctionLike(BasilispObject):  # pylint: disable=abstract-method
     option_spec: OptionSpec = BasilispObject.option_spec.copy()
 
     def handle_signature(self, sig: str, signode: desc_signature) -> Tuple[str, str]:
@@ -314,14 +314,16 @@ def generate(  # pylint: disable=too-many-locals
 
             for ignore in ignores:
                 if nsname.startswith(ignore):
-                    nsname = nsname[len(ignore) :]
+                    nsname = nsname[  # pylint: disable=redefined-loop-name
+                        len(ignore) :
+                    ]
                     stripped = ignore
                     break
             else:
                 stripped = ""
 
             if not nsname:
-                nsname, stripped = stripped, ""
+                nsname, stripped = stripped, ""  # pylint: disable=redefined-loop-name
 
             entries = content[nsname[0].lower()]
 
@@ -562,3 +564,14 @@ def resolve_xref(  # pylint: disable=too-many-arguments
         return make_refnode(
             builder, fromdocname, docname, node_id, contnode, title=title
         )
+
+    def resolve_any_xref(  # pylint: disable=too-many-arguments
+        self,
+        env: BuildEnvironment,
+        fromdocname: str,
+        builder: Builder,
+        target: str,
+        node: pending_xref,
+        contnode: Element,
+    ) -> List[Tuple[str, Element]]:
+        raise NotImplementedError
diff --git a/src/basilisp/importer.py b/src/basilisp/importer.py
@@ -123,7 +123,7 @@ def _is_namespace_package(path: str) -> bool:
     return no_inits and has_basilisp_files
 
 
-class BasilispImporter(MetaPathFinder, SourceLoader):
+class BasilispImporter(MetaPathFinder, SourceLoader):  # pylint: disable=abstract-method
     """Python import hook to allow directly loading Basilisp code within
     Python."""
 
diff --git a/src/basilisp/lang/compiler/__init__.py b/src/basilisp/lang/compiler/__init__.py
@@ -182,7 +182,7 @@ def compile_and_exec_form(
     bytecode = compile(ast_module, ctx.filename, "exec")
     if collect_bytecode:
         collect_bytecode(bytecode)
-    exec(bytecode, ns.module.__dict__)
+    exec(bytecode, ns.module.__dict__)  # pylint: disable=exec-used
     try:
         return getattr(ns.module, final_wrapped_name)()
     finally:
@@ -215,7 +215,7 @@ def _incremental_compile_module(
     bytecode = compile(module, source_filename, "exec")
     if collect_bytecode:
         collect_bytecode(bytecode)
-    exec(bytecode, ns.module.__dict__)
+    exec(bytecode, ns.module.__dict__)  # pylint: disable=exec-used
 
 
 def _bootstrap_module(
@@ -277,4 +277,4 @@ def compile_bytecode(
     and then proceeds to compile a collection of bytecodes into the module."""
     _bootstrap_module(gctx, optimizer, ns)
     for bytecode in code:
-        exec(bytecode, ns.module.__dict__)
+        exec(bytecode, ns.module.__dict__)  # pylint: disable=exec-used
diff --git a/src/basilisp/lang/compiler/analyzer.py b/src/basilisp/lang/compiler/analyzer.py
@@ -1,3 +1,5 @@
+# pylint: disable=too-many-branches,too-many-lines,too-many-return-statements
+
 import builtins
 import collections
 import contextlib
@@ -864,7 +866,7 @@ def _await_ast(form: ISeq, ctx: AnalyzerContext) -> Await:
     )
 
 
-def _def_ast(  # pylint: disable=too-many-locals
+def _def_ast(  # pylint: disable=too-many-locals,too-many-statements
     form: ISeq, ctx: AnalyzerContext
 ) -> Def:
     assert form.first == SpecialForm.DEF
@@ -1369,7 +1371,7 @@ def __deftype_or_reify_prop_or_method_arity(
             form=form,
         )
 
-    if not sum([is_classmethod, is_property, is_staticmethod]) in {0, 1}:
+    if sum([is_classmethod, is_property, is_staticmethod]) not in {0, 1}:
         raise AnalyzerException(
             f"{special_form} member may be only one of: :classmethod, :property, "
             "or :staticmethod",
@@ -2012,7 +2014,7 @@ def _inline_fn_ast(
 
 
 @_with_meta  # noqa: MC0001
-def _fn_ast(  # pylint: disable=too-many-locals
+def _fn_ast(  # pylint: disable=too-many-locals,too-many-statements
     form: Union[llist.PersistentList, ISeq], ctx: AnalyzerContext
 ) -> Fn:
     assert form.first == SpecialForm.FN
diff --git a/src/basilisp/lang/compiler/generator.py b/src/basilisp/lang/compiler/generator.py
@@ -1,3 +1,5 @@
+# pylint: disable=too-many-lines
+
 import ast
 import collections
 import contextlib
@@ -3479,6 +3481,7 @@ def _const_record_to_py_ast(form: IRecord, ctx: GeneratorContext) -> GeneratedPy
     form_seq = runtime.to_seq(form)
     assert form_seq is not None, "IRecord types must be iterable"
 
+    # pylint: disable=no-member
     keys, vals = [], []
     vals_deps: List[ast.AST] = []
     for k, v in form_seq:
diff --git a/src/basilisp/lang/interfaces.py b/src/basilisp/lang/interfaces.py
@@ -1,11 +1,11 @@
 import itertools
 from abc import ABC, abstractmethod
+from collections.abc import Hashable
 from typing import (
     AbstractSet,
     Any,
     Callable,
     Generic,
-    Hashable,
     Iterable,
     Iterator,
     Mapping,
diff --git a/src/basilisp/lang/list.py b/src/basilisp/lang/list.py
@@ -1,7 +1,7 @@
 from typing import Optional, TypeVar, cast
 
 from pyrsistent import PList, plist  # noqa # pylint: disable=unused-import
-from pyrsistent._plist import _EMPTY_PLIST
+from pyrsistent._plist import _EMPTY_PLIST  # pylint: disable=import-private-name
 
 from basilisp.lang.interfaces import IPersistentList, IPersistentMap, ISeq, IWithMeta
 from basilisp.lang.obj import seq_lrepr as _seq_lrepr
diff --git a/src/basilisp/lang/reader.py b/src/basilisp/lang/reader.py
@@ -1,10 +1,13 @@
+# pylint: disable=too-many-branches,too-many-lines,too-many-return-statements
+
 import collections
 import contextlib
 import decimal
 import functools
 import io
 import re
 import uuid
+from collections.abc import Hashable
 from datetime import datetime
 from fractions import Fraction
 from itertools import chain
@@ -14,7 +17,6 @@
     Collection,
     Deque,
     Dict,
-    Hashable,
     Iterable,
     List,
     MutableMapping,
@@ -695,6 +697,7 @@ def _read_map(
     d: MutableMapping[Any, Any] = {}
     process_key = _map_key_processor(namespace)
     try:
+        # pylint: disable=redefined-loop-name
         for k, v in partition(list(__read_map_elems(ctx)), 2):
             k = process_key(k)
             if k in d:
diff --git a/src/basilisp/lang/reference.py b/src/basilisp/lang/reference.py
@@ -106,7 +106,7 @@ def _validate(self, val: Any, vf: Optional[RefValidator] = None):
         if vf is not None:
             try:
                 res = vf(val)
-            except Exception:
+            except Exception:  # pylint: disable=broad-exception-caught
                 res = False
 
             if not res:
diff --git a/src/basilisp/lang/runtime.py b/src/basilisp/lang/runtime.py
diff --git a/src/basilisp/prompt.py b/src/basilisp/prompt.py
diff --git a/tox.ini b/tox.ini

Original file line number	Diff line number	Diff line change
`@@ -368,7 +368,7 @@ def repl(`
`368`	`368`	`)`
`369`	`369`	`repl_module.mark_exception(e)`
`370`	`370`	`continue`
`371`		`- except Exception as e:`
	`371`	`+ except Exception as e: # pylint: disable=broad-exception-caught`
`372`	`372`	`traceback.print_exception(Exception, e, e.__traceback__)`
`373`	`373`	`repl_module.mark_exception(e)`
`374`	`374`	`continue`