Pytestを使ってみる(その2:VSCode拡張機能編)

| 2 min read
Author: shuichi-takatsu shuichi-takatsuの画像

前回はPytestのインストールと簡単なサンプルを実行してみました。
今回はPytestを便利に使うVSCodeの拡張機能「Python Test Explorer for Visual Studio Code」を紹介したいと思います。

拡張機能のインストール

#

VSCodeを起動して「拡張機能」から「Python Test Explorer for Visual Studio Code」を検索して、インストールします。

VSCodeの左側のパネルの「テスト」を選択します。

設定

#

「Configure Python Tests」というボタンが表示されるので「Configure Python Tests」を選択します。

テスティングフレームワークとして

  • unittest
  • pytest

の2つの選択肢が表示されますので「Pytest pytest framework」を選択します。

次にテストケースファイルが含まれているディレクトリを選択します。
「ルートディレクトリ」を選択します。
このディレクトリには前回作成したテストケースのファイル(test_sample.py)が格納されていると仮定します。

正しくテストケースが認識されると「テストエクスプローラ」にPytestのサンプルが表示されます。

実行

#

テストテクスプローラ上にマウスカーソルをかざすと以下のような実行ボタンが表示されます。

実行ボタンを押してテストを実行します。
以下のように結果をビジュアルに表示してくれます。

個別に1つづつテストを実行させたい場合は特定のテストケース上の「Run」ボタンを押します。

デバッグ

#

テストケースにブレークポイントを設定して、デバッグボタンを押すと、コードをデバッグすることも可能です。

注意

#

これは最初の「ハマりポイント」かもしれませんが、本拡張機能はテストケースファイル名が「test_」で始まっている必要があります。
「test_」で始まっていないテストケースファイル名はテストケースとして認識されず、テストエクスプローラ上に表示すらされません。
本拡張機能を使ってPytestを実行したい場合はファイル名規則を守る必要があります。

まとめ

#

今回は「Pytest」を便利に使うVSCode拡張機能を紹介しました。
今後もいろいろなPytestの使い方を紹介していきたいと思います。

ソフトウェアテストに関する技法やテクニックをまとめています。

テストに活用していただければ幸いです。

豆蔵デベロッパーサイト - 先週のアクセスランキング
  1. 基本から理解するJWTとJWT認証の仕組み(2022-12-08)
  2. 直感が理性に大反抗!「モンティ・ホール問題」(2022-07-04)
  3. Nuxt3入門(第8回) - Nuxt3のuseStateでコンポーネント間で状態を共有する(2022-10-28)
  4. Nuxt3入門(第4回) - Nuxtのルーティングを理解する(2022-10-09)
  5. OpenAIのAssistants API(ベータ版)を試す(2023-11-08)
  6. RAGを利用して国会会議録に基づいて質問に回答するLLMを作る方法(2023-09-27)
  7. GitHub Actions - 構成変数(環境変数)が外部設定できるようになったので用途を整理する(2023-01-16)
  8. Nuxt3入門(第1回) - Nuxtがサポートするレンダリングモードを理解する(2022-09-25)
  9. Pytestを使ってみる(その2:VSCode拡張機能編)(2023-03-05)
  10. WSL2上にUbuntu-22.04LTSを導入し、Dockerをインストールしようとしたら、いろいろとハマった件(2023-09-09)