オレオレ Python 開発環境

poetry add -D flake8

poetry add -D flake8-isort flake8-bugbear flake8-builtins flake8-eradicate flake8-unused-arguments flake8-pytest-style pep8-naming

poetry run flake8 src tests

poetry add -D mypy

[tool.mypy]
# エラー時のメッセージを詳細表示
show_error_context = true
# エラー発生箇所の行数/列数を表示
show_column_numbers = true
# import 先のチェックを行わない (デフォルトだとサードパーティーライブラリまでチェックする)
ignore_missing_imports = true
# 関数定義の引数/戻り値に型アノテーション必須
disallow_untyped_defs = true
# デフォルト引数に None を取る場合型アノテーションに Optional 必須
no_implicit_optional = true
# 戻り値が Any 型ではない関数の戻り値の型アノテーションが Any のとき警告
warn_return_any = true
# mypy エラーに該当しない箇所に `# type: ignore` コメントが付与されていたら警告
# ※ `# type: ignore` が付与されている箇所は mypy のエラーを無視出来る
warn_unused_ignores = true
# 冗長なキャストに警告
warn_redundant_casts = true

poetry run mypy src tests

poetry add -D black

[tool.black]
line-length = 79

poetry run black src tests

poetry run black --check src tests

poetry add -D isort

[tool.isort]
profile = "black"
line_length = 79

poetry run isort src tests

poetry add -D pytest pytest-mock pytest-cov

poetry run pytest -s -vv --cov=. --cov-branch --cov-report=html

poetry add -D Sphinx sphinx-rtd-theme sphinx-pyproject

[project]
name = "python-template"
version = "0.1.0"
description = "Python Project の Template"
readme = "README.md"

[[project.authors]]
name = "jDBTISK"

[tool.sphinx-pyproject]
project = "python-template"
copyright = "2022, jDBTISK"
language = "en"
package_root = "python-template"
html_theme = "sphinx_rtd_theme"
todo_include_todos = true
templates_path = ["_templates"]
html_static_path = ["_static"]
extensions = [
  "sphinx.ext.autodoc",
  "sphinx.ext.viewcode",
  "sphinx.ext.todo",
  "sphinx.ext.napoleon",
]

import os
import sys

from sphinx_pyproject import SphinxConfig

sys.path.append(
    os.path.abspath(f"{os.path.dirname(os.path.abspath(__file__))}/../../")
)

config = SphinxConfig("../../pyproject.toml", globalns=globals())

poetry run sphinx-apidoc -F -o docs/source src
poetry run sphinx-build docs/source docs/build

poetry add -D taskipy

[tool.taskipy.tasks]
test = "pytest -s -vv --cov=. --cov-branch --cov-report=html"
fmt = "task fmt-black && task fmt-isort"
fmt-black = "black src tests"
fmt-isort = "isort src tests"
lint = "task lint-black && task lint-flake8 && task lint-mypy"
lint-flake8 = "flake8 src tests"
lint-mypy = "mypy src tests"
lint-black = "black --check src tests"
docs = "sphinx-apidoc -F -o docs/source src && sphinx-build docs/source docs/build"

# テスト実行
poetry run task test
# フォーマッター実行
poetry run task fmt
# リンター実行
poetry run task lint
# ドキュメント出力
poetry run task docs

poetry add -D pre-commit

repos:
  # hooks script のソースリポジトリ
  - repo: https://github.com/pre-commit/pre-commit-hooks
    # リポジトリのブランチ or タグ
    rev: v4.2.0
    # 使用したい hook script の指定
    hooks:
      # markdown 以外の行末スペース削除
      - id: trailing-whitespace
        args: [--markdown-linebreak-ext=md]
      # ファイル最終行を改行コードにする
      - id: end-of-file-fixer
      # 改行コードを LF に統一
      - id: mixed-line-ending
        args: [--fix=lf]
      # 巨大なファイルの commit を禁止
      - id: check-added-large-files
      # toml 構文チェック
      - id: check-toml
      # yaml 構文チェック
      - id: check-yaml
      # aws の認証情報が含まれていないかチェック
      - id: detect-aws-credentials
  - repo: https://github.com/psf/black
    rev: 22.3.0
    hooks:
      # black によるフォーマット実行
      - id: black
        language_version: python3
  - repo: https://github.com/pre-commit/mirrors-mypy
    rev: v0.942
    hooks:
    # mypy による型チェック実行
    - id: mypy
  - repo: https://github.com/pycqa/isort
    rev: 5.10.1
    hooks:
      # isort によるフォーマット実行
      - id: isort
  - repo: https://gitlab.com/pycqa/flake8
    rev: 4.0.1
    hooks:
      # flake8 によるコードチェック実行
      - id: flake8
        # 使用する flake8 プラグイン
        additional_dependencies:
          - flake8-isort
          - flake8-bugbear
          - flake8-builtins
          - flake8-eradicate
          - flake8-pytest-style
          - flake8-unused-arguments
          - pep8-naming

poetry run pre-commit install

name: python lint

on:
  # main ブランチ向けのプルリク作成時、及び
  # main ブランチ向けプルリクのソースブランチへの push 時に workflow 実行
  pull_request:
    branches:
      - main
    # python ファイル or 使用するライブラリ (poetry.lock) or このファイル
    # に変更があったときだけ workflow 実行
    paths:
      - "src/**.py"
      - "tests/**.py"
      - "poetry.lock"
      - ".github/workflows/lint.yml"

jobs:
  lint:
    name: Lint
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      # ここで指定するバージョンを増やせば複数の python バージョンで各 step を実行出来ます
      # ライブラリを作っていて対応している python バージョン全てで test を行いたいときに便利です
      matrix:
        python-version: ["3.10"]

    steps:
      - name: Checkout
        uses: actions/checkout@v2

      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v2
        with:
          python-version: ${{ matrix.python-version }}

      - name: Install Poetry
        run: |
          curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python -
          echo "$HOME/.poetry/bin" >> $GITHUB_PATH

      # .venv ディレクトリをキャッシュ
      - uses: actions/cache@v2
        id: venv_cache
        with:
          path: .venv
          key: venv-${{ matrix.python-version }}-${{ hashFiles('**/poetry.lock') }}

      # poetry.lock ファイルに変更がなければキャッシュされている .venv を使用
      - name: Install Dependencies
        if: steps.venv_cache.outputs.cache-hit != 'true'
        run: poetry install

      - name: Python Lint
        run: poetry run task lint

      - name: Python Test
        run: poetry run task test

{
  "[python]": {
    // タブサイズは 4
    "editor.tabSize": 4,
    // ファイル保存時にフォーマット
    "editor.formatOnSave": true
  },
  // tests ディレクトリから src ディレクトリのモジュールをインポートするときの vscode 上でモジュールが見つからないエラー防止
  "python.analysis.extraPaths": ["./src"],
  // .venv 内の python を使用
  "python.defaultInterpreterPath": "${workspaceFolder}/.venv/bin/python",
  // フォーマッターは black を使用
  "python.formatting.provider": "black",
  "python.formatting.blackPath": "${workspaceFolder}/.venv/bin/black",
  "python.sortImports.path": "${workspaceFolder}/.venv/bin/isort",
  // リンターに flake8 と mypy を使用
  "python.linting.pylintEnabled": false,
  "python.linting.flake8Enabled": true,
  "python.linting.flake8Path": "${workspaceFolder}/.venv/bin/flake8",
  "python.linting.mypyEnabled": true,
  "python.linting.mypyPath": "${workspaceFolder}/.venv/bin/mypy",
  // docstring は nympy スタイル (ここは完全好みです)
  "autoDocstring.docstringFormat": "numpy"
}

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