Switch formatting and linting to ruff

Author: mdellweg

.ci/bootstrap_catdog.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 
-set -euv
+set -eu
 
 GITHUB_EVENT_NAME="${GITHUB_EVENT_NAME:-not_pull_request}"
 if [ "$GITHUB_EVENT_NAME" = "pull_request" ]
@@ -23,8 +23,8 @@ sed -i "s/disabled_redis_runners: \[\]/disabled_redis_runners: [s3]/g" ../pulp_c
 cd ../pulp_catdog
 
 # ignore unused imports
-flake8 .ci || exit 1 # check ci files before ignoring imports
-sed -i -e '/^ignore/s/$/,F401/' .flake8
+ruff check .ci || exit 1 # check ci files before ignoring imports
+echo $'[tool.ruff.lint]\nignore = [ "F401" ]' >> pyproject.toml
 
 # include post_before_script to generate migrations
 cp ../plugin_template/.ci/post_before_script.sh .github/workflows/scripts

.ci/post_before_script.sh

@@ -1,6 +1,6 @@
 #!/bin/sh
 
-set -euv
+set -eu
 
 cmd_prefix pulpcore-manager makemigrations
 cmd_user_prefix pulpcore-manager migrate

.flake8

@@ -30,10 +30,9 @@ jobs:
       - name: "Lint plugin_template"
         working-directory: "plugin_template"
         run: |
-          pip3 install black~=26.3 flake8
-          black --version
-          black --check --diff plugin-template utils.py
-          flake8 plugin-template utils.py
+          pip3 install ruff
+          ruff format --check --diff plugin-template utils.py
+          ruff check --diff plugin-template utils.py
       - name: "Bootstrap catdog plugin"
         working-directory: "plugin_template"
         run: |
@@ -49,16 +48,13 @@ jobs:
         run: |
           yamllint -s -d '{extends: relaxed, rules: {line-length: disable}}' .github/workflows
 
-      # run black separately from flake8 to get a diff
-      - name: "Run black"
+      - name: "Check formatting"
         run: |
-          black --version
-          black --check --diff .
+          ruff format --check --diff
 
-      # Lint code.
-      - name: "Run flake8"
+      - name: "Lint code"
         run: |
-          flake8
+          ruff check --diff
 
       - name: "Check for common gettext problems"
         run: |

.github/workflows/lint.yml

@@ -36,10 +36,6 @@ You can edit them according to your needs to control subsequent calls to `plugin
 The following settings are stored in `template_config.yml`.
 
 ```bash
-  black                 Boolean, whether to use black to format python source files.
-
-  flake8                Boolean, whether to use flake8 to lint python source files.
-
   check_commit_message  Include inspection of commit message for a reference to an issue in
                         pulp.plan.io.
 
@@ -118,9 +114,6 @@ The following settings are stored in `template_config.yml`.
                         layers in Containerfile configuring the base Pulp image. `<scenario>` is one
                         of "azure", "s3", "gcp".
 
-  pydocstyle            Boolean, whether to have flake8 use pydocstyle to check for compliance with
-                        Python docstring conventions.
-
   release_user          The GitHub user that is associated with the RELEASE_TOKEN secret on GitHub.
                         The username and token are used to push the Changelog and version bump commits
                         created by the release workflow. The default is 'pulpbot'.

README.md

@@ -2,14 +2,14 @@
 # /// script
 # requires-python = ">=3.11"
 # dependencies = [
-#     "black~=26.3",
-#     "jamldump>=1.2.0,<1.3.0",
-#     "jinja2>=3.1.6,<3.2.0",
+#     "jamldump>=1.2.0,<1.3",
+#     "jinja2>=3.1.6,<3.2",
 #     "packaging>=26.0,<27",
-#     "pyyaml>=6.0.3,<6.1.0",
+#     "pyyaml>=6.0.3,<6.1",
 #     "requests~=2.32.3",
-#     "requests-cache>=1.3.0,<1.4.0",
-#     "tomlkit>=0.14.0,<0.14.1",
+#     "requests-cache>=1.3.0,<1.4",
+#     "ruff>=0.15.11,<0.16",
+#     "tomlkit>=0.14.0,<0.15",
 # ]
 # ///
 
@@ -29,7 +29,6 @@ from jinja2 import Environment, FileSystemLoader
 import utils
 
 DEFAULT_SETTINGS = {
-    "black": True,
     "check_commit_message": True,
     "check_gettext": True,
     "check_manifest": True,
@@ -46,10 +45,9 @@ DEFAULT_SETTINGS = {
     "disabled_redis_runners": [],
     "docker_fixtures": False,
     "extra_files": [],
-    "flake8_ignore": [],
-    "flake8": True,
     "github_org": "pulp",
     "latest_release_branch": None,
+    "lint_ignore": [],
     "lint_requirements": True,
     "os_required_packages": [],
     "parallel_test_workers": 8,
@@ -130,7 +128,6 @@ DEFAULT_SETTINGS = {
             },
         },
     },
-    "pydocstyle": True,
     "release_email": "pulp-infra@redhat.com",
     "release_user": "pulpbot",
     "stalebot_days_until_close": 30,
@@ -170,6 +167,7 @@ DEPRECATED_FILES = {
         ".ci/scripts/update_github.sh",
         ".ci/scripts/update_redmine.sh",
         ".ci/scripts/upper_bound.py",
+        ".flake8",
         ".github/template_gitref",
         ".github/workflows/kanban.yml",
         ".github/workflows/changelog.yml",
@@ -188,6 +186,7 @@ DEPRECATED_FILES = {
         ".github/workflows/scripts/publish_plugin_pypi.sh",
         ".travis",
         ".travis.yml",
+        "dev_requirements.txt",
         "flake8.cfg",
         "CHANGES/.TEMPLATE.rst",
     ],
@@ -321,10 +320,20 @@ def load_config(plugin_config_path: Path, verbose: bool) -> tuple[dict[str, t.An
     # Migrate api_root to (scenario) setting
     if config["pulp_settings"] is None:
         config["pulp_settings"] = {}
-    config["pulp_settings"].setdefault("api_root", config.get("api_root", "/pulp/"))
+        write_new_config = True
+    if "api_root" not in config["pulp_settings"]:
+        config["pulp_settings"]["api_root"] = "/pulp/"
+        write_new_config = True
     if config["pulp_settings_s3"] is None:
         config["pulp_settings_s3"] = {}
-    config["pulp_settings_s3"].setdefault("api_root", "/rerouted/djnd/")
+        write_new_config = True
+    if "api_root" not in config["pulp_settings_s3"]:
+        config["pulp_settings_s3"]["api_root"] = "/rerouted/djnd/"
+        write_new_config = True
+    # Migrate flake8_ignore
+    if "flake8_ignore" in config:
+        config["lint_ignore"] = config.pop("flake8_ignore")
+        write_new_config = True
     # remove deprecated options
     for key in set(config.keys()) - set(DEFAULT_SETTINGS.keys()):
         config.pop(key)
@@ -385,7 +394,6 @@ def write_template_section(
         "current_version": utils.current_version(plugin_root_dir),
         "pulpdocs_branch": PULPDOCS_BRANCH,
         "is_pulpdocs_member": config["plugin_name"] in utils.get_pulpdocs_members(PULPDOCS_BRANCH),
-        "black_requirement": utils.black_requirement(),
         "config": config,
         **config,
     }
@@ -501,11 +509,10 @@ def remove_deprecated_files(plugin_root_dir: Path, sections: list[str]) -> None:
 
 
 def reformat_files(plugin_root_dir: Path, config: dict[str, t.Any]) -> None:
-    if config["black"]:
-        try:
-            subprocess.run(["black", "--quiet", "."], cwd=plugin_root_dir)
-        except FileNotFoundError:
-            pass
+    try:
+        subprocess.run(["ruff", "format"], cwd=plugin_root_dir)
+    except FileNotFoundError:
+        pass
 
 
 if __name__ == "__main__":

plugin-template

@@ -6,18 +6,6 @@ title_format = "{version} ({project_date})"
 template = "CHANGES/.TEMPLATE.rst"
 issue_format = "`#{issue} <https://github.com/pulp/plugin_template/issues/{issue}>`__"
 
-[tool.black]
+[tool.ruff]
 line-length = 100
-target-version = ["py36", "py37", "py38"]
-exclude = '''
-/(
-    \.eggs
-  | \.git
-  | \.venv
-  | _build
-  | build
-  | dist
-  | migrations
-  | docs
-)/
-'''
+extend-exclude = ["templates"]

pyproject.toml

@@ -1,9 +1,8 @@
-# This (black) is copied into templates/github/lint_requirement.txt.j2
-black~=26.3  # Pin style to the year. https://black.readthedocs.io/en/stable/faq.html#how-stable-is-black-s-style
 jamldump>=1.2.0,<1.3.0
 jinja2
 packaging>=26.0,<27
 pyyaml
 requests~=2.32.3
 requests_cache
+ruff
 tomlkit

requirements.txt

@@ -20,7 +20,6 @@ fi
 
 PLUGIN_NAME="$(python ../plugin_template/scripts/get_template_config_value.py plugin_name)"
 CI_UPDATE_DOCS="$(python ../plugin_template/scripts/get_template_config_value.py ci_update_docs)"
-USE_BLACK="$(python ../plugin_template/scripts/get_template_config_value.py black)"
 
 if [[ "${CI_UPDATE_DOCS}" == "True" ]]; then
   DOCS=("--docs")

scripts/update_ci.sh

@@ -82,37 +82,16 @@ underlines = ["", "", ""]
         name = "Misc"
         showcontent = false
 
-{% if black %}
-[tool.black]
-line-length = 100
-target-version = ["py39", "py310", "py311", "py312"]
-exclude = '''
-/(
-    \.eggs
-  | \.git
-  | \.venv
-  | _build
-  | build
-  | dist
-  | migrations
-  | docs
-  | protobuf
-)/
-'''
-{% endif %}
-
 {% if check_manifest %}
 [tool.check-manifest]
 ignore = [
     ".git-blame-ignore-revs",
     "AGENTS.md",
     "CHANGES/**",
     "CLAUDE.md",
-    "dev_requirements.txt",
     "doc_requirements.txt",
     "lint_requirements.txt",
     "docs/**",
-    ".flake8",
     "template_config.yml",
     ".coveragerc",
     ".dependabot/config.yml",