VS Codeのエージェントモードを拡張するには、を試してください!

VS Code で Python を使い始める

このチュートリアルでは、Visual Studio Code で Python 3 を使用して、Python の「Roll a dice!」アプリケーションを作成、実行、デバッグし、仮想環境を操作し、パッケージを使用する方法などを学びます。Python 拡張機能を使用すると、VS Code が優れた軽量な Python エディターになります。

プログラミングが初めての場合は、Visual Studio Code for Education - Introduction to Python コースをチェックしてください。このコースでは、Python の包括的な入門を提供し、コード記述準備ができたブラウザーベースの開発環境で構造化されたモジュールが特徴です。

Python 言語の理解を深めるために、python.org にリストされているプログラミングチュートリアルのいずれかを VS Code のコンテキストで探索できます。

Python を使用したデータサイエンスに特化したチュートリアルについては、弊社のデータサイエンスセクションをご覧ください。

前提条件

このチュートリアルを正常に完了するには、まず Python 開発環境をセットアップする必要があります。具体的には、このチュートリアルでは以下が必要です

Python インタープリターをインストールする

Python 拡張機能とともに、Python インタープリターをインストールする必要があります。使用するインタープリターは特定のニーズによって異なりますが、以下にいくつかのガイダンスを示します。

Windows

python.org から Python をインストールします。ページに最初に表示されるDownload Python ボタンを使用して、最新バージョンをダウンロードします。

注意: 管理者アクセス権がない場合、Windows に Python をインストールする追加のオプションとして、Microsoft Store を使用する方法があります。Microsoft Store は、サポートされている Python バージョンのインストールを提供します。

Windows での Python の使用に関する追加情報については、Python.org の Windows での Python の使用を参照してください。

macOS

macOS での Python のシステムインストールはサポートされていません。代わりに、Homebrewのようなパッケージ管理システムが推奨されます。macOS で Homebrew を使用して Python をインストールするには、ターミナルプロンプトで brew install python3 を使用します。

注意: macOS では、VS Code のインストール場所が PATH 環境変数に含まれていることを確認してください。詳細については、これらのセットアップ手順を参照してください。

Linux

Linux の組み込み Python 3 インストールはうまく機能しますが、他の Python パッケージをインストールするには、get-pip.py を使用して pip をインストールする必要があります。

その他のオプション

  • データサイエンス: Python を使用する主な目的がデータサイエンスである場合は、Anaconda からのダウンロードを検討してもよいでしょう。Anaconda は Python インタープリターだけでなく、データサイエンスに役立つ多くのライブラリとツールも提供します。

  • Windows Subsystem for Linux: Windows で作業していて、Python で作業するための Linux 環境が必要な場合は、Windows Subsystem for Linux (WSL) がオプションとなります。このオプションを選択する場合は、WSL 拡張機能もインストールすることをお勧めします。VS Code で WSL を使用する方法の詳細については、VS Code リモート開発を参照するか、WSL での作業チュートリアルを試してみてください。このチュートリアルでは、WSL のセットアップ、Python のインストール、WSL で実行される Hello World アプリケーションの作成について説明します。

注意: お使いのマシンに Python が正常にインストールされていることを確認するには、次のコマンドのいずれかを実行します (オペレーティングシステムによって異なります)

Linux/macOS: ターミナルウィンドウを開き、次のコマンドを入力します

python3 --version

Windows: コマンドプロンプトを開き、次のコマンドを実行します

py -3 --version

インストールが成功した場合、出力ウィンドウにはインストールした Python のバージョンが表示されます。または、VS Code の統合ターミナルで py -0 コマンドを使用して、マシンにインストールされている Python のバージョンを表示することもできます。デフォルトのインタープリターはアスタリスク (*) で識別されます。

ワークスペースフォルダーで VS Code を起動する

VS Code をフォルダーで起動すると、そのフォルダーが「ワークスペース」になります。

コマンドプロンプトまたはターミナルを使用して、「hello」という空のフォルダーを作成し、そのフォルダーに移動して、次のコマンドを入力してそのフォルダー (.) で VS Code (code) を開きます

mkdir hello
cd hello
code .

注意: Anaconda ディストリビューションを使用している場合は、Anaconda コマンドプロンプトを使用するようにしてください。

または、オペレーティングシステムの UI を介してフォルダーを作成し、VS Code のファイル > フォルダーを開くを使用してプロジェクトフォルダーを開くこともできます。

仮想環境を作成する

Python 開発者のベストプラクティスは、プロジェクト固有の仮想環境を使用することです。この環境をアクティブにすると、インストールするすべてのパッケージは、グローバルインタープリター環境を含む他の環境から分離され、パッケージバージョンの競合から生じる多くの問題を軽減します。VS Code で Venv または Anaconda を使用して、Python: 環境を作成で非グローバル環境を作成できます。

コマンドパレット (⇧⌘P (Windows、Linux Ctrl+Shift+P)) を開き、Python: 環境を作成コマンドの入力を開始して検索し、そのコマンドを選択します。

このコマンドは、Venv または Conda の環境タイプの一覧を表示します。この例では、Venv を選択します。

Create Environment dropdown

次に、このコマンドはプロジェクトに使用できるインタープリターの一覧を表示します。チュートリアルの冒頭でインストールしたインタープリターを選択します。

Virtual environment interpreter selection

インタープリターを選択すると、環境作成の進行状況を示す通知が表示され、環境フォルダー (/.venv) がワークスペースに表示されます。

Create environment status notification

コマンドパレットからPython: インタープリターを選択コマンドを使用して、新しい環境が選択されていることを確認してください。

Select an Interpreter

注意: 仮想環境に関する追加情報、または環境作成プロセスでエラーが発生した場合は、環境を参照してください。

Python ソースコードファイルを作成する

ファイルエクスプローラーのツールバーから、hello フォルダー上の新しいファイルボタンを選択します

File Explorer New File

ファイルを hello.py という名前にすると、VS Code が自動的にエディターで開きます

File Explorer hello.py

.py ファイル拡張子を使用すると、VS Code はこのファイルを Python プログラムとして解釈し、Python 拡張機能と選択されたインタープリターで内容を評価するように指示されます。

注意: ファイルエクスプローラーのツールバーでは、コードをより適切に整理するためにワークスペース内にフォルダーを作成することもできます。新しいフォルダーボタンを使用して、フォルダーをすばやく作成できます。

ワークスペースにコードファイルができたので、hello.py に次のソースコードを入力します

msg = "Roll a dice!"
print(msg)

print と入力し始めると、IntelliSense がオートコンプリートのオプションを提示することに気づくでしょう。

IntelliSense appearing for Python code

IntelliSense とオートコンプリートは、標準の Python モジュールや、選択された Python インタープリターの環境にインストールした他のパッケージでも機能します。また、オブジェクトタイプで利用可能なメソッドの補完も提供します。たとえば、msg 変数には文字列が含まれているため、msg. と入力すると IntelliSense が文字列メソッドを提供します。

IntelliSense appearing for a variable whose type provides methods

最後に、ファイルを保存します (⌘S (Windows、Linux Ctrl+S))。この時点で、VS Code で最初の Python ファイルを実行する準備が整いました。

編集、フォーマット、リファクタリングの詳細については、コードの編集を参照してください。Python 拡張機能はLintingも完全にサポートしています。

Python コードの実行

エディターの右上にあるPython ファイルを実行プレイボタンをクリックします。

Using the Run Python File button

このボタンをクリックするとターミナルパネルが開き、Python インタープリターが自動的にアクティブ化され、python3 hello.py (macOS/Linux) または python hello.py (Windows) が実行されます。

Program output in a Python terminal

VS Code 内で Python コードを実行するには、他に 3 つの方法があります

  1. エディターウィンドウの任意の場所を右クリックし、Python を実行 > ターミナルで Python ファイルを実行を選択します (これによりファイルが自動的に保存されます)

    Run Python File in Terminal command in the Python editor

  2. 1 行以上を選択し、Shift+Enter を押すか、右クリックしてPython を実行 > Python ターミナルで選択/行を実行を選択します。または、選択せずに Shift+Enter を使用してスマート送信をアクティブにすると、Python 拡張機能はカーソルが置かれている場所の近くにある実行可能な最小のコードブロックをターミナルに送信します。このコマンドは、ファイルの一部だけをテストするのに便利です。

    注意: カーソルがある特定の行でコードを送信したい場合は、ユーザー設定で python.REPL.enableREPLSmartSend : "false" を設定することにより、スマート送信をオフにできます。

  3. コマンドパレット (⇧⌘P (Windows、Linux Ctrl+Shift+P)) から、Python: ターミナル REPL を開始コマンドを選択して、現在選択されている Python インタープリターの REPL ターミナル (>>> で表記) を開きます。REPL では、コードの行を一度に 1 行ずつ入力して実行できます。

おめでとうございます、Visual Studio Code で最初の Python コードを実行しました!

デバッガーを設定して実行する

次に、Python プログラムをデバッグしてみましょう。デバッグサポートは、Python 拡張機能とともに自動的にインストールされるPython デバッガー拡張機能によって提供されます。正しくインストールされていることを確認するには、拡張機能ビュー (⇧⌘X (Windows、Linux Ctrl+Shift+X)) を開き、@installed python debugger を検索します。結果に Python デバッガー拡張機能がリストされているはずです。

Python Debugger extension shown in installed extensions view in VS Code.

次に、hello.py の 2 行目の print 呼び出しにカーソルを置き、F9 を押してブレークポイントを設定します。または、行番号の横のエディターの左側余白をクリックしても設定できます。ブレークポイントを設定すると、余白に赤い丸が表示されます。

Setting a breakpoint in hello.py

次に、デバッガーを初期化するには、F5 を押します。このファイルをデバッグするのが初めての場合、コマンドパレットから構成メニューが開き、開いているファイルに必要なデバッグ構成の種類を選択できるようになります。

List of Python debugger configuration options

注意: VS Code は、さまざまな構成すべてに JSON ファイルを使用します。launch.json は、デバッグ構成を含むファイルの標準名です。

Python ファイルを選択します。これは、現在選択されている Python インタープリターを使用してエディターに表示されている現在のファイルを実行する構成です。

デバッガーが開始し、ファイルのブレークポイントの最初の行で停止します。現在の行は左余白に黄色の矢印で示されます。この時点でローカル変数ウィンドウを調べると、msg 変数がローカルペインに表示されていることがわかります。

Debugging step 2 - variable defined

デバッグツールバーが上部に表示され、左から右に次のコマンドが表示されます: 続行 (F5)、ステップオーバー (F10)、ステップイン (F11)、ステップアウト (⇧F11 (Windows、Linux Shift+F11))、再起動 (⇧⌘F5 (Windows、Linux Ctrl+Shift+F5))、停止 (⇧F5 (Windows、Linux Shift+F5))。

Debugging toolbar

ステータスバーも色が変わる (多くのテーマではオレンジ色) ことで、デバッグモードであることを示します。Python デバッグコンソールも右下パネルに自動的に表示され、実行中のコマンドとプログラムの出力が表示されます。

プログラムの実行を続行するには、デバッグツールバーの続行コマンド (F5) を選択します。デバッガーはプログラムを最後まで実行します。

ヒント デバッグ情報は、変数などのコードにカーソルを合わせても確認できます。msg の場合、変数にカーソルを合わせると、変数の上に文字列 Roll a dice! がボックスで表示されます。

デバッグコンソールでも変数を操作できます (表示されていない場合は、VS Code の右下領域でデバッグコンソールを選択するか、... メニューから選択します)。次に、コンソール下部の>プロンプトで、次の行を 1 行ずつ入力してみてください

msg
msg.capitalize()
msg.split()

Debugging step 3 - using the debug console

ツールバーの青い続行ボタンをもう一度選択 (または F5 を押す) して、プログラムを完了まで実行します。切り替えると「Roll a dice!」がPython デバッグコンソールに表示され、プログラムが完了すると VS Code はデバッグモードを終了します。

デバッガーを再起動すると、デバッガーは再び最初のブレークポイントで停止します。

プログラムが完了する前に実行を停止するには、デバッグツールバーの赤い四角い停止ボタン (⇧F5 (Windows、Linux Shift+F5)) を使用するか、実行 > デバッグの停止メニューコマンドを使用します。

詳細については、デバッグ構成を参照してください。これには、デバッグに特定の Python インタープリターを使用する方法に関する注記が含まれています。

ヒント: print ステートメントの代わりにログポイントを使用する: 開発者は、デバッガーでコードの各行を必ずしもステップ実行せずに変数をすばやく検査するために、ソースコードを print ステートメントで埋め尽くすことがよくあります。VS Code では、代わりにログポイントを使用できます。ログポイントはブレークポイントと似ていますが、コンソールにメッセージをログし、プログラムを停止しません。詳細については、VS Code のメインのデバッグ記事にあるログポイントを参照してください。

パッケージをインストールして使用する

パッケージを使用して、前の例をさらに拡張してみましょう。

Python では、パッケージは、通常PyPIから、プログラムに追加機能を提供する多数の有用なコードライブラリを入手する方法です。この例では、乱数を生成するために numpy パッケージを使用します。

エクスプローラービュー (左側の一番上にある、ファイルを表示するアイコン) に戻り、hello.py を開き、次のソースコードを貼り付けます

import numpy as np

msg = "Roll a dice!"
print(msg)

print(np.random.randint(1,9))

ヒント: 上記のコードを手で入力した場合、行末で Enter を押すと、as キーワードの後の名前がオートコンプリートによって変更されることがあります。これを避けるには、スペースを入力してから Enter を押してください。

次に、前セクションで説明した「Python: 現在のファイル」構成を使用して、デバッガーでファイルを実行します。

「ModuleNotFoundError: No module named 'numpy'」というメッセージが表示されるはずです。このメッセージは、必要なパッケージがインタープリターで利用できないことを示します。Anaconda ディストリビューションを使用している場合や、以前に numpy パッケージをインストールしている場合は、このメッセージは表示されないことがあります。

numpy パッケージをインストールするには、デバッガーを停止し、コマンドパレットを使用してターミナル: 新しいターミナルを作成 (⌃⇧` (Windows、Linux Ctrl+Shift+`)) を実行します。このコマンドは、選択したインタープリターのコマンドプロンプトを開きます。

仮想環境に必要なパッケージをインストールするには、お使いのオペレーティングシステムに合わせて次のコマンドを入力します

  1. パッケージをインストールする

    # Don't use with Anaconda distributions because they include matplotlib already.
    
    # macOS
    python3 -m pip install numpy
    
    # Windows (may require elevation)
    py -m pip install numpy
    
    # Linux (Debian)
    apt-get install python3-tk
    python3 -m pip install numpy
    
  2. さあ、デバッガーの有無にかかわらずプログラムを再実行して、出力を確認しましょう!

環境間での依存関係の管理

Python プロジェクトで作業する際、依存関係を効果的に管理することが不可欠です。有用なヒントの 1 つは、pip freeze > requirements.txt コマンドを使用することです。このコマンドは、仮想環境にインストールされているすべてのパッケージをリストする requirements.txt ファイルを作成するのに役立ちます。このファイルは、同じ環境を別の場所で再作成するために使用できます。

requirements.txt ファイルを作成するには、次の手順に従います

  1. まだ行っていない場合は、仮想環境をアクティブ化します。

    source venv/bin/activate  # On macOS/Linux
    
    .\venv\Scripts\activate   # On Windows
    
  2. requirements.txt ファイルを生成します。

    pip freeze > requirements.txt
    

これで、新しく生成された requirements.txt ファイルを使用して、別の環境に依存関係をインストールできます。さらに、プロジェクトが複雑になるにつれて、依存関係を追加し続けることができます。

pip install -r requirements.txt

これらの手順に従うことで、異なる環境間でプロジェクトの依存関係の一貫性を確保し、他のユーザーとの共同作業やプロジェクトの展開を容易にすることができます。

Python チュートリアルを完了おめでとうございます!このチュートリアルを通して、Python プロジェクトの作成、仮想環境の作成、Python コードの実行とデバッグ、Python パッケージのインストール方法を学びました。Visual Studio Code で Python を最大限に活用する方法を学ぶために、追加のリソースを探索してください!

次のステップ

人気のある Python Web フレームワークを使用して Web アプリを構築する方法を学ぶには、次のチュートリアルを参照してください

Visual Studio Code で Python を使ってもっと探索できることがたくさんあります