axe-devtools-api Python APIリファレンス
axe-coreを注入して実行するためのaxe-devtools-api PythonパッケージのAPIリファレンス
ウェブページに対してaxe-coreを注入し実行するためのAPIを提供します。
axe_devtools_api.Axe
axe-coreを実行する設定を行い、ページに対して実行します。
report = Axe(page).with_rules("document-title", "label").analyze()Axe(page, report_configuration=None, axe_source=None)
ブラウザーアダプタとオプションの設定を使用してAxeインスタンスを初期化します。
page: ブラウザアダプタ、例えばaxe-devtools-seleniumからのAxeDriverインスタンスなど。
report_configuration: オプション。レポート設定オブジェクト。
axe_source: オプション。バンドルされているバージョンの代わりに使用するaxe-coreのソースコード文字列。
analyze()
axe-coreをページに注入し、アクセシビリティ分析を実行します。
Resultsオブジェクトを返します。完全なResultsAPIとレポートメタデータの設定方法についてはPythonによるレポートの生成を参照してください。
report = Axe(page).analyze()including(*selector)
axe-coreが分析するページの一部分を指定します。
selector: 含める要素のための1つ以上のCSSセレクタ。
メソッドチェーン用にこのオブジェクトを返します。
report = Axe(page).including(".sidebar-frame", ".some-class").analyze()excluding(*selector)
axe-coreが分析の際にスキップするページの一部分を指定します。
selector: 除外する要素のための1つ以上のCSSセレクタ。
メソッドチェーン用にこのオブジェクトを返します。
report = Axe(page).excluding(".iframe1", ".third-party-ad").analyze()with_rules(*rules)
axe-coreを実行するためのルールをIDで指定します。指定されたルールのみが使用されます。このオプションはwith_tagsとは互換性がありません。
rules: 1つ以上のルールID。使用可能なIDの一覧についてはルール説明を参照してください。
メソッドチェーン用にこのオブジェクトを返します。
同じインスタンスでwith_tagsと一緒に呼び出された場合、RuntimeErrorを発生させます。
report = Axe(page).with_rules("document-title", "label").analyze()with_tags(*tags)
axe-coreを実行するためのルールをタグで指定します。指定されたルールのみが使用されます。このオプションはwith_rulesとは互換性がありません。
tags: 1つ以上のタグ名。使用可能なタグの一覧についてはaxe-coreタグを参照してください。
メソッドチェーン用にこのオブジェクトを返します。
同じインスタンスでwith_rulesと一緒に呼び出された場合、RuntimeErrorを発生させます。
report = Axe(page).with_tags("best-practice", "wcag2a").analyze()disabling_rules(*rules)
axe-coreの実行から特定のルールを無効化します。
rules: 1つ以上のルールID。
メソッドチェーン用にこのオブジェクトを返します。
report = Axe(page).disabling_rules("html-has-lang", "label").analyze()run_options(options)
axe.runを呼び出すときにaxe-coreに渡すrunOptionsを指定してください。
options: axe-coreに渡すオプションオブジェクト。
メソッドチェーン用にこのオブジェクトを返します。
options = {"iframes": False}
report = Axe(page).run_options(options).analyze()configure(spec)
axe.configureを通じてaxe-coreを設定します。
spec: axe.configureに渡すスペックオブジェクト。
メソッドチェーン用にこのオブジェクトを返します。
report = Axe(page).configure(spec).analyze()without_iframe_sandboxes()
axe-coreがそれらの中で実行できるように、iframeからsandbox属性を削除します。
メソッドチェーン用にこのオブジェクトを返します。
report = Axe(page).without_iframe_sandboxes().analyze()with_config_file(config_path)
ルールセット設定ファイルのパスを設定します。デフォルトのパスはconfig/axe-ruleset.json、または設定されている場合は$AXE_RULESET_PATH環境変数の値です。
config_path: 設定ファイルのパス。
メソッドチェーン用にこのオブジェクトを返します。
report = Axe(page).with_config_file("path/to/file.json").analyze()with_ruleset(ruleset_id, enable_best_practices=False)
axe-coreの実行に特定のルールセットを使用します。
ruleset_id: 使用するルールセットのID。利用可能なルールセット: wcag2, wcag2.1, wcag2.2, wcag2aaa, wcag2.1aaa, wcag2.2aaa, 508, en301549, ttv5, rgaav4。
enable_best_practices: タグ付けされたbest-practiceルールを有効にするかどうか。デフォルトはFalseです。
メソッドチェーン用にこのオブジェクトを返します。
report = Axe(page).with_ruleset("508").analyze()set_legacy_mode(state=True)
axe.runPartialの代わりにaxe.runを使用します。クロスオリジンの影響があります。
state: レガシーモードを有効にするかどうか。デフォルトはTrueです。
メソッドチェーン用にこのオブジェクトを返します。
report = Axe(page).set_legacy_mode().analyze()使用サービス
組織内でのAxe DevToolsの使用傾向に関する洞察を得ることができます。デフォルトでは、使用状況サービスは無効になっています。デフォルトのURLはhttps://usage.deque.comです。
使用サービス環境変数
これらの環境変数を使用して使用状況サービスを設定し、報告されるイベントのプロパティを変更できます。
| 名前 | タイプ | 上書き可能 | 説明 |
|---|---|---|---|
AXE_DISTINCT_ID |
文字列 | — | ログイン中のユーザーに対して同一であるUUID識別子（再生成されない限り） |
AXE_METRICS_URL |
文字列 | — | REST使用エンドポイントのURL |
AXE_TRACK_USAGE |
ブール値 | — | 使用サービスのレポートを有効にします（デフォルトはfalseです） |
AXE_APPLICATION |
文字列 | false | アクセシビリティエラーのチェックに使用されたアプリケーション |
AXE_DEV_INSTANCE |
ブール値 | true | このイベントがソフトウェア開発者の行動によるものかを示します。開発またはテスト中に記録されたイベントをマークし、後で削除するのに便利です。 |
AXE_DEPARTMENT |
文字列 | true | 組織内でのユーザーの部署 |
AXE_KEYCLOAK_ID |
文字列 | false | ユーザーのKeycloak ID |
AXE_LOGGED_IN |
ブール値 | false | テスト対象アプリケーションにユーザーがログインしているかどうかを記録します |
AXE_ORGANIZATION |
文字列 | true | ユーザーの組織 |
AXE_SESSION_ID |
文字列 | false | ユーザーのセッションを識別するUUID |
AXE_USER_ID |
文字列 | false | 特定のユーザーの名前やログインIDなどのアイデンティティ |
AXE_USER_JOB_ROLE |
文字列 | false | ユーザーの役割 |
AXE_USER_STATUS |
文字列 | false | ユーザーに紐づけたいステータス情報 |
enable_tracking(state)
利用サービスへのデータ送信を選択。
state: トラッキングが有効になっているかどうか。
メソッドチェーン用にこのオブジェクトを返します。
report = Axe(page).enable_tracking(True).analyze()set_tracking_url(url)
利用指標データの送信先を設定します。
url: データが送信されるURL。
メソッドチェーン用にこのオブジェクトを返します。
report = Axe(page).set_tracking_url("https://usage.deque.com").analyze()set_distinct_id(id)
利用指標送信用の一意のIDを設定します。
id: 送信される一意のID。
メソッドチェーン用にこのオブジェクトを返します。
report = Axe(page).set_distinct_id("SOMEUUID").analyze()