Remove pylint (#408)

Ruff replaces pylint

Author: jorisroovers

.devcontainer/devcontainer.json

@@ -22,7 +22,6 @@
 			"settings": {
 				"python.defaultInterpreterPath": "/usr/local/bin/python",
 				"python.linting.enabled": true,
-				"python.linting.pylintEnabled": true,
 				"python.formatting.autopep8Path": "/usr/local/py-utils/bin/autopep8",
 				"python.formatting.blackPath": "/usr/local/py-utils/bin/black",
 				"python.formatting.yapfPath": "/usr/local/py-utils/bin/yapf",
@@ -31,7 +30,6 @@
 				"python.linting.mypyPath": "/usr/local/py-utils/bin/mypy",
 				"python.linting.pycodestylePath": "/usr/local/py-utils/bin/pycodestyle",
 				"python.linting.pydocstylePath": "/usr/local/py-utils/bin/pydocstyle",
-				"python.linting.pylintPath": "/usr/local/py-utils/bin/pylint"
 			},
 			// Add the IDs of extensions you want installed when the container is created.
 			"extensions": [

.github/workflows/checks.yml

@@ -36,7 +36,7 @@ jobs:
       - name: Code formatting (black)
         run: hatch run test:format
 
-      - name: Code linting (pylint)
+      - name: Code linting (ruff)
         run: hatch run test:lint
 
       - name: Integration tests
@@ -128,7 +128,7 @@ jobs:
       - name: Code formatting (black)
         run: hatch run test:format
 
-      - name: Code linting (pylint)
+      - name: Code linting (ruff)
         run: hatch run test:lint
 
       - name: Integration tests

.pylintrc

@@ -94,8 +94,8 @@ hatch run qa:integration-tests   # Run integration tests
 # Formatting check
 hatch run test:format            # Run formatting checks
 
-#  Linting (pylint)
-hatch run test:lint              # Run pylint
+#  Linting (ruff)
+hatch run test:lint              # Run Ruff
 
 # Project stats
 hatch run test:stats

docs/contributing.md

@@ -13,7 +13,7 @@ def _try_cache(self, cache_key, cache_populate_func):
         return self._cache[cache_key]
 
 
-def cache(original_func=None, cachekey=None):  # pylint: disable=unused-argument
+def cache(original_func=None, cachekey=None):
     """Cache decorator. Caches function return values.
     Requires the parent class to extend and initialize PropertyCache.
     Usage:

gitlint-core/gitlint/cache.py

@@ -1,4 +1,3 @@
-# pylint: disable=bad-option-value,wrong-import-position
 # We need to disable the import position checks because of the windows check that we need to do below
 import copy
 import logging
@@ -72,7 +71,7 @@ def log_system_info():
     LOG.debug("DEFAULT_ENCODING: %s", gitlint.utils.DEFAULT_ENCODING)
 
 
-def build_config(  # pylint: disable=too-many-arguments
+def build_config(
     target,
     config_path,
     c,
@@ -255,7 +254,7 @@ def __init__(self, config, config_builder, commit_hash, refspec, msg_filename, g
               help=f"Config file location [default: {DEFAULT_CONFIG_FILE}]")
 @click.option("-c", multiple=True,
               help="Config flags in format <rule>.<option>=<value> (e.g.: -c T1.line-length=80). " +
-                   "Flag can be used multiple times to set multiple config values.")  # pylint: disable=bad-continuation
+                   "Flag can be used multiple times to set multiple config values.")
 @click.option("--commit", envvar="GITLINT_COMMIT", default=None, help="Hash (SHA) of specific commit to lint.")
 @click.option("--commits", envvar="GITLINT_COMMITS", default=None,
               help="The range of commits (refspec or comma-separated hashes) to lint. [default: HEAD]")
@@ -281,7 +280,7 @@ def __init__(self, config, config_builder, commit_hash, refspec, msg_filename, g
 @click.option("-d", "--debug", envvar="GITLINT_DEBUG", help="Enable debugging output.", is_flag=True)
 @click.version_option(version=gitlint.__version__)
 @click.pass_context
-def cli(  # pylint: disable=too-many-arguments
+def cli(
         ctx, target, config, c, commit, commits, extra_path, ignore, contrib,
         msg_filename, ignore_stdin, staged, fail_without_commits, verbose,
         silent, debug,
@@ -497,5 +496,4 @@ def generate_config(ctx):
 # Let's Party!
 setup_logging()
 if __name__ == "__main__":
-    # pylint: disable=no-value-for-parameter
     cli()  # pragma: no cover

gitlint-core/gitlint/cli.py

@@ -9,7 +9,7 @@
 from gitlint import (
     options,
     rule_finder,
-    rules,  # For some weird reason pylint complains about this, pylint: disable=unused-import
+    rules,
 )
 from gitlint.contrib import rules as contrib_rules
 from gitlint.exception import GitlintError
@@ -33,7 +33,7 @@ class LintConfigError(GitlintError):
     pass
 
 
-class LintConfig:  # pylint: disable=too-many-instance-attributes
+class LintConfig:
     """Class representing gitlint configuration.
     Contains active config as well as number of methods to easily get/set the config.
     """

gitlint-core/gitlint/config.py

@@ -17,20 +17,20 @@ def _output(self, message, verbosity, exact, stream):
             if self.config.verbosity >= verbosity:
                 stream.write(message + "\n")
 
-    def v(self, message, exact=False):  # pylint: disable=invalid-name
+    def v(self, message, exact=False):
         self._output(message, 1, exact, stdout)
 
-    def vv(self, message, exact=False):  # pylint: disable=invalid-name
+    def vv(self, message, exact=False):
         self._output(message, 2, exact, stdout)
 
-    def vvv(self, message, exact=False):  # pylint: disable=invalid-name
+    def vvv(self, message, exact=False):
         self._output(message, 3, exact, stdout)
 
-    def e(self, message, exact=False):  # pylint: disable=invalid-name
+    def e(self, message, exact=False):
         self._output(message, 1, exact, stderr)
 
-    def ee(self, message, exact=False):  # pylint: disable=invalid-name
+    def ee(self, message, exact=False):
         self._output(message, 2, exact, stderr)
 
-    def eee(self, message, exact=False):  # pylint: disable=invalid-name
+    def eee(self, message, exact=False):
         self._output(message, 3, exact, stderr)

gitlint-core/gitlint/display.py

@@ -43,7 +43,7 @@ def _git(*command_parts, **kwargs):
     git_kwargs.update(kwargs)
     try:
         LOG.debug(command_parts)
-        result = sh.git(*command_parts, **git_kwargs)  # pylint: disable=unexpected-keyword-arg
+        result = sh.git(*command_parts, **git_kwargs)
         # If we reach this point and the result has an exit_code that is larger than 0, this means that we didn't
         # get an exception (which is the default sh behavior for non-zero exit codes) and so the user is expecting
         # a non-zero exit code -> just return the entire result
@@ -77,7 +77,7 @@ def git_commentchar(repository_path=None):
     """Shortcut for retrieving comment char from git config"""
     commentchar = _git("config", "--get", "core.commentchar", _cwd=repository_path, _ok_code=[0, 1])
     # git will return an exit code of 1 if it can't find a config value, in this case we fall-back to # as commentchar
-    if hasattr(commentchar, "exit_code") and commentchar.exit_code == 1:  # pylint: disable=no-member
+    if hasattr(commentchar, "exit_code") and commentchar.exit_code == 1:
         commentchar = "#"
     return commentchar.replace("\n", "")
 
@@ -190,7 +190,7 @@ def __init__(
         message,
         sha=None,
         date=None,
-        author_name=None,  # pylint: disable=too-many-arguments
+        author_name=None,
         author_email=None,
         parents=None,
         changed_files_stats=None,
@@ -286,7 +286,7 @@ class LocalGitCommit(GitCommit, PropertyCache):
     startup time and reduces gitlint's memory footprint.
     """
 
-    def __init__(self, context, sha):  # pylint: disable=super-init-not-called
+    def __init__(self, context, sha):
         PropertyCache.__init__(self)
         self.context = context
         self.sha = sha
@@ -379,7 +379,7 @@ class StagedLocalGitCommit(GitCommit, PropertyCache):
     information.
     """
 
-    def __init__(self, context, commit_message):  # pylint: disable=super-init-not-called
+    def __init__(self, context, commit_message):
         PropertyCache.__init__(self)
         self.context = context
         self.message = commit_message

gitlint-core/gitlint/git.py

@@ -1,4 +1,3 @@
-# pylint: disable=logging-not-lazy
 import logging
 
 from gitlint import display

gitlint-core/gitlint/lint.py

@@ -78,7 +78,7 @@ def find_rule_classes(extra_path):
     return rule_classes
 
 
-def assert_valid_rule_class(clazz, rule_type="User-defined"):  # pylint: disable=too-many-branches
+def assert_valid_rule_class(clazz, rule_type="User-defined"):
     """
     Asserts that a given rule clazz is valid by checking a number of its properties:
      - Rules must extend from  LineRule, CommitRule or ConfigurationRule

gitlint-core/gitlint/rule_finder.py

@@ -1,4 +1,3 @@
-# pylint: disable=inconsistent-return-statements
 import copy
 import logging
 import re

gitlint-core/gitlint/rules.py

@@ -17,10 +17,10 @@ def shell(cmd):
 
 if USE_SH_LIB:
     # import exceptions separately, this makes it a little easier to mock them out in the unit tests
-    from sh import (  # pylint: disable=import-error
+    from sh import (
         CommandNotFound,
         ErrorReturnCode,
-        git,  # pylint: disable=unused-import,import-error
+        git,
     )
 else:
 

gitlint-core/gitlint/shell.py

@@ -165,7 +165,7 @@ def clearlog(self):
         self.logcapture.clear()
 
     @contextlib.contextmanager
-    def assertRaisesMessage(self, expected_exception, expected_msg):  # pylint: disable=invalid-name
+    def assertRaisesMessage(self, expected_exception, expected_msg):
         """Asserts an exception has occurred with a given error message"""
         try:
             yield

gitlint-core/gitlint/tests/base.py

@@ -100,13 +100,13 @@ def test_body_min_length(self):
         expected_violation = rules.RuleViolation("B5", "Body message is too short (21<120)", "å" * 21, 3)
 
         rule = rules.BodyMinLength({"min-length": 120})
-        commit = self.gitcommit("Title\n\n{}\n".format("å" * 21))  # pylint: disable=consider-using-f-string
+        commit = self.gitcommit("Title\n\n{}\n".format("å" * 21))
         violations = rule.validate(commit)
         self.assertListEqual(violations, [expected_violation])
 
         # Make sure we don't get the error if the body-length is exactly the min-length
         rule = rules.BodyMinLength({"min-length": 8})
-        commit = self.gitcommit("Tïtle\n\n{}\n".format("å" * 8))  # pylint: disable=consider-using-f-string
+        commit = self.gitcommit("Tïtle\n\n{}\n".format("å" * 8))
         violations = rule.validate(commit)
         self.assertIsNone(violations)
 

gitlint-core/gitlint/tests/rules/test_body_rules.py

@@ -202,7 +202,7 @@ class MyRuleClass(parent_class):
                 assert_valid_rule_class(MyRuleClass)
 
             # option_spec is a list, but not of gitlint options
-            MyRuleClass.options_spec = ["föo", 123]  # pylint: disable=bad-option-value,redefined-variable-type
+            MyRuleClass.options_spec = ["föo", 123]
             with self.assertRaisesMessage(UserRuleError, expected_msg):
                 assert_valid_rule_class(MyRuleClass)
 
@@ -262,5 +262,5 @@ def validate(self):
             assert_valid_rule_class(MyRuleClass)
 
         # valid target, no exception should be raised
-        MyRuleClass.target = rules.CommitMessageTitle  # pylint: disable=bad-option-value,redefined-variable-type
+        MyRuleClass.target = rules.CommitMessageTitle
         self.assertIsNone(assert_valid_rule_class(MyRuleClass))

gitlint-core/gitlint/tests/rules/test_user_rules.py

@@ -1,5 +1,5 @@
 from io import StringIO
-from unittest.mock import patch  # pylint: disable=no-name-in-module, import-error
+from unittest.mock import patch
 
 from gitlint.config import LintConfig
 from gitlint.display import Display

gitlint-core/gitlint/tests/test_display.py

@@ -1,5 +1,5 @@
 from io import StringIO
-from unittest.mock import patch  # pylint: disable=no-name-in-module, import-error
+from unittest.mock import patch
 
 from gitlint.config import LintConfig, LintConfigBuilder
 from gitlint.lint import GitLinter

gitlint-core/gitlint/tests/test_lint.py

@@ -1,4 +1,3 @@
-# pylint: disable=bad-option-value,unidiomatic-typecheck,undefined-variable,no-else-return
 import codecs
 import locale
 import os
@@ -67,7 +66,7 @@ def getpreferredencoding():
         # This scenario is fairly common on Windows where git sets LC_CTYPE=C when invoking the commit-msg hook, which
         # is not a valid encoding in Python on Windows.
         try:
-            codecs.lookup(default_encoding)  # pylint: disable=no-member
+            codecs.lookup(default_encoding)
         except LookupError:
             default_encoding = fallback_encoding
 

gitlint-core/gitlint/utils.py

@@ -87,7 +87,6 @@ dependencies = [
     "pytest==7.2.0",
     "pytest-cov==4.0.0",
     "python-coveralls==2.9.3",
-    "pylint==2.15.3",
     "ruff==0.0.215",
     "radon==5.1.0",
     "pdbr==0.7.5; sys_platform != \"win32\""

pyproject.toml

@@ -1,6 +1,3 @@
-# pylint: disable=bad-option-value,unidiomatic-typecheck,undefined-variable,no-else-return,
-# pylint: disable=too-many-function-args,unexpected-keyword-arg
-
 import os
 import platform
 import shutil
@@ -42,7 +39,7 @@ def tearDown(self):
             # On windows we need to ignore errors because git might still be holding on to some files
             shutil.rmtree(repo, ignore_errors=PLATFORM_IS_WINDOWS)
 
-    def assertEqualStdout(self, output, expected):  # pylint: disable=invalid-name
+    def assertEqualStdout(self, output, expected):
         self.assertIsInstance(output, RunningCommand)
         output = output.stdout.decode(DEFAULT_ENCODING)
         output = output.replace("\r", "")
@@ -86,10 +83,9 @@ def create_file(parent_dir, content=None):
             else:
                 open_kwargs = {"mode": "w", "encoding": FILE_ENCODING}
 
-            with open(full_path, **open_kwargs) as f:  # pylint: disable=unspecified-encoding
+            with open(full_path, **open_kwargs) as f:
                 f.write(content)
         else:
-            # pylint: disable=consider-using-with
             open(full_path, "a", encoding=FILE_ENCODING).close()
 
         return test_filename
@@ -152,7 +148,7 @@ def create_tmpfile(self, content):
         else:
             open_kwargs = {"mode": "w", "encoding": FILE_ENCODING}
 
-        with open(tmpfile, **open_kwargs) as f:  # pylint: disable=unspecified-encoding
+        with open(tmpfile, **open_kwargs) as f:
             f.write(content)
 
         return tmpfilepath