Use ruff instead of flake8

And fix some error along the way

Author: philpep

.flake8

@@ -14,7 +14,6 @@ dist
 AUTHORS
 ChangeLog
 coverage.xml
-flake8.report
 junit*.xml
 doc/build
 .cache

.gitignore

@@ -25,6 +25,13 @@ repos:
       - id: check-merge-conflict
       - id: debug-statements
         language_version: python3
+  - repo: local
+    hooks:
+    - id: ruff-check
+      name: ruff-check
+      entry: ruff check
+      language: system
+      types: [python]
   - repo: https://github.com/PyCQA/isort
     rev: 5.12.0
     hooks:
@@ -37,18 +44,6 @@ repos:
     hooks:
       - id: black
         language_version: python3
-  - repo: https://github.com/pycqa/flake8.git
-    rev: 6.0.0
-    hooks:
-      - id: flake8
-        language_version: python3
-        additional_dependencies:
-          - flake8-bugbear
-          - flake8-comprehensions
-          - flake8-debugger
-          - flake8-logging-format
-          - flake8-pep3101
-          - flake8-print
   - repo: https://github.com/pre-commit/mirrors-mypy
     rev: v1.4.1
     hooks:

.pre-commit-config.yaml

@@ -30,10 +30,7 @@ To run only some selected tests::
 Code style
 ==========
 
-Your code must pass without errors under `flake8
-<https://flake8.readthedocs.io>`_ with the extension `hacking
-<https://docs.openstack.org/hacking/latest/>`_::
+Your code must pass without errors under `ruff <https://docs.astral.sh/ruff/>`_
 
-
-    pip install hacking
-    flake8 testinfra
+    pip install ruff
+    ruff check

CONTRIBUTING.rst

@@ -5,7 +5,6 @@ recursive-include doc *.py *.rst *.svg
 include doc/source/_templates/piwik.html
 include doc/Makefile
 include tox.ini
-include .flake8
 include mypy.ini
 include Makefile
 include *.yaml
@@ -15,6 +14,7 @@ include ansible.cfg
 include dev-requirements.txt
 include test-requirements.txt
 include LICENSE
+include *.toml
 exclude .editorconfig
 exclude .gitignore
 prune doc/build

MANIFEST.in

@@ -0,0 +1,71 @@
+target-version = "py39"
+
+[lint]
+select = [
+    # pycodestyle
+    "E",
+    # Pyflakes
+    "F",
+    # pyupgrade
+    "UP",
+    # flake8-bugbear
+    "B",
+    # flake8-debugger
+    "T10",
+    # flake8-logging
+    "G",
+    # flake8-comprehension
+    "C4",
+    # flake8-simplify
+    "SIM",
+    # flake8-print
+    "T20",
+    # individual rules
+    "RUF100", # unused-noqa
+    # imports
+    "I",
+]
+
+# For error codes, see https://docs.astral.sh/ruff/rules/#error-e
+ignore = [
+# argument is shadowing a Python builtin
+  "A001",
+  "A002",
+  "A005",
+# attribute overriding builtin name
+  "A003",
+# [bugbear] Do not use mutable data structures for argument defaults (I choose by myself)
+  "B006",
+# [bugbear] Do not perform function calls in argument defaults (conflict with fastapi dependency system)
+  "B008",
+# [bugbear] Function definition does not bind loop variable
+  "B023",
+# closing bracket does not match indentation of opening bracket's line (disagree with emacs python mode)
+#  "E123",
+# continuation line over-indented for hanging indent line (disagree with emacs python mode)
+  # "E126",
+# whitespace before ':'
+  "E203",
+# missing whitespace around arithmetic operator (disagree when in parameter)
+  "E226",
+# line too long
+  "E501",
+# multiple statements on one line (def) (not compatible with black)
+#  "E704",
+# do not assign lambda expression (this is inconvenient)
+  "E731",
+# Logging statement uses exception in arguments (seems legit to display only str representation of exc)
+#  "G200",
+# [string-format] format string does contain unindexed parameters (don't care of py2.6)
+#  "P101",
+# [string-format] docstring does contain unindexed parameters
+#  "P102",
+# [string-format] other string does contain unindexed parameters
+#  "P103",
+# Line break occurred before a binary operator (to keep operators aligned)
+#  "W503",
+]
+
+[lint.isort]
+known-first-party = ["testinfra"]
+section-order = ["future", "standard-library", "third-party", "first-party", "local-folder"]

ruff.toml

@@ -78,13 +78,11 @@ def setup_ansible_config(tmpdir, name, host, user, port, key):
     vault_password_file.write("polichinelle\n")
     ansible_cfg = tmpdir.join("ansible.cfg")
     ansible_cfg.write(
-        
-            "[defaults]\n"
-            f"vault_password_file={str(vault_password_file)}\n"
-            "host_key_checking=False\n\n"
-            "[ssh_connection]\n"
-            "pipelining=True\n"
-        
+        "[defaults]\n"
+        f"vault_password_file={str(vault_password_file)}\n"
+        "host_key_checking=False\n\n"
+        "[ssh_connection]\n"
+        "pipelining=True\n"
     )
 
 
@@ -156,7 +154,8 @@ def host(request, tmpdir_factory):
         hostname = spec.name
         tmpdir = tmpdir_factory.mktemp(str(id(request)))
         key = tmpdir.join("ssh_key")
-        key.write(open(os.path.join(BASETESTDIR, "ssh_key")).read())
+        with open(os.path.join(BASETESTDIR, "ssh_key")) as f:
+            key.write(f.read())
         key.chmod(384)  # octal 600
         if kw["connection"] == "ansible":
             setup_ansible_config(
@@ -168,26 +167,21 @@ def host(request, tmpdir_factory):
         else:
             ssh_config = tmpdir.join("ssh_config")
             ssh_config.write(
-                
-                    f"Host {hostname}\n"
-                    f"  Hostname {docker_host}\n"
-                    f"  Port {port}\n"
-                    "  UserKnownHostsFile /dev/null\n"
-                    "  StrictHostKeyChecking no\n"
-                    f"  IdentityFile {str(key)}\n"
-                    "  IdentitiesOnly yes\n"
-                    "  LogLevel FATAL\n"
-                
+                f"Host {hostname}\n"
+                f"  Hostname {docker_host}\n"
+                f"  Port {port}\n"
+                "  UserKnownHostsFile /dev/null\n"
+                "  StrictHostKeyChecking no\n"
+                f"  IdentityFile {str(key)}\n"
+                "  IdentitiesOnly yes\n"
+                "  LogLevel FATAL\n"
             )
             kw["ssh_config"] = str(ssh_config)
 
         # Wait ssh to be up
         service = testinfra.get_host(docker_id, connection="docker").service
 
-        if image == "rockylinux9":
-            service_name = "sshd"
-        else:
-            service_name = "ssh"
+        service_name = "sshd" if image == "rockylinux9" else "ssh"
 
         while not service(service_name).is_running:
             time.sleep(0.5)

test/conftest.py

@@ -125,18 +125,16 @@ def test_sudo(host):
 def test_ansible_get_hosts():
     with tempfile.NamedTemporaryFile() as f:
         f.write(
-            
-                b"ungrp\n"
-                b"[g1]\n"
-                b"debian\n"
-                b"[g2]\n"
-                b"rockylinux\n"
-                b"[g3:children]\n"
-                b"g1\n"
-                b"g2\n"
-                b"[g4:children]\n"
-                b"g3"
-            
+            b"ungrp\n"
+            b"[g1]\n"
+            b"debian\n"
+            b"[g2]\n"
+            b"rockylinux\n"
+            b"[g3:children]\n"
+            b"g1\n"
+            b"g2\n"
+            b"[g4:children]\n"
+            b"g3"
         )
         f.flush()
 
@@ -158,16 +156,14 @@ def get_hosts(spec):
 def test_ansible_get_variables():
     with tempfile.NamedTemporaryFile() as f:
         f.write(
-            
-                b"debian a=b c=d\n"
-                b"rockylinux e=f\n"
-                b"[all:vars]\n"
-                b"a=a\n"
-                b"[g]\n"
-                b"debian\n"
-                b"[g:vars]\n"
-                b"x=z\n"
-            
+            b"debian a=b c=d\n"
+            b"rockylinux e=f\n"
+            b"[all:vars]\n"
+            b"a=a\n"
+            b"[g]\n"
+            b"debian\n"
+            b"[g:vars]\n"
+            b"x=z\n"
         )
         f.flush()
 

test/test_backends.py

@@ -50,7 +50,7 @@ def test_package(host, docker_image):
     }[docker_image]
     if release is None:
         with pytest.raises(NotImplementedError):
-            ssh.release
+            ssh.release  # noqa: B018
     else:
         assert release in ssh.release
 
@@ -66,7 +66,7 @@ def test_held_package(host):
 def test_rpmdb_corrupted(host):
     host.check_output("dd if=/dev/zero of=/var/lib/rpm/rpmdb.sqlite bs=1024 count=1")
     with pytest.raises(RuntimeError) as excinfo:
-        host.package("zsh").is_installed
+        host.package("zsh").is_installed  # noqa: B018
     assert (
         "Could not check if RPM package 'zsh' is installed. error: sqlite failure:"
     ) in str(excinfo.value)
@@ -82,7 +82,7 @@ def test_non_default_package_tool(host):
 @pytest.mark.destructive
 def test_uninstalled_package_version(host):
     with pytest.raises(AssertionError) as excinfo:
-        host.package("zsh").version
+        host.package("zsh").version  # noqa: B018
     assert (
         "The package zsh is not installed, dpkg-query output: unknown ok not-installed"
         in str(excinfo.value)
@@ -91,7 +91,7 @@ def test_uninstalled_package_version(host):
     host.check_output("apt-get -y remove sudo")
     assert not host.package("sudo").is_installed
     with pytest.raises(AssertionError) as excinfo:
-        host.package("sudo").version
+        host.package("sudo").version  # noqa: B018
     assert (
         "The package sudo is not installed, dpkg-query output: "
         "deinstall ok config-files 1.9."
@@ -114,11 +114,7 @@ def test_systeminfo(host, docker_image):
 
 @all_images
 def test_ssh_service(host, docker_image):
-    if docker_image == "rockylinux9":
-        name = "sshd"
-    else:
-        name = "ssh"
-
+    name = "sshd" if docker_image == "rockylinux9" else "ssh"
     ssh = host.service(name)
     # wait at max 10 seconds for ssh is running
     for _ in range(10):
@@ -196,7 +192,7 @@ def test_socket(host):
 
     assert not host.socket("tcp://4242").is_listening
 
-    if not host.backend.get_connection_type() == "docker":
+    if host.backend.get_connection_type() != "docker":
         # FIXME
         for spec in (
             "tcp://22",
@@ -324,7 +320,7 @@ def test_file(host):
     assert link.linked_to == "/d/f"
     assert link.linked_to == f
     assert f == host.file("/d/f")
-    assert not d == f
+    assert d != f
 
     host.check_output("ln /d/f /d/h")
     hardlink = host.file("/d/h")
@@ -334,7 +330,7 @@ def test_file(host):
     assert isinstance(f.inode, int)
     assert hardlink.inode == f.inode
     assert f == host.file("/d/f")
-    assert not d == f
+    assert d != f
 
     host.check_output("rm -f /d/p && mkfifo /d/p")
     assert host.file("/d/p").is_pipe
@@ -516,7 +512,7 @@ def test_supervisor(host, supervisorctl_path, supervisorctl_conf):
     host.run("service supervisor stop")
     assert not host.service("supervisor").is_running
     with pytest.raises(RuntimeError) as excinfo:
-        host.supervisor(
+        host.supervisor(  # noqa: B018
             "tail",
             supervisorctl_path=supervisorctl_path,
             supervisorctl_conf=supervisorctl_conf,
@@ -551,9 +547,9 @@ def test_sudo_from_root(host):
 
 def test_sudo_fail_from_root(host):
     assert host.user().name == "root"
-    with pytest.raises(AssertionError) as exc:
-        with host.sudo("unprivileged"):
-            assert host.user().name == "unprivileged"
+    with host.sudo("unprivileged"):
+        assert host.user().name == "unprivileged"
+        with pytest.raises(AssertionError) as exc:
             host.check_output("ls /root/invalid")
     assert str(exc.value).startswith("Unexpected exit code")
     with host.sudo():

test/test_modules.py

@@ -40,7 +40,7 @@ def get_backend_class(connection: str) -> type["testinfra.backend.base.BaseBacke
     try:
         classpath = BACKENDS[connection]
     except KeyError:
-        raise RuntimeError(f"Unknown connection type '{connection}'")
+        raise RuntimeError(f"Unknown connection type '{connection}'") from None
     module, name = classpath.rsplit(".", 1)
     return getattr(importlib.import_module(module), name)  # type: ignore[no-any-return]
 
@@ -109,9 +109,6 @@ def get_backends(
             key = (name, frozenset(kw.items()))
             if key in backends:
                 continue
-            if connection == "local":
-                backend = klass(**kw)
-            else:
-                backend = klass(name, **kw)
+            backend = klass(**kw) if connection == "local" else klass(name, **kw)
             backends[key] = backend
     return list(backends.values())