VS Code で Python を始める

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

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

Python 言語をより深く理解するために、python.org にリストされているプログラミングチュートリアルを VS Code のコンテキストで確認することもできます。

Python を使ったデータサイエンス向けのチュートリアルについては、データサイエンスのセクションをご覧ください。

前提条件

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

• Python 3
• VS Code
• VS Code Python 拡張機能 (拡張機能のインストールに関する詳細については、拡張機能マーケットプレイスを参照してください)

Python インタープリターのインストール

Python 拡張機能に加えて、Python インタープリターをインストールする必要があります。どのインタープリターを使用するかは個々のニーズによって異なりますが、以下にガイドラインを示します。

Windows

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

注: 管理者権限がない場合、Windows で Python をインストールする別の方法として Microsoft Store を使用できます。Microsoft Store は サポートされている Python バージョン のインストールを提供しています。

Windows での Python の使用に関する詳細については、Python.org の Using Python on Windows を参照してください。

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

注: マシンに 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: Create Environment を使用して、Venv または Anaconda で非グローバル環境を作成できます。

コマンドパレット (⇧⌘P (Windows, Linux Ctrl+Shift+P)) を開き、Python: Create Environment コマンドを入力して検索し、選択します。

コマンドは、Venv または Conda という環境タイプのリストを表示します。この例では、Venv を選択します。

次に、プロジェクトで使用できるインタープリターのリストが表示されます。チュートリアルの冒頭でインストールしたインタープリターを選択します。

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

コマンドパレットから Python: Select Interpreter コマンドを使用して、新しい環境が選択されていることを確認します。

注: 仮想環境の詳細や、環境作成プロセスでエラーが発生した場合は、環境 を参照してください。

Python ソースコードファイルの作成

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

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

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

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

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

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

print と入力し始めると、IntelliSense が自動補完オプションを提示することに注目してください。

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

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

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

Python コードを実行する

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

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

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

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

   

2. 1行または複数行を選択して Shift+Enter を押すか、右クリックして Run Python > Run Selection/Line in Python Terminal を選択します。あるいは、選択範囲なしで Shift+Enter を使用して「スマート送信 (Smart Send)」をアクティブにすることもできます。Python 拡張機能は、カーソル位置の近くにある最小限の実行可能なコードブロックをターミナルに送信します。このコマンドは、ファイルの一部のみをテストする場合に便利です。

   注: 特定の行のコードを送信したい場合は、ユーザー設定で python.REPL.enableREPLSmartSend : "false" を設定することで、スマート送信を無効にできます。

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

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

デバッガーの設定と実行

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

次に、hello.py の2行目にブレークポイントを設定します。print 呼び出しにカーソルを合わせ、F9 を押します。あるいは、エディターの左側のガター（行番号の隣）をクリックします。ブレークポイントを設定すると、ガターに赤い円が表示されます。

次に、デバッガーを初期化するために F5 を押します。このファイルをデバッグするのは初めてなので、コマンドパレットから設定メニューが開き、開いているファイルに適したデバッグ設定の種類を選択できます。

注: VS Code はすべての設定に JSON ファイルを使用します。launch.json はデバッグ設定を含むファイルの標準的な名前です。

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

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

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

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

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

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

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

msg
msg.capitalize()
msg.split()

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

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

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

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

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

パッケージのインストールと使用

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

Python においてパッケージとは、プログラムに機能を追加する、通常は PyPI から取得される便利なコードライブラリのことです。この例では、numpy パッケージを使用して乱数を生成します。

エクスプローラー ビュー (左側の一番上のアイコン) に戻り、hello.py を開き、以下のソースコードを貼り付けます。

import numpy as np

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

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

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

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

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

numpy パッケージをインストールするには、デバッガーを停止し、次のいずれかの方法を使用します。

オプション 1: パッケージ管理 UI を使用する

1. Python サイドバーを開き、環境マネージャー (Environment Managers) を展開します。
2. 環境を右クリックし、パッケージの管理 (Manage Packages) を選択します。
3. numpy を検索し、インストール (Install) を選択します。

オプション 2: ターミナルを使用する

コマンドパレットから Terminal: Create New Terminal (⌃⇧` (Windows, Linux Ctrl+Shift+`)) を実行します。このコマンドは、選択したインタープリター用のコマンドプロンプトを開きます。

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

# Don't use with Anaconda distributions because they include matplotlib already.

# macOS
python3 -m pip install numpy

# Windows (may require elevation)
python -m pip install numpy

# Linux (Debian)
apt-get install python3-tk
python3 -m pip install numpy

それでは、デバッガーの有無にかかわらず、もう一度プログラムを実行して出力を確認しましょう！

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

Python プロジェクトで作業する場合、依存関係を効率的に管理することが不可欠です。役立つヒントとして、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 で Django を使用する
• Visual Studio Code で Flask を使用する
• Visual Studio Code で FastAPI を使用する

Visual Studio Code での Python には、他にも探求すべきことがたくさんあります。

• Python プロファイルテンプレート - 厳選された拡張機能、設定、スニペットを備えた新しいプロファイルを作成します。
• コードの編集 - Python のオートコンプリート、IntelliSense、フォーマット、リファクタリングについて説明します。
• Linting - さまざまな Python リンターを有効化、構成、適用する。
• デバッグ - ローカルおよびリモートでの Python のデバッグ方法を学習します。
• テスト - テスト環境を構成し、テストを検出、実行、およびデバッグします。
• 設定リファレンス - VS Code の Python 関連設定の全範囲を調べます。
• Python を Azure App Service にデプロイする
• Python を Container Apps にデプロイする