Visual Studio Codeをpython用エディターにするための拡張機能・設定

環境

• macOS Ventura v13.5.2
• Python 3.10.5

拡張機能

Python extension for Visual Studio Code

https://marketplace.visualstudio.com/items?itemName=ms-python.python

IntelliSense ,デバッグ，コードナビゲーション，コードフォーマット，リファクタリング機能，変数探索，テスト探索などの機能を提供

Pylance

https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance

静的型チェックツールであるPyrightが動作することにより、型情報のコード補完,パラメータの提案,型チェック,ドキュメントストリング機能を提供。

ただし、デフォルトでは有効となっていないので、python.analysis.typeCheckingModeをbasicもしくはstrictに切り替える必要があるので注意。

設定

Pythonインタープリターの設定

コマンドラインやエディターからpythonスクリプトを実行するためには、あらかじめコマンドラインやエディターにpythonインタープリター（実行ファイル）の場所を教えてあげる必要がある。具体的にはsettings.jsonに以下のパスを指定してあげる必要がある

"python.defaultInterpreterPath": "/Users/username/git/hoge/foo/.venv/bin/python3"

importパスの指定

pythonを書いていると、自作モジュールと、サードパーティーモジュールをimportして使う必要が必ず発生する。これらのモジュールに対してパスが通っていないと、開発体験が著しく低下する(コード補完が効かない、定義元を参照できない等のデメリットが発生するため)

main.py

from dotenv import load_dotenv

load_dotenv()

パスを通すためには、以下のようにpython.analysis.extraPathsにそれぞれのパスを指定する必要がある。ちなみに、サードパーティーライブラリのインストール先はsite-packagesというディレクトリなので、ここのパスを通せばいい。

{
    "python.analysis.extraPaths": [
        "/Users/username/foo/.venv/lib/python3.10/site-packages/", // third party module
        "/Users/username/foo/bar/" // my module
    ],
}

自動インポート

自動インポートの設定が有効になっていれば、別モジュールのimport時に直接import文を書かずとも、使いたい関数名を記述するとその関数が定義されているモジュールを自動的にインポートしてくれる。設定するには、settings.jsonにpython.analysis.autoImportCompletionsをtrueで設定するか、設定から検索してチェックをつける

python.analysis.autoImportCompletions

いかがでしたでしょうか。本記事では、Visual Studio Codeをpython用エディターにするための拡張機能・設定を紹介しています。是非参考にしてみてください。