参考書籍

業務効率化に向けたおすすめの参考書になります。

VSCodeでPythonコードのインポート順を自動整理：isortの設定ガイド

Python開発を行う際、コードの読みやすさとメンテナンス性を高めるために、インポートの順序が重要です。PEP8、Pythonのコーディング標準では、インポートは標準ライブラリ、サードパーティライブラリ、ローカルライブラリの順に分類し、各セクション間に空行を入れることを推奨しています。この手動での整理作業を自動化するツールが、静的解析ツールisortです。

VSCodeでisortを設定する手順

1. isortインストール: コマンドプロンプトでpy -m pip install isortを実行し、isortをインストールします。
2. VSCode拡張機能: VSCodeには拡張機能としてisortが用意されています。拡張機能タブからisortを検索し、設定画面を開きます。
3. 拡張機能の設定: isortの拡張機能設定で、保存時にインポートを自動整理するオプションを有効にします。
4. VSCodeの設定用コードの追加: isort拡張機能画面に示された設定コードを、VSCodeのsettings.jsonファイルに追加します。これにより、ファイル保存時に自動的にインポート順が整理されます。

設定例

設定前のsettings.json例：

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

設定後のsettings.json例：

{
 "python.formatting.provider": "black",
 "editor.formatOnSave": true,
 "isort.check": true,
 "editor.codeActionsOnSave": {
   "source.organizeImports": true
 }
}
    

まとめ

isortをVSCodeに設定することで、Pythonのインポート順をPEP8に準拠して自動的に整理できるようになります。これにより、コードの可読性が向上し、開発効率が高まります。設定は簡単で、VSCodeの拡張機能を活用することで、面倒なインポート整理の作業から解放されます。