Adjust code quality posts

Author: bcb

docs/_posts/python/2021-07-01-code-quality-github-actions.markdown

@@ -1,7 +1,7 @@
 ---
 layout: post
 category: python
-title: How to use Black, Pylint and Mypy in GitHub Actions?
+title: How to use Ruff, Mypy, Black, Isort and Pytest in GitHub Actions?
 permalink: /python/github-actions
 ---
 <div class="wide-logos" markdown="1">
@@ -15,46 +15,48 @@ of quality.
 </div>
 
 I use the following code quality checks:
-- *Black* to ensure code is formatted,
-- *Pylint* to disallow unused imports, and
-- *Mypy* for type checking.
 
-The following Github Actions workflow will check your code when a Pull
-Request is created, catching problems before they're merged.
+- *Ruff* for linting
+- *Mypy* for type checking
+- *Black* to ensure code is formatted
+- *Isort* to ensure imports are grouped and sorted
+
+The following Github Actions workflow will check your code when a pull request
+is created, catching problems before they're merged.
 
 ## How to add the Github Actions workflow
 
 Add the following to your repository in `.github/workflows/code-quality.yml`.
 
 ```sh
-name: Checks
+name: Code Quality
 on: [pull_request]
 
 jobs:
   build:
     runs-on: ubuntu-latest
-    name: Checks
     steps:
     - uses: actions/checkout@v2
     - uses: actions/setup-python@v2
       with:
-        python-version: 3.x
+        python-version: "3.7"
     - run: pip install --upgrade pip
-    - run: pip install "black<23" pylint==v3.0.0a3 mypy==v0.902
-    - run: black --diff --check $(git ls-files '*.py')
-    - run: pylint --disable=all --enable=unused-import $(git ls-files '*.py')
-    - run: mypy --strict $(git ls-files '*.py')
+    - run: pip install "ruff<1" "mypy<2" "black<23" "isort<6" pytest
+    - run: ruff check .
+    - run: mypy --strict .
+    - run: black --check .
+    - run: isort --check --profile black .
+    - run: pytest .
 ```
 
 ## Notes
 
-- Be consistent with your Black version across your tooling. The formatting can
-  change between versions, so what's considered "formatted" in one version may
-  not be in another. Note as of 2022 Black has a
+- Be consistent with the Black version across your tooling.
+  The formatting can change between versions, so what's considered "formatted"
+  in one version may not be in another. Note as of 2022 Black has a
   [Stability Policy](https://black.readthedocs.io/en/stable/the_black_code_style/index.html)
-  which states the formatting will not change in a calendar year. This is why I use `black<23`
-  above -- we take all updates from this year but not next.
-- If you have an existing project with unformatted code, _format the entire
-  codebase all at once_. Don't do it gradually.
+  which states the formatting will not change in a calendar year.
+- If you have an existing project with un-blackened code, _format the entire
+  project all at once_. Don't do it gradually. Do it in a single dedicated pull request.
 
-See also: [How to use Black, Pylint and Mypy in Pre-commit?](/python/pre-commit)
+See also: [How to use Ruff, Mypy, Black and Isort in Pre-commit?](/python/pre-commit)

docs/_posts/python/2021-07-01-code-quality-pre-commit.markdown

@@ -1,7 +1,7 @@
 ---
 layout: post
 category: python
-title: How to use Black, Pylint and Mypy in Pre-commit?
+title: How to use Ruff, Mypy, Black and Isort in Pre-commit?
 permalink: /python/pre-commit
 redirect_from:
     - /black
@@ -22,43 +22,52 @@ of quality.
 
 I use the following code quality checks:
 
-- *Black* to ensure code is formatted,
-- *Pylint* to disallow unused imports, and
-- *Mypy* for type checking.
+- *Ruff* for linting
+- *Mypy* for type checking
+- *Black* to ensure code is formatted
+- *Isort* to ensure imports are grouped and sorted
 
-These Pre-commit hooks will check your code when you try to commit, catching problems
-before they reach your repository.
+These pre-commit hooks will check your code when you try to commit, catching
+problems before they reach your repository.
 
 ## Install the Pre-commit hooks
 
 Add the following `.pre-commit-config.yaml` file to the root of your
 repository.
 
 ```yaml
-fail_fast: true
+default_language_version:
+  python: python3.7
 
 repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.1.8
+    hooks:
+      - id: ruff
+        types: [python]
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v0.971
+    hooks:
+      - id: mypy
+        types: [python]
+        args: [--strict]
+
   - repo: https://github.com/ambv/black
-    rev: 22.3.0
+    rev: 22.8.0
     hooks:
       - id: black
-        args: [--diff, --check]
+        types: [python]
+        args: [--check]
 
   - repo: local
     hooks:
-    -   id: pylint
-        name: pylint
-        entry: pylint
+      - id: isort
+        name: isort
+        entry: isort
         language: system
         types: [python]
-        require_serial: true
-
-  - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v0.902
-    hooks:
-      - id: mypy
-        exclude: ^tests/
-        args: [--strict]
+        args: [--check,--profile=black]
 ```
 
 Install [Pre-commit](https://pre-commit.com) and add the git hooks:
@@ -69,14 +78,15 @@ pre-commit install
 
 ## Notes
 
-- Since Pylint needs to import modules and dependencies to work correctly, the
-  hook only works with a local installation of pylint (in your environment).
+- Isort needs to know about your project's dependencies, therefore the hook
+  only works with a local installation of isort, (i.e. it's installed in your
+  environment).
 - Be consistent with the Black version across your tooling.
   The formatting can change between versions, so what's considered "formatted"
   in one version may not be in another. Note as of 2022 Black has a
   [Stability Policy](https://black.readthedocs.io/en/stable/the_black_code_style/index.html)
   which states the formatting will not change in a calendar year.
-- If you have an existing project with unformatted code, _format the entire
-  codebase all at once_. Don't do it gradually.
+- If you have an existing project with un-blackened code, _format the entire
+  project all at once_. Don't do it gradually. Do it in a single dedicated pull request.
 
-See also: [How to use Black, Pylint and Mypy in Github Actions?](/python/github-actions)
+See also: [How to use Ruff, Mypy, Black, Isort and Pytest in Github Actions?](/python/github-actions)