Pythonでレポートを生成する
リポーター対応のJSON出力を生成し、Axe DevTools for Web for Pythonでレポート を設定する
axe-devtools-api は、フォーマットで結果を出力します Axe DevToolsリポーターに対応します。
リポーター対応のJSON作成
Axe.analyze() は、 Results オブジェクトを返します。それは、リポーター対応のJSON文字列に変換できます Results.to_json()。
ページを分析し、結果をファイルに保存する例を以下に示します。
axe = Axe(driver)
results = axe.analyze()
with open("my_results.json", "w") as f:
f.write(results.to_json())レポートの設定
レポートメタデータは次の方法で設定されます ReportConfiguration クラスを用いて。
望ましい状態の ReportConfiguration オブジェクトができたら、それをスキャンに2通りの方法で適用できます：
-
それを単一のスキャンに適用するには、次の方法で渡します
Axe()：report_config = ReportConfiguration().test_suite_name("my suite").ui_state("some state") axe = Axe(driver, report_configuration=report_config) results = axe.analyze() assert results.name == "my suite" assert results.id == "some state" -
個別にそれを上書きしないすべてのスキャンに対するデフォルトとして設定します：
ReportConfiguration().test_suite_name("my suite").set_as_default() axe = Axe(driver) results = axe.analyze() assert results.name == "my suite"
現在デフォルトとして設定されている ReportConfiguration インスタンスを取得するには、次のように呼び出します ReportConfiguration.get_default()。
axe_devtools_api.Results
により返されます Axe.analyze()。axe-coreの発見結果を保持し、それらを検査およびシリアル化するためのメソッドを提供します。
プロパティ
name
テストスイート名。この方法で設定されます ReportConfiguration.test_suite_name()。デフォルトでは "axe-run"です。
id
スキャン識別子—UI状態値（この方法で設定 ReportConfiguration.ui_state()）とUUIDの組み合わせをハイフンで結合したもの。デフォルトでは "check-<uuid>"です。
メソッド
to_json()
結果をリポーター対応のJSON文字列に変換します。
is_axe_clean()
axe-coreがエラーを起こさず、違反が見つからなかった場合、 True を返します。
is_errored()
axe-coreが実行中にエラーに遭遇した場合、 True を返します。
violations_report()
発見された違反を要約した人間が読める文字列を返します。axe-coreがエラーを起こした場合は、代わりにエラーメッセージを返します。
axe_devtools_api.ReportConfiguration
テストスイート名やユーザーエージェント情報などのレポートメタデータを設定します。
report_config = ReportConfiguration().test_suite_name("my suite").ui_state("login page")
axe = Axe(driver, report_configuration=report_config)ReportConfiguration()
既定の値を持つ新しい ReportConfiguration を作成します。
get_default()
現在の既定の ReportConfigurationを返します。なお、既定は次の方法で変更できます set_as_default()。
set_as_default()
全ての Axe インスタンスに対するデフォルト設定としてこのオブジェクトを設定します。そのインスタンスが独自に指定しない場合です。
reset_default()
デフォルト設定を初期状態にリセットします。
test_suite_name(name)
テストスイート名を設定します。 name フィールドとして利用されます Results オブジェクトの中で。
name：テストスイートの名前。
メソッドチェーンのためにこのオブジェクトを返します。
ui_state(id)
このテストセットのUI状態を設定します。 id フィールドとして Results オブジェクトで使用されます。
id：UI状態の文字列識別子（例えば、 "login-page" または "dark-mode"）。
メソッドチェーンのためにこのオブジェクトを返します。
user_agent(ua)
レポートに記録されるユーザーエージェント文字列を設定します。
ua：ユーザーエージェント文字列。
メソッドチェーンのためにこのオブジェクトを返します。
test_machine(t_machine)
テストが実行されたマシンの名前を設定します。
t_machine：マシンの識別子。
メソッドチェーンのためにこのオブジェクトを返します。
参照
- JSONアクセシビリティ結果をaxe Reportsにアップロードする は、結果をaxe Reportsにアップロードする方法を説明します。
- axe Reports APIキーの取得 は、axe Reportsの使用を開始するためのAPIキーを取得する方法を説明します。
- レポートの作成とフィルタリング は、JSONアクセシビリティ結果からCSV、XML、またはHTMLでアクセシビリティレポートを作成する方法を示します。また、このツールを使用して重大度で出力をフィルタリングすることもできます。
- ディスク上のJSON結果の保存方法 は、JSONアクセシビリティ結果のファイル命名規則を説明します。
- CLIを使用してアクセシビリティ結果をaxe Developer Hubに送信する は、
.json結果ファイルを axe Developer Hubにアップロードする方法を示します。