axe-devtools-api Référence de l'API Python
Référence API pour le package Python axe-devtools-api pour injecter et exécuter axe-core
Fournit une API permettant d'injecter et d'exécuter axe-core sur une page web.
axe_devtools_api.Axe
Configure la manière dont axe-core est exécuté et l'exécute sur la page.
report = Axe(page).with_rules("document-title", "label").analyze()Axe(page, report_configuration=None, axe_source=None)
Initialisez une instance Axe avec un adaptateur de navigateur et une configuration optionnelle.
page: Un adaptateur de navigateur, tel qu'une AxeDriver instance de axe-devtools-selenium.
report_configuration: Optionnel. Un objet de configuration de rapport.
axe_source: Optionnel. Une chaîne de code source axe-core à utiliser au lieu de la version intégrée.
analyze()
Injectez axe-core dans la page et exécutez l'analyse d'accessibilité.
Retourne un Results objet. Voir Générer des rapports avec Python pour l'API complète et comment configurer les métadonnées du rapport. Results Spécifiez une partie de la page à analyser par axe-core.
report = Axe(page).analyze()including(*selector)
: Un ou plusieurs sélecteurs CSS pour les éléments à inclure.
selectorRenvoie cet objet pour chaînage.
Spécifiez une partie de la page pour que axe-core l'ignore pendant l'analyse.
report = Axe(page).including(".sidebar-frame", ".some-class").analyze()excluding(*selector)
: Un ou plusieurs sélecteurs CSS pour les éléments à exclure.
selectorRenvoie cet objet pour chaînage.
Spécifiez des règles (par ID) à exécuter par axe-core. Seules les règles spécifiées sont utilisées. Cette option est incompatible avec
report = Axe(page).excluding(".iframe1", ".third-party-ad").analyze()with_rules(*rules)
. with_tags: Un ou plusieurs IDs de règles. Voir
rulesDescriptions des règles pour une liste des IDs valides. Renvoie cet objet pour chaînage.
Soulève
si appelé avec RuntimeError sur la même instance. with_tags Spécifiez des règles (par étiquette) à exécuter par axe-core. Seules les règles spécifiées sont utilisées. Cette option est incompatible avec
report = Axe(page).with_rules("document-title", "label").analyze()with_tags(*tags)
. with_rules: Un ou plusieurs noms d'étiquettes. Voir
tagsétiquettes axe-core pour une liste des étiquettes valides. Renvoie cet objet pour chaînage.
Soulève
si appelé avec RuntimeError sur la même instance. with_rules Désactivez des règles spécifiques de l'exécution axe-core.
report = Axe(page).with_tags("best-practice", "wcag2a").analyze()disabling_rules(*rules)
: Un ou plusieurs IDs de règles.
rulesRenvoie cet objet pour chaînage.
Spécifiez
report = Axe(page).disabling_rules("html-has-lang", "label").analyze()run_options(options)
runOptions à passer à axe-core lors de l'appel de . axe.run: Objet d'options à passer à axe-core.
optionsRenvoie cet objet pour chaînage.
Configurez axe-core via
options = {"iframes": False}
report = Axe(page).run_options(options).analyze()configure(spec)
Configure axe-core via axe.configure.
spec: Objet spécifié à transmettre à axe.configure.
Retourne cet objet pour l'enchaînement.
report = Axe(page).configure(spec).analyze()without_iframe_sandboxes()
Supprimer l'attribut sandbox de iframes afin qu'axe-core puisse s'exécuter à l'intérieur.
Retourne cet objet pour l'enchaînement.
report = Axe(page).without_iframe_sandboxes().analyze()with_config_file(config_path)
Définir le chemin vers un fichier de config de jeu de règles. Le chemin par défaut est config/axe-ruleset.json, ou la valeur de la variable d'environnement $AXE_RULESET_PATH si elle est définie.
config_path: Chemin vers le fichier de configuration.
Retourne cet objet pour l'enchaînement.
report = Axe(page).with_config_file("path/to/file.json").analyze()with_ruleset(ruleset_id, enable_best_practices=False)
Utiliser un jeu de règles spécifique pour l'exécution d'axe-core.
ruleset_id: ID du jeu de règles à utiliser. Jeux de règles disponibles : wcag2, wcag2.1, wcag2.2, wcag2aaa, wcag2.1aaa, wcag2.2aaa, 508, en301549, ttv5, rgaav4.
enable_best_practices: Activer ou non les règles étiquetées best-practice. Par défaut, False.
Retourne cet objet pour l'enchaînement.
report = Axe(page).with_ruleset("508").analyze()set_legacy_mode(state=True)
Utiliser axe.run au lieu de axe.runPartial. A des implications cross-origin.
state: Activer ou non le mode hérité. Par défaut, True.
Retourne cet objet pour l'enchaînement.
report = Axe(page).set_legacy_mode().analyze()Service d'utilisation
Obtenez un aperçu des tendances d'utilisation d'Axe DevTools au sein de votre organisation. Par défaut, le service d'utilisation est désactivé. L'URL par défaut est https://usage.deque.com.
Variables d'environnement du service d'utilisation
Les variables d'environnement suivantes configurent le service d'utilisation.
| Variable d'environnement | Type |
|---|---|
| AXE_IS_LOGGED_IN | Booléen |
| AXE_KEYCLOAK_ID | Chaîne |
| AXE_USER_ID | Chaîne |
| AXE_SESSION_ID | Chaîne |
| AXE_USER_STATUS | Chaîne |
| AXE_USER_JOB_ROLE | Chaîne |
| AXE_DISTINCT_ID | Chaîne |
| AXE_IS_DEV_INSTANCE | Booléen |
| AXE_ORGANIZATION | Chaîne |
| AXE_APPLICATION | Chaîne |
| AXE_METRICS_URL | Chaîne |
| AXE_TRACK_USAGE | Booléen |
enable_tracking(state)
Choisir d'envoyer ou non des données au service d'utilisation.
state: Indique si le suivi est activé.
Retourne cet objet pour le chaînage.
report = Axe(page).enable_tracking(True).analyze()set_tracking_url(url)
Définir où les données des métriques d'utilisation sont envoyées.
url: URL où les données seront envoyées.
Retourne cet objet pour le chaînage.
report = Axe(page).set_tracking_url("https://usage.deque.com").analyze()set_distinct_id(id)
Définir l'ID distinct utilisé lors de l'envoi des métriques d'utilisation.
id: ID distinct à envoyer.
Retourne cet objet pour le chaînage.
report = Axe(page).set_distinct_id("SOMEUUID").analyze()