Riferimento API Python di axe-devtools-api

Fornisce un'API per iniettare ed eseguire axe-core su una pagina web.

axe_devtools_api.Axe

Configura come eseguire axe-core ed eseguirlo sulla pagina.

report = Axe(page).with_rules("document-title", "label").analyze()

Axe(page, report_configuration=None, axe_source=None)

Inizializza un'istanza di Axe con un adattatore browser e una configurazione opzionale.

page: Un adattatore browser, come un AxeDriver istanza da axe-devtools-selenium.

report_configuration: Opzionale. Un oggetto di configurazione del report.

axe_source: Opzionale. Una stringa di codice sorgente axe-core da utilizzare al posto della versione inclusa.

analyze()

Inietta axe-core nella pagina ed esegue l'analisi di accessibilità.

Restituisce un Results oggetto. Vedi Generazione di rapporti con Python per l'intera Results API e come configurare i metadati del report.

report = Axe(page).analyze()

including(*selector)

Specifica quale parte della pagina axe-core deve analizzare.

selector: Uno o più selettori CSS per gli elementi da includere.

Restituisce questo oggetto per concatenazioni.

report = Axe(page).including(".sidebar-frame", ".some-class").analyze()

excluding(*selector)

Specifica quale parte della pagina axe-core deve saltare durante l'analisi.

selector: Uno o più selettori CSS per gli elementi da escludere.

Restituisce questo oggetto per concatenazioni.

report = Axe(page).excluding(".iframe1", ".third-party-ad").analyze()

with_rules(*rules)

Specifica le regole (per ID) che axe-core deve eseguire. Solo le regole specificate sono utilizzate. Questa opzione è incompatibile con with_tags.

rules: Uno o più ID di regole. Vedi Descrizioni delle Regole per un elenco di ID validi.

Restituisce questo oggetto per concatenazioni.

Genera RuntimeError se chiamato insieme a with_tags sulla stessa istanza.

report = Axe(page).with_rules("document-title", "label").analyze()

with_tags(*tags)

Specifica le regole (per tag) che axe-core deve eseguire. Solo le regole specificate sono utilizzate. Questa opzione è incompatibile con with_rules.

tags: Uno o più nomi di tag. Vedi tag di axe-core per un elenco di tag validi.

Restituisce questo oggetto per concatenazioni.

Genera RuntimeError se chiamato insieme a with_rules sulla stessa istanza.

report = Axe(page).with_tags("best-practice", "wcag2a").analyze()

disabling_rules(*rules)

Disabilita regole specifiche dall'esecuzione di axe-core.

rules: Uno o più ID di regole.

Restituisce questo oggetto per concatenazioni.

report = Axe(page).disabling_rules("html-has-lang", "label").analyze()

run_options(options)

Specifica opzioni di esecuzione da passare ad axe-core quando si chiama axe.run.

options: Oggetto opzioni da passare ad axe-core.

Restituisce questo oggetto per concatenazioni.

options = {"iframes": False}
report = Axe(page).run_options(options).analyze()

configure(spec)

Configura axe-core tramite axe.configure.

spec: Oggetto Spec da passare a axe.configure.

Restituisce questo oggetto per il chaining.

report = Axe(page).configure(spec).analyze()

without_iframe_sandboxes()

Rimuovere l'attributo sandbox da iframein modo che axe-core possa funzionare al loro interno.

Restituisce questo oggetto per il chaining.

report = Axe(page).without_iframe_sandboxes().analyze()

with_config_file(config_path)

Imposta il percorso a un file di configurazione del set di regole. Il percorso predefinito è config/axe-ruleset.json, o il valore della variabile d'ambiente $AXE_RULESET_PATH se impostata.

config_path: Percorso al file di configurazione.

Restituisce questo oggetto per il chaining.

report = Axe(page).with_config_file("path/to/file.json").analyze()

with_ruleset(ruleset_id, enable_best_practices=False)

Utilizzare un set di regole specifico per l'esecuzione di axe-core.

ruleset_id: ID del set di regole da utilizzare. Set di regole disponibili: wcag2, wcag2.1, wcag2.2, wcag2aaa, wcag2.1aaa, wcag2.2aaa, 508, en301549, ttv5, rgaav4.

enable_best_practices: Se abilitare le regole contrassegnate best-practice. Predefinito a False.

Restituisce questo oggetto per il chaining.

report = Axe(page).with_ruleset("508").analyze()

set_legacy_mode(state=True)

Usa axe.run invece di axe.runPartial. Ha implicazioni cross-origin.

state: Se abilitare la modalità legacy. Predefinito a True.

Restituisce questo oggetto per il chaining.

report = Axe(page).set_legacy_mode().analyze()

Servizio di Utilizzo

Ottieni informazioni sulle tendenze di utilizzo di Axe DevTools all'interno della tua organizzazione. Per impostazione predefinita, il servizio di utilizzo è disabilitato. L'URL predefinito è https://usage.deque.com.

Variabili d'ambiente del servizio di utilizzo

Le seguenti variabili d'ambiente configurano il servizio di utilizzo.

enable_tracking(state)

Abbonarsi o cancellarsi dall'invio di dati al servizio di utilizzo.

state: Se il tracciamento è abilitato.

Restituisce questo oggetto per concatenazione.

report = Axe(page).enable_tracking(True).analyze()

set_tracking_url(url)

Impostare dove inviare i dati delle metriche di utilizzo.

url: URL dove i dati verranno inviati.

Restituisce questo oggetto per concatenazione.

report = Axe(page).set_tracking_url("https://usage.deque.com").analyze()

set_distinct_id(id)

Impostare l'ID distinto utilizzato per inviare le metriche di utilizzo.

id: ID distinto da inviare.

Restituisce questo oggetto per concatenazione.

report = Axe(page).set_distinct_id("SOMEUUID").analyze()