VSCode Python 開発環境構築ガイド：初心者でも簡単！

By /

はい、承知いたしました。初心者でも簡単にできる、VS Codeを使ったPython開発環境構築ガイドを詳細に記述します。

VS Code Python 開発環境構築ガイド：初心者でも簡単！

Pythonは、そのシンプルさと汎用性から、初心者からプロフェッショナルまで幅広い層に人気のプログラミング言語です。データ分析、機械学習、Web開発、自動化スクリプトなど、様々な分野で活用されています。

Pythonを効率的に開発するためには、優れた開発環境が不可欠です。Visual Studio Code (VS Code) は、その強力な機能と柔軟性から、多くのPython開発者に支持されている無料のコードエディタです。

この記事では、VS Codeを使ってPythonの開発環境を構築する手順を、初心者でもわかりやすく、詳細に解説します。環境構築から基本的な使い方、便利な拡張機能まで、Python開発に必要な知識を網羅的にご紹介します。

1. 必要なソフトウェアのインストール

まず、PythonとVS Codeをインストールする必要があります。

1.1 Pythonのインストール

Python公式サイトから、最新版のPythonをダウンロードします。

ダウンロードページから、お使いのOS（Windows, macOS, Linux）に合ったインストーラを選択してください。

Windowsの場合:

  1. ダウンロードしたインストーラ（.exeファイル）を実行します。
  2. インストール画面が表示されたら、必ず “Add Python x.x to PATH” にチェックを入れてください。 これにより、コマンドプロンプトからPythonを実行できるようになります。
  3. “Install Now” をクリックしてインストールを開始します。
  4. インストールが完了したら、コマンドプロンプトを開き、python --version と入力してPythonのバージョンが表示されることを確認してください。

macOSの場合:

  1. ダウンロードしたインストーラ（.pkgファイル）を実行します。
  2. インストーラの指示に従ってインストールを進めます。
  3. インストールが完了したら、ターミナルを開き、python3 --version と入力してPythonのバージョンが表示されることを確認してください。

Linuxの場合:

Linuxでは、パッケージマネージャを使ってPythonをインストールするのが一般的です。

  • Debian/Ubuntu: sudo apt update && sudo apt install python3 python3-pip
  • Fedora/CentOS/RHEL: sudo dnf install python3 python3-pip
  • Arch Linux: sudo pacman -S python python-pip

インストール後、ターミナルで python3 --version と pip3 --version と入力して、Pythonとpipのバージョンが表示されることを確認してください。

補足:

  • pip (Python Package Installer) は、Pythonのパッケージ（ライブラリ）をインストール・管理するためのツールです。Pythonをインストールする際に、自動的にインストールされます。
  • 複数のバージョンのPythonがインストールされている場合は、python3 または python コマンドで実行するバージョンを指定できます。

1.2 VS Codeのインストール

VS Code公式サイトから、最新版のVS Codeをダウンロードします。

ダウンロードページから、お使いのOSに合ったインストーラを選択してダウンロードし、インストールしてください。インストール手順は、基本的に指示に従って進めるだけです。

2. VS Codeの基本設定

VS Codeをインストールしたら、Python開発に適した設定を行いましょう。

2.1 VS Codeの起動と初期設定

VS Codeを起動すると、ウェルカム画面が表示されます。ここで、テーマの選択やキーボードショートカットの設定など、基本的な設定を行うことができます。

2.2 拡張機能のインストール

VS Codeの強力な点は、豊富な拡張機能を利用できることです。Python開発に役立つ拡張機能をインストールしましょう。

  1. VS Codeのサイドバーにある拡張機能アイコン（四角いアイコン）をクリックします。
  2. 検索ボックスに “Python” と入力し、Microsoftが提供している “Python” 拡張機能をインストールします。この拡張機能は、Pythonのコード補完、構文チェック、デバッグ、テストなど、Python開発に必要な機能を包括的に提供します。
  3. 必要に応じて、以下の拡張機能もインストールすると便利です。
    • Pylance: より高度な型チェックとコード補完を提供します。（Microsoft製、Python拡張機能と連携）
    • autopep8: PythonのコードをPEP 8（Pythonのコーディング規約）に準拠するように自動整形します。
    • flake8: Pythonのコードの品質をチェックします。エラーや警告を表示し、潜在的な問題を早期に発見するのに役立ちます。
    • Black: 強力なコードフォーマッタ。autopep8よりも積極的にコードを整形します。好みが分かれるかもしれません。
    • Jupyter: VS Code上でJupyter Notebookを扱うための拡張機能です。データ分析や機械学習の分野でよく使われます。
    • GitLens: Gitの履歴を視覚的に表示し、コードの変更履歴を追跡するのに役立ちます。

2.3 ワークスペースの設定

VS Codeでは、プロジェクトごとにワークスペースを作成することができます。ワークスペースは、プロジェクトに関連するファイルや設定をまとめて管理するためのものです。

  1. VS Codeのメニューから “ファイル” -> “フォルダーを開く…” を選択し、プロジェクトのルートディレクトリを選択します。
  2. 選択したディレクトリがVS Codeのワークスペースとして開きます。
  3. ワークスペースの設定は、.vscode フォルダに保存されます。このフォルダは、VS Codeが自動的に作成します。

2.4 Pythonインタプリタの設定

VS Codeは、複数のPythonインタプリタを認識し、切り替えることができます。プロジェクトで使用するPythonインタプリタを設定しましょう。

  1. VS Codeの画面下部にあるステータスバーに表示されているPythonのバージョンをクリックします。
  2. Pythonインタプリタのリストが表示されるので、使用するPythonインタプリタを選択します。
  3. または、コマンドパレット（Ctrl+Shift+P または Cmd+Shift+P）を開き、”Python: Select Interpreter” と入力して、Pythonインタプリタを選択することもできます。

2.5 lintingとformattingの設定

Linting: コーディング規約やスタイルガイドに沿っているか、潜在的なエラーがないかをチェックするプロセスです。
Formatting: コードを自動的に整形し、一貫したスタイルを維持するプロセスです。

VS Codeでlintingとformattingを設定することで、コードの品質を向上させ、可読性を高めることができます。

  1. VS Codeの設定を開きます。（”ファイル” -> “設定” -> “設定” または Ctrl+,）
  2. 検索ボックスに “python.linting.enabled” と入力し、チェックボックスをオンにします。
  3. “python.linting.linter” を設定して、使用するリンターを選択します。（例: “flake8″）
  4. “python.formatting.provider” を設定して、使用するフォーマッタを選択します。（例: “autopep8” または “black”）
  5. 必要に応じて、リンターやフォーマッタの設定をカスタマイズします。（例: python.linting.flake8Args, python.formatting.autopep8Args）

3. 基本的な使い方

VS CodeでPythonコードを作成、実行、デバッグする方法を説明します。

3.1 Pythonファイルの作成

  1. VS Codeのエクスプローラービューで、プロジェクトのディレクトリを右クリックし、”新しいファイル” を選択します。
  2. ファイル名を入力し、拡張子を .py にします。（例: main.py）
  3. 新しいPythonファイルが作成され、エディタで開きます。

3.2 コードの記述

エディタでPythonコードを記述します。VS CodeのPython拡張機能は、コード補完、構文ハイライト、エラーチェックなどの機能を提供し、コーディングをサポートします。

“`python
def hello_world():
“””
Hello Worldを出力する関数
“””
print(“Hello, World!”)

if name == “main“:
hello_world()
“`

3.3 コードの実行

Pythonコードを実行するには、いくつかの方法があります。

  • ターミナルから実行: VS Codeの下部にあるターミナルを開き、python ファイル名.py と入力して実行します。（例: python main.py）
  • VS Codeの実行ボタンを使用: エディタの右上にある実行ボタン（緑色の三角アイコン）をクリックして実行します。この方法は、Python拡張機能が設定されている場合に利用できます。
  • デバッグ実行: デバッグモードで実行することで、コードのステップ実行や変数の値の確認などができます。後述の「4. デバッグ」を参照してください。

3.4 コードの保存

編集したコードは、Ctrl+S（または Cmd+S）で保存します。

4. デバッグ

VS Codeは、強力なデバッグ機能を備えています。デバッグ機能を使用することで、コードのバグを効率的に見つけて修正することができます。

4.1 デバッグ構成の作成

  1. VS Codeのサイドバーにあるデバッグアイコン（虫のアイコン）をクリックします。
  2. “構成の作成” をクリックし、”Python File” を選択します。
  3. .vscode フォルダに launch.json ファイルが作成され、デバッグ構成が記述されます。

launch.json ファイルの内容は、以下のような形式になります。

json
{
"version": "0.2.0",
"configurations": [
{
"name": "Python: Current File",
"type": "python",
"request": "launch",
"program": "${file}",
"console": "integratedTerminal",
"justMyCode": false
}
]
}

  • name: デバッグ構成の名前。
  • type: デバッガの種類。（ここでは “python”）
  • request: デバッグのリクエストの種類。（ここでは “launch”、起動を意味する）
  • program: 実行するPythonファイル。（${file} は、現在開いているファイルを意味する）
  • console: 出力の表示先。（”integratedTerminal” は、VS Codeのターミナルを使用することを意味する）
  • justMyCode: デバッグ対象を自分のコードのみにするかどうか。 false にするとライブラリのコードもデバッグ対象になる。

4.2 ブレークポイントの設定

ブレークポイントは、コードの実行を一時停止させるポイントです。ブレークポイントを設定することで、コードの特定の箇所で変数の値を確認したり、ステップ実行したりすることができます。

ブレークポイントを設定するには、エディタの行番号の左側をクリックします。ブレークポイントが設定された行には、赤い丸が表示されます。

4.3 デバッグの開始

デバッグを開始するには、デバッグビューの上部にある緑色の再生ボタンをクリックします。または、F5 キーを押します。

デバッグが開始されると、VS Codeの下部にデバッグコンソールが表示されます。デバッグコンソールでは、変数の値を確認したり、式を評価したりすることができます。

4.4 デバッグの操作

デバッグ中に、以下の操作を行うことができます。

  • ステップオーバー (Step Over): 現在の行を実行し、次の行に進みます。（F10）
  • ステップイン (Step Into): 現在の行が関数呼び出しの場合、関数の中に入ります。（F11）
  • ステップアウト (Step Out): 現在の関数から抜け出します。（Shift+F11）
  • 続行 (Continue): 次のブレークポイントまで実行を再開します。（F5）
  • 停止 (Stop): デバッグを停止します。（Shift+F5）

5. 仮想環境 (venv)

Pythonのプロジェクトごとに、必要なパッケージ（ライブラリ）のバージョンが異なる場合があります。仮想環境 (venv) は、プロジェクトごとに独立したPython環境を作成し、パッケージの依存関係を管理するためのツールです。

5.1 仮想環境の作成

仮想環境を作成するには、以下のコマンドをターミナルで実行します。

bash
python3 -m venv .venv # .venvは仮想環境のディレクトリ名。名前は任意。

このコマンドは、.venv という名前のディレクトリに仮想環境を作成します。.venv は、仮想環境のディレクトリ名として一般的な名前です。

5.2 仮想環境の有効化

作成した仮想環境を有効にするには、以下のコマンドをターミナルで実行します。

  • Windows:

    bash
    .venv\Scripts\activate

  • macOS/Linux:

    bash
    source .venv/bin/activate

仮想環境が有効になると、ターミナルのプロンプトの先頭に仮想環境名が表示されます。（例: (.venv) $）

5.3 仮想環境へのパッケージのインストール

仮想環境が有効な状態で、pip コマンドを使ってパッケージをインストールします。

bash
pip install パッケージ名

たとえば、requests パッケージをインストールするには、以下のコマンドを実行します。

bash
pip install requests

5.4 仮想環境の無効化

仮想環境を無効にするには、以下のコマンドをターミナルで実行します。

bash
deactivate

5.5 VS Codeでの仮想環境の選択

VS Codeで仮想環境を使用するには、Pythonインタプリタの設定と同様に、使用するPythonインタプリタとして仮想環境内のPythonを選択します。

VS Codeは、ワークスペースのルートディレクトリにある .venv フォルダを自動的に認識し、Pythonインタプリタのリストに表示します。

6. その他の便利な拡張機能

Python開発に役立つ、その他の便利な拡張機能をいくつか紹介します。

  • indent-rainbow: インデントを色分けして表示し、コードの構造を視覚的にわかりやすくします。
  • Bracket Pair Colorizer: 対応する括弧を同じ色で表示し、括弧の対応関係をわかりやすくします。
  • TODO Highlight: コード内のTODOコメントを強調表示し、未完了のタスクを管理するのに役立ちます。
  • vscode-icons: ファイルやフォルダにアイコンを表示し、視覚的にファイルの種類を識別しやすくします。

これらの拡張機能は、VS Codeの拡張機能マーケットプレイスから検索してインストールできます。

7. まとめ

この記事では、VS Codeを使ってPythonの開発環境を構築する手順を詳細に解説しました。

  • PythonとVS Codeのインストール
  • VS Codeの基本設定（拡張機能のインストール、ワークスペースの設定、Pythonインタプリタの設定）
  • 基本的な使い方（Pythonファイルの作成、コードの記述、コードの実行、コードの保存）
  • デバッグ機能の使い方
  • 仮想環境 (venv) の使い方
  • その他の便利な拡張機能

これらの手順に従って、自分に合ったPython開発環境を構築し、快適なPythonプログラミングを楽しんでください。

VS Codeは非常に柔軟なツールであり、様々な拡張機能や設定を組み合わせることで、自分にとって最適な開発環境を構築することができます。ぜひ、色々な拡張機能を試したり、設定をカスタマイズしたりして、自分だけのVS Code環境を作り上げてください。

Happy coding!

コメントする

メールアドレスが公開されることはありません。 ※ が付いている欄は必須項目です

上部へスクロール