概要
Pythonプロジェクトを開発する際、スタイルを揃えたい。特に複数人で開発するときにそれぞれ違う書き方をされると開発がしにくい。
そこでプロジェクトでフォーマッタなどを導入して、VSCodeでオートフォーマットしてもらう。
まだまだ発展途上なのでもっと良くしていきたい。
プロジェクトの設定
poetryを使う想定。
開発環境にライブラリをインストール
poetry init
poetry add black flake8 mypy --dev
各種ファイルに設定を記述。
現状は一行の最大長を99文字で揃える設定のみ書いている。
pyproject.toml
...
[tool.black]
line-length = 99
.flake8
[flake8]
max-line-length = 99
VSCodeの設定
Settingsメニューは cmd+, で開ける
flake8 Linting
- Settingsで
python.linting.flake8を検索 -
Whether to lint Python files using flake8にチェックを入れる
black auto formatting
- Settingsで
editor.formatOnSaveを検索 -
Editor: Format On Saveにチェック
- Settingsで
editor.formatting.providerを検索 -
blackに設定
mypy static linting
- Settingsで
python.linting.mypyEnabledを検索 -
Whether tot lint Python files using mypyにチェック
VSCodeでVirtual Environmentの設定
- Settingsで
python.venvPathを検索 - 自分のvirtualenvのパスを追加
- プロジェクトを開発する際は左下のPython環境設定部分をクリックして適切な環境を選択する
参考Links