Djangoの開発環境で工夫したこと - pre-commit / DevContainer

Djangoの開発環境で工夫したこと pre-commit / DevContainer Djangoオンラインミートアップ #4 2024年11月22日　余田大輝

自己紹介名前：余田大輝（@Hiroki_Yoda）所属：株式会社スカラコミュニケーションズ学生時代に初めて触ったFWはDjangoです。現在の業務でもDjangoを使用しています。明後日、福島県葛尾村に移住します。たまにカレー屋さんになります。

1. Linter / Formatter / Type Checker

型の整合性を検証する ⇩ mypy 03. 型チェッカーコードを整形する ⇩ isort / yapf
02. フォーマッターコードの品質を検証する ⇩ Flake8 01. リンター Djangoのプロジェクトで下記のツールを導入しました

導入と設定パッケージ管理ツールでインストールした上で、各ツールの設定を pyproject.toml に記載している。ただし、Flake8を除く

実行方法下記のコマンドを実行することで、 Flake8 は規約違反を指摘し、 isort & yapf は自動整形してくれる。ただし、次の部分は手動で変更しました・コメントアウトに記載している内容
・import json の削除

手動実行で生じる問題コードベースにフォーマットがかけられていないコードがマージされた場合、他の人の作業の中で予期しないフォーマットが実行されてしまう。予期せぬフォーマット 01 Flake8 や
mypy に規約違反を指摘されても無視することが可能であるため、対応が開発者それぞれに委ねられる。規約違反の放置 02

2. pre-commit の導入

自動実行をいつする？最初に試してみたが、保存の度にフォーマットの実行が走るのが鬱陶しかったため、チームの総意でこちらは却下。保存時に自動実行 01 フォーマットの他に、規約違反の検証も含めて、git commit
のタイミングで自動実行することをチームで合意した。コミット時に自動実行 02

pre-commit の導入 pre-commit は、Git フックを利用して、コミット前に自動的に各種チェックやフォーマットを実行するためのフレームワークである。設定ファイルを使用して、実行するツールやそのオプションを指定する。

導入と設定パッケージ管理ツールでインストールした上で、 .pre-commit-config.yaml に各ツールの設定を記載する。右図は isort / yapf
/ flake8 / mypy の4つを導入した例。

実行方法普段通りに git commit を実行すると、右図のように先ほど手動実行した検証がそれぞれ自動実行される。 isort /
yapf は自動でフォーマットされ、flake8 / mypy は規約違反を指摘してくれる。すべて pass するまで、 commit は完了できない。

3. DevContainer の導入

関連する別の問題エディターに導入する拡張機能など、メンバーの開発環境を統一させたい。私を含めて、経験の浅いメンバーが多いチームであるため、特に重要。開発環境の一貫性 01 Docker等を開発に利用する場合、右図のように、ホスト側からコンテナ内のPythonパッケージを認識できない
（今回のテーマとの関連は薄い）パッケージの解決 02

DevContainerの導入 DevContainer は、コンテナを開発環境として利用し、ローカルのファイルをマウントしながら、VSCode の全機能を活用できる仕組みである。出典: "Developing inside a Container",
Visual Studio Code URL: https://code.visualstudio.com/docs/devc ontainers/containers 参照: 2024-11-21

DevContainerの使い方 devcontainer.json に必要な設定（共有で使用したい拡張機能を含む）を記載して、メニューから「コンテナで再度開く」を選択する。「コンテナで再度開く」を選択

まとめ

コードのフォーマットや拡張機能のインストールなど、開発者で共通の対応をしたいが手動で各々対応していた部分を pre-commit や DevContainer を用いて仕組みにすることで、開発者が常に意識をしなくても一貫性が維持されるようになった。

皆さんが普段使っているリンター / フォーマッターや開発環境の工夫を教えてください！

Djangoの開発環境で工夫したこと - pre-commit / DevContainer

Djangoの開発環境で工夫したこと - pre-commit / DevContainer

Hiroki Yoda

Other Decks in Programming

Featured

Transcript