style(ruff): switch from flake8, isort, bandit & black to ruff (#18)

* style(lint): switched to ruff

* docs(makefile): update commands

* build(deps): add poetry.lock

* ci(github): update existing workflows

* ci(style): update style job

* style(pyproject): update ruff exceptions

* style(ruff): fix lint

* ci(labeler): add job for triage

* ci(dependabot): configure dependabot

* docs(readme): update badges

* ci(labeler): add docker label

* ci(pr): add PR title checker

Author: frgfm

.flake8

@@ -1,4 +1,4 @@
-# Copyright (C) 2022, François-Guillaume Fernandez.
+# Copyright (C) 2022-2024, François-Guillaume Fernandez.
 
 # This program is licensed under the Apache License version 2.
 # See LICENSE or go to <https://www.apache.org/licenses/LICENSE-2.0.txt> for full license details.
@@ -13,26 +13,22 @@
 
 import locale
 import re
-import subprocess
+import subprocess  # noqa S404
 import sys
-from collections import namedtuple
+from typing import NamedTuple
 
 PY3 = sys.version_info >= (3, 0)
 
 
 # System Environment Information
-SystemEnv = namedtuple(
-    "SystemEnv",
-    [
-        "os",
-        "python_version",
-    ],
-)
+class SystemEnv(NamedTuple):
+    os: str
+    python_version: str
 
 
 def run(command):
     """Returns (return-code, stdout, stderr)"""
-    p = subprocess.Popen(command, stdout=subprocess.PIPE, stderr=subprocess.PIPE, shell=True)
+    p = subprocess.Popen(command, stdout=subprocess.PIPE, stderr=subprocess.PIPE, shell=True)  # noqa S602
     output, err = p.communicate()
     rc = p.returncode
     if PY3:
@@ -64,14 +60,13 @@ def run_and_parse_first_match(run_lambda, command, regex):
 def get_platform():
     if sys.platform.startswith("linux"):
         return "linux"
-    elif sys.platform.startswith("win32"):
+    if sys.platform.startswith("win32"):
         return "win32"
-    elif sys.platform.startswith("cygwin"):
+    if sys.platform.startswith("cygwin"):
         return "cygwin"
-    elif sys.platform.startswith("darwin"):
+    if sys.platform.startswith("darwin"):
         return "darwin"
-    else:
-        return sys.platform
+    return sys.platform
 
 
 def get_mac_version(run_lambda):
@@ -137,14 +132,14 @@ def get_env_info():
 
 def pretty_str(envinfo):
     def replace_nones(dct, replacement="Could not collect"):
-        for key in dct.keys():
+        for key in dct:
             if dct[key] is not None:
                 continue
             dct[key] = replacement
         return dct
 
     def replace_bools(dct, true="Yes", false="No"):
-        for key in dct.keys():
+        for key in dct:
             if dct[key] is True:
                 dct[key] = true
             elif dct[key] is False:

.github/collect_env.py

@@ -0,0 +1,21 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "daily"
+      time: "06:00"
+      timezone: "Europe/Paris"
+    reviewers:
+      - "frgfm"
+    assignees:
+      - "frgfm"
+    allow:
+      - dependency-name: "ruff"
+      - dependency-name: "mypy"
+      - dependency-name: "pre-commit"

.github/dependabot.yml

@@ -0,0 +1,35 @@
+'module: src':
+- changed-files:
+  - any-glob-to-any-file: src/*
+
+'module: action':
+- changed-files:
+  - any-glob-to-any-file: action.yml
+
+'topic: ci':
+- changed-files:
+  - any-glob-to-any-file: .github/*
+
+'topic: docs':
+- changed-files:
+  - any-glob-to-any-file:
+    - README.md
+    - CONTRIBUTING.md
+    - CODFE_OF_CONDUCT.md
+    - LICENSE
+
+'topic: docker':
+- changed-files:
+  - any-glob-to-any-file:
+    - Dockerfile
+    - entrypoint.sh
+
+'topic: build':
+- changed-files:
+  - any-glob-to-any-file:
+    - pyproject.toml
+    - poetry.lock
+
+'topic: style':
+- changed-files:
+  - any-glob-to-any-file: .pre-commit-config.yaml

.github/labeler.yml

@@ -14,10 +14,9 @@ jobs:
       matrix:
         os: [ubuntu-latest]
     steps:
-      - uses: actions/checkout@v2
-      - name: Cache python modules
-        uses: satackey/action-docker-layer-caching@v0.0.11
+      - uses: actions/checkout@v4
+      - uses: satackey/action-docker-layer-caching@v0.0.11
         # Ignore the failure of a step and avoid terminating the job.
         continue-on-error: true
       - name: Build docker
-        run: docker build . -t header-validator:py3.8.13-alpine
+        run: docker build . -t header-validator:latest

.github/workflows/builds.yml

@@ -0,0 +1,21 @@
+name: pr-title
+
+on:
+  pull_request_target:
+    types: [opened, reopened, edited, synchronize]
+  pull_request:
+    types: [opened, reopened, edited, synchronize]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: amannn/action-semantic-pull-request@v5
+        with:
+          subjectPattern: ^(?![A-Z]).+$
+          subjectPatternError: |
+            The subject "{subject}" found in the pull request title "{title}"
+            didn't match the configured pattern. Please ensure that the subject
+            doesn't start with an uppercase character.
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/pr-title.yml

@@ -0,0 +1,16 @@
+name: pull_requests
+
+on:
+  pull_request:
+    branches: main
+
+jobs:
+  triage:
+    permissions:
+      contents: read
+      pull-requests: write
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/labeler@v4
+      with:
+        repo-token: "${{ secrets.GITHUB_TOKEN }}"

.github/workflows/pull_requests.yml

@@ -7,98 +7,108 @@ on:
     branches: main
 
 jobs:
-  flake8:
+  ruff:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
         os: [ubuntu-latest]
-        python: [3.8]
+        python: [3.9]
     steps:
-      - uses: actions/checkout@v2
-      - name: Set up Python
-        uses: actions/setup-python@v1
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python }}
           architecture: x64
-      - name: Run flake8
-        run: |
-          pip install flake8
-          flake8 --version
-          flake8
-
-  isort:
-    runs-on: ${{ matrix.os }}
-    strategy:
-      matrix:
-        os: [ubuntu-latest]
-        python: [3.8]
-    steps:
-      - uses: actions/checkout@v2
-      - name: Set up Python
-        uses: actions/setup-python@v1
+      - uses: abatilo/actions-poetry@v3
         with:
-          python-version: ${{ matrix.python }}
-          architecture: x64
-      - name: Run isort
+          poetry-version: "1.8.2"
+      - name: Resolve dependencies
+        run: poetry export -f requirements.txt --without-hashes --only quality --output requirements.txt
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade uv
+          uv pip install --system -r requirements.txt
+      - name: Run ruff
         run: |
-          pip install isort
-          isort --version
-          isort .
-          if [ -n "$(git status --porcelain --untracked-files=no)" ]; then exit 1; else echo "All clear"; fi
+          ruff --version
+          ruff check --diff .
 
   mypy:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
         os: [ubuntu-latest]
-        python: [3.8]
+        python: [3.9]
     steps:
-      - uses: actions/checkout@v2
-      - name: Set up Python
-        uses: actions/setup-python@v1
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python }}
           architecture: x64
+      - uses: abatilo/actions-poetry@v3
+        with:
+          poetry-version: "1.8.2"
+      - name: Resolve dependencies
+        run: poetry export -f requirements.txt --without-hashes --with quality --output requirements.txt
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade uv
+          uv pip install --system -r requirements.txt
       - name: Run mypy
         run: |
-          pip install mypy
           mypy --version
           mypy
 
-  black:
+  ruff-format:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
         os: [ubuntu-latest]
-        python: [3.8]
+        python: [3.9]
     steps:
-      - uses: actions/checkout@v2
-      - name: Set up Python
-        uses: actions/setup-python@v2
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python }}
           architecture: x64
-      - name: Run black
+      - uses: abatilo/actions-poetry@v3
+        with:
+          poetry-version: "1.8.2"
+      - name: Resolve dependencies
+        run: poetry export -f requirements.txt --without-hashes --only quality --output requirements.txt
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade uv
+          uv pip install --system -r requirements.txt
+      - name: Run ruff
         run: |
-          pip install black
-          black --version
-          black --check --diff .
+          ruff --version
+          ruff format --check --diff .
 
-  bandit:
+  precommit-hooks:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
         os: [ubuntu-latest]
-        python: [3.8]
+        python: [3.9]
     steps:
-      - uses: actions/checkout@v2
-      - name: Set up Python
-        uses: actions/setup-python@v2
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python }}
           architecture: x64
-      - name: Run bandit
+      - uses: abatilo/actions-poetry@v3
+        with:
+          poetry-version: "1.8.2"
+      - name: Resolve dependencies
+        run: poetry export -f requirements.txt --without-hashes --only quality --output requirements.txt
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade uv
+          uv pip install --system -r requirements.txt
+      - name: Run pre-commit hooks
         run: |
-          pip install bandit[toml]
-          bandit --version
-          bandit -r . -c pyproject.toml
+          git checkout -b temp
+          pre-commit install
+          pre-commit --version
+          pre-commit run --all-files

.github/workflows/style.yml

@@ -14,14 +14,12 @@ jobs:
       matrix:
         os: [ubuntu-latest]
     steps:
-      - uses: actions/checkout@v2
-      - name: Cache python modules
-        uses: satackey/action-docker-layer-caching@v0.0.11
+      - uses: actions/checkout@v4
+      - uses: satackey/action-docker-layer-caching@v0.0.11
         # Ignore the failure of a step and avoid terminating the job.
         continue-on-error: true
-      - name: Build docker
-        run: docker build . -t header-validator:py3.8.13-alpine
+      - run: docker build . -t header-validator:latest
       - name: Run action
         run: |
-          docker run --workdir /github/workspace -v "/home/runner/work/validate-python-headers/validate-python-headers":"/github/workspace" header-validator:py3.8.13-alpine 'François-Guillaume Fernandez' 2022 Apache-2.0 src/ __init__.py .github/ ''
-          docker run --workdir /github/workspace -v "/home/runner/work/validate-python-headers/validate-python-headers":"/github/workspace" header-validator:py3.8.13-alpine 'François-Guillaume Fernandez' 2022 '' src/ __init__.py .github/ .github/license-notice.txt
+          docker run --workdir /github/workspace -v "/home/runner/work/validate-python-headers/validate-python-headers":"/github/workspace" header-validator:latest 'François-Guillaume Fernandez' 2022 Apache-2.0 src/ __init__.py .github/ ''
+          docker run --workdir /github/workspace -v "/home/runner/work/validate-python-headers/validate-python-headers":"/github/workspace" header-validator:latest 'François-Guillaume Fernandez' 2022 '' src/ __init__.py .github/ .github/license-notice.txt