Berichte mit Python generieren

axe-devtools-api erzeugt Ergebnisse in einem Format, das mit dem Axe DevTools Reporter kompatibel ist.

Erstellung reporter-kompatibler JSON-Daten

Axe.analyze() gibt ein Results-Objekt zurück. Es kann über Results.to_json() in einen mit dem Reporter kompatiblen JSON-String 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

Metadaten des Berichts werden über die Klasse ReportConfiguration konfiguriert.

Sobald sich ein ReportConfiguration-Objekt im gewünschten Zustand befindet, kann es auf zwei Arten auf einen Scan angewendet werden:

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

   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 momentan als Standard gesetzte ReportConfiguration-Instanz zu erhalten, rufen Sie ReportConfiguration.get_default() auf.

axe_devtools_api.Results

Zurückgegeben von Axe.analyze(). Hält die axe-core-Funde und bietet Methoden zur Inspektion und Serialisierung dieser.

Eigenschaften

name

Der Name der Test-Suite. Festgelegt über ReportConfiguration.test_suite_name(). Standardmäßig "axe-run".

id

Die Scan-Kennung — eine Kombination aus dem UI-Zustandswert (festgelegt über ReportConfiguration.ui_state()) und einer UUID, verbunden durch einen Bindestrich. Standardmäßig "check-<uuid>".

Methoden

to_json()

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

is_axe_clean()

Rückgabe von True, wenn axe-core ohne Fehler lief und keine Verletzungen gefunden wurden.

is_errored()

Rückgabe von True, wenn axe-core während des Laufs einen Fehler festgestellt hat.

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 mit Standardwerten.

get_default()

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

set_as_default()

Setzen Sie dieses Objekt als Standardkonfiguration für alle Axe-Instanzen, die keine eigene angeben.

reset_default()

Setzt die Standardkonfiguration auf den Ausgangszustand zurück.

test_suite_name(name)

Setzen Sie den Namen der Test-Suite. Wird als name-Feld auf dem Results-Objekt verwendet.

name: Der Name der Test-Suite.

Gibt dieses Objekt zum Verkettung zurück.

ui_state(id)

Setzen Sie den UI-Zustand für diesen Satz von Tests. Wird als id-Feld auf dem Results-Objekt verwendet.

id: Ein Zeichenfolgen-Identifier für den UI-Zustand (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 Identifier für die Maschine.

Gibt dieses Objekt zum Verkettung zurück.

Siehe auch

• Hochladen von JSON-Zugänglichkeitsergebnissen zu den Axe-Berichten beschreibt, wie Sie Ihre Ergebnisse in Axe-Berichte hochladen können.
• Erhalten eines Axe-Berichts-API-Schlüssels erklärt, wie Sie einen API-Schlüssel erhalten, um mit der Verwendung der Axe-Berichte zu beginnen.
• Erstellen und Filtern von Berichten zeigt, wie Sie Barriereberichte in CSV, XML oder HTML aus Ihren JSON-Barrierefreiheitsergebnissen erstellen können. Sie können Ihre Ausgabe auch nach Schweregrad filtern, indem Sie dieses Tool verwenden.
• Wie JSON-Ergebnisse auf der Festplatte gespeichert werden beschreibt die Namenskonventionen für JSON-Barrierefreiheitsergebnisse.
• Verwenden des CLI zum Senden von Zugänglichkeitsergebnissen an die Axe Developer Hub zeigt, wie Sie Ihre .json Ergebnisdateien zu Axe Developer Hub hochladen können.