🚀 VS Code で を入手しましょう!

VS Code で Python を始める

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

プログラミングを初めて行う場合は、Visual Studio Code for Education - Introduction to Python コースをご覧ください。このコースでは、すぐにコードを記述できるブラウザーベースの開発環境で、構造化されたモジュールを備えた Python の包括的な入門を提供しています。

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

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.pypip をインストールする必要があります。

その他のオプション

  • データサイエンス: 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 では、[Python: 環境の作成] を使用して、Venv または Anaconda でグローバルでない環境を作成できます。

コマンドパレット (⇧⌘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 拡張機能は、Lint も完全にサポートしています。

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 を押します) プログラムを最後まで実行します。[Python デバッグコンソール] に切り替えると [Roll a dice!] が表示され、プログラムが完了すると 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 をさらに詳しく見ていきましょう