Rapporten genereren met Python

axe-devtools-api produceert resultaten in een formaat dat compatibel is met de Axe DevTools-reporter.

Reporter-compatibele JSON maken

Axe.analyze() retourneert een Results object. Dit kan worden omgezet naar een reporter-compatibele JSON-string via Results.to_json().

Hier is een voorbeeld waarin we een pagina analyseren en de resultaten naar een bestand opslaan:

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

Het rapport configureren

Rapportmetadata worden geconfigureerd via de ReportConfiguration klasse.

Zodra een ReportConfiguration object in de gewenste staat is, kan het op twee manieren op een scan worden toegepast:

1. Pas het toe op een enkele scan door het door te geven aan Axe():

   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. Stel het in als standaard voor alle scans die het niet individueel overschrijven:

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

Om de ReportConfiguration instantie die momenteel als standaard is ingesteld op te halen, bel ReportConfiguration.get_default().

axe_devtools_api.Results

Geretourneerd door Axe.analyze(). Bevat de bevindingen van axe-core en biedt methoden om ze te inspecteren en te serialiseren.

Eigenschappen

name

De naam van de testsuite. Ingesteld via ReportConfiguration.test_suite_name(). Standaardwaarde is "axe-run".

id

De scanidentificator — een combinatie van de UI-statuswaarde (ingesteld via ReportConfiguration.ui_state()) en een UUID, gescheiden door een koppelteken. Standaardwaarde is "check-<uuid>".

Methoden

to_json()

Zet de resultaten om in een reporter-compatibele JSON-string.

is_axe_clean()

Retourneer True als axe-core zonder fouten draaide en geen overtredingen vond.

is_errored()

Retourneer True als axe-core een fout tegenkwam tijdens het draaien.

violations_report()

Retourneer een menselijk leesbare string die eventuele gevonden overtredingen samenvat. Als axe-core een fout maakte, retourneert het in plaats daarvan het foutbericht.

axe_devtools_api.ReportConfiguration

Configureert rapportmetadata zoals de naam van de testsuite en informatie over de user agent.

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

ReportConfiguration()

Maak een nieuwe ReportConfiguration met standaardwaarden.

get_default()

Retourneer de huidige standaard ReportConfiguration. Merk op dat de standaard kan worden gewijzigd via set_as_default().

set_as_default()

Stel dit object in als de standaardconfiguratie voor alle Axe instanties die niet hun eigen specificeren.

reset_default()

Herstel de standaardconfiguratie naar de oorspronkelijke staat.

test_suite_name(name)

Stel de naam van de testsuite in. Gebruikt als het name veld op het Results object.

name: De naam van de testsuite.

Geeft dit object terug voor chaining.

ui_state(id)

Stel de UI-status in voor deze set tests. Gebruikt als het id veld op het Results object.

id: Een string-id voor de UI-status (bijvoorbeeld, "login-page" of "dark-mode").

Geeft dit object terug voor chaining.

user_agent(ua)

Stel de user agent-string in die in het rapport wordt geregistreerd.

ua: De user agent-string.

Geeft dit object terug voor chaining.

test_machine(t_machine)

Stel de naam in van de machine waarop de tests werden uitgevoerd.

t_machine: Een id voor de machine.

Geeft dit object terug voor chaining.

Zie ook

• Uploaden van JSON-toegankelijkheidsresultaten naar axe Reports beschrijft hoe je je resultaten naar axe Reports kunt uploaden.
• Verkrijgen van een axe Reports API-sleutel legt uit hoe je een API-sleutel kunt verkrijgen om te beginnen met het gebruiken van axe Reports.
• Rapporten maken en filteren laat zien hoe je toegankelijkheidsrapporten in CSV, XML of HTML kunt maken van je JSON-toegankelijkheidsresultaten. Je kunt ook je output filteren op ernst met deze tool.
• Hoe JSON-resultaten op schijf worden opgeslagen beschrijft de naamgevingsconventies voor JSON-toegankelijkheidsresultaten.
• De CLI gebruiken om toegankelijkheidsresultaten naar axe Developer Hub te sturen laat zien hoe je je .json resultatenbestanden naar axe Developer Hub.