Générer des rapports avec Python

axe-devtools-api produit des résultats dans un format compatible avec le Axe DevTools reporter.

Créer un JSON compatible avec le reporter

Axe.analyze() renvoie un Results objet. Il peut être converti en une chaîne JSON compatible avec le reporter via Results.to_json().

Voici un exemple où nous analysons une page et sauvegardons les résultats dans un fichier :

axe = Axe(driver)
results = axe.analyze()
with open("my_results.json", "w") as f:
    f.write(results.to_json())

Configurer le rapport

Les métadonnées du rapport sont configurées via la ReportConfiguration classe.

Une fois qu'un ReportConfiguration objet est dans l'état souhaité, il peut être appliqué à un scan de deux manières :

1. Appliquez-le à une analyse unique en le passant à 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. Définissez-le comme défaut pour toutes les analyses qui ne le remplacent pas individuellement :

   ReportConfiguration().test_suite_name("my suite").set_as_default()
   
   axe = Axe(driver)
   results = axe.analyze()
   
   assert results.name == "my suite"

Pour obtenir l' ReportConfiguration instance actuellement définie par défaut, appelez ReportConfiguration.get_default().

axe_devtools_api.Results

Renvoyé par Axe.analyze(). Contient les résultats axe-core et offre des méthodes pour les inspecter et les sérialiser.

Propriétés

name

Le nom de la suite de tests. Définir via ReportConfiguration.test_suite_name(). Par défaut, "axe-run".

id

L'identifiant de l'analyse — une combinaison de la valeur d'état UI (définie via ReportConfiguration.ui_state()) et un UUID, séparés par un tiret. Par défaut, "check-<uuid>".

Méthodes

to_json()

Convertir les résultats en une chaîne JSON compatible avec le reporter.

is_axe_clean()

Retourne True si axe-core a fonctionné sans erreur et n'a trouvé aucune violation.

is_errored()

Retourne True si axe-core a rencontré une erreur lors de l'exécution.

violations_report()

Retourne une chaîne lisible par l'homme résumant les violations trouvées. Si axe-core a échoué, renvoie le message d'erreur à la place.

axe_devtools_api.ReportConfiguration

Configure les métadonnées du rapport comme le nom de la suite de tests et les informations de l'agent utilisateur.

report_config = ReportConfiguration().test_suite_name("my suite").ui_state("login page")
axe = Axe(driver, report_configuration=report_config)

ReportConfiguration()

Créer un nouveau ReportConfiguration avec des valeurs par défaut.

get_default()

Retourne le ReportConfigurationpar défaut actuel. Notez que le défaut peut être modifié via set_as_default().

set_as_default()

Définissez cet objet comme configuration par défaut pour tous les Axe qui ne spécifient pas leur propre configuration.

reset_default()

Réinitialisez la configuration par défaut à son état initial.

test_suite_name(name)

Définissez le nom de la suite de tests. Utilisé comme le name champ sur le Results objet.

name: Le nom de la suite de tests.

Renvoie cet objet pour permettre l'enchaînement.

ui_state(id)

Définissez l'état de l'interface utilisateur pour cet ensemble de tests. Utilisé comme le id champ dans l' Results objet.

id: Un identifiant de chaîne pour l'état de l'interface utilisateur (par exemple, "login-page" ou "dark-mode").

Renvoie cet objet pour permettre l'enchaînement.

user_agent(ua)

Définir la chaîne de l'agent utilisateur enregistrée dans le rapport.

ua: La chaîne de l'agent utilisateur.

Renvoie cet objet pour permettre l'enchaînement.

test_machine(t_machine)

Définissez le nom de la machine sur laquelle les tests ont été exécutés.

t_machine: Un identifiant pour la machine.

Renvoie cet objet pour permettre l'enchaînement.

Voir aussi

• Téléchargement des résultats d'accessibilité JSON dans les rapports axe décrit comment télécharger vos résultats dans les rapports axe.
• Obtention d'une clé API Axe Reports explique comment obtenir une clé API pour commencer à utiliser Axe Reports.
• Création et filtrage de rapports montre comment vous pouvez créer des rapports d'accessibilité au format CSV, XML ou HTML à partir de vos résultats d'accessibilité JSON. Vous pouvez également filtrer votre sortie par gravité à l'aide de cet outil.
• Comment les résultats JSON sont stockés sur le disque décrit les conventions de nommage des fichiers pour les résultats d'accessibilité JSON.