Zenn
Open3

VSCode の設定(Python用)

yubeshiyubeshi

前提

  • 仮想環境は In-Projectで .venv に作成する。
  • ワークスペースのルートに .env ファイルを作成し、環境変数をセットする
  • .envファイルは .ignore で無視リストに加えておく。これでAPI_KEYなどを.envに分離できる
.vscode/settings.json
{
    "liveServer.settings.root": "/docs/_build/html",
    "python.analysis.typeCheckingMode": "strict",
    "python.analysis.autoImportCompletions": true,
    "python.envFile": "${workspaceFolder}/.env",
    "python.analysis.extraPaths": [
        "${workspaceFolder}/src"
    ],
    "python.analysis.diagnosticMode": "workspace",
    "python.defaultInterpreterPath": "${workspaceFolder}/.venv/Scripts/python",
    "files.exclude": {
        "**/__pycache__": true,
        "**/*.pyc": true
    }
}
.env
PYTHONPATH=${workspaceFolder}/src

project-root/
├─ .vscode/
│   └─ settings.json
│
├─ .env                        # python.envFile で指定
│
├─ .venv/
│   └─ Scripts/
│       └─ python              # python.defaultInterpreterPath で指定される仮想環境Python実行ファイル
│
├─ docs/
│   └─ _build/
│       └─ html/               # liveServer.settings.root で指定されたドキュメントビルド成果物ディレクトリ(Sphinx想定)
│
└─ src/                        # python.analysis.extraPaths に指定されるソースコード配置ディレクトリ
    ├─ __init__.py
    ├─ main.py
    └─ ... (その他のPythonファイル)