axe-devtools-api Python API-referentie
API-referentie voor het axe-devtools-api Python-pakket voor het injecteren en uitvoeren van axe-core
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 met axe-core broncode om te gebruiken in plaats van de meegeleverde versie.
analyze()
Injeteer axe-core in de pagina en voer de toegankelijkheidsanalyse uit.
Geeft een Results-object terug. 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 kettingaanroepen.
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 kettingaanroepen.
report = Axe(page).excluding(".iframe1", ".third-party-ad").analyze()with_rules(*rules)
Specificeer regels (per ID) voor axe-core om uit te voeren. Alleen de gespecificeerde regels worden gebruikt. Deze optie is niet compatibel met with_tags.
rules: Een of meer regel-ID's. Zie Regelbeschrijvingen voor een lijst met geldige ID's.
Retourneert dit object voor kettingaanroepen.
Verhoogt RuntimeError als het samen met with_tags op dezelfde instantie wordt aangeroepen.
report = Axe(page).with_rules("document-title", "label").analyze()with_tags(*tags)
Specificeer regels (per tag) voor axe-core om uit te voeren. Alleen de gespecificeerde regels worden gebruikt. Deze optie is niet compatibel met with_rules.
tags: Een of meer tagnamen. Zie axe-core tags voor een lijst met geldige tags.
Retourneert dit object voor kettingaanroepen.
Verhoogt RuntimeError als het samen met with_rules op dezelfde instantie wordt aangeroepen.
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 kettingaanroepen.
report = Axe(page).disabling_rules("html-has-lang", "label").analyze()run_options(options)
Specificeer runOptions om door te geven aan axe-core bij het aanroepen van axe.run.
options: Optieobject om door te geven aan axe-core.
Retourneert dit object voor kettingaanroepen.
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.
Retourneert dit object voor kettingaanroepen.
report = Axe(page).configure(spec).analyze()without_iframe_sandboxes()
Verwijder het sandbox-attribuut van iframes zodat axe-core erin kan draaien.
Retourneert dit object voor kettingaanroepen.
report = Axe(page).without_iframe_sandboxes().analyze()with_config_file(config_path)
Stel het pad in naar een configuratiebestandsregels. Het standaardpad is config/axe-ruleset.json, of de waarde van de $AXE_RULESET_PATH-omgevingsvariabele indien ingesteld.
config_path: Pad naar het configuratiebestand.
Retourneert dit object voor kettingaanroepen.
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 regelsets: wcag2, wcag2.1, wcag2.2, wcag2aaa, wcag2.1aaa, wcag2.2aaa, 508, en301549, ttv5, rgaav4.
enable_best_practices: Of regels met tag best-practice moeten worden ingeschakeld. Standaard is False.
Retourneert dit object voor kettingaanroepen.
report = Axe(page).with_ruleset("508").analyze()set_legacy_mode(state=True)
Gebruik axe.run in plaats van axe.runPartial. Heeft gevolgen voor cross-origin.
state: Of de oude modus moet worden ingeschakeld. Standaard is True.
Retourneert dit object voor kettingaanroepen.
report = Axe(page).set_legacy_mode().analyze()Gebruik Service
Verkrijg inzicht in het gebruik van Axe DevTools-trends binnen uw organisatie. Standaard is de gebruiksservice uitgeschakeld. De standaard-URL is https://usage.deque.com.
Omgevingsvariabelen voor gebruiksdienst
Deze omgevingsvariabelen laten u toe de gebruiksservice te configureren en de eigenschappen van gerapporteerde gebeurtenissen te wijzigen.
| Naam | Type | Kan Override | Beschrijving |
|---|---|---|---|
AXE_DISTINCT_ID |
String | — | Een UUID-identificator die hetzelfde blijft voor de ingelogde gebruiker (tenzij deze wordt opnieuw gegenereerd) |
AXE_METRICS_URL |
String | — | De URL van het REST-gebruikseindpunt |
AXE_TRACK_USAGE |
Boolean | — | Schakelt het rapporteren van gebruiksservices in (standaard is false) |
AXE_APPLICATION |
String | false | De applicatie die werd gebruikt om toegankelijkheidsfouten te controleren |
AXE_DEV_INSTANCE |
Boolean | true | Geeft aan of dit evenement afkomstig is van acties van een softwareontwikkelaar. Nuttig voor het markeren en later verwijderen van evenementen die tijdens ontwikkeling of testen zijn geregistreerd. |
AXE_DEPARTMENT |
String | true | De afdeling van de gebruiker binnen de organisatie |
AXE_KEYCLOAK_ID |
String | false | De Keycloak-ID van de gebruiker |
AXE_LOGGED_IN |
Boolean | false | Registreert of de gebruiker is ingelogd op de toepassing onder test |
AXE_ORGANIZATION |
String | true | De organisatie van de gebruiker |
AXE_SESSION_ID |
String | false | Een UUID die de sessie van de gebruiker identificeert |
AXE_USER_ID |
String | false | De identiteit van een specifieke gebruiker, zoals naam of inlog-ID |
AXE_USER_JOB_ROLE |
String | false | De functie van de gebruiker |
AXE_USER_STATUS |
String | false | Statusinformatie die u aan de gebruiker wilt koppelen |
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 gestuurd.
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()