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: インタープリターを選択 (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: インタープリターを選択) を使用して Python コードを実行するショートカットを提供します。アクティブな Python ファイルを実行するには、エディターの右上にある Python ファイルの実行の再生ボタンをクリックします。
また、Python: Python ターミナルで選択範囲/行を実行 (Python: Run Selection/Line in Python Terminal) コマンド (Shift+Enter) を使用して、個々の行または選択したコードを実行することもできます。選択範囲がない場合、スマート送信 (Smart Send) は、(Shift+Enter) でカーソルが置かれている行の周囲にある最小の実行可能なコード ブロックを Python ターミナルに送信します。エディター内の選択範囲のコンテキスト メニューでも、これと同じ Python の実行 > Python ターミナルで選択範囲/行を実行 コマンドが使用できます。ターミナル/REPL で選択範囲または行を実行するたびに、そのターミナルが閉じられるまで同じターミナルが使用されます。この同じターミナルは、ターミナルで Python ファイルを実行 でも使用されます。そのターミナルがまだ REPL を実行している場合は、Python ファイルを実行する前に REPL を終了 (exit()) するか、別のターミナルに切り替える必要があります。
Python 拡張機能は、選択範囲の最初の空でない行に基づいて自動的にインデントを削除し、必要に応じて他のすべての行を左にシフトします。
このコマンドは必要に応じて Python ターミナルを開きます。また、現在選択されているインタープリターでターミナルをアクティブにし、Python REPL を実行する 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 Debugger 拡張機能による Python の優れたデバッグ サポートが用意されており、ブレークポイントの設定、変数の検査、デバッグ コンソールの使用によるプログラムの段階的な実行状況の詳細な確認が可能です。マルチスレッド、Web、リモート アプリケーションなど、さまざまな種類の Python アプリケーションをデバッグできます。
launch.json 設定の構成やリモート デバッグの実装など、Python でのデバッグに関するより具体的な情報については、デバッグを参照してください。VS Code の一般的なデバッグ情報については、デバッグに関するドキュメントを参照してください。
さらに、Django および Flask のチュートリアルでは、Django テンプレートのデバッグなど、Web アプリケーションのコンテキストでデバッグを実装する方法の例を示しています。
環境
Python 拡張機能は、標準的な場所にインストールされている Python インタープリターを自動的に検出します。また、ワークスペース フォルダー内の conda 環境や仮想環境も検出します。Python 環境の構成を参照してください。
現在の環境は、VS Code ステータス バーの右側に表示されます。
ステータス バーには、インタープリターが選択されていないことも表示されます。
選択された環境は、IntelliSense、自動補完、リンティング、書式設定、およびその他の言語関連機能に使用されます。また、ターミナルで Python を実行またはデバッグするとき、または ターミナル: 新しいターミナルの作成 (Terminal: Create New Terminal) コマンドで新しいターミナルを作成するときにもアクティブになります。
conda 環境や仮想環境への切り替えなど、現在のインタープリターを変更するには、ステータス バーでインタープリター名を選択するか、Python: インタープリターを選択 (Python: Select Interpreter) コマンドを使用します。
VS Code は、検出された環境に加えて、ユーザー設定に手動で追加した環境の一覧を表示します (Python 環境の構成を参照)。
Jupyter ノートブック
VS Code で Jupyter ノートブック ファイル (.ipynb) の Python サポートを有効にするには、Jupyter 拡張機能をインストールします。Python 拡張機能と Jupyter 拡張機能が連携することで、VS Code で優れたノートブック体験が提供され、IntelliSense のサポートを利用してコード セルを直接表示および修正できるだけでなく、それらを実行およびデバッグすることもできます。
また、Jupyter: Python スクリプトにエクスポート (Jupyter: Export to Python Script) コマンドを使用して、ノートブックを Python コード ファイルとして変換して開くこともできます。ノートブックのセルは Python ファイル内で #%% コメントで区切られ、Jupyter 拡張機能には セルの実行 または 以下を実行 の CodeLens が表示されます。いずれかの CodeLens を選択すると、Jupyter サーバーが起動し、Python インタラクティブ ウィンドウでセルが実行されます。
リモート Jupyter サーバーに接続してノートブックを実行することもできます。詳細については、Jupyter サポートを参照してください。
テスト
Python 拡張機能は、Python に組み込まれている unittest framework および pytest によるテストをサポートしています。
テストを実行するには、プロジェクトの設定でサポートされているテスト フレームワークのいずれかを有効にする必要があります。各フレームワークには、テスト検出用のパスやパターンを識別するための引数など、独自の固有の設定があります。
テストが検出されると、VS Code はテストを実行およびデバッグするためのさまざまなコマンド (ステータス バー、コマンド パレット、その他の場所) を提供します。これらのコマンドを使用すると、個々のテスト ファイルやメソッドを実行することもできます。
構成
Python 拡張機能は、そのさまざまな機能に対して幅広い設定を提供します。これらについては、コードの編集、リンティング、デバッグ、テストなどの関連するトピックで説明されています。完全な一覧は 設定リファレンス にあります。
Python プロファイル テンプレート
プロファイルを使用すると、現在のプロジェクトやタスクに応じて、拡張機能、設定、UI レイアウトをすばやく切り替えることができます。Python 開発をすぐに始められるように、便利な拡張機能、設定、スニペットが含まれた精選プロファイルである Python プロファイル テンプレートを使用できます。プロファイル テンプレートをそのまま使用することも、独自のワークフローに合わせてさらにカスタマイズするための出発点として使用することもできます。
プロファイル テンプレートは、プロファイル > プロファイルの作成... ドロップダウンから選択します。
プロファイル テンプレートを選択したら、設定と拡張機能を確認し、新しいプロファイルに含めたくない個々の項目を削除できます。テンプレートに基づいて新しいプロファイルを作成した後は、設定、拡張機能、または UI に加えられた変更がプロファイルに保存されます。
その他の一般的な Python 拡張機能
Microsoft Python 拡張機能は、この記事で前述したすべての機能を提供します。その他の人気のある Python 拡張機能をインストールすることで、VS Code に追加の Python 言語サポートを追加できます。
- 拡張機能 ビューを開きます (⇧⌘X (Windows、Linux では Ctrl+Shift+X))。
- 'python' と入力して、拡張機能の一覧をフィルターします。
上に表示されている拡張機能は動的に照会されます。上の拡張機能のタイルをクリックして、説明やレビューを読み、どの拡張機能が最適かを判断してください。詳細は、Marketplace を参照してください。
次のステップ
- Python Hello World チュートリアル - VS Code で Python を始めましょう。
- Python の編集 - Python の自動補完、書式設定、リファクタリングについて説明します。
- 基本的な編集 - 強力な VS Code エディターについて学習します。
- コードナビゲーション - ソースコードを素早く移動します。
- Django チュートリアル
- Flask チュートリアル