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 oggetto Results. 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 classe ReportConfiguration.

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

1. Applicalo a un'unica 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 è "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 è "check-<uuid>".

Metodi

to_json()

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

is_axe_clean()

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

is_errored()

Restituisci 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()

Restituisci il ReportConfiguration predefinito corrente. Nota che il valore predefinito può essere cambiato tramite set_as_default().

set_as_default()

Imposta questo oggetto come configurazione predefinita per tutte le istanze di Axe che non specificano la propria.

reset_default()

Reimposta la configurazione predefinita al suo stato iniziale.

test_suite_name(name)

Imposta il nome del test suite. Usato come campo name sull'oggetto Results.

name: Il nome del test suite.

Restituisce questo oggetto per concatenazione.

ui_state(id)

Imposta lo stato UI per questo insieme di test. Usato come campo id sull'oggetto Results.

id: Un identificatore in formato stringa per lo stato UI (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'user agent.

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 tuoi 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 dei report mostra come puoi creare report di accessibilità in formato CSV, XML o HTML dai tuoi risultati di accessibilità JSON. Puoi anche filtrare il tuo output per gravità utilizzando questo strumento.
• Come vengono memorizzati i risultati JSON sul disco descrive le convenzioni di denominazione dei file per i risultati di accessibilità JSON.
• Utilizzo della CLI per inviare i risultati di accessibilità a Axe Developer Hub mostra come puoi caricare i tuoi file di risultati .json su Axe Developer Hub.