Playwright
Playwright(英語) は、オープンソースのテスト自動化フレームワークです。Chrome、Firefox、Safari などの Web ブラウザーを自動化するための高レベル API を提供します。
新しい Playwright プロジェクトを作成する
メインメニューで、に移動します。
または、ウェルカム画面を表示している場合は、新規プロジェクトをクリックします。
左側のリストから、Playwright を選択します。
新しいプロジェクトに名前を付け、必要に応じてその場所を変更します。
Node インタープリターを指定します。
Playwright をインストールするコマンドを指定します。
作成をクリックします。
メインメニューで、に移動します。
または、ウェルカム画面を表示している場合は、新規プロジェクトをクリックします。
左側のリストから、Python 用 Playwright を選択します。
新しいプロジェクトに名前を付け、必要に応じてその場所を変更します。
(オプション) Git リポジトリの作成オプションを有効にして、新しいプロジェクトをバージョン管理下に置きます。今すぐ実行したくない場合は、後でいつでも実行できます。
新しい環境を作成するか既存の環境を使用するかを選択し、対応する設定を構成します。
リストから基本インタープリターを選択するか、
をクリックしてファイルシステム内の Python 実行可能ファイルを見つけます。ロケーションフィールドに新しい仮想環境の場所を指定するか、
をクリックしてファイルシステム内の場所を参照します。新しい仮想環境のディレクトリは空である必要があります。マシン上のグローバル Python にインストールされているすべてのパッケージを、これから作成する仮想環境に追加する場合は、グローバル site-packages を継承するチェックボックスを選択します。このチェックボックスは、virtualenv(英語) ツールの
--system-site-packagesオプションに対応しています。PyCharm で Python インタープリターを作成するときにこの環境を再利用する場合は、すべてのプロジェクトで使用可能にするチェックボックスを選択します。
詳細は、仮想環境を構成するを参照してください。
ロケーションフィールドに新しい conda 環境の場所を指定するか、
をクリックしてファイルシステム内の場所を参照します。新しい conda 環境のディレクトリは空である必要があります。リストから Python のバージョンを選択します。
通常、PyCharm は conda のインストールを検出します。
それ以外の場合は、conda 実行可能ファイルの場所を指定するか、
をクリックして参照します。
詳細は、conda 仮想環境を構成するを参照してください。
リストから基本インタープリターを選択するか、
をクリックしてファイルシステム内の Python 実行可能ファイルを見つけます。ベースバイナリディレクトリを
PATH環境変数に追加した場合、追加のオプションを設定する必要はありません。pipenv 実行可能ファイルへのパスは自動検出されます。PyCharm が pipenv 実行可能ファイルを検出しない場合は、pip 経由で pipenv をインストールするをクリックして、PyCharm が自動的にインストールできるようにします。
または、pipenv のインストール手順に従って実行可能パスを検出し、それをダイアログで指定します。
詳細は、Pipenv 環境を構成するを参照してください。
リストから基本インタープリターを選択するか、
をクリックしてファイルシステム内の Python 実行可能ファイルを見つけます。または、パスの選択をクリックして必要なファイルを手動で選択するか、ダイアログで次のパスを指定して、
jetbrainsをユーザー名に置き換えます。/Users/jetbrains/Library/Application Support/pypoetry/venv/bin/poetryC:\Users\jetbrains\AppData\Roaming\pypoetry\venv\Scripts\poetry.exe/home/jetbrains/.local/bin/poetry
詳細は、Poetry 環境を構成するを参照してください。
リストからインタープリターを選択します。利用可能なインタープリターがない場合は、インタープリターの追加をクリックし、必要に応じてインタープリターを構成します。
作成をクリックします。
選択したオプションに従って新しいプロジェクトが作成されます。
Playwright プロジェクトを初期化する
プロジェクトが作成されたら、初期化する必要があります。この手順では、目的の言語を選択し、Playwright ブラウザーをインストールし、その他の設定を指定します。
プロジェクトの初期化を開始するには:
実行ツールウィンドウ Alt+4 では、キーボードの上 / 下矢印ボタンを押して、プロジェクトで使用する言語を選択します。
エンドツーエンドテストを配置するフォルダーの名前を入力します。
GitHub アクションのワークフロー(英語)を追加するかどうかを指定します。
Playwright ブラウザーをインストールするかどうかを指定します。
すべてのパラメーターを指定すると、初期化が開始されます。プロセスが完了すると、システムから通知が届きます。
ロールベースのロケーターのサポート
Playwright では、ロール(英語)別に要素を見つけることができます。これにより、ボタン、チェックボックス、見出し、リンク、その他の要素など、ページ上の特定の要素を正確に特定できます。
PyCharm はそのようなロケーターを生成してコードに追加できるため、テストで使用できます。
コードに要素を追加する
要素を追加するファイルを開きます。
右側のサイドバーの
をクリックして、Web インスペクターツールバーウィンドウを開きます。アドレスバーにページの URL を指定します。
「
」をクリックし、Web インスペクターで追加する要素を選択します。
要素を選択したら、「
」をクリックして要素をコードに追加します。
特定のタイプのセレクター (ID、名前、クラスでタグ付けするなど) を追加するには、
をクリックして必要なオプションを選択します。CSS ロケーターと XPath ロケーターの間で具体的に切り替える場合は、
をクリックして、必要なロケーター型を選択します。
その結果、コードの一部が生成され、コードエディターに追加されます。
テストの実行
テストを実行するには、テストクラスまたはテストメソッドの横にある
ガターアイコンをクリックし、リストから実行オプションを選択します。あるいは、キャレットをテストクラスに置いてそのクラス内のすべてのテストを実行するか、テストメソッドにキャレットを置き、Ctrl+Shift+F10 を押します。
実行 / デバッグ構成を使用すると、よりカスタマイズ可能な方法でテストを実行できます。詳細については、テストの実行を参照してください。
見出しモードでテストを実行する
見出しモードでテストを実行すると、Playwright が Web サイトとどのように対話するかを視覚的に表現できます。
ヘッドモードでテストを実行するには:
実行 / デバッグ構成スイッチャーで現在の構成をクリックし、
をクリックして、編集オプションを選択します。
Playwright オプションフィールドに、
--headedコマンドを指定します。
変更を適用し、テストを実行します。
実行 / デバッグ構成スイッチャーで現在の構成をクリックし、
をクリックして、編集オプションを選択します。
追加引数フィールドに、
--headedコマンドを指定します。
変更を適用し、テストを実行します。
その結果、ブラウザーが開き、テストの手順が再現されます。
テスト結果を確認する
テストの実行が終了すると、結果が実行ツールウィンドウのテストランナータブに表示されます。このタブでは、テストの再実行、テスト結果のエクスポートとインポート、各テストの実行にかかった時間を確認したり、その他のアクションを実行したりできます。
詳細は、テスト結果を調べるを参照してください。
デバッグテスト
一般に、デバッグ手順には次の手順が含まれます。
実行を一時停止する必要があるコード行にブレークポイントを設定します。
コードをデバッグモードで実行します。
デバッグツールウィンドウを使用してコードを分析し、潜在的な問題を特定します。
問題を修正します。
IDE でこれらの手順を再現するには、次の手順を実行します。
ガターで、実行を一時停止したいコードの実行可能行にマウスを置き、
をクリックします。
ガターの
をクリックし、デバッグを選択します。これにより、デバッガーセッションが開始され、コードが実行されます。プログラムがブレークポイントに到達すると、実行が一時停止され、デバッグツールウィンドウでデバッガーセッションの結果を確認できます。
デバッグの詳細については、「デバッグ」を参照してください。
Playwright レポートの生成
Playwright 報告者(英語)は、失敗したテストに関する詳細情報を提供するため、テスト実行中に何が起こったのかをより徹底的に分析できます。
デフォルトでは、html レポートが生成されますが、実行 / デバッグ構成を使用して別の形式に切り替えることができます。これを行うには、次の手順を実行します。
実行 / デバッグ構成スイッチャーで現在の構成をクリックし、
をクリックして、編集オプションを選択します。Playwright オプションフィールドで、目的の報告者(英語)を指定します。例:
--reporter=line変更を適用し、テストを実行します。
その結果、詳細なレポートが生成されます。
実行 / デバッグ構成を変更する
テストの起動プロパティを変更する場合は、実行 / デバッグ構成を編集します。
実行 / デバッグ構成スイッチャーで現在の構成をクリックし、実行構成の編集オプションを選択します。
実行 / デバッグ構成ダイアログで、編集する構成を選択します。
必要なスタートアッププロパティを構成します。
変更を適用して OK をクリックします。
実行 / デバッグ構成の詳細については、「実行 / デバッグ構成」を参照してください。
ロケーターテンプレートをカスタマイズする
選択した要素をコードに追加する方法をカスタマイズしたい場合は、テンプレートを変更できます。
ステータスバーのフレームワーク名をクリックします。UI オートメーションフレームワークメニューが開きます。
テンプレートのカスタマイズオプションを選択してください。
ファイルおよびコードテンプレートダイアログで、リストから必要なフレームワークを選択します。
Web 要素ロケーターのコード生成アルゴリズムを書き換えます。
変更を保存するには、OK をクリックします。
その結果、更新されたコード生成アルゴリズムに従ってロケーターがコードに追加されます。
関連ページ：
仮想環境を構成する
PyCharm では、virtualenv ツールを使用してプロジェクト固有の分離された仮想環境を作成できます。仮想環境の主な目的は、他の Python プロジェクトに関係なく、特定のプロジェクトの設定と依存関係を管理することです。virtualenv ツールは PyCharm にバンドルされているため、ユーザーがインストールする必要はありません。virtualenv 環境を作成する以下のいずれか 1 つを実行します:Python インタープリターセレクターをクリックして、新しいインタープリターを...
conda 仮想環境を構成する
PyCharm は、Conda を使用した Python の仮想環境の作成をサポートしています。次の手順は、サポートされているすべてのオペレーティングシステムに適用されます。このページの上部にあるプラットフォームスイッチャーを使用して、オペレーティングシステムに固有のショートカットを表示します。conda 環境を作成する Anaconda または Miniconda がコンピューターにダウンロードされインストールされていること、およびその実行可能ファイルへのパスを認識していることを確認します。詳細について...
Pipenv 環境を構成する
Pipenv は、Python プロジェクトの仮想環境を作成するために必要なすべての手段を提供するツールです。パッケージをインストールまたはアンインストールすると、Pipfile ファイルを介して自動的にプロジェクトパッケージが管理されます。Pipenv は、確定的なビルドを生成し、作業環境のスナップショットを作成するために使用される Pipfile.lock ファイルも生成します。これは、プロジェクトの要件とパッケージのバージョンが重要である場合、セキュリティに敏感なデプロイにとって特に役立つ可能性が...
Poetry 環境を構成する
Poetry は、プロジェクトの依存関係に基づいて Python 仮想環境を簡単に作成できるツールです。プロジェクトが依存するライブラリを宣言でき、Poetry がインストールして更新します。プロジェクトの依存関係は、必要なパッケージ、スクリプト、プラグイン、URL を指定する pyproject.toml ファイルに記録されます。その構造と形式の詳細については、pyproject リファレンスを参照してください。PyCharm で Poetry を使用するには、Poetry をマシンにインストールして...
テストの実行
通常、PyCharm は、作成した実行 / デバッグ構成を実行することにより、他のアプリケーションと同じ方法でテストを実行およびデバッグします。その際、指定されたテストクラスまたはメソッドをテストランナーに渡します。多くの場合、コンテキストメニューからテストセッションを開始できます。この目的のために、実行およびデバッグコマンドは、特定のコンテキストメニューで提供されます。例: これらのコマンドは、プロジェクトツールウィンドウのテストクラス、ディレクトリ、パッケージで使用できます。エディターで現在...
テスト結果を調べる
PyCharm でテストが実行されている間、テスト実行は実行ツールウィンドウのその実行構成のタブに表示されます。テスト実行が終了すると、そのタブでテスト結果を確認できます。右側のコンソールには、現在のテストセッションの出力が表示されます。テストの実行に関する詳細情報と、テストが失敗したか無視された理由を確認できます。テスト結果リストの上にあるテスト結果ツールバーを使用すると、成功したテストと無視されたテストの表示と非表示を切り替えたり、各テストの実行にかかった時間を表示したり、テスト結果をエクス...