Switch from black to ruff (openwallet-foundation#3080)

* Remove black in favor of ruff Signed-off-by: jamshale <[email protected]> * Update poetry.lock file Signed-off-by: jamshale <[email protected]> * Remove only changed files from format check for now Signed-off-by: jamshale <[email protected]> * Fix poetry.lock file after rebase Signed-off-by: jamshale <[email protected]> * Use sude and fix format individual file Signed-off-by: jamshale <[email protected]> --------- Signed-off-by: jamshale <[email protected]>
ff137 · Jul 4, 2024 · 7f1695a · 7f1695a
1 parent d59e995
commit 7f1695a
Show file tree

Hide file tree

Showing 11 changed files with 35 additions and 148 deletions.
diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
@@ -14,7 +14,6 @@
         "vscode": {
             "extensions": [
               "ms-python.python",
-              "ms-python.black-formatter",
               "charliermarsh.ruff"
             ],
             "settings": {
@@ -33,11 +32,9 @@
                         "source.fixAll": true,
                         "source.organizeImports": true
                       },
-                    "editor.defaultFormatter": "ms-python.black-formatter",
-                    "ruff.organizeImports": false
+                    "editor.defaultFormatter": "charliermarsh.ruff",
+                    "ruff.organizeImports": true
                   },
-                "black-formatter.importStrategy": "useBundled",
-                "black-formatter.showNotifications": "always",
                 "ruff.codeAction.fixViolation": {
                     "enable": true
                 },

diff --git a/.devcontainer/post-install.sh b/.devcontainer/post-install.sh
@@ -8,9 +8,6 @@ WORKSPACE_DIR=$(pwd)
 python -m pip install --upgrade pip
 pip3 install -r demo/requirements.txt -r demo/requirements.behave.txt
 
-# install black for formatting
-pip3 install black
-
 # install a version of aries-cloudagent so the pytests can pick up a version
 pip3 install aries-cloudagent
 

diff --git a/.github/workflows/blackformat.yml → .github/workflows/format.yml b/.github/workflows/blackformat.yml → .github/workflows/format.yml
@@ -1,4 +1,4 @@
-name: Black Code Formatter Check
+name: Ruff Code Formatter and Linting Check
 
 "on":
   pull_request:
@@ -14,7 +14,5 @@ jobs:
       - uses: actions/setup-python@v5
         with:
           python-version: "3.9"
-      - name: Black Code Formatter Check
-        # The version of black should be adjusted at the same time dev
-        # dependencies are updated.
-        uses: psf/[email protected]
+      - name: Ruff Format and Lint Check
+        uses: chartboost/ruff-action@v1
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -6,16 +6,15 @@ repos:
         stages: [commit-msg]
         args: ["--config", ".commitlint.config.js"]
         additional_dependencies: ['@commitlint/config-conventional']
-  - repo: https://github.com/psf/black
-    # Ensure this is synced with pyproject.toml
-    rev: 24.4.2
-    hooks:
-      - id: black
-        stages: [commit]
   - repo: https://github.com/astral-sh/ruff-pre-commit
     # Ensure this is synced with pyproject.toml
-    rev: v0.4.4
+    rev: v0.5.0
     hooks:
+      # Run the linter
       - id: ruff
         stages: [commit]
         args: [--fix, --exit-non-zero-on-fix]
+      # Run the formatter
+      - id: ruff-format
+        stages: [commit]
+        args: [--fix, --exit-non-zero-on-fix, --formatter]
diff --git a/.vscode-sample/launch.json b/.vscode-sample/launch.json
@@ -60,7 +60,7 @@
             ]
         },
         {
-            "name": "ruff - aries_cloudagent",
+            "name": "ruff (lint) - aries_cloudagent",
             "type": "python",
             "request": "launch",
             "module": "ruff",
@@ -71,7 +71,7 @@
             "args": ["check", "."]
         },
         {
-            "name": "ruff fix - aries_cloudagent",
+            "name": "ruff fix (lint) - aries_cloudagent",
             "type": "python",
             "request": "launch",
             "module": "ruff",
@@ -82,7 +82,7 @@
             "args": ["check", ".", "--fix"]
         },
         {
-            "name": "ruff - current file",
+            "name": "ruff (lint) - current file",
             "type": "python",
             "request": "launch",
             "module": "ruff",
@@ -93,52 +93,37 @@
             "args": ["check", ".", "${file}"]
         },
         {
-            "name": "black (check) - aries_cloudagent",
+            "name": "ruff fix (lint) - current file",
             "type": "python",
             "request": "launch",
-            "module": "black",
+            "module": "ruff",
             "console": "integratedTerminal",
+            "sudo": true,
             "justMyCode": true,
             "cwd": "${workspaceFolder}/aries_cloudagent",
-            "args": [
-                ".",
-                "--check"
-            ]
+            "args": ["check", ".", "${file}", "--fix"]
         },
         {
-            "name": "black (check) - current file",
+            "name": "ruff (format) - aries_cloudagent",
             "type": "python",
             "request": "launch",
-            "module": "black",
-            "console": "integratedTerminal",
-            "justMyCode": true,
-            "args": [
-                "${file}",
-                "--check"
-            ]
-        },
-        {
-            "name": "black (format) - aries_cloudagent",
-            "type": "python",
-            "request": "launch",
-            "module": "black",
+            "module": "ruff",
             "console": "integratedTerminal",
+            "sudo": true,
             "justMyCode": true,
             "cwd": "${workspaceFolder}/aries_cloudagent",
-            "args": [
-                "."
-            ]
+            "args": ["format", "."]
         },
         {
-            "name": "black (format) - current file",
+            "name": "ruff (format) - current file",
             "type": "python",
             "request": "launch",
-            "module": "black",
+            "module": "ruff",
             "console": "integratedTerminal",
+            "sudo": true,
             "justMyCode": true,
-            "args": [
-                "${file}"
-            ]
+            "cwd": "${workspaceFolder}/aries_cloudagent",
+            "args": ["format", "${file}"]
         }
     ]
 }
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -19,7 +19,7 @@ Contributions are made pursuant to the Developer's Certificate of Origin, availa
 
 A configuration for [pre-commit](https://pre-commit.com/) is included in this repository. This is an optional tool to help contributors commit code that follows the formatting requirements enforced by the CI pipeline. Additionally, it can be used to help contributors write descriptive commit messages that can be parsed by changelog generators.
 
-On each commit, pre-commit hooks will run that verify the committed code complies with ruff and is formatted with black. To install the ruff and black checks:
+On each commit, pre-commit hooks will run that verify the committed code complies and formats with ruff. To install the ruff checks:
 
 ```bash
 pre-commit install

diff --git a/docs/deploying/ContainerImagesAndGithubActions.md b/docs/deploying/ContainerImagesAndGithubActions.md
@@ -92,7 +92,7 @@ variants and between the BC Gov ACA-Py images.
   Github Container Registry.
 - Integration Tests (`.github/workflows/integrationtests.yml`) - Run on pull
   requests (to the hyperledger fork only); runs BDD integration tests.
-- Black Format (`.github/workflows/blackformat.yml`) - Run on pull requests;
+- Format (`.github/workflows/format.yml`) - Run on pull requests;
   checks formatting of files modified by the PR.
 - CodeQL (`.github/workflows/codeql.yml`) - Run on pull requests; performs
   CodeQL analysis.

diff --git a/docs/features/DevReadMe.md b/docs/features/DevReadMe.md
@@ -241,8 +241,6 @@ The `manage` script is described in detail [here](https://github.com/hyperledger
 
 We use [Ruff](https://github.com/astral-sh/ruff) to enforce a coding style guide.
 
-We use [Black](https://black.readthedocs.io/en/stable/) to automatically format code.
-
 Please write tests for the work that you submit.
 
 Tests should reside in a directory named `tests` alongside the code under test. Generally, there is one test file for each file module under test. Test files _must_ have a name starting with `test_` to be automatically picked up the test runner.

diff --git a/docs/features/devcontainer.md b/docs/features/devcontainer.md
@@ -44,19 +44,18 @@ To open ACA-Py in a devcontainer, we open the *root* of this repository. We can
 
 #### devcontainer.json
 
-When the [.devcontainer/devcontainer.json](https://github.com/hyperledger/aries-cloudagent-python/blob/main/.devcontainer/devcontainer.json) is opened, you will see it building... it is building a Python 3.9 image (bash shell) and loading it with all the ACA-Py requirements (and black). We also load a few Visual Studio settings (for running Pytests and formatting with Flake and Black).
+When the [.devcontainer/devcontainer.json](https://github.com/hyperledger/aries-cloudagent-python/blob/main/.devcontainer/devcontainer.json) is opened, you will see it building... it is building a Python 3.9 image (bash shell) and loading it with all the ACA-Py requirements. We also load a few Visual Studio settings (for running Pytests and formatting with Ruff).
 
 ### Poetry
 
-The Python libraries / dependencies are installed using [`poetry`](https://python-poetry.org). For the devcontainer, we *DO NOT* use virtual environments. This means you will not see or need venv prompts in the terminals and you will not need to run tasks through poetry (ie. `poetry run black .`). If you need to add new dependencies, you will need to add the dependency via poetry *AND* you should rebuild your devcontainer.
+The Python libraries / dependencies are installed using [`poetry`](https://python-poetry.org). For the devcontainer, we *DO NOT* use virtual environments. This means you will not see or need venv prompts in the terminals and you will not need to run tasks through poetry (ie. `poetry run ruff check .`). If you need to add new dependencies, you will need to add the dependency via poetry *AND* you should rebuild your devcontainer.
 
 In VS Code, open a Terminal, you should be able to run the following commands:
 
 ```bash
 python -m aries_cloudagent -v
 cd aries_cloudagent
 ruff check .
-black . --check
 poetry --version
 ```
 
@@ -72,10 +71,9 @@ Found 1 error.
 
 #### extensions
 
-We have added Black formatter and Ruff extensions. Although we have added launch settings for both `ruff` and `black`, you can also use the extension commands from the command palette.
+We have added Ruff extensions. Although we have added launch settings for both `ruff`, you can also use the extension commands from the command palette.
 
-- `Ruff: Format Document`
-- `Ruff: Fix all auto-fixable problems`
+- `ruff (format) - aries_cloudagent`
 
 More importantly, these extensions are now added to document save, so files will be formatted and checked. We advise that after each time you rebuild the container that you also perform: `Developer: Reload Window` to ensure the extensions are loaded correctly.
 

diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -66,9 +66,6 @@ didcomm-messaging = {version = "^0.1.1a0", optional = true }
 pre-commit = "~3.7.0"
 # Sync with version in .pre-commit-config.yaml
 ruff = "0.5.0"
-# Sync with version in .github/workflows/blackformat.yml
-# Sync with version in .pre-commit-config.yaml
-black = "24.4.2"
 
 sphinx="^5.3.0"
 sphinx-rtd-theme=">=0.4.3"