VS CodeでPython開発を快適に！おすすめ拡張機能6選

python

Python開発を始めたばかりの人から、よくこんな質問をいただきます。

「VS CodeでPythonを書きたいけど、どんな拡張機能を入れればいいの？」
「Pythonの開発環境を整えたいけど、何から始めればいいかわからない」
「コードの補完や自動整形ができるようにしたい」

VS Codeは軽量で高機能なエディタですが、Python開発を快適に行うには適切な拡張機能の組み合わせが重要です。

拡張機能を追加することで、VS CodeはPython専用の統合開発環境（IDE）に変身します。

この記事では、VS CodeでPython開発を行うために必要な拡張機能を初心者にもわかりやすく解説します。

記事を読み終わる頃には、プロ仕様のPython開発環境が構築できているはずです。

スポンサーリンク

VS CodeでPython開発するメリット

他のエディタとの比較

VS Code vs PyCharm

VS Code:

  • 軽量で起動が速い
  • 無料で使える
  • 豊富な拡張機能
  • Web開発など他の言語との連携が容易

PyCharm:

  • Python特化の高機能IDE
  • 高度なデバッグ機能
  • プロフェッショナル版は有料
  • 重い、メモリ使用量が多い

VS Code vs Jupyter Notebook

VS Code:

  • 通常のPythonファイル（.py）も快適に編集
  • プロジェクト管理機能
  • Git統合
  • 複数ファイルの同時編集

Jupyter Notebook:

  • データ分析に特化
  • セル単位の実行
  • 結果の可視化に優れる
  • プロジェクト管理は不得意

VS CodeでPython開発する利点

1. 柔軟性の高さ

  • 多言語対応: Python以外の言語も同じエディタで開発
  • カスタマイズ性: 拡張機能で自分好みの環境を構築
  • 軽量性: 必要な機能だけを追加して軽快に動作

2. 豊富なエコシステム

  • 活発なコミュニティ: 問題解決の情報が豊富
  • 頻繁なアップデート: 新機能が定期的に追加
  • 企業サポート: Microsoftによる安定した開発体制

3. 学習コストの低さ

  • 直感的なUI: 初心者でも使いやすい設計
  • 段階的導入: 基本機能から始めて徐々に高度な機能を習得
  • 豊富なドキュメント: 公式ドキュメントや解説記事が充実

必須拡張機能（絶対に入れるべき）

Python（by Microsoft）

VS CodeでPython開発を行うための基盤となる拡張機能です。

主な機能

シンタックスハイライト

# コメントが緑色で表示
def calculate_area(radius):  # 関数名が青色
    pi = 3.14159  # 数値が赤色
    return pi * radius ** 2  # キーワードが紫色

コード補完（インテリセンス）

  • 変数名、関数名の自動補完
  • モジュールのメソッド候補表示
  • 引数の型情報表示

構文エラー検知

# エラーのある例
def greet(name)  # ← コロン(;)がないとエラー表示
    print(f"Hello, {name}")

# インデントエラーも検知
def calculate():
print("Error!")  # ← インデントがないとエラー

デバッグ機能

  • ブレークポイントの設定
  • 変数の値をリアルタイムで確認
  • ステップ実行でコードの動作を追跡

Python環境の管理

  • 仮想環境（venv、conda）の自動検出
  • インタープリターの切り替え
  • パッケージの管理

インストール方法

  1. VS Codeの拡張機能ビュー（Ctrl + Shift + X）を開く
  2. 検索欄に「python」と入力
  3. 「Python」（発行者: Microsoft）を選択してインストール

基本設定

settings.jsonに以下を追加：

{
  "python.defaultInterpreterPath": "python",
  "python.linting.enabled": true,
  "python.linting.pylintEnabled": true,
  "python.formatting.provider": "black"
}

Pylance

Pythonの言語サーバーとして動作し、高度な型チェックと補完機能を提供します。

Pylanceの特徴

高速な型推論

# 型ヒントがなくても推論
numbers = [1, 2, 3, 4, 5]
# numbersは自動的にList[int]として認識

def process_data(data):
    # dataの型に基づいて適切な補完を提供
    return data.upper()  # strメソッドが補完される

型ヒントのサポート

from typing import List, Dict, Optional

def analyze_scores(scores: List[int]) -> Dict[str, float]:
    """
    型ヒントにより、より正確な補完とエラーチェック
    """
    return {
        "average": sum(scores) / len(scores),
        "max": max(scores),
        "min": min(scores)
    }

未使用変数の検出

def calculate_total(prices, tax_rate):
    subtotal = sum(prices)
    # discount変数が定義されているが使用されていない
    discount = 0.1  # ← グレー表示される
    return subtotal * (1 + tax_rate)

インポート文の自動追加

# datetime.datetime.now() と入力すると
# 自動的に以下のインポートが追加される
from datetime import datetime

current_time = datetime.now()

インストールと設定

Pylanceは通常、Python拡張機能と一緒に自動でインストールされます。手動でインストールする場合：

  1. 拡張機能ビューで「Pylance」を検索
  2. 「Pylance」（発行者: Microsoft）をインストール

高度な設定

{
  "python.languageServer": "Pylance",
  "python.analysis.typeCheckingMode": "basic",
  "python.analysis.autoImportCompletions": true,
  "python.analysis.completeFunctionParens": true
}

データ分析・機械学習向け拡張機能

Jupyter

VS Code内でJupyterノートブックを使用するための拡張機能です。

Jupyter拡張機能の機能

ノートブック（.ipynb）ファイルの編集

# セル1: データの読み込み
import pandas as pd
import matplotlib.pyplot as plt

df = pd.read_csv('data.csv')
df.head()

# セル2: データの可視化
plt.figure(figsize=(10, 6))
plt.plot(df['date'], df['price'])
plt.title('Price Trend')
plt.show()

インタラクティブPythonファイル

通常の.pyファイルでも、# %%を使ってセル分割が可能：

# %%
# データ準備セル
import numpy as np
data = np.random.randn(1000)

# %%
# 分析セル
mean_value = np.mean(data)
std_value = np.std(data)
print(f"平均: {mean_value:.2f}, 標準偏差: {std_value:.2f}")

# %%
# 可視化セル
import matplotlib.pyplot as plt
plt.hist(data, bins=50)
plt.title('データの分布')
plt.show()

変数エクスプローラー

  • 現在定義されている変数の一覧表示
  • DataFrameの内容をテーブル形式で確認
  • 配列やリストの中身を視覚的に確認

データ分析での活用例

# %%
# ライブラリのインポート
import pandas as pd
import numpy as np
import matplotlib.pyplot as plt
import seaborn as sns

# %%
# データの読み込みと確認
df = pd.read_csv('sales_data.csv')
print(df.info())
df.describe()

# %%
# データの前処理
df['date'] = pd.to_datetime(df['date'])
df['month'] = df['date'].dt.month
df_clean = df.dropna()

# %%
# 可視化
plt.figure(figsize=(12, 8))
sns.boxplot(data=df_clean, x='month', y='sales')
plt.title('月別売上分布')
plt.show()

インストールと設定

  1. 拡張機能ビューで「Jupyter」を検索
  2. 「Jupyter」（発行者: Microsoft）をインストール
  3. Python拡張機能と連携して自動設定

コード品質向上拡張機能

Python Docstring Generator

関数やクラスの説明文（docstring）を自動生成する拡張機能です。

基本的な使い方

def calculate_bmi(weight, height):
    # 関数定義の下で """ を入力してTabを押すと...

自動で以下が生成されます：

def calculate_bmi(weight, height):
    """_summary_

    Args:
        weight (_type_): _description_
        height (_type_): _description_

    Returns:
        _type_: _description_
    """
    return weight / (height ** 2)

より詳細な例

def process_user_data(user_list, filter_active=True, sort_by='name'):
    """ユーザーデータを処理する関数

    Args:
        user_list (List[Dict]): ユーザー情報のリスト
        filter_active (bool, optional): アクティブユーザーのみ抽出するか. Defaults to True.
        sort_by (str, optional): ソートするキー. Defaults to 'name'.

    Returns:
        List[Dict]: 処理済みのユーザーデータ

    Raises:
        ValueError: user_listが空の場合
        KeyError: sort_byで指定されたキーが存在しない場合
    """
    if not user_list:
        raise ValueError("user_listが空です")
    
    # 処理のロジック
    pass

カスタマイズ設定

{
  "autoDocstring.docstringFormat": "google",
  "autoDocstring.startOnNewLine": false,
  "autoDocstring.includeExtendedSummary": true
}

Black Formatter

Pythonコードを自動整形するフォーマッタです。

Blackの特徴

一貫したコードスタイル

Blackを使用すると、誰が書いても同じスタイルのコードになります：

# フォーマット前
def long_function_name(parameter_one,parameter_two,parameter_three,parameter_four,parameter_five):
    return parameter_one+parameter_two+parameter_three

# フォーマット後
def long_function_name(
    parameter_one, parameter_two, parameter_three, parameter_four, parameter_five
):
    return parameter_one + parameter_two + parameter_three

文字列クォートの統一

# フォーマット前（混在）
name = 'Alice'
message = "Hello, world!"

# フォーマット後（統一）
name = "Alice"
message = "Hello, world!"

インストールと設定

  1. 拡張機能ビューで「Black Formatter」を検索
  2. 「Black Formatter」（発行者: Microsoft）をインストール

自動フォーマット設定

{
  "[python]": {
    "editor.formatOnSave": true,
    "editor.defaultFormatter": "ms-python.black-formatter"
  },
  "black-formatter.args": ["--line-length", "88"]
}

isort

Pythonのimport文を自動で整理・ソートする拡張機能です。

import文の整理例

# 整理前（ぐちゃぐちゃ）
from mymodule import function_a
import numpy as np
import os
from django.contrib.auth import authenticate
import sys
from mymodule.submodule import ClassA

# 整理後（きれい）
import os
import sys

import numpy as np
from django.contrib.auth import authenticate

from mymodule import function_a
from mymodule.submodule import ClassA

整理のルール

  1. 標準ライブラリ: os、sys、datetimeなど
  2. サードパーティライブラリ: numpy、pandas、djangoなど
  3. ローカルモジュール: 自分のプロジェクトのモジュール

設定例

{
  "isort.args": ["--profile", "black"],
  "[python]": {
    "editor.codeActionsOnSave": {
      "source.organizeImports": true
    }
  }
}

追加で役立つ拡張機能

Python Test Explorer

テストの実行と管理を行う拡張機能です。

機能

  • テストの自動検出: unittestやpytestを自動認識
  • 個別テスト実行: 特定のテストだけを実行
  • テスト結果の可視化: 成功/失敗を視覚的に表示
# test_calculator.py
import unittest
from calculator import Calculator

class TestCalculator(unittest.TestCase):
    def setUp(self):
        self.calc = Calculator()
    
    def test_add(self):
        result = self.calc.add(2, 3)
        self.assertEqual(result, 5)
    
    def test_divide_by_zero(self):
        with self.assertRaises(ZeroDivisionError):
            self.calc.divide(10, 0)

Python Environment Manager

仮想環境の管理を簡単にする拡張機能です。

仮想環境の作成と切り替え

# venv環境の作成
python -m venv myproject_env

# Conda環境の作成
conda create -n myproject python=3.9

VS Codeで環境を切り替える：

  1. 左下のPythonバージョン表示をクリック
  2. 使用したい環境を選択
  3. 新しいターミナルで選択した環境が有効化

GitLens

Gitの履歴やブランチ情報を視覚的に表示する拡張機能です。

Python開発での活用

  • コード変更履歴: 各行の最終変更者と変更日時を表示
  • ブランチ管理: feature/bugfixブランチの管理
  • コードレビュー: 変更差分の確認

開発環境のセットアップ手順

ステップ1: 基本拡張機能のインストール

// .vscode/extensions.json
{
  "recommendations": [
    "ms-python.python",
    "ms-python.pylance",
    "ms-toolsai.jupyter",
    "ms-python.black-formatter",
    "ms-python.isort"
  ]
}

ステップ2: 基本設定の適用

// .vscode/settings.json
{
  // Python基本設定
  "python.defaultInterpreterPath": "./venv/bin/python",
  
  // フォーマット設定
  "[python]": {
    "editor.formatOnSave": true,
    "editor.defaultFormatter": "ms-python.black-formatter",
    "editor.codeActionsOnSave": {
      "source.organizeImports": true
    }
  },
  
  // Pylance設定
  "python.languageServer": "Pylance",
  "python.analysis.typeCheckingMode": "basic",
  
  // テスト設定
  "python.testing.pytestEnabled": true,
  "python.testing.unittestEnabled": false,
  
  // その他
  "python.terminal.activateEnvironment": true
}

ステップ3: プロジェクト構造の作成

my_python_project/
├── .vscode/
│   ├── settings.json
│   └── extensions.json
├── src/
│   ├── __init__.py
│   └── main.py
├── tests/
│   ├── __init__.py
│   └── test_main.py
├── requirements.txt
└── README.md

ステップ4: 仮想環境の設定

# 仮想環境の作成
python -m venv venv

# Windows
venv\Scripts\activate

# macOS/Linux
source venv/bin/activate

# パッケージのインストール
pip install -r requirements.txt

よくある問題と解決方法

Python拡張機能が動作しない

問題1: インタープリターが認識されない

症状:

  • コード補完が効かない
  • 構文エラーが表示されない
  • import文がエラーになる

解決方法:

  1. VS Code左下のPythonバージョン表示をクリック
  2. 正しいPythonインタープリターを選択
  3. 仮想環境を使用している場合は、その環境のpythonを選択
# 現在のPythonパスを確認
which python
# または
where python

問題2: モジュールがインポートできない

症状:

import pandas as pd  # ← エラー: ModuleNotFoundError

解決方法:

  1. 正しい仮想環境が選択されているか確認
  2. パッケージがインストールされているか確認
  3. PYTHONPATH環境変数の設定
# パッケージの確認
pip list

# パッケージのインストール
pip install pandas numpy matplotlib

フォーマットが動作しない

問題: Blackによる自動フォーマットが効かない

確認事項:

  1. Black Formatter拡張機能がインストールされているか
  2. デフォルトフォーマッタが正しく設定されているか
  3. formatOnSaveが有効になっているか

設定の確認:

{
  "[python]": {
    "editor.defaultFormatter": "ms-python.black-formatter",
    "editor.formatOnSave": true
  }
}

デバッグが動作しない

問題: ブレークポイントで停止しない

解決方法:

  1. launch.jsonの設定確認
  2. 正しいPythonインタープリターの選択
  3. ワーキングディレクトリの確認
// .vscode/launch.json
{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "Python: 現在のファイル",
      "type": "python",
      "request": "launch",
      "program": "${file}",
      "console": "integratedTerminal",
      "cwd": "${workspaceFolder}"
    }
  ]
}

プロジェクト別設定例

Webアプリケーション開発（Django/Flask）

{
  "python.defaultInterpreterPath": "./venv/bin/python",
  "[python]": {
    "editor.formatOnSave": true,
    "editor.defaultFormatter": "ms-python.black-formatter"
  },
  "python.linting.pylintArgs": [
    "--load-plugins=pylint_django",
    "--django-settings-module=myproject.settings"
  ],
  "python.testing.pytestEnabled": true,
  "python.testing.pytestArgs": ["tests/"]
}

データサイエンス・機械学習

{
  "python.defaultInterpreterPath": "./conda_env/bin/python",
  "[python]": {
    "editor.formatOnSave": true,
    "editor.defaultFormatter": "ms-python.black-formatter"
  },
  "jupyter.askForKernelRestart": false,
  "jupyter.interactiveWindowMode": "perFile",
  "python.dataScience.sendSelectionToInteractiveWindow": true
}

CLI ツール開発

{
  "python.defaultInterpreterPath": "./venv/bin/python",
  "[python]": {
    "editor.formatOnSave": true,
    "editor.defaultFormatter": "ms-python.black-formatter"
  },
  "python.testing.pytestEnabled": true,
  "python.linting.mypyEnabled": true,
  "python.analysis.typeCheckingMode": "strict"
}

まとめ

VS CodeでPython開発を快適に行うために、適切な拡張機能の選択と設定が重要です。

必須拡張機能（すぐに入れるべき）

  • Python: Python開発の基盤
  • Pylance: 高度な補完と型チェック
  • Jupyter: データ分析・機械学習用途

推奨拡張機能（慣れてきたら追加）

  • Black Formatter: コードの自動整形
  • isort: import文の整理
  • Python Docstring Generator: ドキュメント作成支援

効果的な活用のポイント

  • 段階的導入: まず基本的な拡張機能から始める
  • プロジェクト設定: プロジェクトの種類に応じて設定をカスタマイズ
  • チーム共有: .vscode/フォルダで設定を共有
  • 継続的改善: 開発効率を見ながら設定を調整

Youtube

神話・歴史・伝承の解説チャンネル

スポンサーリンク

コメント

タイトルとURLをコピーしました