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：ブラウザーアダプタ、例えば AxeDriver インスタンスなど。 axe-devtools-selenium。

report_configuration：オプション。レポート設定オブジェクト。

axe_source：オプション。同梱版の代わりに使用するaxe-coreのソースコードの文字列。

analyze()

axe-coreをページに注入し、アクセシビリティ分析を実行します。

を返します。 Results オブジェクトを参照してください。 Pythonによるレポートの生成 に関する完全な Results APIおよびレポートメタデータの設定方法。

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のリストがあります。

このオブジェクトを返すことでメソッドチェーンを可能にします。

を発生させます、 RuntimeError と一緒に同じインスタンスで呼び出された場合。 with_tags 。

report = Axe(page).with_rules("document-title", "label").analyze()

with_tags(*tags)

axe-coreが実行するルール（タグで指定）を指定します。指定したルールのみが使用されます。このオプションは with_rulesと互換性がありません。

tags：1つ以上のタグ名。 axe-coreタグ に有効なタグのリストがあります。

このオブジェクトを返すことでメソッドチェーンを可能にします。

を発生させます、 RuntimeError と一緒に同じインスタンスで呼び出された場合。 with_rules 。

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)

を指定します。 runOptions 、axe-coreを呼び出す際に渡すもの。 axe.run。

options：axe-coreに渡すオプションオブジェクト。

このオブジェクトを返すことでメソッドチェーンを可能にします。

options = {"iframes": False}
report = Axe(page).run_options(options).analyze()

configure(spec)

を通じてaxe-coreを設定します axe.configure。

spec：「」に渡すSpecオブジェクト。 axe.configure。

オブジェクトを返してチェーン可能にします。

report = Axe(page).configure(spec).analyze()

without_iframe_sandboxes()

を削除します。 sandbox 属性を iframesから削除し、axe-coreが内部で動作できるようにします。

オブジェクトを返してチェーン可能にします。

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.run を使用します。 axe.runPartialクロスオリジンの影響があります。

state：レガシーモードを有効にするかどうか。デフォルトは True。

オブジェクトを返してチェーン可能にします。

report = Axe(page).set_legacy_mode().analyze()

使用サービス

組織内のAxe DevToolsの使用トレンドを把握します。デフォルトでは使用サービスは無効になっています。デフォルトURLは https://usage.deque.com。

使用サービス環境変数

次の環境変数は使用サービスを構成します。

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()