【VSCode × Python 超入門ガイド】「環境構築」から「おすすめ拡張機能の使い方」まで徹底解説

VSCodeでPython開発するための「環境構築」と「おすすめ拡張機能の使い方」を解説します。

VSCodeをPython開発に使うメリット

VSCode(読み方:ブイエスコード)は、Microsoftが開発しているWindows、Linux、macOS、Web用の無料で高性能なエディタです。正式名称は「Visual Studio Code」(読み方:ビジュアルスタジオコード)です。Python開発でよく使われるエディタの1つで、PyCharmと並んで定番の選択肢になっています。VSCodeの特徴をまとめると以下のとおりです。

  1. 無料なのに軽くて速い
    • 無料で使えて、起動が速く、大きなプロジェクトでもサクサク動く
  2. 拡張機能が豊富
    • 定番のPython拡張を入れるだけで、補完・実行・デバッグ・環境管理が簡単にできる
    • Python開発」や「AIコーディング関連」の拡張機能が豊富で、使いこなすと作業効率がぐんと上がる
  3. デバッグが簡単
    • 変数の中身が一目でわかる
    • ブレークポイントを使って、コードの流れを細かく確認できる
  4. フォルダー単位でプロジェクト管理
    • 複数のファイルもわかりやすく管理可能
    • .vscodeフォルダで設定を保存できて、再利用やチーム共有にも便利
  5. リモート開発もできる
    • SSHを使って別のコンピュータにリモート接続して、VSCode上で直接編集・実行できる
  6. 見た目も自分好みにカスタム可能
    • ダークモードや明るめの色など、豊富なテーマを選べる
    • アイコンも豊富で見やすく整理できる

今回は、「PythonとVSCodeの導入方法」と「VSCodeの標準機能と拡張機能を用いたPythonプログラミング向けのカスタマイズ」について解説します。

解説動画

本ページの内容は以下動画でも詳しく解説しています。

PythonとVSCodeの導入

Pythonを導入する方法はいくつかありますが、今回の公式インストーラーを使う方法がおすすめです。常に最新バージョンを導入可能で、動作が安定していることが特徴です。例えば、Microsoft Storeからインストールすると、一部正常に動作しない外部ライブラリなどがあります。公式インストーラーによりPythonを導入する方法については以下ページで解説します。

Python公式インストーラでWindowsにインストールする方法
Python公式インストーラでWindows環境にPythonをインストールする方法について紹介します。

また、VSCodeの導入方法については以下ページで解説します。

【Windows11】VSCodeをインストールする方法
Windows11にVSCode(Visual Studio Code)をインストールする方法を解説します。

拡張機能「Python」の導入と使い方

VSCode(Visual Studio Code)には、エディタの機能を拡張したり追加したりできる「拡張機能」というものがあります。VSCode上でPythonのプログラムを扱う場合、拡張機能「Python」をインストールするのが一般的で、Pythonプログラムのコード補完(自動入力補助)、デバッグ機能、コードフォーマット、統合ターミナルでの実行などの機能があります。

拡張機能のインストール

「Python」拡張機能をインストールする方法は以下のとおりです。

VSCodeを開きます。

左のアクティビティバーにある「拡張機能」アイコン(四角いアイコン)をクリックします。

③ 検索バーに Python と入力します。

④ 「Python」拡張機能(Microsoft提供)を見つけ、「インストール」をクリックします。

プログラムの作成と実行

① VSCodeの上部メニューバーの「ファイル」からフォルダを開く」をクリックします。そして、プログラムファイルを格納するフォルダを選択し、「フォルダの選択」をクリックします。
(※フォルダをVSCodeにドラッグ&ドロップしてもOKです)

② 「このフォルダー内のファイル作成者を信頼しますか?」というポップアップが表示されます。チェックボックスにチェックを入れ、「作成者を信頼します」ボタンをクリックします。

【常に信頼する設定】
settings.jsonに対して以下のように設定すると、上記ポップアップは表示されなくなります。

“security.workspace.trust.enabled”: false

③ 「ようこそ」タブは邪魔なので閉じ、エクスプローラーの「新しいファイル」アイコンをクリックします。

④ 新しいファイル名の入力欄があるので、ファイル名を入力し、Enterを押してプログラムファイルを作成します、
(※ファイル名の例:test.py)

⑤ コード編集画面にプログラムを記述し、ショートカット(Ctrl + S)でファイルに保存します。

【コードの例】

x = 10
y = 2

z = x + y

print("x+y=")
print(z)
print("以上")

⑥ 右上の「▶(実行)」ボタンをクリックします。

⑦ ターミナルに結果が表示されたら成功です。

部分実行

部分実行とは、例えば10行あるコードのうち、5-6行目に記述されているコードのみ実行することです。
実行したいコードを範囲選択して、Shift + Enterキーで部分実行できます。

部分実行をやめる場合は、ターミナルのゴミ箱アイコンをクリックして強制終了します。

インタープリターの変更

インタープリター」とはPythonコードを実行するプログラムのことです。拡張機能「Python」の導入後、VSCodeでPythonファイルを開いたら、Pythonインタープリターを選択し、プログラムの実行を行うことができるようになります。

Pythonのバージョンが違うと、インタープリターも異なります。複数のバージョンのPythonをインストールした場合、実行したいバージョンのインタープリターを選択する必要があります。

Pythonインタープリターを選択して実行する具体的な手順は以下のとおりです。

① VSCodeの右下に表示されているPythonのバージョン番号(3.x.x)をクリックします。

② 使用するPython環境を選択します。

【補足】
コマンドパレットを用いて選択することもできます。

① ショートカット(`Ctrl + Shift + P`)を押してコマンドパレットを開きます。

② `Python: Select Interpreter` を検索して選択します。

③ 使用するPython環境を選択します。

デバッグ

デバッグ(debug)とは、プログラムの中にある間違い(バグ)を見つけて直す作業です。つまり、プログラムが思った通りに動かないとき、どこがおかしいのか調べて、その原因を突き止めて修正します。デバッグの基本手順は以下のとおりです。

【手順】

① コードの停止したい行の左端(行番号の左)をクリックすると赤丸が表示されます。これを「ブレークポイント」といいます。ブレークポイントで指定した行は実行される直前に停止します。

② 画面右上の実行ボタン(▶)の横にある「v」をクリックし、「Pythonデバッカー:Pythonファイルのデバッグ」をクリックします。

③ デバッグが開始されます。デバッグ中は上部にツールバーが表示されます。それぞれのボタンを押すことで、様々なステップ実行を行うことができます。

ボタン 動作
▶️ 続行(F5) 次のブレークポイントまで実行
⏭ ステップオーバー(F10) 1行ずつ実行(関数の中には入らない)
⏬ ステップイン(F11) 関数の中に入って実行
⏮ ステップアウト(Shift+F11) 関数の中から抜け出して元の呼び出し元に戻る
🔁 再起動(Ctrl+Shift+F5) デバッグを一旦終了して、最初からやり直す
⏹ 停止(Shift+F5) デバッグ終了
  • ステップアウトは、関数内でステップインして細かく追っていたけど、もう深追いしたくないときに使います。関数の残りの処理を一気に終わらせて、呼び出し元の位置まで戻ります。
  • 再起動は、デバッグの流れをもう一度最初から確認したいときに使います。値の変化やブレークポイントの位置を変えて検証するときにも役立ちます。

【使用例】

① 例えば、以下のコードを普通に実行すると、「ZeroDivisionError: division by zero」というエラーになります。これは、0で割り算すると生じるゼロ除算エラー(ZeroDivisionError)です。

def divide(a, b):
    result = a / b  # ← この行にブレークポイントを設定
    return result

x = 10
y = 0  # ← エラーの原因になる値
print(divide(x, y))

② 割り算で生じているエラーなので、割り算を行っているresult = a / b の行にブレークポイントを置き、F5キーを押してデバッグを開始します。

③ 画面左の「変数」ウィンドウで ab の値を確認します。すると、b = 0 となっているので、これがエラーの原因であると特定できます。

④ 例えば、以下のように条件分岐でbの値が0のときは割り算を行わないようコードを修正します。

def divide(a, b):
    if b == 0:
        return "割り算できません"  # エラーを回避
    result = a / b
    return result
【VSCode】Pythonのコードを実行&デバッグする方法
VSCode上でPythonのコードを実行&デバッグする方法について解説します。

テーマとフォントの設定

VSCode(Visual Studio Code)のテーマやフォントの設定手順は以下のとおりです。

テーマの設定方法

① 上部メニューから「ファイル」→「ユーザー設定」→「テーマ」→「配色テーマ」を選択します。

② 一覧から好きなテーマをクリックすると、即座に反映されます。

【コマンドパレットを使う場合】
ショートカット`Ctrl + Shift + P`でコマンドパレットを開き、「Color Theme」と入力し、「Preferences: Color Theme」を選択することでも同様にテーマの選択を行うことができます。
※Macは「`Cmd + Shift + P`」

【一覧にないテーマを追加したい場合】
拡張機能(Extensions)から「theme」で検索し、インストールして追加することもできます。ただし、インストール前には「マルウェアが混入していないか」など、評判を見て慎重に判断することをおすすめします。
例:One Dark Pro、Dracula Official、Tokyo Nightなど。

フォントの設定方法(種類とサイズ)

① 上部メニューから「ファイル」→「ユーザー設定」→「設定」を選択し、設定画面を開きます。
※ショートカットCtrl +(Macは「Cmd +」)でも開くことができます・

② 検索バーに「font」と入力し、以下の項目を設定します。

項目 概要
Editor: Font Size フォントサイズ(例:14)
Editor: Font Family 使用するフォント名(例:'Fira Code', 'MS 明朝', monospace
デフォルトで設定されているフォントの種類は「Consolas, ‘Courier New’, monospace」になっています。複数のフォントを指定する場合はカンマ(,)で区切って入力します。(前に指定したフォントが優先されます)。フォント名に空白が含まれる場合はシングルクオーテーション(’)で囲って記述します。
Editor: Font Ligatures 合字(ligature、リガチャ)を使うかどうか(例:true)。合字とは、2文字以上の文字を、1文字として表記する文字のことです。
【補足】
「settings.json」は、エディタの動作やデザインを細かくカスタマイズできる設定ファイルです。このファイルを弄ってフォントを設定することもできます。設定画面右上の「{}」 アイコンをクリックして開くことができます。また、コマンドパレット(Ctrl+Shift+P)を開いて「Preferences: Open Settings (JSON)」と入力して選択することでも開くことができます。プロジェクトごとに上書きしたい設定があれば、「s.vscode/settings.json」に記述します。

【記述例】settings.json

   "editor.fontFamily": "'Fira Code', 'Source Han Code JP', monospace",
   "editor.fontSize": 14,
   "editor.fontLigatures": true
【VSCode】テーマやフォントの設定
VSCodeのテーマやフォントの設定方法を解説します。

コマンドパレット

コマンドパレットは、VSCodeのあらゆる機能にアクセスできる検索ボックスです。「VSCodeの司令塔」とも言える存在で、コマンドパレットはCtrl + Shift + P(または F1)で呼び出し、キーワード検索で目的のコマンドを見つけて実行できます。ここからほぼすべての操作を実行できるので、使いこなせば作業効率が上がります。

使用例

Ctrl + Shift + P(または F1)を押します。
※Macは「 Cmd + Shift + P

② 上部に表示される入力欄に「Color Theme」と入力します。

Preferences: Color Theme を選択すると、テーマ一覧が表示されます。好きなテーマを選択するとそのテーマが反映されます。

よく使うコマンド

コマンドパレットでよく使うコマンドを以下にまとめました。

コマンド名(英語) 機能概要
> Format Document コード整形
> Git: Commit Git コミット操作
> Preferences: Open Settings 設定画面を開く
> View: Toggle Terminal ターミナルの表示/非表示
> Extensions: Install 拡張機能の検索とインストール
【VSCode】コマンドパレットとは?使い方や便利なコマンドを解説
VSCodeのコマンドパレットとは?使い方や便利なコマンドを解説します。

便利なショートカット

VSCode(Visual Studio Code)の便利なショートカットを簡単に紹介します。これらを覚えると、作業効率がぐっと上がります。使い始めから最初に慣れておくと便利です。

基本操作

操作内容 Windows Mac
コマンドパレットを開く Ctrl + Shift + P Cmd + Shift + P
ファイルを開く Ctrl + P Cmd + P
保存する Ctrl + S Cmd + S
設定を開く Ctrl + , Cmd + ,
ターミナルを開く Ctrl + `` Ctrl + ``

編集系

操作内容 Windows Mac
行をコピー Shift + Alt + ↓ / ↑ Shift + Option + ↓ / ↑
行を移動 Alt + ↓ / ↑ Option + ↓ / ↑
行を削除 Ctrl + Shift + K Cmd + Shift + K
コメントアウト Ctrl + / Cmd + /
コード整形 Shift + Alt + F Shift + Option + F

検索・置換

操作内容 Windows Mac
検索 Ctrl + F Cmd + F
置換 Ctrl + H Cmd + Option + F
プロジェクト全体検索 Ctrl + Shift + F Cmd + Shift + F
プロジェクト全体置換 Ctrl + Shift + H Cmd + Shift + H

他にも便利なショートカットがありますが、それらについては以下ページで別途解説しています。

【VSCode】便利なショートカット集
VSCodeの便利なショートカットを解説します。

おすすめ拡張機能

VSCodeでPython開発を行うときのおすすめ拡張機能を以下にまとめました。
(2025年7月時点の拡張機能名ですので、今後、名前が変わることがあります)

  • Black Formatter
    • Pythonのスタイルガイド(PEP 8)に準拠した自動整形を行ってくれます。
  • Code Spell Checker
    • コードのスペルミスをチェックし、修正できます。
  • Indent-Rainbow
    • インデントの深さに応じて色分けしてくれす。PythonやYAMLなど、インデントが構造に直結する言語で重宝します。
    • VSCode v1.81以降では、標準機能でインデントガイドの色分けが可能になり、拡張機能なしでも似た表示ができます。詳細は「【VSCode】拡張機能を使わずにインデントを色分けする方法
      」を参照。
  • Rainbow CSV
    • CSV/TSV ファイルを「列単位で色分け」し、読みやすくします。
  • Edit CSV
    • CSVファイルをExcelのような表形式で編集できる便利なツールです。
  • IntelliCode
    • MicrosoftのAI技術による高度なコード補完を行ってくれます。
  • GitHub Copilot
    • MicrosoftのAI技術による高度なコード提案を行ってくれます。例えば「CSVファイルを読み込んでフィルター処理をする関数」とコメントを書くと、AIがその内容に基づいたコードを生成してくれます。IntelliCodeが「既存のコードスタイルに即した補完」が得意なのに対して、Copilotは「自然言語から創造的なコード提案」を行うのが得意です。うまく使い分けると良いでしょう。
  • autoDocstring
    • Docstringのテンプレートを挿入できます。
  • Jupyter
    • Jupyter NotebookをVS Code上で実行できます。データ分析や機械学習に便利。
  • Remote Development
    • サーバーをリモートで操作するのに必要な「Remote SSH」や「Remote Tunnels」等の拡張機能を一度にインストールできるパックです。
  • Draw.io Integration
    • 拡張機能「Draw.io Integration」を入れると、VSCode上で簡単に作図(UML/ER図、ネットワーク図、電気回路図など)ができます。

ただし、利用する前に次節で解説するセキュリティリスクについて確認しましょう。

拡張機能のセキュリティリスクと対策

セキュリティリスク

VSCode(Visual Studio Code)の拡張機能はカスタマイズ性が高く非常に便利ですが、それ故にセキュリティ上のリスクがあります。リスクを簡単にまとめると以下のとおりです。

  1. 拡張機能に悪意あるコードが仕込まれているリスク
    • 公式マーケットプレイスでも、悪意のあるコードを含む拡張機能が多数発見されています。2024年には悪意のあるコードを含む拡張機能が1,283件2億回以上ダウンロード)存在したという報告もあります(※1)。
    • デフォルトで自動更新されます。後から故意もしくは開発者のアカウント乗っ取りにより、悪意のあるコードが仕込まれるケースがあります。
    • 拡張機能はOSレベルで動作するため、悪意あるコードが実行されると、システムへの影響も大きくなります。
  2. 拡張機能の脆弱性や機能が悪用されるリスク
    • 拡張機能はファイル操作やネットワーク通信など、広範な権限を持つことが可能です。拡張機能に存在する脆弱性や機能を不正な攻撃等に悪用されるリスクがあります。
    • VSCode本体機能の悪用事例ですが、攻撃者がVSCodeの「開発トンネル機能(Microsoft Dev Tunnels)」のVSCode CLIを通じてマルウェアを自動的にダウンロード・実行させるケースが警視庁の資料で報告されています(※2)。

【参考文献】

セキュリティ対策

拡張機能のリスクを鑑みて、以下のようなセキュリティ対策の実施を検討しましょう。

  1. 信頼できる拡張機能のみを使用
    • インストール数レビューが多く、評価が高いか確認する。
    • 低評価レビューの内容に注目し、不審な動作やセキュリティ懸念が書かれていないか確認する。
    • 最近まで更新されている(開発が継続されている)か確認しましょう。利用者が少なく、長期間更新されていないものは脆弱性なども放置されているリスクがあるため、注意が必要です。「脆弱性対策情報データベース」などで過去に脆弱性の報告がないか、対応されていない脆弱性があれば自身の環境に悪影響が出る可能性があるか確認する。一例として、人気の拡張機能「Python」でも過去に脆弱性の報告があります。→ JVNDB-2024-013116 – JVN iPedia – 脆弱性対策情報データベース
    • 正規の拡張機能に似せた名前で、偽装された拡張機能でないか確認する。
    • GitHubリポジトリが公開されているか、開発元のWebサイトや連絡先が明記されているかなど、透明性があるか確認する。
  2. 不要な拡張機能は削除
    • 使用していない拡張機能を定期的にチェックしてアンインストールしましょう。
  3. 自動更新を無効化(中級者向け)
    • settings.json"extensions.autoUpdate": false に設定し、更新内容を確認してから手動で適用可能。必要に応じて利用を検討しましょう。
  4. セキュリティツールの導入(上級者向け)
    • 拡張機能の挙動を監視するツール(例:ファイルアクセス監視、ネットワーク監視)を活用する。
  5. 仮想環境やコンテナ上での開発(上級者向け)
    • 仮想環境やコンテナ上など、VSCodeをOSから隔離して使用することで、万が一の被害を最小限にできる。
【VSCode】拡張機能のセキュリティリスクと利用者の取るべき対策
VSCodeの拡張機能のセキュリティリスクと対策について解説します。

【拡張機能】「Black Formatter」で自動整形

VSCodeの拡張機能「Black Formatter」は、Pythonのコーディング規約(PEP 8)に準拠した自動整形を行ってくれます。コーディング規約とは、「コードを書くときのルールや推奨事項」をまとめたドキュメントです。PEP 8はPython公式のコーディング規約です。
以下は、Black Formatterで整形したときの実行例です。

【整形前】

def foo(bar,  baz=  None):
    x= [1,2,3,
4,5 ]
    if(bar and  baz):
       return{x:bar+baz}
    return    x

【整形後】

def foo(bar, baz=None):
    x = [1, 2, 3, 4, 5]
    if bar and baz:
        return {x: bar + baz}
    return x

引数のスペース、リスト要素のカンマ区切り&改行、インデント幅や波括弧周りの一貫性などが「Black Formatter」によって自動的に修正されています。設定がほとんど不要で、Blackが決めたスタイルに従ってコードを整形します。「黒は他の色と混ざらない」ことから、スタイルの統一性を重視しているという意味で「Black」と名付けられました。

「Black Formatter」の主な特徴は以下のとおりです。

  • 人気のフォーマッターで、「Pandas」や「scikit-learn」など、主要なPythonライブラリでも採用されている。
  • 88文字以内の行長を推奨(PEP8の79文字より少し長め)。
  • インデントは、スペース4文字(PEP 8と同じ)。
  • クラス定義や関数定義の間は、2行の空白行を入れる。クラス内メソッドの間は1行。(PEP 8と同じ)
  • ダブルクォーテーションを基本に統一(シングルクォーテーションも自動で変換されます)。
  • 並列実行や未変更ファイルのスキップなど、処理速度にも配慮
  • 設定ファイル不要でも使えるが、settings.jsonで細かい調整も可能。
  • 拡張機能版は、Python環境ごとにpipコマンドでblackをインストール (pip install black) する必要がない。

本ページでは、VSCodeの拡張機能「Black Formatter」の導入方法と使い方について解説します。

拡張機能のインストール

① Visual Studio Code を起動します。

② 左側の 拡張機能アイコン(四角が4つ) をクリックします。

③ 検索バーに「Black Formatter」と入力します。

④ 「Black Formatter」を選択して [インストール] をクリックします。

デフォルトフォーマッターの設定と使い方

「Black Formatter」をVSCodeのデフォルトのフォーマッターに設定し、ショートカットで自動整形できるようにする方法を解説します。

① VSCodeの上部メニューから、「ファイル」 → 「ユーザー設定」 → 「設定」を開きます。

② 「Editer:Default Formatter」で「Black Formatter(ms-python.black-formatter)」を選択します。

③ Pythonファイルを開き、ショートカットキー「Shift + Alt + F」を押してコードが自動整形されたら正常に動作しています。
(※macOSは「Shift + Option + F」)

【サンプルコード(整形前)】

def foo(bar,  baz=  None):
    x= [1,2,3,
4,5 ]
    if(bar and  baz):
       return{x:bar+baz}
    return    x

ファイル保存時に自動整形

ショートカットでいちいち整形するのが面倒な場合、「ファイル保存時に自動整形」する設定が便利ですので、やり方を解説します。

① VSCodeの上部メニューから、「ファイル」 → 「ユーザー設定」 → 「設定」を開きます。

② 「Editer:Format On Save」にチェックを入れます。

③ Pythonファイルの保存時に自動で整形されたら成功です。
自動整形を無効化したい場合は、チェックを外しましょう。

【サンプルコード(整形前)】

def foo(bar,  baz=  None):
    x= [1,2,3,
4,5 ]
    if(bar and  baz):
       return{x:bar+baz}
    return    x

その他、使い方の詳細は以下ページで解説しています。

【VSCode】拡張機能「Black Formatter」の使い方
VSCodeの拡張機能「Black Formatter」の使い方を解説します。

【拡張機能】「Code Spell Checker」でスペルミス確認&修正

VSCodeの拡張機能「Code Spell Checker」は、コード内のスペルミス(typo)を検出してくれるツールです。変数名や関数名などは英語ベースなのでスペルミスが発生しがちですので、この拡張機能が役に立ちます。

「camelCase」や「snake_case」などの記法にも対応しており、単語単位でチェックしてくれます。

導入方法

① Visual Studio Code を起動します。

② 左側の 拡張機能アイコン(四角が4つ) をクリックします。

③ 検索バーに「Code Spell Checker」と入力します。

④ 「Code Spell Checker」を選んで [インストール] をクリックします。

基本的な使い方

  • インストール完了後、プログラムファイルを開くと、スペルミスがある単語には 波線(青や緑) が表示されるようになります。
  • マウスカーソルをその単語に合わせると、修正候補が表示されます。
  • 「クイックフィックス」を使えば、候補から正しいスペルを選んで簡単に修正できます。

辞書への単語登録方法

スペルミスと判定されたくない単語(例:ライブラリ名や略語など)は、以下の手順で辞書に追加できます。

① 該当単語にカーソルを合わせます。

② クイックフィックスを開きます。

Add "単語" to workspace settings または Add "単語" to user settings を選択します。

登録完了後、その単語はスペルミスと判定されなくなります。

設定ファイルでの管理

辞書に登録された単語は settings.json に保存されます。プロジェクト単位で管理したい場合は .vscode/settings.json に、ユーザー全体で管理したい場合はグローバル設定に追加されます。

"cSpell.words": [
  "myCustomWord",
  "devtoolschange"
]

Code Spell Checker」の使い方に関する詳細は以下ページで別途解説しています。

【VSCode】拡張機能「Code Spell Checker」の使い方
VSCodeでコードのスペルミスをチェックできる拡張機能「Code Spell Checker」の使い方を解説します。

【標準機能】インデントの深さで色分け

VSCodeには、インデントの深さに応じて色分けしてくれる「Indent-Rainbow」という拡張機能があります。PythonやYAMLなど、インデントが構造に直結する言語で重宝します(詳細は以下ページ参照)。

【VSCode】拡張機能「Indent-Rainbow」の使い方
VSCodeの拡張機能「Indent-Rainbow」で、PythonやYAMLなどのコードをインデントの深さに応じて色分けする方法を解説します。

VSCode v1.81以降では、標準機能「workbench.colorCustomizations」だけで、インデントの深さに応じた色分けが可能になり、拡張機能「Indent-Rainbow」と似た表示ができるようになりました。

今回は、標準機能だけでインデントを色分けする方法を解説します。

設定方法

① ショートカット「Ctrl + Shift + P」でコマンドパレットを表示し、以下を入力してEnterを押します。
※Macは「Cmd + Shift + P」

Preferences: Open User Settings (JSON)

② 以下をsettings.jsonに追加します。

    "workbench.colorCustomizations": {
        "editorIndentGuide.background1": "#b51616",
        "editorIndentGuide.background2": "#ff4400",
        "editorIndentGuide.background3": "#ffd900",
        "editorIndentGuide.background4": "#0da50d",
        "editorIndentGuide.background5": "#0b0bb2",
        "editorIndentGuide.background6": "#9a0e9a",
        "editorIndentGuide.activeBackground1": "#fff",
        "editorIndentGuide.activeBackground2": "#fff",
        "editorIndentGuide.activeBackground3": "#fff",
        "editorIndentGuide.activeBackground4": "#fff",
        "editorIndentGuide.activeBackground5": "#fff",
        "editorIndentGuide.activeBackground6": "#fff"
    }

【上記コードの説明】

キー名 カラーコード 表示色 説明
editorIndentGuide.background1 #b51616 深紅色 最初のインデントガイドの背景色
editorIndentGuide.background2 #ff4400 オレンジレッド 2番目のインデントガイドの背景色
editorIndentGuide.background3 #ffd900 ゴールド 3番目のインデントガイドの背景色
editorIndentGuide.background4 #228b22 フォレストグリーン 4番目のインデントガイドの背景色
editorIndentGuide.background5 #0da50d ネイビーブルー 5番目のインデントガイドの背景色
editorIndentGuide.background6 #9a0e9a ダークマゼンタ 6番目のインデントガイドの背景色

③ Pythonプログラムを開き、インデントの深さに応じて色分け表示されていたら成功です。
なお、上記のように6色まで設定でき、指定した個数以上のインデントの深さがある場合、指定した色がループします。

その他、使い方の詳細は以下ページで解説しています。

【VSCode】拡張機能を使わずにインデントを色分けする方法
VSCodeの拡張機能「Indent-Rainbow」を使わずにインデントを色分けする方法を解説します。

また、拡張機能「Indent-Rainbow」で、同様にインデントの深さに応じて色分けする方法は以下ページで解説しています。

【VSCode】拡張機能「Indent-Rainbow」の使い方
VSCodeの拡張機能「Indent-Rainbow」で、PythonやYAMLなどのコードをインデントの深さに応じて色分けする方法を解説します。

【拡張機能】「Rainbow CSV」でCSVの各列を色分け

VSCodeの拡張機能「Rainbow CSV」の主な機能は以下のとおりです。

  • CSVやTSVファイルの各列を色分けして表示します。
  • 各データにカーソルをあてると、列情報(列番号やヘッダー名)を確認できます。
  • RBQLというSQLに似たクエリを用いて、CSV内のレコード検索や集計、編集操作ができます。例えば、「select * where a1 == ‘Tokyo’」のような検索ができます。
  • 複数行にまたがる列の一括編集が可能です(ただし1万行以上は非対応)。

Pythonはデータ分析でよく使いますが、CSVファイル形式のデータの前処理やログ解析に役立ちます。

導入方法

① VSCodeの拡張機能から「Rainbow CSV」を検索してインストールします。

② VS Codeを再起動します。

③ これでCSV/TSV ファイルを開くと、列単位で色分けされた状態となります。
各データにカーソルをあてると、列情報(列番号やヘッダー名)を確認できます。

RBQLの使い方など、「Rainbow CSV」の詳細は以下ページで別途解説しています。

【VSCode】拡張機能「Rainbow CSV」の使い方
VSCodeの拡張機能「「Rainbow CSV」の使い方を解説します。

【拡張機能】「Edit CSV」でCSVファイルをExcel形式の表で操作

VSCodeの拡張機能「Edit CSV」は、CSVファイルをExcelのような表形式で編集できる便利なツールです。特に、テキストエディタでの編集が煩雑になりがちなCSVを、視覚的にわかりやすく操作できます。

導入方法

① Visual Studio Code を起動します。

② 左側の 拡張機能アイコン(四角が4つ) をクリックします。

③ 検索バーに「Edit CSV」と入力します。

④ 「Edit CSV by janisdd」を選んで [インストール] をクリックします。

基本的な使い方

① CSVファイルをVSCodeで開きます。

② 右上に表示される「Edit CSV」ボタンをクリックします。

③ 表形式のUIでCSVが表示され、セルをダブルクリックして編集できます。

編集画面はプレビュー状態なので、Ctrl+S(Windows)で保存すると、元ファイルに編集内容が反映されます。

Edit CSV」の詳細は以下ページで別途解説しています。

【VSCode】拡張機能「Edit CSV」の使い方
VSCodeの拡張機能「Edit CSV」でExcelのような表形式でCSVファイルを編集する方法を解説します。

【標準機能】「SettingSync」で複数のOSやPC上で設定を同期

VSCodeの標準機能「Settings Sync」は、設定ファイルや拡張機能、キーバインド、テーマやレイアウトなどをクラウド経由で複数マシン間で共有できます。利用するには、Microsoft アカウント or GitHub アカウントが必要となります。使い方は以下のとおりです。

① VS Code 右下のアカウントアイコン (👤) をクリックします。

② 「Turn On Settings Sync…」を選択します。

③ サインイン方法を選択(「Microsoft アカウント」 or 「GitHub アカウント」) し、ログインします。

④ 同期対象をチェックします。

  • Settings(設定) ・・・settings.json の中身
  • Keybindings(キー割当) ・・・ keybindings.json のカスタム設定
  • Extensions(拡張機能) ・・・インストール済み拡張機能のリスト
  • Snippets(スニペット) ・・・ユーザースニペット
  • UI State(テーマやレイアウト) ・・・ テーマ、カラーテーマ、サイドバー配置などのレイアウト情報

⑤ 「Turn On」をクリックすると、Settings Syncが有効化され、クラウドに設定の保存が開始されます。

⑥ 以降、設定変更や拡張インストール等をするたびに、同じ「Microsoft アカウント」 or 「GitHub アカウント」でSettings Syncを有効化している端末間で自動で同期されます。

「Settings Sync」の詳しい使い方は以下ページで別途解説しています。

【VSCode】複数のOSやPC上で設定を同期させる方法(SettingSync)
VSCodeに内蔵されている「Settings Sync」を用いて、数のOSやPC上で設定を同期させる方法を解説します。

【拡張機能】「IntelliCode」でAIコード補完

拡張機能「IntelliCode」は、よく使われるコードパターンを学習したAIが、より的確な補完候補を表示してくれます。Python、JavaScript、TypeScript、Java、C# など主要な言語に対応しています。

① VSCodeの拡張機能から「IntelliCode」を検索してインストールします。

② コードを書くと、通常の補完候補よりも上に⭐付きでおすすめが表示されます。これがIntelliCodeの提案です。

③ 自分のプロジェクトに合わせた提案を得たい場合は、IntelliCodeのコマンドパレット(Ctrl + Shift + P)から IntelliCode: Train on my code を実行します。

「IntelliCode」の詳しい使い方は以下ページで別途解説しています。

【VSCode】拡張機能「IntelliCode」の使い方
VSCodeの拡張機能「IntelliCode」の使い方を解説します。

【拡張機能】「GitHub Copilot」でAIコード提案

VSCodeの拡張機能「GitHub Copilot」は、リアルタイムでコードを書くのを助けてくれるAIツールです。Python、JavaScript、TypeScript、Ruby、Go、C++、HTML、CSSなどの幅広い言語に対応しています。

「GitHub Copilot」の主な機能をまとめると、以下のとおりです。

  1. コード補完
    • 書きかけのコードに対して、次に書くべき内容をAIが提案します。例えば、関数の処理を途中まで書くと、続きのコードが表示されます。
  2. コメントからのコード生成
    • 「○○をする関数を作成」と書くだけで、対応するコードを自動生成します。例えば「CSVファイルを読み込んでフィルター処理をする関数」とコメントを書くと、AIがその内容に基づいたコードを生成してくれます。
  3. テストコードの自動生成
    • 関数に対するユニットテストなどを自動で作成します。
  4. Docstring生成
    • 関数の説明コメントを自動で追加します。
  5. リファクタリング
    • 冗長なコードを簡潔にする改善案を提示します。

IntelliCodeが「既存のコード補完」が得意なのに対して、Copilotは「創造的なコード提案」を行うのが得意です。うまく使い分けると良いでしょう。ただし、提案されたコードは誤りや脆弱性が存在することも多いため、内容をレビューすることが大切です。

導入方法

Githubの無料アカウントを持っている前提で「GitHub Copilot」の導入方法を解説します。また、今回は無料プラン「Copilot Free」で説明します。

Githubの無料アカウントを持っていない場合は、サインアップページ(https://github.com/signup)にアクセスし、必要事項を入力して作成しましょう。

拡張機能のインストール

① Visual Studio Code を起動します。

② 左側の 拡張機能アイコン(四角が4つ) をクリックします。

③ 検索バーに「GitHub Copilot」と入力します。

④ 「GitHub Copilot」を選択して [インストール] をクリックします。

GitHub Copilotの有効化

今回は、「GitHub Copilot」の無料プランを使います。

① ブラウザでGitHub(https://github.co.jp/)にサインイン(ログイン)しておきます。

② Copilotの公式ページ(https://github.com/features/copilot)にアクセスします。

③「無料で始める」等のボタンがあればクリックし、案内に従って進めます。すると、GitHubの設定ページ上でCopilot Freeプランを有効化できます。

GitHubのCopilot設定ページ(https://github.com/settings/copilot/featuresに「You are using Copilot for free」と書いてあればOKです。

VSCodeでGitHubにログイン

① VSCodeの右下にある「サインアウト済み」をクリックします。

② 「サインインしてCopilotを使用する」をクリックします。

③ 「Githubで続行する」をクリックします。

④ ブラウザが開きます。「continue」をクリックします。

⑤ ポップアップ画面の「Visual studio codeを開く」をクリックします。

⑥ VSCodeの右下にCopilotアイコンが表示されていれば GitHub Copilot が使えるようになっています。
これでコメントや関数名を書くだけで、AIが先回りして提案を出してくれます。

【使用例】コード補完・提案

例えば以下のようにコメントを書くだけで、Copilotが関数を提案してくれます。

# リストの平均値を計算する関数

TABキーで受け入れ、ESCキーで拒否できます。
コメントは具体的に書くと、より正確な提案が得られます。
また、コードを書き始めると、Copilotが次の行を予測して提案してくれます。

その他、使い方の詳細は以下ページで詳しく解説しています。

【VSCode】拡張機能「GitHub Copilot」の使い方
VSCodeの拡張機能「GitHub Copilot」の使い方を解説します。

【拡張機能】「autoDocstring」でドキュメント生成

拡張機能「autoDocstring」は、以下例のようなPythonの関数/メソッドやクラスのドキュメントを自動生成します。引数や戻り値を自動で解析してくれます。

   def greet(name: str, age: int = 0) -> str:
       """
       Summary line.

       Parameters
       ----------
       name : str
           Description of name.
       age : int, optional
           Description of age (default is 0).

       Returns
       -------
       str
           Description of return value.
       """
       return f"Hello, {name}!"

「autoDocstring」の導入と使い方は以下のとおりです。

① VSCodeの左サイドバー拡張機能から拡張機能「autoDocstring」を検索してインストールします。

② Python ファイルを開き、docstring を生成したい 関数 や クラス の中にカーソルを置きます。

③ ショートカット「Alt+Shift+2」で関数/メソッドの引数や戻り値を自動で解析し、雛形が挿入されます。
※ショートカット「Ctrl + Shift + P」でコマンドパレットを表示し、「Auto Docstring: Generate Docstring」を入力してEnterを押すことでも自動挿入されます。

【応用】
「autoDocstring」でドキュメントを自動生成後、「GitHub Copilot」 の提案する文を
Copilot が提案する文を Tabで取り込み、必要に応じて手動で微調整すれば快適にドキュメントを作成できます。「autoDocstring」を使わず「GitHub Copilot」だけで「”””」を打ってからCopilotの提案を受けると、ドキュメントを生成することもできますが、、引数リストの自動解析は行われません。

また、「autoDocstring」の複数スタイル混在(NumPy/Google)でドキュメントを生成し、「GitHub Copilot」 に「Google style docstring for function that…」とプロンプトして文を埋めてもらうと高精度に自動生成できます。

「autoDocstring」の詳しい使い方は以下ページで別途解説しています。

【VSCode】拡張機能「autoDocstring」の使い方
VSCodeの拡張機能「autoDocstring」の使い方を解説します。

【拡張機能】「Jupyter」でノートブックを利用

VSCodeの拡張機能「Jupyter」は、VSCode上で「Jupyter Notebook」を利用できるようにするツールです。

【Jupyter Notebookとは】
「Jupyter Notebook」は、Webブラウザで動作するプログラムの対話型実行環境です。Notebook(ノートブック)と呼ばれるファイルを作成し、Pythonコードの記述や実行、メモの作成、保存と共有などを1つのファイル内で行うことができます。

データ分析のプロセスを可視化し、報告書のように内容をまとめて共有するのに便利です。

今回は、拡張機能「Jupyter」の導入方法と基本操作を解説します。

導入方法

① Visual Studio Code を起動します。

② 左側の 拡張機能アイコン(四角が4つ) をクリックします。

③ 検索バーに「Jupyter」と入力します。

④ 「Jupyter」を選んで [インストール] をクリックします。

新規ノートブックの作成

③ ショートカット「Ctrl + Shift + P」でコマンドパレットを表示し、以下を入力してEnterを押しましす。

Jupyter: Create New Blank Notebook  

④ 新規ファイル .ipynb が開きます。画面左上で Python カーネルを選択します。

⑤ セルにコード/Markdownを入力し、「Shift+Enter」で実行します。

既存ノートブックを開く

① エクスプローラーで .ipynb をダブルクリックします。

③ 編集画面がそのまま読み込ますので、セルにコード/Markdownを入力し、「Shift+Enter」で実行します。

「Jupyter」の詳しい使い方は以下ページで別途解説しています。

【VSCode】拡張機能「Jupyter」の使い方
VSCodeの拡張機能「Jupyter」の使い方を解説します。

【拡張機能】「Remote Development」で遠隔操作

VSCodeの拡張機能「Remote Development」は、Visual Studio Code(VSCode)でリモート環境に接続して操作を行うための拡張機能パックです。Microsoftが公式に提供しており、主に以下の拡張機能で構成されています。

拡張機能 概要
Remote – SSH SSH接続でリモートサーバー上のファイルやコードをVSCodeで編集・実行可能にする
Remote – Containers Dockerコンテナ内で開発を行える(ローカルやリモートのコンテナに接続可能)
Remote – WSL WSL内の環境を用いた実行やデバッグができる
Remote – Tunnels リモート接続するためのトンネル機能

リモート環境でもVSCodeのデバッグ、補完、Git操作などがそのまま使えるため、大変便利です。

導入方法

① Visual Studio Code を起動します。

② 左側の 拡張機能アイコン(四角が4つ) をクリックします。

③ 検索バーに「Remote Development」と入力します。

④ 「Remote Development」を選んで [インストール] をクリックします。

設定方法など、詳しい使い方は以下ページで別途解説しています。

【VSCode】拡張機能「Remote Development」の使い方
VSCodeの拡張機能「Remote Development」でリモート環境に接続して操作を行う方法を解説します。

【拡張機能】「Draw.io Integration」で作図

拡張機能「Draw.io Integration」を入れると、VSCodeV上でisioライクにVSCode上で簡単に作図(UML/ER図、ネットワーク図、電気回路図など)ができます。diagrams.net(旧Draw.io)のGUIを直接呼び出します。

ブラウザを開かずにエディタ内で図を描けるので、ドキュメントやリポジトリに図版を組み込みやすくなります。

【VSCode】拡張機能「Draw.io Integration」の使い方
VSCodeの拡張機能「Draw.io Integration」の使い方を解説します。

関連ページ

【Python超入門】使い方とサンプル集
Pythonの使い方について、基礎文法から応用例まで入門者向けに解説します。
【VSCode超入門】基本的な使い方から応用例まで解説
VSCode(Visual Studio Code)の基本的な使い方から応用例まで入門者向けに解説します。
この記事を書いた人
西住技研

プログラミング言語「Python」を研究、仕事、趣味でデータ分析や作業自動化などに活用してきたノウハウを情報発信しています。
筆者の詳しいプロフィールやお問合せはこちらのページまで。
YoutubeX(旧Twitter)でも情報発信中です!

西住技研をフォローする
Python基礎

コメント

  1. 匿名 より:

    ユーザー設定がないぞ・・・・・・

    • 管理人 より:

      ※匿名様
      コメントありがとうございます。
      VSCodeのバージョンアップにより「ユーザー設定」が「設定」に変わっていたようです。