Merge pull request #1186 from dimaqq/chore-ruff

#1186

What this PR does

In short, we'll be relying on ruff via pre-commit as opposed to flake8 via tox.

- switches from flake8 to ruff
- reformats the source code
- reformats the docstrings where safe, conservatively
- resolves ruff complaints where that's straightforward
- silences with a `FIXME` where public API could break or code change is not obvious or where too much manual work is required, those can be fixed in separate PRs
- updates the CI and docs for the above


Check list

- [x] pre-commit config
- [x] ruff over the codebase
- [x] resolve or silence errors
- [x] kill old linter and github actions
- [x] GitHub actions to check pre-commit
- [x] run pre-commit after codegen
- [x] add to docs

Author: jujubot

.github/ISSUE_TEMPLATE/BugReport.yml

@@ -53,4 +53,4 @@ body:
         Please provide a simplified reproducer, and if it's possible please refrain from providing a 'clone this repository and run the integration tests to see the problem' type of a reproducer. Thanks!"
       render: python
     validations:
-      required: true
+      required: true

.github/ISSUE_TEMPLATE/FeatureRequest.yml

@@ -33,4 +33,4 @@ body:
       description: "Please provide valid Python code that you'd like to be able to run with this new feature: "
       render: python
     validations:
-      required: true
+      required: true

.github/pull_request_template.md

@@ -23,4 +23,4 @@ All CI tests need to pass.
 
 #### Notes & Discussion
 
-*\<Additional notes for the reviewers if needed. Please delete section if not applicable.\>*
+*\<Additional notes for the reviewers if needed. Please delete section if not applicable.\>*

.github/workflows/pre-commit.yaml

@@ -0,0 +1,17 @@
+---
+name: pre-commit
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v5
+      with:
+        python-version: "3.13"
+    - uses: pre-commit/action@v3.0.1

.github/workflows/static-analysis.yaml

@@ -15,4 +15,3 @@ jobs:
     steps:
         - uses: actions/checkout@v4
         - uses: wagoid/commitlint-github-action@v6
-

.github/workflows/test.yaml

@@ -7,28 +7,6 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
-  lint:
-    name: Linter
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        python:
-          - "3.9"
-          - "3.10"
-    steps:
-      - name: Check out code
-        uses: actions/checkout@v4
-      - name: Setup Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: ${{ matrix.python }}
-      - name: Install dependencies
-        run: pip install tox
-      - name: Run linter
-        run: |
-          tox -e lint
-          ./scripts/copyright.sh
-
   build-test:
     name: Build test
     runs-on: ubuntu-latest
@@ -37,14 +15,12 @@ jobs:
         python:
           - "3.10"
     steps:
-      - name: Check out code
-        uses: actions/checkout@v4
-      - name: Setup Python
-        uses: actions/setup-python@v5
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python }}
-      - name: Run build test target
-        run: |
+      - uses: astral-sh/setup-uv@v3.2.2
+      - run: |
           make build-test
 
   validate:
@@ -67,7 +43,6 @@ jobs:
         run: tox -e validate
 
   unit-tests:
-    needs: lint
     name: Unit tests
     runs-on: ubuntu-latest
     strategy:
@@ -93,7 +68,7 @@ jobs:
 
   integration:
     name: Integration
-    needs: [lint, unit-tests]
+    needs: [unit-tests]
     timeout-minutes: 150
     runs-on: ubuntu-latest
     strategy:
@@ -161,7 +136,7 @@ jobs:
 
   integration-quarantine:
     name: Quarantined Integration Tests
-    needs: [lint, unit-tests]
+    needs: [unit-tests]
     timeout-minutes: 150
     runs-on: ubuntu-latest
     strategy:

.github/workflows/test_candidate.yaml

@@ -42,7 +42,7 @@ jobs:
             else
               echo "Candidate $candidate has to be tested"
               next_test="$candidate"
-            fi 
+            fi
           fi
           echo "next-test=$next_test" >> $GITHUB_ENV
           echo "$next_test" > ~/juju-last-candidate-version

.github/workflows/test_edge.yaml

@@ -42,7 +42,7 @@ jobs:
             else
               echo "Edge $edge has to be tested"
               next_test="$edge"
-            fi 
+            fi
           fi
           echo "next-test=$next_test" >> $GITHUB_ENV
           echo "$next_test" > ~/juju-last-edge-version

.pre-commit-config.yaml

@@ -0,0 +1,46 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: check-added-large-files
+        exclude: |
+          (?x)  # Verbose mode
+          ^juju/client/schemas-juju-.*[.]json$  |
+          ^tests/.*[.]charm$  |
+          ^examples/.*[.]charm$
+      - id: check-ast
+      - id: check-case-conflict
+      - id: check-executables-have-shebangs
+      - id: check-shebang-scripts-are-executable
+      - id: check-merge-conflict
+      - id: check-symlinks
+      - id: check-json
+      - id: check-yaml
+        # Overlays deliberately comprise multiple YAML documents per file
+        exclude: "^tests/integration/bundle/test-overlays/.*multi.*yaml$"
+      - id: check-toml
+      - id: mixed-line-ending
+      - id: end-of-file-fixer
+        exclude: "^juju/client/schemas-juju-.*[.]json$"
+      - id: trailing-whitespace
+      - id: detect-private-key
+        exclude: "^tests/.*$"
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.7.3
+    hooks:
+      - id: ruff
+        args: [ --preview, --fix ]
+      - id: ruff-format
+        args: [ --preview ]
+
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.3.0
+    hooks:
+    - id: codespell
+      additional_dependencies:
+        - tomli
+      exclude: "^juju/client/schemas-juju-.*[.]json$"
+
+ci:
+  autofix_prs: false

.readthedocs.yaml

@@ -10,4 +10,4 @@ build:
     python: "3.10"
 
 sphinx:
-  configuration: docs/conf.py
+  configuration: docs/conf.py