axe-devtools-api Python API-referentie

Biedt een API om axe-core te injecteren en uit te voeren op een webpagina.

axe_devtools_api.Axe

Configureert hoe axe-core wordt uitgevoerd en voert het uit op de pagina.

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

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

Initialiseer een Axe-instantie met een browseradapter en optionele configuratie.

page: Een browseradapter, zoals een AxeDriver instantie van axe-devtools-selenium.

report_configuration: Optioneel. Een configuratieobject voor rapporten.

axe_source: Optioneel. Een string van axe-core broncode om te gebruiken in plaats van de meegeleverde versie.

analyze()

Injeteer axe-core in de pagina en voer de toegankelijkheidsanalyse uit.

Retourneert een Results object. Zie Rapporten genereren met Python voor de volledige Results API en hoe rapportmetadata te configureren.

report = Axe(page).analyze()

including(*selector)

Specificeer een deel van de pagina voor axe-core om te analyseren.

selector: Een of meer CSS-selectors voor elementen om op te nemen.

Retourneert dit object voor chaining.

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

excluding(*selector)

Specificeer een deel van de pagina dat axe-core moet overslaan tijdens de analyse.

selector: Een of meer CSS-selectors voor elementen om uit te sluiten.

Retourneert dit object voor chaining.

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

with_rules(*rules)

Specificeer regels (op ID) die axe-core moet uitvoeren. Alleen de gespecificeerde regels worden gebruikt. Deze optie is onverenigbaar met with_tags.

rules: Een of meer regel-ID's. Zie Regelbeschrijvingen voor een lijst met geldige ID's.

Retourneert dit object voor chaining.

Geeft een foutmelding RuntimeError als het samen wordt aangeroepen met with_tags in dezelfde instantie.

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

with_tags(*tags)

Specificeer regels (op tag) die axe-core moet uitvoeren. Alleen de gespecificeerde regels worden gebruikt. Deze optie is onverenigbaar met with_rules.

tags: Een of meer tagnamen. Zie axe-core tags voor een lijst met geldige tags.

Retourneert dit object voor chaining.

Geeft een foutmelding RuntimeError als het samen wordt aangeroepen met with_rules in dezelfde instantie.

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

disabling_rules(*rules)

Schakel specifieke regels uit bij het uitvoeren van axe-core.

rules: Een of meer regel-ID's.

Retourneert dit object voor chaining.

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

run_options(options)

Specificeer runOptions die naar axe-core worden doorgegeven bij het aanroepen van axe.run.

options: Opties-object om door te geven aan axe-core.

Retourneert dit object voor chaining.

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

configure(spec)

Configureer axe-core via axe.configure.

spec: Spec-object om door te geven aan axe.configure.

Geeft dit object terug voor chaining.

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

without_iframe_sandboxes()

Verwijder het sandbox attribuut van iframes zodat axe-core erin kan draaien.

Geeft dit object terug voor chaining.

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

with_config_file(config_path)

Stel het pad in naar een regelsconfiguratiebestand. Het standaardpad is config/axe-ruleset.json, of de waarde van de $AXE_RULESET_PATH omgevingsvariabele indien ingesteld.

config_path: Pad naar het configuratiebestand.

Geeft dit object terug voor chaining.

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

with_ruleset(ruleset_id, enable_best_practices=False)

Gebruik een specifieke regels voor de axe-core run.

ruleset_id: ID van de regels om te gebruiken. Beschikbare regels: wcag2, wcag2.1, wcag2.2, wcag2aaa, wcag2.1aaa, wcag2.2aaa, 508, en301549, ttv5, rgaav4.

enable_best_practices: Of de regels met de tag best-practiceingeschakeld moeten worden. Standaard is False.

Geeft dit object terug voor chaining.

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

set_legacy_mode(state=True)

Gebruik axe.run in plaats van axe.runPartial. Heeft cross-origin implicaties.

state: Of de legacy-modus ingeschakeld moet worden. Standaard is True.

Geeft dit object terug voor chaining.

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

Gebruik Service

Krijg inzicht in de gebruikstrends van Axe DevTools binnen uw organisatie. Standaard is de gebruiksdienst uitgeschakeld. De standaard URL is https://usage.deque.com.

Omgevingsvariabelen voor gebruiksdienst

De volgende omgevingsvariabelen configureren de gebruiksdienst.

enable_tracking(state)

Kies ervoor om gegevens wel of niet naar de gebruiksdienst te verzenden.

state: Of tracking is ingeschakeld.

Retourneert dit object voor kettingaanroepen.

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

set_tracking_url(url)

Stel in waar gebruiksmetriekgegevens naartoe worden verzonden.

url: URL waar gegevens naartoe worden verzonden.

Retourneert dit object voor kettingaanroepen.

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

set_distinct_id(id)

Stel de unieke ID in die wordt gebruikt bij het verzenden van gebruiksstatistieken.

id: Unieke ID om te verzenden.

Retourneert dit object voor kettingaanroepen.

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