axe-devtools-api Python API-Referenz
API-Referenz für das axe-devtools-api Python-Paket zum Injizieren und Ausführen von axe-core
Bietet eine API, mit der axe-core in eine Webseite injiziert und ausgeführt werden kann.
axe_devtools_api.Axe
Konfiguriert, wie axe-core ausgeführt wird, und führt es auf der Seite aus.
report = Axe(page).with_rules("document-title", "label").analyze()Axe(page, report_configuration=None, axe_source=None)
Initialisiert eine Axe-Instanz mit einem Browser-Adapter und optionaler Konfiguration.
page: Ein Browser-Adapter, wie eine AxeDriver Instanz von axe-devtools-selenium.
report_configuration: Optional. Ein Berichtskonfigurationsobjekt.
axe_source: Optional. Ein String des axe-core-Quellcodes zur Verwendung anstelle der mitgelieferten Version.
analyze()
Injiziert axe-core in die Seite und führt die Barrierefreiheitsanalyse durch.
Gibt ein Results -Objekt zurück. Siehe Berichte mit Python erstellen für die vollständige Results API und wie man die Berichtsdaten konfiguriert.
report = Axe(page).analyze()including(*selector)
Bestimmen Sie den Teil der Seite, den axe-core analysieren soll.
selector: Ein oder mehrere CSS-Selektoren für einzuschließende Elemente.
Gibt dieses Objekt zur Verkettung zurück.
report = Axe(page).including(".sidebar-frame", ".some-class").analyze()excluding(*selector)
Bestimmen Sie den Teil der Seite, den axe-core bei der Analyse überspringen soll.
selector: Ein oder mehrere CSS-Selektoren für auszuschließende Elemente.
Gibt dieses Objekt zur Verkettung zurück.
report = Axe(page).excluding(".iframe1", ".third-party-ad").analyze()with_rules(*rules)
Geben Sie Regeln (nach ID) an, die axe-core ausführen soll. Nur die angegebenen Regeln werden verwendet. Diese Option ist nicht kompatibel mit with_tags.
rules: Eine oder mehrere Regel-IDs. Siehe Regelbeschreibungen für eine Liste gültiger IDs.
Gibt dieses Objekt zur Verkettung zurück.
Löst ein RuntimeError aus, wenn zusammen mit with_tags auf derselben Instanz aufgerufen.
report = Axe(page).with_rules("document-title", "label").analyze()with_tags(*tags)
Geben Sie Regeln (nach Tag) an, die axe-core ausführen soll. Nur die angegebenen Regeln werden verwendet. Diese Option ist nicht kompatibel mit with_rules.
tags: Einer oder mehrere Tag-Namen. Siehe axe-core-Tags für eine Liste gültiger Tags.
Gibt dieses Objekt zur Verkettung zurück.
Löst ein RuntimeError aus, wenn zusammen mit with_rules auf derselben Instanz aufgerufen.
report = Axe(page).with_tags("best-practice", "wcag2a").analyze()disabling_rules(*rules)
Deaktivieren Sie spezifische Regeln beim Ausführen von axe-core.
rules: Einer oder mehrere Regel-IDs.
Gibt dieses Objekt zur Verkettung zurück.
report = Axe(page).disabling_rules("html-has-lang", "label").analyze()run_options(options)
Geben Sie runOptions an, die an axe-core übergeben werden, wenn axe.run.
options: Optionsobjekt, das an axe-core übergeben werden soll.
Gibt dieses Objekt zur Verkettung zurück.
options = {"iframes": False}
report = Axe(page).run_options(options).analyze()configure(spec)
Konfigurieren Sie axe-core über axe.configure.
spec: Spec-Objekt zum Weitergeben an axe.configure.
Gibt dieses Objekt zur Verkettung zurück.
report = Axe(page).configure(spec).analyze()without_iframe_sandboxes()
Entferne das sandbox -Attribut von iframeen, damit axe-core innerhalb dieser ausgeführt werden kann.
Gibt dieses Objekt zur Verkettung zurück.
report = Axe(page).without_iframe_sandboxes().analyze()with_config_file(config_path)
Legen Sie den Pfad zu einer Ruleset-Konfigurationsdatei fest. Der Standardpfad ist config/axe-ruleset.json, oder der Wert der $AXE_RULESET_PATH -Umgebungsvariable, falls gesetzt.
config_path: Pfad zur Konfigurationsdatei.
Gibt dieses Objekt zur Verkettung zurück.
report = Axe(page).with_config_file("path/to/file.json").analyze()with_ruleset(ruleset_id, enable_best_practices=False)
Verwenden Sie ein bestimmtes Regelset für den axe-core-Durchlauf.
ruleset_id: ID des zu verwendenden Regelsets. Verfügbare Regelsets: wcag2, wcag2.1, wcag2.2, wcag2aaa, wcag2.1aaa, wcag2.2aaa, 508, en301549, ttv5, rgaav4.
enable_best_practices: Ob Regeln mit dem Tag best-practiceaktiviert werden sollen. Standardmäßig ist dies False.
Gibt dieses Objekt zur Verkettung zurück.
report = Axe(page).with_ruleset("508").analyze()set_legacy_mode(state=True)
Verwenden Sie axe.run anstelle von axe.runPartial. Hat Auswirkungen auf die Cross-Origin-Richtlinie.
state: Ob der Legacy-Modus aktiviert werden soll. Standardmäßig ist dies True.
Gibt dieses Objekt zur Verkettung zurück.
report = Axe(page).set_legacy_mode().analyze()Nutzungsdienst
Gewinnen Sie Einblicke in die Nutzungstrends von Axe DevTools innerhalb Ihrer Organisation. Standardmäßig ist der Nutzungsdienst deaktiviert. Die Standard-URL ist https://usage.deque.com.
Umgebungsvariablen des Nutzungsdienstes
Die folgenden Umgebungsvariablen konfigurieren den Nutzungsdienst.
| Umgebungsvariable | Typ |
|---|---|
| AXE_IS_LOGGED_IN | Boolean |
| AXE_KEYCLOAK_ID | String |
| AXE_USER_ID | String |
| AXE_SESSION_ID | String |
| AXE_USER_STATUS | String |
| AXE_USER_JOB_ROLE | String |
| AXE_DISTINCT_ID | String |
| AXE_IS_DEV_INSTANCE | Boolean |
| AXE_ORGANIZATION | String |
| AXE_APPLICATION | String |
| AXE_METRICS_URL | String |
| AXE_TRACK_USAGE | Boolean |
enable_tracking(state)
Entscheiden Sie sich dafür, Daten an den Nutzungsdienst zu senden oder nicht.
state: Ob das Tracking aktiviert ist.
Gibt dieses Objekt zur Verkettung zurück.
report = Axe(page).enable_tracking(True).analyze()set_tracking_url(url)
Legen Sie fest, wohin Nutzungsmetriken gesendet werden.
url: URL, an die die Daten gesendet werden.
Gibt dieses Objekt zur Verkettung zurück.
report = Axe(page).set_tracking_url("https://usage.deque.com").analyze()set_distinct_id(id)
Legen Sie die eindeutige ID fest, die beim Senden von Nutzungsmetriken verwendet wird.
id: Eindeutige ID, die gesendet werden soll.
Gibt dieses Objekt zur Verkettung zurück.
report = Axe(page).set_distinct_id("SOMEUUID").analyze()