PyCharm 2024.1 ヘルプ

テストの実行

通常、PyCharm は、作成した実行 / デバッグ構成を実行することにより、他のアプリケーションと同じ方法でテストを実行およびデバッグします。その際、指定されたテストクラスまたはメソッドをテストランナーに渡します。

多くの場合、コンテキストメニューからテストセッションを開始できます。この目的のために、実行およびデバッグコマンドは、特定のコンテキストメニューで提供されます。例: これらのコマンドは、プロジェクトツールウィンドウのテストクラス、ディレクトリ、パッケージで使用できます。エディターで現在作業しているテストクラスまたはメソッドでも使用できます。

永続的な実行 / デバッグ構成がないテストを実行すると、一時的な構成が作成されます。後で再利用したい場合は、実行 / デバッグ構成ダイアログを使用してそのような構成を保存できます。

テストはバックグラウンドで実行されるため、同時に複数のテストを実行できます。

各実行構成は実行ツールウィンドウテスト結果タブ)に独自のタブを持っています。1 つのタブで複数のテストを集約できます。

コンテキストメニューに表示されるコマンドは、状況に応じて異なります。つまり、表示されるテストコマンドは、テストランナーと、このコマンドが呼び出される場所によって異なります。

PyCharm がテストの実行を終了すると、その実行構成のタブ上の実行ツールウィンドウに結果が表示されます。テスト結果の分析の詳細については、「テスト結果を調べる」を参照してください。

コミット後にテストを実行する

変更をプッシュする前に変更によってコードが壊れないことを確認したい場合は、コミットチェックとしてテストを実行することでそれを行うことができます。

  1. 次のトピックの説明に従って、コミットツールウィンドウを開きます。

  2. コミットオプションを表示 the Settings button をクリックします。

  3. コミットチェック」メニューで、「テストの実行」オプションの横にある「構成の選択」をクリックし、実行する構成を選択します。

    Pre-commit checks menu

テスト構成をセットアップした後、コミットするたびに指定されたテストが実行されます。

Non-modal commit dialog running a test

テストの実行またはデバッグ

テストの実行またはデバッグを開始するには、プロジェクトツールウィンドウまたはエディターのメインツールバーまたはコンテキストメニューを使用できます。

  • メインツールバーを使用してください。

    1. メインツールバーのリストから必要な実行 / デバッグ構成を選択します。

      使用可能な実行構成のリストを表示するには Alt+Shift+F10 を、デバッグ構成の場合は Alt+Shift+F9 を押してください。

    2. リストの右側にある実行 Run またはデバッグ Debug をクリックします。あるいは、メインメニューから実行 | 実行 Shift+F10 または実行 | デバッグ Shift+F9 を選択します。

  • コンテキストメニューを使う:

    • プロジェクトツールウィンドウでテストファイルまたはテストクラスを右クリックするか、エディターで開いて背景を右クリックします。コンテキストメニューから、<クラス名> を実行 /<ファイル名> を実行またはデバッグ ... を選択します。

    • テストメソッドの場合は、エディターでクラスを開き、メソッド内の任意の場所を右クリックします。コンテキストメニューには、コマンド実行 / デバッグ <メソッド名> が表示されます。

ディレクトリ内のすべてのテストを実行する

  1. プロジェクトツールウィンドウで、実行するテストが含まれているディレクトリを選択します。

  2. コンテキストメニューから、対応する実行コマンドを選択します。

    ディレクトリに、さまざまなテストフレームワークに属するテストが含まれている場合は、使用する構成を選択します。

    例: <ディレクトリ名> で pytest を実行しますを選択してください。

    Run all tests in a directory
  3. テストランナーの検索結果

    Running all pytest tests from one directory

テストを並行して実行する

デフォルトでは、すべてのテストは 1 つずつ実行されます。pytest テストフレームワークのためにこの振る舞いを変えて、あなたのテストを並行して実行することができます。

pytest テストの実行を最適化するためにテスト多重処理を可能にしてください。

テスト実行用の CPU の数を明示的に指定するには

  1. pytest-xdist(英語) の説明に従って、パッケージのインストール、アンインストール、アップグレードパッケージをインストールします。

  2. プロジェクトテストフレームワークとして pytest を指定してください。詳しくはテストフレームワークを参照してください。

  3. メインツールバーの実行 / デバッグ構成のリストから実行構成の編集 ... を選択します。実行 / デバッグ構成ダイアログで、Pytest テストグループを展開し、<ディレクトリ名> の pytest を選択します。

    PyCharm は、ディレクトリ内のすべてのテストを初めて実行するときにこの構成を作成します。テストをまだ実行していない場合は、the Add button アイコンをクリックして run/debug 設定パラメーターを指定します。

  4. 実行 / デバッグ構成ダイアログの追加引数フィールドに、テストを実行する CPU の数(-n <number of CPUs>)を指定し、変更を保存します。

    Editing Run/Debug configuration for a group of pytest tests
  5. ここで、ディレクトリ内のすべてのテストを再度実行し、実行ツールウィンドウで出力をインスペクションします。示された例では、同じテストを結果的に実行した場合の合計実行時間は 35 秒 11 ミリ秒であるのに対し、20 秒 26 ミリ秒になります。テストレポートには、テストの実行に使用された CPU と実行時間に関する情報が提供されます。

    Running tests in parallel

あるいは、pytest.ini ファイルでテストを実行するための CPU の数を指定できます。例:

[pytest] addopts = -n3

テストの実行を終了する

実行中のテストを停止できる場合は、実行中のすべてのテストがすぐに停止します。実行ツールウィンドウのテストのアイコンは、テストのステータス(合格、失敗、中止)を反映しています。

  • 実行ツールウィンドウで、停止ボタン the Stop button をクリックします。

  • または、Ctrl+F2 を押します。

関連ページ:

テスト用の実行 / デバッグ構成を作成する

実行 / デバッグ構成を使用して、通常のアプリケーションの実行と同様の方法でテスト(テストケース、テストスイートなど)を実行できます。PyCharm は、テストをターゲットとして指定できる、テスト目的で特別な実行 / デバッグ構成を作成するためのフレームワークを提供します。PyCharm は、通常の実行構成を作成する通常の手順に加えて、コンテナー内のすべてのテスト、単一のテストケース、テストメソッドの実行 / デバッグ構成を作成できるショートカットを提供します。テスト設定を作成するエディターでテ...

プロジェクトツールウィンドウ

プロジェクトツールウィンドウでは、様々な視点からプロジェクトを見て、新しいアイテム(ディレクトリ、ファイル、クラスなど)の作成、エディターでのファイルのオープン、必要なコードフラグメントへの移動など、様々なタスクを実行することができます。このツールウィンドウのほとんどの機能には、コンテンツペインのコンテキストメニューコマンドとして、関連するショートカットを介してアクセスします。また、ビューには、作成されたスクラッチファイル、クエリコンソール、拡張スクリプトを管理できるスクラッチとコンソールフォル...

実行 / デバッグ構成ダイアログ

このダイアログを使用して、実行 / デバッグ構成を作成、編集、調整、削除したり、新しく作成されたすべての実行 / デバッグ構成に適用されるデフォルトのテンプレートを構成したりします。既存の実行 / デバッグ構成は、構成タイプごとにグループ化されています。新しい構成を作成するためのテンプレートは編集可能であり、ダイアログの左側のペインにある構成テンプレートの編集リンクから利用できます。いくつかの実行 / デバッグ構成では、PyCharm はログファイルでの出力の表示をサポートしています。対応する実...

テストランナータブ

テストランナータブは、テストセッションの開始時に実行ツールウィンドウで開き、同じツールバーボタンを備えています。実行ツールバーは、実行ツールウィンドウのツールバーとほとんど同じですが、テスト固有のボタンを備えています。左側のペインには、現在の実行 / デバッグ構成内のすべてのテストのツリービューが表示されます。ルートノードは、実行するように選択されたテストを表します。ネストされたノードは、テストスイートとテストケースの階層を表します。リーフノードは個々のテストを表します。各テストのステータスはア...

テスト結果を調べる

PyCharm でテストが実行されている間、テスト実行は実行ツールウィンドウのその実行構成のタブに表示されます。テスト実行が終了すると、そのタブでテスト結果を確認できます。右側のコンソールには、現在のテストセッションの出力が表示されます。テストの実行に関する詳細情報と、テストが失敗したか無視された理由を確認できます。テスト結果リストの上にあるテスト結果ツールバーを使用すると、成功したテストと無視されたテストの表示と非表示を切り替えたり、各テストの実行にかかった時間を表示したり、テスト結果をエクス...

Git リポジトリに変更をコミットしてプッシュする

Git リポジトリに新しいファイルを追加するか、すでに Git バージョン管理下にあるファイルを変更し、現在の状態に満足したら、作業の結果を共有できます。これには、ローカルにコミットしてリポジトリのスナップショットをプロジェクト履歴に記録し、次にリモートリポジトリにプッシュして他のユーザーが使用できるようにすることが含まれます。Git ユーザー名を設定する Git は、コミットを ID に関連付けるために、ユーザー名を知っている必要があります。ユーザー名を設定していない場合、PyCharm は、最...