Visual Studio Code の Python
Microsoft Python 拡張機能を使用して Visual Studio Code で Python を操作することは、シンプルで楽しく、生産的です。この拡張機能により、VS Code は優れた Python エディターになり、さまざまな Python インタープリターを搭載した任意のオペレーティング システムで動作します。VS Code のすべての機能を活用して、オートコンプリートと IntelliSense、リンティング、デバッグ、単体テスト、および仮想環境や conda 環境を含む Python 環境間の簡単な切り替え機能を提供します。
この記事では、VS Code 用 Python 拡張機能のさまざまな機能の概要のみを説明します。コードの編集、実行、デバッグの詳細については、以下のボタンを使用してください。
Python と Python 拡張機能をインストールする
チュートリアルでは、Python のインストールと拡張機能の使用方法について説明します。Python インタープリターは、拡張機能とは別に自分でインストールする必要があります。すばやくインストールするには、python.org から Python を使用し、VS Code Marketplace から拡張機能をインストールしてください。
注: Python 開発を開始するのに役立つように、便利な拡張機能、設定、Python コードスニペットを含むPython プロファイル テンプレートを使用できます。
いずれかのバージョンの Python をインストールしたら、Python: Select Interpreter コマンドを使用して選択します。VS Code が目的のインタープリターを自動的に見つけられない場合は、環境 - インタープリターの手動指定を参照してください。
Python 拡張機能は設定から構成できます。Python 設定リファレンスで詳細を確認してください。
Windows Subsystem for Linux: Windows を使用している場合、WSL は Python 開発を行うのに最適な方法です。Windows で Linux ディストリビューションを実行でき、Python はすでにインストールされていることがよくあります。WSL 拡張機能と組み合わせることで、WSL のコンテキストで実行しながら、VS Code の完全な編集およびデバッグのサポートを受けることができます。詳細については、WSL での開発にアクセスするか、WSL での作業チュートリアルを試してください。
Python コードの実行
Python を体験するには、ファイル エクスプローラーを使用して hello.py という名前のファイルを作成し、次のコードを貼り付けます。
print("Hello World")
その後、Python 拡張機能は、現在選択されているインタープリター (コマンド パレットの Python: Select Interpreter) を使用して Python コードを実行するためのショートカットを提供します。アクティブな Python ファイルを実行するには、エディターの右上にある Run Python File 再生ボタンをクリックします。
Python: Run Selection/Line in Python Terminal コマンド (Shift+Enter) を使用して、個々の行またはコードの選択を実行することもできます。選択範囲がない場合、スマート送信はカーソルがある行の周りの実行可能な最小のコードブロックを Python ターミナルに (Shift+Enter) 送信します。エディターで選択したコンテキスト メニューには、同様の Run Python > Run Selection/Line in Python Terminal コマンドが用意されています。ターミナルが閉じられるまで、ターミナル/REPL で選択または行を実行するたびに同じターミナルが使用されます。同じターミナルは、Run Python File in Terminal にも使用されます。そのターミナルでまだ REPL が実行されている場合は、Python ファイルを実行する前に REPL を終了するか (exit())、別のターミナルに切り替える必要があります。
Python 拡張機能は、選択範囲の最初の空白でない行に基づいてインデントを自動的に削除し、必要に応じて他のすべての行を左にシフトします。
必要に応じて、このコマンドは Python ターミナルを開きます。また、現在選択されているインタープリターでターミナルをアクティブにし、Python REPL を実行する Python: Start Terminal REPL コマンドを使用して、対話型 REPL 環境を直接開くこともできます。
より具体的な手順やその他のコードの実行方法については、コードの実行チュートリアルを参照してください。
オートコンプリートと IntelliSense
Python 拡張機能は、現在選択されているインタープリターを使用してコード補完と IntelliSense をサポートしています。IntelliSense は、すべてのファイルおよび組み込みモジュールとサードパーティ モジュールにわたるインテリジェントなコード補完 (コンテキスト内のメソッドと変数の候補) を含む、いくつかの機能の総称です。
IntelliSense は、入力中にメソッド、クラスメンバー、ドキュメントをすばやく表示します。⌃Space (Windows、Linux Ctrl+Space) を使用して、いつでも補完をトリガーすることもできます。識別子にマウスカーソルを合わせると、それらに関する詳細情報が表示されます。
AI で補完を強化する
GitHub Copilot は、AI を活用したコード補完ツールであり、より速く、よりスマートにコードを記述するのに役立ちます。VS Code でGitHub Copilot 拡張機能を使用して、コードを生成したり、生成されたコードから学習したりできます。
GitHub Copilot は、Python 以外の言語や、JavaScript、TypeScript、Ruby、Go、C#、C++ など、さまざまなフレームワークの候補を提供します。
Copilot の使用開始方法については、Copilot ドキュメントで詳しく学ぶことができます。
Linting
リンティングは Python コードの潜在的なエラーを分析し、さまざまな問題への移動と修正を容易にします。
Python 拡張機能は、Pylint、pycodestyle、Flake8、mypy、pydocstyle、prospector、pylama など、さまざまなリンターを適用できます。リンティングを参照してください。
デバッグ
もはや print ステートメントによるデバッグは不要です! VS Code には、Python デバッガー拡張機能を介して Python の優れたデバッグ サポートが付属しており、ブレークポイントを設定したり、変数を検査したり、デバッグ コンソールを使用してプログラムがステップバイステップでどのように実行されているかを詳細に確認したりできます。マルチスレッド、Web、リモート アプリケーションを含む、さまざまな種類の Python アプリケーションをデバッグできます。
Python でのデバッグに関するより具体的な情報 (launch.json 設定の構成やリモート デバッグの実装など) については、デバッグを参照してください。一般的な VS Code のデバッグ情報は、デバッグ ドキュメントに記載されています。
さらに、Django および Flask チュートリアルでは、Django テンプレートのデバッグを含め、Web アプリケーションのコンテキストでデバッグを実装する方法の例を示しています。
環境
Python 拡張機能は、標準の場所にインストールされている Python インタープリターを自動的に検出します。また、conda 環境とワークスペース フォルダー内の仮想環境も検出します。Python 環境の構成を参照してください。
現在の環境は VS Code ステータス バーの右側に表示されます。
ステータス バーには、インタープリターが選択されていない場合も表示されます。
選択された環境は、IntelliSense、オートコンプリート、リンティング、フォーマット、およびその他の言語関連機能に使用されます。また、ターミナルで Python を実行またはデバッグするとき、または Terminal: Create New Terminal コマンドで新しいターミナルを作成するときにもアクティブ化されます。
現在のインタープリターを変更するには (conda または仮想環境への切り替えを含む)、ステータス バーのインタープリター名を選択するか、Python: Select Interpreter コマンドを使用します。
VS Code は、検出された環境のリストと、ユーザー設定に手動で追加した環境のリストを表示します (Python 環境の構成を参照)。
Jupyter Notebook
VS Code で Jupyter Notebook ファイル (.ipynb) の Python サポートを有効にするには、Jupyter 拡張機能をインストールできます。Python 拡張機能と Jupyter 拡張機能は連携して、VS Code で優れたノートブック エクスペリエンスを提供し、IntelliSense サポート付きでコード セルを直接表示および変更したり、実行およびデバッグしたりする機能を提供します。
Jupyter: Export to Python Script コマンドを介して、ノートブックを Python コード ファイルとして変換して開くこともできます。ノートブックのセルは、Python ファイル内で #%% コメントで区切られ、Jupyter 拡張機能は Run Cell または Run Below CodeLens を表示します。いずれかの CodeLens を選択すると、Jupyter サーバーが起動し、Python 対話型ウィンドウでセルが実行されます。
リモートの Jupyter サーバーに接続して、ノートブックを実行することもできます。詳細については、Jupyter サポートを参照してください。
テスト
Python 拡張機能は、Python の組み込み unittest フレームワークと pytest を使用したテストをサポートしています。
テストを実行するには、プロジェクトの設定でサポートされているテスト フレームワークのいずれかを有効にする必要があります。各フレームワークには、テスト検出のパスとパターンを識別するための引数など、独自の特定の設定があります。
テストが検出されると、VS Code はテストを実行およびデバッグするためのさまざまなコマンド (ステータス バー、コマンド パレットなど) を提供します。これらのコマンドを使用すると、個々のテスト ファイルとメソッドを実行することもできます。
設定
Python 拡張機能は、そのさまざまな機能に対して幅広い設定を提供します。これらは、コードの編集、リンティング、デバッグ、テストなど、関連するトピックで説明されています。完全なリストは設定リファレンスにあります。
Python プロファイル テンプレート
プロファイルを使用すると、現在のプロジェクトやタスクに応じて、拡張機能、設定、UI レイアウトをすばやく切り替えることができます。Python 開発を開始するのに役立つように、便利な拡張機能、設定、スニペットを含む厳選されたプロファイルであるPython プロファイル テンプレートを使用できます。プロファイル テンプレートをそのまま使用することも、独自のワークフローに合わせてさらにカスタマイズするための出発点として使用することもできます。
プロファイルテンプレートは、プロファイル > プロファイルの作成... ドロップダウンから選択します。
プロファイル テンプレートを選択すると、設定と拡張機能を確認し、新しいプロファイルに含めない場合は個々のアイテムを削除できます。テンプレートに基づいて新しいプロファイルを作成した後、設定、拡張機能、または UI に加えられた変更はプロファイルに保持されます。
その他の人気のある Python 拡張機能
Microsoft Python 拡張機能は、この記事で以前に説明したすべての機能を提供します。その他の一般的な Python 拡張機能をインストールすることで、VS Code に追加の Python 言語サポートを追加できます。
- 拡張機能ビュー (⇧⌘X (Windows、Linux Ctrl+Shift+X)) を開きます。
- 'python' と入力して拡張機能リストをフィルター処理します。
上記に表示されている拡張機能は動的にクエリされます。上の拡張機能タイルをクリックして説明とレビューを読み、どの拡張機能が最適かを判断してください。マーケットプレイスで詳細を確認してください。
次のステップ
- Python Hello World チュートリアル - VS Code で Python の使用を開始します。
- Python の編集 - Python のオートコンプリート、フォーマット、リファクタリングについて学習します。
- 基本的な編集 - 強力な VS Code エディターについて学習します。
- コード ナビゲーション - ソースコード内をすばやく移動します。
- Django チュートリアル
- Flask チュートリアル