🐡

Visual Studio Code で Python のテストを実行する方法

2023/04/16に公開

Visual Studio Code (VSCode) には Python のテストを実行するための機能があります。本記事では手順を1から解説します。

VSCode で Python のテストを実行するには、Python 拡張機能をインストールする必要があります。

VSCode は、unittest、pytest、nose などの複数の Python テストフレームワークに対応しています。まずは使用したいフレームワークを選択しましょう。ここでは例として unittest を使うことにします。

次に、VSCode の設定を変更して、選択したテストフレームワークが使われるようにします。

VSCode の左下にある歯車アイコンをクリックし、「Settings」を選択します。
検索ボックスに「python testing」と入力し、設定を絞り込みます。
使用したいテストフレームワークを有効にし、他のフレームワークは無効にします。ここでは Python > Testing: Unittest Enabled をチェックし、他のフレームワークのチェックを外します。
Python > Testing: Unittest Args の設定を変更して、テストファイルの場所や名前のパターンを指定します。例えば、以下のように設定できます。

{
  "python.testing.unittestArgs": [
    "-v",
    "-s",
    "tests",
    "-p",
    "test_*.py"
  ]
}

これで、tests ディレクトリ内の test_*.py という名前のファイルがテストとして認識されます。

設定が完了したら、テストを実行してみましょう。

VSCode の左サイドバーのテストアイコンをクリックします。
テストエクスプローラーに表示されるテストケースの隣にある再生ボタンをクリックして、テストを実行します3. テストが実行され、結果がテストエクスプローラーに表示されます。成功したテストは緑のチェックマークで表示され、失敗したテストは赤いバツマークで表示されます。

テストファイルが保存されるたびにテストが自動的に実行されるように設定することができます。これには、以下の設定を追加します。

{
  "python.testing.autoTestDiscoverOnSaveEnabled": true
}

これで、テストファイルを保存するたびに、テストが自動的に実行されます。

VSCode では、いくつかの便利なショートカットキーが提供されています。これらのキーを利用して、テストの実行やデバッグを効率化できます。

Ctrl+Shift+P（Mac では Cmd+Shift+P）を押してコマンドパレットを開き、「Python: Discover Tests」を実行することで、テストの検出を手動で行うことができます。
Ctrl+Shift+P（Mac では Cmd+Shift+P）を押してコマンドパレットを開き、「Python: Run All Tests」を実行することで、すべてのテストを一度に実行することができます。

今回は、Visual Studio Code で Python のテストを実行する方法を説明しました。VSCode は、さまざまなテストフレームワークに対応しており、設定次第で効率的にテストを実行・管理できます。テストを自動化することで、コードの品質を向上させることができます。