Python Rye+Black+Flake8+pytest+Mypy+Pylance+GitHub ActionsによるVS Codeの開発環境構築

rye add --dev black

[tool.black]
line-length = 120

black ./src/

{
  "editor.formatOnSave": true,
  "python.formatting.blackArgs": [],
  "python.formatting.provider": "black",
}

rye add --dev isort

[tool.isort]
line_length = 120
multi_line_output = 3
include_trailing_comma = true
use_parentheses = true

isort ./src/

{
  "editor.codeActionsOnSave": {
    // isort
    "source.organizeImports": true
  },
}

rye add --dev flake8

[flake8]
ignore = ["E203", "E501", "W503", "W504"]
max-line-length = 120

flake8 ./src/

{
  "python.linting.enabled": true,
  "python.linting.flake8Enabled": true,
  "python.linting.flake8Args": [],
  "python.linting.lintOnSave": true,
  "python.linting.pylintEnabled": false,
}

rye add --dev flake8-annotations

rye add --dev pep8-naming

rye add --dev mypy

mypy ./src/

{
  "python.languageServer": "Pylance",
  "python.analysis.typeCheckingMode": "basic" // 厳しくしたい場合はstrict
}

rye add --dev pytest

pytest ./tests/

{
  "python.testing.pytestArgs": ["tests"], // ./tests/にテストファイルを入れる
  "python.testing.unittestEnabled": false,
  "python.testing.pytestEnabled": true,
}

{
  "recommendations": [
    "ms-python.python",
    "ms-python.vscode-pylance",
    "njpwerner.autodocstring"
  ]
}

[tool.rye.scripts]
format = { chain = ["black src", "isort src"] }
lint = { chain = ["black --check src", "isort -c -v src", "flake8 src", "mypy src"] }
test = { chain = ["python -m pytest tests"] }

name: Check Pull Request

on:
  pull_request:
    types: [opened, synchronize, reopened]

jobs:
  check-pull-request:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3
        with:
          ref: ${{ github.head_ref }}
      - name: Install Rye
        uses: baptiste0928/cargo-install@v2
        with:
          crate: rye
          git: https://github.com/mitsuhiko/rye
          branch: main
      - name: Install Dependencies
        run: rye sync
      - name: Lint
        run: rye run lint
      - name: Test
        run: rye run test