💫
【VScode】一瞬でできるpythonで自動import
概要
VSCode で Python コードを書く際、関数やクラスを入力すると自動的に import 文を補完してくれる機能を有効にする方法を紹介します。
設定方法
VSCode の設定ファイル settings.json に以下の1行を追加するだけです。
"python.analysis.autoImportCompletions": true
完全な設定例
ユーザー設定またはプロジェクトの.vscode/settings.jsonに以下を記載。
settings.json
{
"python.analysis.autoImportCompletions": true
}
効果
この設定により、次のような便利な機能が利用できます：
- 未インポートの関数・クラスを入力すると、自動的に候補が表示される
- 候補を選択すると、ファイル上部に
import文が自動挿入される - 標準ライブラリやインストール済みパッケージに対応
以下の動画が自動importされる挙動です。
補足：カスタムパスの設定
プロジェクトの構造によっては、自動 import が期待通りに動作しない場合があります。その際は extraPaths を追加してパスを指定できます。
settings.json
{
"python.analysis.autoImportCompletions": true,
"python.analysis.extraPaths": ["./src/backend"]
}
例えば、src/backend ディレクトリ内のモジュールを import したい場合、上記の設定により VSCode がそのパスを認識し、適切な自動補完が可能になります。
最後に
自分はJavaScript/TypeScriptのようにpythonって自動importしてくれないものだと思ってたのですが、設定ファイルに1行記述するだけで、自動importが可能になり感動したので、それを共有したくて、この記事を書きました。
自分のようにこの設定を知らなかった誰かの役に立てれば幸いです。
Discussion