Generar informes con Python

axe-devtools-api produce resultados en un formato compatible con el Axe DevTools reporter.

Crear JSON compatible con reportes

Axe.analyze() devuelve un Results objeto. Se puede convertir a una cadena JSON compatible con reportes mediante Results.to_json().

Aquí hay un ejemplo donde analizamos una página y guardamos los resultados en un archivo:

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

Configuración del informe

Los metadatos del informe se configuran a través de la ReportConfiguration clase.

Una vez que un ReportConfiguration objeto está en el estado deseado, se puede aplicar a un escaneo de dos maneras:

1. Aplícalo a un escaneo individual pasándolo a 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. Establécelo como el predeterminado para todos los escaneos que no lo sobrescriban individualmente:

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

Para obtener la ReportConfiguration instancia actualmente establecida como la predeterminada, llama a ReportConfiguration.get_default().

axe_devtools_api.Results

Devuelto por Axe.analyze(). Contiene los hallazgos de axe-core y proporciona métodos para inspeccionarlos y serializarlos.

Propiedades

name

El nombre del conjunto de pruebas. Se establece a través de ReportConfiguration.test_suite_name(). Predeterminado a "axe-run".

id

El identificador de escaneo: una combinación del valor de estado de la interfaz de usuario (establecido a través de ReportConfiguration.ui_state()) y un UUID, unidos por un guion. Predeterminado a "check-<uuid>".

Métodos

to_json()

Convierte los resultados a una cadena JSON compatible con reportes.

is_axe_clean()

Devuelve True si axe-core se ejecutó sin errores y no encontró violaciones.

is_errored()

Devuelve True si axe-core encontró un error durante la ejecución.

violations_report()

Devuelve una cadena legible que resume las violaciones encontradas. Si axe-core tuvo errores, devuelve el mensaje de error en su lugar.

axe_devtools_api.ReportConfiguration

Configura metadatos del informe como el nombre del conjunto de pruebas y la información del agente de usuario.

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

ReportConfiguration()

Crea un nuevo ReportConfiguration con valores predeterminados.

get_default()

Devuelve el actual predeterminado ReportConfiguration. Ten en cuenta que el valor predeterminado se puede cambiar mediante set_as_default().

set_as_default()

Configura este objeto como la configuración predeterminada para todas Axe las instancias que no especifiquen la suya propia.

reset_default()

Restablece la configuración predeterminada a su estado inicial.

test_suite_name(name)

Establece el nombre del conjunto de pruebas. Se utiliza como el name campo en el Results objeto.

name: El nombre del conjunto de pruebas.

Devuelve este objeto para encadenamiento.

ui_state(id)

Establezca el estado de la interfaz de usuario para este conjunto de pruebas. Se usa como el id campo en el Results objeto.

id: Un identificador de cadena para el estado de la interfaz de usuario (por ejemplo, "login-page" o "dark-mode").

Devuelve este objeto para encadenamiento.

user_agent(ua)

Establezca la cadena del agente de usuario registrada en el informe.

ua: La cadena del agente de usuario.

Devuelve este objeto para encadenamiento.

test_machine(t_machine)

Establezca el nombre de la máquina en la que se ejecutaron las pruebas.

t_machine: Un identificador para la máquina.

Devuelve este objeto para encadenamiento.

Ver También

• Cómo cargar resultados de accesibilidad JSON en axe Reports describe cómo cargar sus resultados en axe Reports.
• Cómo obtener una clave API de axe Reports indica cómo obtener una clave API para comenzar a utilizar axe Reports.
• Creación y filtrado de informes muestra cómo puede crear informes de accesibilidad en formato CSV, XML o HTML a partir de sus resultados de accesibilidad JSON. También puede filtrar su salida por severidad utilizando esta herramienta.
• Cómo se almacenan los resultados JSON en el disco describe las convenciones de nombres de archivos para los resultados de accesibilidad JSON.