Generare report con Python

axe-devtools-api produce risultati in un formato compatibile con il reporter di Axe DevTools.

Creare JSON compatibile con il reporter

Axe.analyze() restituisce un Results oggetto. Può essere convertito in una stringa JSON compatibile con il reporter tramite Results.to_json().

Ecco un esempio in cui analizziamo una pagina e salviamo i risultati in un file:

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

Configurare il report

I metadati del report sono configurati tramite la ReportConfiguration classe.

Una volta che un ReportConfiguration oggetto è nello stato desiderato, può essere applicato a una scansione in due modi:

1. Applicalo a una singola scansione passandolo a 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. Impostalo come predefinito per tutte le scansioni che non lo sovrascrivono individualmente:

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

Per ottenere l'istanza ReportConfiguration attualmente impostata come predefinita, chiama ReportConfiguration.get_default().

axe_devtools_api.Results

Restituito da Axe.analyze(). Contiene i risultati di axe-core e fornisce metodi per ispezionarli e serializzarli.

Proprietà

name

Il nome del test suite. Impostato tramite ReportConfiguration.test_suite_name(). Predefinito a "axe-run".

id

L'identificatore della scansione — una combinazione del valore dello stato UI (impostato tramite ReportConfiguration.ui_state()) e un UUID, uniti da un trattino. Predefinito a "check-<uuid>".

Metodi

to_json()

Converte i risultati in una stringa JSON compatibile con il reporter.

is_axe_clean()

Ritorna True se axe-core è stato eseguito senza errori e non ha trovato violazioni.

is_errored()

Ritorna True se axe-core ha incontrato un errore durante l'esecuzione.

violations_report()

Ritorna una stringa leggibile dall'uomo che riassume le eventuali violazioni trovate. Se axe-core ha generato errori, restituisce invece il messaggio di errore.

axe_devtools_api.ReportConfiguration

Configura i metadati del report come il nome del test suite e le informazioni sull'utente agente.

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

ReportConfiguration()

Crea un nuovo ReportConfiguration con valori predefiniti.

get_default()

Ritorna il ReportConfigurationpredefinito attuale. Nota che il predefinito può essere modificato tramite set_as_default().

set_as_default()

Imposta questo oggetto come configurazione predefinita per tutte le Axe istanze che non specificano le proprie.

reset_default()

Reimposta la configurazione predefinita al suo stato iniziale.

test_suite_name(name)

Imposta il nome del test suite. Utilizzato come campo name nell'oggetto Results .

name: Il nome della suite di test.

Restituisce questo oggetto per concatenazione.

ui_state(id)

Imposta lo stato dell'interfaccia utente per questo insieme di test. Usato come id campo nell'oggetto Results .

id: Un identificatore di stringa per lo stato dell'interfaccia utente (ad esempio, "login-page" o "dark-mode").

Restituisce questo oggetto per concatenazione.

user_agent(ua)

Imposta la stringa dell'agent utente registrata nel rapporto.

ua: La stringa dell'agent utente.

Restituisce questo oggetto per concatenazione.

test_machine(t_machine)

Imposta il nome della macchina su cui sono stati eseguiti i test.

t_machine: Un identificatore per la macchina.

Restituisce questo oggetto per concatenazione.

Vedi anche

• Caricamento dei risultati di accessibilità JSON su axe Reports descrive come caricare i risultati su axe Reports.
• Ottenere una chiave API per axe Reports spiega come ottenere una chiave API per iniziare a utilizzare axe Reports.
• Creazione e filtraggio di report mostra come creare report di accessibilità in formato CSV, XML o HTML a partire dai risultati di accessibilità JSON. Utilizzando questo strumento puoi anche filtrare l'output in base alla gravità.
• Come vengono archiviati i risultati JSON su disco descrive le convenzioni di denominazione dei file per i risultati di accessibilità JSON.