Add black linting using

./plugin-template --github pulp_python

Author: dosas

.ci/scripts/calc_constraints.py

@@ -19,7 +19,9 @@
     import tomli as tomllib
 
 
-CORE_TEMPLATE_URL = "https://raw.githubusercontent.com/pulp/pulpcore/main/template_config.yml"
+CORE_TEMPLATE_URL = (
+    "https://raw.githubusercontent.com/pulp/pulpcore/main/template_config.yml"
+)
 
 
 def fetch_pulpcore_upper_bound(requirement):
@@ -89,7 +91,9 @@ def to_lower_bound(req):
                     # TODO Semver libraries should be allowed too.
                     operator = "~="
                     if len(Version(min_version).release) != 3:
-                        raise RuntimeError("Pulpcore lower bound must be in the form '>=x.y.z'.")
+                        raise RuntimeError(
+                            "Pulpcore lower bound must be in the form '>=x.y.z'."
+                        )
                 else:
                     operator = "=="
                 return f"{requirement.name}{operator}{min_version}"
@@ -109,8 +113,14 @@ def main():
 
     modifier = to_upper_bound if args.upper else to_lower_bound
 
-    req_files = [filename for filename in args.filename if not filename.endswith("pyproject.toml")]
-    pyp_files = [filename for filename in args.filename if filename.endswith("pyproject.toml")]
+    req_files = [
+        filename
+        for filename in args.filename
+        if not filename.endswith("pyproject.toml")
+    ]
+    pyp_files = [
+        filename for filename in args.filename if filename.endswith("pyproject.toml")
+    ]
     if req_files:
         with fileinput.input(files=req_files) as req_file:
             for line in req_file:

.ci/scripts/check_requirements.py

@@ -53,10 +53,14 @@ def main():
                     if line.startswith("git+"):
                         # The single exception...
                         if "pulp-smash" not in line:
-                            errors.append(f"{filename}:{nr}: Invalid source requirement: {line}")
+                            errors.append(
+                                f"{filename}:{nr}: Invalid source requirement: {line}"
+                            )
                     elif line.startswith("-r "):
                         if check_r:
-                            errors.append(f"{filename}:{nr}: Invalid deferred requirement: {line}")
+                            errors.append(
+                                f"{filename}:{nr}: Invalid deferred requirement: {line}"
+                            )
                     else:
                         errors.append(f"{filename}:{nr}: Unreadable requirement {line}")
                 else:
@@ -66,13 +70,19 @@ def main():
                             not req.name.startswith("opentelemetry")
                             and req.name != "pulp-python-client"
                         ):
-                            errors.append(f"{filename}:{nr}: Prerelease versions found in {line}.")
+                            errors.append(
+                                f"{filename}:{nr}: Prerelease versions found in {line}."
+                            )
                     ops = [spec.operator for spec in req.specifier]
                     if "~=" in ops:
-                        warnings.warn(f"{filename}:{nr}: Please avoid using ~= on {req.name}!")
+                        warnings.warn(
+                            f"{filename}:{nr}: Please avoid using ~= on {req.name}!"
+                        )
                     elif "<" not in ops and "<=" not in ops and "==" not in ops:
                         if check_upperbound:
-                            errors.append(f"{filename}:{nr}: Upper bound missing in {line}.")
+                            errors.append(
+                                f"{filename}:{nr}: Upper bound missing in {line}."
+                            )
         except FileNotFoundError:
             # skip this test for plugins that don't use this requirements.txt
             pass

.ci/scripts/collect_changes.py

@@ -40,7 +40,9 @@
 TITLE_REGEX = (
     "("
     + re.escape(
-        TITLE_FORMAT.format(name="NAME_REGEX", version="VERSION_REGEX", project_date="DATE_REGEX")
+        TITLE_FORMAT.format(
+            name="NAME_REGEX", version="VERSION_REGEX", project_date="DATE_REGEX"
+        )
     )
     .replace("NAME_REGEX", NAME_REGEX)
     .replace("VERSION_REGEX", VERSION_CAPTURE_REGEX, 1)
@@ -65,13 +67,17 @@ def _tokenize_changes(splits):
 def split_changelog(changelog):
     preamble, rest = changelog.split(START_STRING, maxsplit=1)
     split_rest = re.split(TITLE_REGEX, rest)
-    return preamble + START_STRING + split_rest[0], list(_tokenize_changes(split_rest[1:]))
+    return preamble + START_STRING + split_rest[0], list(
+        _tokenize_changes(split_rest[1:])
+    )
 
 
 def main():
     repo = Repo(os.getcwd())
     remote = repo.remotes[0]
-    branches = [ref for ref in remote.refs if re.match(r"^([0-9]+)\.([0-9]+)$", ref.remote_head)]
+    branches = [
+        ref for ref in remote.refs if re.match(r"^([0-9]+)\.([0-9]+)$", ref.remote_head)
+    ]
     branches.sort(key=lambda ref: parse_version(ref.remote_head), reverse=True)
     branches = [ref.name for ref in branches]
 

.github/workflows/lint.yml

@@ -43,6 +43,12 @@ jobs:
           bump-my-version bump --dry-run release
           bump-my-version show-bump
 
+      # run black separately from flake8 to get a diff
+      - name: "Run black"
+        run: |
+          black --version
+          black --check --diff .
+
       # Lint code.
       - name: "Run flake8"
         run: |

.github/workflows/scripts/stage-changelog-for-default-branch.py

@@ -23,7 +23,9 @@
     """
 )
 
-parser = argparse.ArgumentParser(formatter_class=argparse.RawTextHelpFormatter, description=helper)
+parser = argparse.ArgumentParser(
+    formatter_class=argparse.RawTextHelpFormatter, description=helper
+)
 
 parser.add_argument(
     "release_version",

.github/workflows/scripts/update_backport_labels.py

@@ -28,9 +28,13 @@ def random_color():
 session.headers.update(headers)
 
 # get all labels from the repository's current state
-response = session.get("https://api.github.com/repos/pulp/pulp_python/labels", headers=headers)
+response = session.get(
+    "https://api.github.com/repos/pulp/pulp_python/labels", headers=headers
+)
 assert response.status_code == 200
-old_labels = set([x["name"] for x in response.json() if x["name"].startswith("backport-")])
+old_labels = set(
+    [x["name"] for x in response.json() if x["name"].startswith("backport-")]
+)
 
 # get list of branches from template_config.yml
 with open("./template_config.yml", "r") as f:

lint_requirements.txt

@@ -5,8 +5,10 @@
 #
 # For more info visit https://github.com/pulp/plugin_template
 
+black==24.3.0
 bump-my-version
 check-manifest
 flake8
+flake8-black
 packaging
 yamllint

template_config.yml

@@ -4,7 +4,7 @@
 # generated with plugin_template
 
 api_root: /pulp/
-black: false
+black: true
 check_commit_message: true
 check_gettext: true
 check_manifest: true
@@ -72,4 +72,3 @@ test_reroute: true
 test_s3: true
 test_storages_compat_layer: true
 use_issue_template: true
-