Berichte mit Python generieren

axe-devtools-api produziert Ergebnisse in einem Format, das mit dem Axe DevTools Reporterkompatibel ist.

Erstellung reporter-kompatibler JSON-Daten

Axe.analyze() liefert ein Results -Objekt zurück. Es kann über Results.to_json()in eine reporter-kompatible JSON-Zeichenkette konvertiert werden.

Hier ist ein Beispiel, bei dem wir eine Seite analysieren und die Ergebnisse in einer Datei speichern:

axe = Axe(driver)
results = axe.analyze()
with open("my_results.json", "w") as f:
    f.write(results.to_json())

Bericht konfigurieren

Die Metadaten des Berichts werden über die ReportConfiguration -Klasse konfiguriert.

Sobald ein ReportConfiguration -Objekt den gewünschten Zustand erreicht hat, kann es auf zwei Arten auf einen Scan angewendet werden:

1. Anwenden auf einen einzelnen Scan, indem es an Axe()übergeben wird:

   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"

2. Als Standard für alle Scans festlegen, die es nicht individuell überschreiben:

   ReportConfiguration().test_suite_name("my suite").set_as_default()
   
   axe = Axe(driver)
   results = axe.analyze()
   
   assert results.name == "my suite"

Um die aktuell als Standard festgelegte ReportConfiguration -Instanz zu erhalten, rufen Sie ReportConfiguration.get_default()auf.

axe_devtools_api.Results

Zurückgegeben von Axe.analyze(). Enthält die axe-core-Ergebnisse und bietet Methoden zur Überprüfung und Serialisierung dieser Ergebnisse.

Eigenschaften

name

Der Name der Testsuite. Festgelegt über ReportConfiguration.test_suite_name(). Standardwert ist "axe-run".

id

Der Scan-Identifier — eine Kombination aus dem UI-Statuswert (festgelegt über ReportConfiguration.ui_state()) und einer UUID, verbunden durch einen Bindestrich. Standardwert ist "check-<uuid>".

Methoden

to_json()

Die Ergebnisse in eine reporter-kompatible JSON-Zeichenkette konvertieren.

is_axe_clean()

Gibt True zurück, wenn axe-core ohne Fehler ausgeführt wurde und keine Verstöße gefunden wurden.

is_errored()

Gibt True zurück, wenn ein Fehler während der Ausführung von axe-core auftrat.

violations_report()

Gibt eine lesbare Zeichenkette zurück, die alle gefundenen Verstöße zusammenfasst. Wenn axe-core einen Fehler hatte, wird stattdessen die Fehlermeldung zurückgegeben.

axe_devtools_api.ReportConfiguration

Konfiguriert Metadaten des Berichts wie den Namen der Testsuite und Informationen zum Benutzeragenten.

report_config = ReportConfiguration().test_suite_name("my suite").ui_state("login page")
axe = Axe(driver, report_configuration=report_config)

ReportConfiguration()

Erstellen Sie eine neue ReportConfiguration -Instanz mit Standardwerten.

get_default()

Gibt die aktuelle Standard- ReportConfiguration-Instanz zurück. Beachten Sie, dass der Standard über set_as_default()geändert werden kann.

set_as_default()

Dieses Objekt als Standardkonfiguration für alle Axe -Instanzen festlegen, die keine eigene Konfiguration angeben.

reset_default()

Setzt die Standardkonfiguration auf den Ausgangszustand zurück.

test_suite_name(name)

Den Namen der Testsuite festlegen. Verwendet als name -Feld auf dem Results -Objekt.

name: Der Name der Testsuite.

Gibt dieses Objekt zum Verkettung zurück.

ui_state(id)

Setzen Sie den UI-Status für diese Tests. Verwendet als id Feld im Results Objekt.

id: Ein String-Bezeichner für den UI-Status (zum Beispiel, "login-page" oder "dark-mode").

Gibt dieses Objekt zum Verkettung zurück.

user_agent(ua)

Setzen Sie den User-Agent-String, der im Bericht aufgezeichnet wird.

ua: Der User-Agent-String.

Gibt dieses Objekt zum Verkettung zurück.

test_machine(t_machine)

Setzen Sie den Namen der Maschine, auf der die Tests durchgeführt wurden.

t_machine: Ein Bezeichner für die Maschine.

Gibt dieses Objekt zum Verkettung zurück.

Siehe auch

– Hochladen von JSON-Zugänglichkeitsergebnissen in axe Reports beschreibt, wie Sie Ihre Ergebnisse in axe Reports hochladen.

• Erhalten eines API-Schlüssels für axe Reports erklärt, wie Sie einen API-Schlüssel erhalten, um mit der Verwendung von axe Reports zu beginnen.

– Berichte erstellen und filtern zeigt, wie Sie aus Ihren JSON-Zugänglichkeitsergebnissen Zugänglichkeitsberichte im CSV-, XML- oder HTML-Format erstellen können. Mit diesem Tool können Sie Ihre Ausgabe auch nach Schweregrad filtern. – So werden JSON-Ergebnisse auf der Festplatte gespeichert beschreibt die Dateibenennungskonventionen für JSON-Zugänglichkeitsergebnisse.