Ruff: additional style enforcement (#407)

Enable additional styling rules for ruff and fix related violations.

Author: jorisroovers

docs/index.md

@@ -30,7 +30,8 @@ useful throughout the years.
  - **User-defined rules:** Want to do more then what gitlint offers out of the box? Write your own [user defined rules](user_defined_rules.md).
  - **Full unicode support:** Lint your Russian, Chinese or Emoji commit messages with ease!
  - **Production-ready:** Gitlint checks a lot of the boxes you're looking for: actively maintained, high unit test coverage, integration tests,
-   python code standards (pep8, pylint), good documentation, widely used, proven track record.
+   python code standards ([black](https://github.com/psf/black), [ruff](https://github.com/charliermarsh/ruff)),
+   good documentation, widely used, proven track record.
 
 ## Getting Started
 ### Installation

gitlint-core/gitlint/cli.py

@@ -42,8 +42,6 @@
 class GitLintUsageError(GitlintError):
     """Exception indicating there is an issue with how gitlint is used."""
 
-    pass
-
 
 def setup_logging():
     """Setup gitlint logging"""
@@ -247,40 +245,40 @@ def __init__(self, config, config_builder, commit_hash, refspec, msg_filename, g
 
 
 # fmt: off
-@click.group(invoke_without_command=True, context_settings={'max_content_width': 120},
+@click.group(invoke_without_command=True, context_settings={"max_content_width": 120},
              epilog="When no COMMAND is specified, gitlint defaults to 'gitlint lint'.")
-@click.option('--target', envvar='GITLINT_TARGET',
+@click.option("--target", envvar="GITLINT_TARGET",
               type=click.Path(exists=True, resolve_path=True, file_okay=False, readable=True),
               help="Path of the target git repository. [default: current working directory]")
-@click.option('-C', '--config', envvar='GITLINT_CONFIG',
+@click.option("-C", "--config", envvar="GITLINT_CONFIG",
               type=click.Path(exists=True, dir_okay=False, readable=True, resolve_path=True),
               help=f"Config file location [default: {DEFAULT_CONFIG_FILE}]")
-@click.option('-c', multiple=True,
+@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
-@click.option('--commit', envvar='GITLINT_COMMIT', default=None, help="Hash (SHA) of specific commit to lint.")
-@click.option('--commits', envvar='GITLINT_COMMITS', default=None,
+@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]")
-@click.option('-e', '--extra-path', envvar='GITLINT_EXTRA_PATH',
+@click.option("-e", "--extra-path", envvar="GITLINT_EXTRA_PATH",
               help="Path to a directory or python module with extra user-defined rules",
               type=click.Path(exists=True, resolve_path=True, readable=True))
-@click.option('--ignore', envvar='GITLINT_IGNORE', default="", help="Ignore rules (comma-separated by id or name).")
-@click.option('--contrib', envvar='GITLINT_CONTRIB', default="",
+@click.option("--ignore", envvar="GITLINT_IGNORE", default="", help="Ignore rules (comma-separated by id or name).")
+@click.option("--contrib", envvar="GITLINT_CONTRIB", default="",
               help="Contrib rules to enable (comma-separated by id or name).")
-@click.option('--msg-filename', type=click.File(encoding=gitlint.utils.DEFAULT_ENCODING),
+@click.option("--msg-filename", type=click.File(encoding=gitlint.utils.DEFAULT_ENCODING),
               help="Path to a file containing a commit-msg.")
-@click.option('--ignore-stdin', envvar='GITLINT_IGNORE_STDIN', is_flag=True,
+@click.option("--ignore-stdin", envvar="GITLINT_IGNORE_STDIN", is_flag=True,
               help="Ignore any stdin data. Useful for running in CI server.")
-@click.option('--staged', envvar='GITLINT_STAGED', is_flag=True,
+@click.option("--staged", envvar="GITLINT_STAGED", is_flag=True,
               help="Attempt smart guesses about meta info (like author name, email, branch, changed files, etc) " +
                    "for staged commits.")
-@click.option('--fail-without-commits', envvar='GITLINT_FAIL_WITHOUT_COMMITS', is_flag=True,
+@click.option("--fail-without-commits", envvar="GITLINT_FAIL_WITHOUT_COMMITS", is_flag=True,
               help="Hard fail when the target commit range is empty.")
-@click.option('-v', '--verbose', envvar='GITLINT_VERBOSITY', count=True, default=0,
-              help="Verbosity, more v's for more verbose output (e.g.: -v, -vv, -vvv). [default: -vvv]", )
-@click.option('-s', '--silent', envvar='GITLINT_SILENT', is_flag=True,
+@click.option("-v", "--verbose", envvar="GITLINT_VERBOSITY", count=True, default=0,
+              help="Verbosity, use multiple times for more verbose output (e.g.: -v, -vv, -vvv). [default: -vvv]", )
+@click.option("-s", "--silent", envvar="GITLINT_SILENT", is_flag=True,
               help="Silent mode (no output). Takes precedence over -v, -vv, -vvv.")
-@click.option('-d', '--debug', envvar='GITLINT_DEBUG', help="Enable debugging output.", is_flag=True)
+@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

gitlint-core/gitlint/config.py

@@ -296,7 +296,7 @@ def set_general_option(self, option_name, option_value):
         if not hasattr(self, attr_name) or attr_name[0] == "_":
             raise LintConfigError(f"'{option_name}' is not a valid gitlint option")
 
-        # else:
+        # else
         setattr(self, attr_name, option_value)
 
     def __eq__(self, other):
@@ -386,7 +386,7 @@ def delete_rules_by_attr(self, attr_name, attr_val):
         """Deletes all rules from the collection that match a given attribute name and value"""
         # Create a new list based on _rules.values() because in python 3, values() is a ValuesView as opposed to a list
         # This means you can't modify the ValueView while iterating over it.
-        for rule in [r for r in self._rules.values()]:  # pylint: disable=unnecessary-comprehension
+        for rule in list(self._rules.values()):
             if hasattr(rule, attr_name) and (getattr(rule, attr_name) == attr_val):
                 del self._rules[rule.id]
 

gitlint-core/gitlint/exception.py

@@ -1,4 +1,2 @@
 class GitlintError(Exception):
     """Based Exception class for all gitlint exceptions"""
-
-    pass

gitlint-core/gitlint/git.py

@@ -21,8 +21,6 @@
 class GitContextError(GitlintError):
     """Exception indicating there is an issue with the git context"""
 
-    pass
-
 
 class GitNotInstalledError(GitContextError):
     def __init__(self):

gitlint-core/gitlint/options.py

@@ -37,7 +37,6 @@ def __init__(self, name, value, description):
     @abstractmethod
     def set(self, value):
         """Validates and sets the option's value"""
-        pass  # pragma: no cover
 
     def __str__(self):
         return f"({self.name}: {self.value} ({self.description}))"

gitlint-core/gitlint/rule_finder.py

@@ -55,7 +55,7 @@ def find_rule_classes(extra_path):
             importlib.import_module(module)
 
         except Exception as e:
-            raise rules.UserRuleError(f"Error while importing extra-path module '{module}': {e}")
+            raise rules.UserRuleError(f"Error while importing extra-path module '{module}': {e}") from e
 
         # Find all rule classes in the module. We do this my inspecting all members of the module and checking
         # 1) is it a class, if not, skip
@@ -138,13 +138,13 @@ def assert_valid_rule_class(clazz, rule_type="User-defined"):  # pylint: disable
         if not hasattr(clazz, "validate") or not inspect.isroutine(clazz.validate):
             raise rules.UserRuleError(f"{rule_type} rule class '{clazz.__name__}' must have a 'validate' method")
     # Configuration rules must have an `apply` method
-    elif issubclass(clazz, rules.ConfigurationRule):
+    elif issubclass(clazz, rules.ConfigurationRule):  # noqa: SIM102
         if not hasattr(clazz, "apply") or not inspect.isroutine(clazz.apply):
             msg = f"{rule_type} Configuration rule class '{clazz.__name__}' must have an 'apply' method"
             raise rules.UserRuleError(msg)
 
     # LineRules must have a valid target: rules.CommitMessageTitle or rules.CommitMessageBody
-    if issubclass(clazz, rules.LineRule):
+    if issubclass(clazz, rules.LineRule):  # noqa: SIM102
         if clazz.target not in [rules.CommitMessageTitle, rules.CommitMessageBody]:
             msg = (
                 f"The target attribute of the {rule_type.lower()} LineRule class '{clazz.__name__}' "

gitlint-core/gitlint/rules.py

@@ -50,40 +50,28 @@ def __str__(self):
 class ConfigurationRule(Rule):
     """Class representing rules that can dynamically change the configuration of gitlint during runtime."""
 
-    pass
-
 
 class CommitRule(Rule):
     """Class representing rules that act on an entire commit at once"""
 
-    pass
-
 
 class LineRule(Rule):
     """Class representing rules that act on a line by line basis"""
 
-    pass
-
 
 class LineRuleTarget:
     """Base class for LineRule targets. A LineRuleTarget specifies where a given rule will be applied
     (e.g. commit message title, commit message body).
     Each LineRule MUST have a target specified."""
 
-    pass
-
 
 class CommitMessageTitle(LineRuleTarget):
     """Target class used for rules that apply to a commit message title"""
 
-    pass
-
 
 class CommitMessageBody(LineRuleTarget):
     """Target class used for rules that apply to a commit message body"""
 
-    pass
-
 
 class RuleViolation:
     """Class representing a violation of a rule. I.e.: When a rule is broken, the rule will instantiate this class
@@ -107,8 +95,6 @@ def __str__(self):
 class UserRuleError(GitlintError):
     """Error used to indicate that an error occurred while trying to load a user rule"""
 
-    pass
-
 
 class MaxLineLength(LineRule):
     name = "max-line-length"
@@ -319,7 +305,7 @@ def validate(self, commit):
         for needs_mentioned_file in self.options["files"].value:
             # if a file that we need to look out for is actually changed, then check whether it occurs
             # in the commit msg body
-            if needs_mentioned_file in commit.changed_files:
+            if needs_mentioned_file in commit.changed_files:  # noqa: SIM102
                 if needs_mentioned_file not in " ".join(commit.message.body):
                     violation_message = f"Body does not mention changed file '{needs_mentioned_file}'"
                     violations.append(RuleViolation(self.id, violation_message, None, len(commit.message.body) + 1))

gitlint-core/gitlint/shell.py

@@ -27,8 +27,6 @@ def shell(cmd):
     class CommandNotFound(Exception):
         """Exception indicating a command was not found during execution"""
 
-        pass
-
     class ShResult:
         """Result wrapper class. We use this to more easily migrate from using https://amoffat.github.io/sh/ to using
         the builtin subprocess module"""
@@ -45,8 +43,6 @@ def __str__(self):
     class ErrorReturnCode(ShResult, Exception):
         """ShResult subclass for unexpected results (acts as an exception)."""
 
-        pass
-
     def git(*command_parts, **kwargs):
         """Git shell wrapper.
         Implemented as separate function here, so we can do a 'sh' style imports:

gitlint-core/gitlint/tests/base.py

@@ -173,11 +173,11 @@ def assertRaisesMessage(self, expected_exception, expected_msg):  # pylint: disa
             exception_msg = str(exc)
             if exception_msg != expected_msg:
                 error = f"Right exception, wrong message:\n      got: {exception_msg}\n expected: {expected_msg}"
-                raise self.fail(error)
+                raise self.fail(error) from exc
             # else: everything is fine, just return
             return
         except Exception as exc:
-            raise self.fail(f"Expected '{expected_exception.__name__}' got '{exc.__class__.__name__}'")
+            raise self.fail(f"Expected '{expected_exception.__name__}' got '{exc.__class__.__name__}'") from exc
 
         # No exception raised while we expected one
         raise self.fail(f"Expected to raise {expected_exception.__name__}, didn't get an exception at all")

gitlint-core/gitlint/tests/cli/test_cli.py

@@ -218,8 +218,7 @@ def test_lint_commit(self, sh, _):
             self.assertEqual(result.exit_code, 2)
 
     @patch("gitlint.cli.get_stdin_data", return_value=False)
-    @patch("gitlint.git.sh")
-    def test_lint_commit_negative(self, sh, _):
+    def test_lint_commit_negative(self, _):
         """Negative test for --commit option"""
 
         # Try using --commit and --commits at the same time (not allowed)