VSCodeとFastAPIでの効率的なデバッグ環境の構築

by mr_osson 投稿日:

FastAPIとは何か

FastAPIは、Python 3.6以降でAPIを構築するためのモダンで高速なWebフレームワークです。Pythonの標準である型ヒントに基づいています。

FastAPIの特徴

FastAPIには以下のような特徴があります：

  1. 日本語の公式マニュアルが充実している：公式のチュートリアルやマニュアルが日本語でも作成されています。
  2. ドキュメント自動生成機能がある：コードを書くとそれに合わせてドキュメントが自動で生成される機能があります。
  3. コードが書きやすい：APIを構築する多くの要素が用意されており、ルーティングやリクエスト処理などAPI開発に必要な部分はシンプルにモジュール化されています。
  4. サーバーを立ち上げやすい：FastAPIを使用してサーバーを立ち上げるためには、いくつかのコマンド入力が必要です。
  5. Pythonに型定義を含めることが可能：FastAPIの特徴のひとつは、「Python」の型ヒントを活用してAPIのバリデーションやドキュメント生成をおこなうことです。
  6. 非同期通信の実装がしやすい：FastAPIは非同期通信の実装がしやすいという特徴もあります。
  7. 高い拡張性がある：FastAPIは拡張性が高く、RESTやGraphQLでの開発にも対応しています。

FastAPIの利用

FastAPIは、PythonでのWebアプリ開発やAPI開発をサポートするフレームワークで、日本語にも対応していることから国内で注目を集めています。他のフレームワークよりも直感的にコーディングができるため、初心者でも扱いやすく、これから「Python」でアプリやAPI開発に挑戦する方にもおすすめです。また拡張性も高く、RESTやGraphQLでの開発にも対応しているため、初心者以外でも物足りなさを感じない性能となっています。このため、FastAPIは幅広い開発者に利用されているフレームワークのひとつです。

VSCodeのlaunch.json設定の概要

launch.jsonは、VSCodeでデバッグ実行するための設定ファイルです。このファイルは、どの言語でどのファイルを実行するかなどを設定します。作業ディレクトリ（プロジェクトのルートディレクトリやworkspace）に作成される.vscode配下に作成されます。

launch.jsonの作成方法

  1. デバッグしたいファイルを開いてアクティブにします。
  2. 「実行とデバッグ」をクリックします。
  3. 「launch.jsonファイルを作成します」をクリックします。
  4. 開いているファイルを検知し、何をデバッグしたいか候補が出てきます。
  5. 選択した項目で自動でlaunch.jsonを作成してくれます。

launch.jsonの設定

launch.jsonに設定する項目は以下のようなものがあります：

  • name: デバッグ実行の名前
  • type: 使用するDebugger
  • request: デバッグ実行のモード (launchかattach)
  • program: デバッグ対象のプログラムのパス
  • console: デバッグの結果を出力するコンソール
  • cwd: 現在の作業ディレクトリ
  • args: デバッグ実行時に渡される引数

他にも項目はありますので、公式ドキュメントをご確認ください。

定義済みの変数

launch.jsonには事前定義された変数を利用することができます。変数は、${変数名}で定義済みの変数が使えます。例えば以下のような変数が定義されています：

  • ${file}: 現在開いているファイルのパス
  • ${fileBasename}: 現在開いているファイル名
  • ${workspaceFolder}: VSCodeで開いているフォルダのパス
  • ${workspaceFolderBasename}: VSCodeで開いているフォルダ名
  • ${cwd}: 現在の作業ディレクトリ

デバッグ実行

実際に作成したlaunch.jsonでPythonのデバッグ実行をしてみます。launch.jsonファイルがあると、デバッグ実行のプルダウンに設定した名前が出てくるようになります。実行したい設定を選んで、デバッグ実行を開始します。デバッグ実行が始まればブレイクポイントを置いたり、ステップ実行や変数の値を確認したりが可能になります。

FastAPIアプリケーションのデバッグ設定

FastAPIアプリケーションをデバッグするためには、uvicornを直接インポートして実行します。以下にその一例を示します。

import uvicorn
from fastapi import FastAPI

app = FastAPI()

@app.get("/")
def root():
    a = "a"
    b = "b" + a
    return {"hello world": b}

if __name__ == "__main__":
    uvicorn.run(app, host="0.0.0.0", port=8000)

このコードは、FastAPIアプリケーションを起動し、デバッグを可能にします。__name__ == "__main__"の部分は、ファイルが直接実行されたときにのみコードが実行されるようにするためのものです。

VSCodeでのデバッグ設定

VSCodeでは、デバッガーから直接Pythonプログラム（FastAPIアプリケーション）を呼び出すことができます。具体的な手順は以下の通りです：

  1. 「デバッグ」パネルに移動します。
  2. 「構成の追加…」をクリックします。
  3. 「Python」を選択します。
  4. オプション「Python: Current File (Integrated Terminal)」を指定してデバッガーを実行します。

これにより、FastAPIコードでサーバーが起動され、ブレークポイントで停止したりすることができます。

PyCharmでのデバッグ設定

PyCharmでも同様にデバッグ設定を行うことができます。具体的な手順は以下の通りです：

  1. 「実行」メニューをオープンします。
  2. オプション「デバッグ…」を選択します。
  3. デバッグするファイル（ここではmain.py）を選択します。

これにより、FastAPIコードでサーバーが起動され、ブレークポイントで停止したりすることができます。

以上がFastAPIアプリケーションのデバッグ設定の概要です。具体的な設定方法は使用するエディターや環境により異なるため、各自の環境に合わせて設定を行ってください。

launch.jsonの詳細な設定方法

launch.jsonは、VSCodeでデバッグ実行するための設定ファイルです。このファイルは、どの言語でどのファイルを実行するかなどを設定します。作業ディレクトリ（プロジェクトのルートディレクトリやworkspace）に作成される.vscode配下に作成されます。

launch.jsonの作成方法

  1. デバッグしたいファイルを開いてアクティブにします。
  2. 「実行とデバッグ」をクリックします。
  3. 「launch.jsonファイルを作成します」をクリックします。
  4. 開いているファイルを検知し、何をデバッグしたいか候補が出てきます。
  5. 選択した項目で自動でlaunch.jsonを作成してくれます。

launch.jsonの設定

launch.jsonに設定する項目は以下のようなものがあります：

  • name: デバッグ実行の名前
  • type: 使用するDebugger
  • request: デバッグ実行のモード (launchかattach)
  • program: デバッグ対象のプログラムのパス
  • console: デバッグの結果を出力するコンソール
  • cwd: 現在の作業ディレクトリ
  • args: デバッグ実行時に渡される引数

他にも項目はありますので、公式ドキュメントをご確認ください。

定義済みの変数

launch.jsonには事前定義された変数を利用することができます。変数は、${変数名}で定義済みの変数が使えます。例えば以下のような変数が定義されています：

  • ${file}: 現在開いているファイルのパス
  • ${fileBasename}: 現在開いているファイル名
  • ${workspaceFolder}: VSCodeで開いているフォルダのパス
  • ${workspaceFolderBasename}: VSCodeで開いているフォルダ名
  • ${cwd}: 現在の作業ディレクトリ

デバッグ実行

実際に作成したlaunch.jsonでPythonのデバッグ実行をしてみます。launch.jsonファイルがあると、デバッグ実行のプルダウンに設定した名前が出てくるようになります。実行したい設定を選んで、デバッグ実行を開始します。デバッグ実行が始まればブレイクポイントを置いたり、ステップ実行や変数の値を確認したりが可能になります。

以上がlaunch.jsonの詳細な設定方法になります。具体的な設定方法は使用するエディターや環境により異なるため、各自の環境に合わせて設定を行ってください。

デバッグセッションの開始方法

VSCodeでは、デバッグセッションを開始するためには以下の手順を行います：

  1. 実行する実行/デバッグ構成を選択します。
  2. 左ガターのアイコンをクリックし、デバッグを選択します。
  3. ツールバーのデバッグアイコンをクリックします。
  4. メインメニューから「実行」|「デバッグ ‘selected configuration’」を選択します。
  5. キーボードショートカットShift+F9を押します。

これらの操作により、選択したデバッグ構成に基づいてデバッグセッションが開始されます。デバッグセッションが開始されると、ブレークポイントでコードの実行が停止したり、ステップ実行を行ったり、変数の値を確認したりすることができます。

以上がVSCodeでのデバッグセッションの開始方法です。具体的な設定方法は使用するエディターや環境により異なるため、各自の環境に合わせて設定を行ってください。

デバッグ中のコードの操作

VSCodeでは、デバッグ中のコードを操作するためのいくつかの基本的な手順があります。

ブレークポイントの設定

ブレークポイントは、デバッグ中にコードの実行を一時停止するポイントを設定します。ブレークポイントを設定するには、VSCodeのエディタでコードの行番号の左側をクリックします。赤い丸が表示され、これがブレークポイントを示します。

ステップ実行

ステップ実行は、ブレークポイントでコードの実行を一時停止した後、コードを一行ずつ実行する機能です。ステップ実行を行うには、「F10」キーを押します。これを「ステップオーバー」とも呼びます。

変数の確認

デバッグ中に変数の値を確認することができます。「ローカル」ウィンドウには現在実行中のコードにある変数とその中身の一覧が表示されます。「ウォッチ式」には確認したい変数情報を式の形で自由に記入できます。

次のブレークポイントまでの実行

次のブレークポイントまでコードを実行するには、「F5」キーを押します。これを「続行」とも呼びます。

以上がVSCodeでのデバッグ中のコードの操作方法です。具体的な設定方法は使用するエディターや環境により異なるため、各自の環境に合わせて設定を行ってください。

よくあるトラブルシューティング

コンピューターやソフトウェアのトラブルシューティングは、問題の特定と解決を目指すプロセスです。以下に、一般的なトラブルシューティングの手順を示します。

  1. 問題の特定：まず、何が問題なのかを明確に理解することが重要です。エラーメッセージが表示されている場合、それを読むことで問題の手がかりを得ることができます。

  2. 問題の再現：問題が再現可能なものであれば、それを再現してみます。これにより、問題が発生する具体的な条件を特定することができます。

  3. 問題の分離：問題が特定のコンポーネントや機能に関連している場合、それを分離してみます。これにより、問題の範囲を絞り込むことができます。

  4. 解決策の試行：問題の原因が特定できたら、それを解決するための手段を試みます。これには、設定の変更、ソフトウェアの更新、ハードウェアの交換などが含まれます。

  5. 解決策の確認：解決策を試した後、問題が解決したかどうかを確認します。問題が解決していない場合、別の解決策を試すか、専門家の助けを求めることが必要です。

以上が一般的なトラブルシューティングの手順です。具体的な手順は問題の性質や使用しているソフトウェアやハードウェアにより異なるため、各自の状況に合わせて適切な手順を選択してください。

コメントする

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