Referencia de la API de Python de axe-devtools-api
Referencia de la API para el paquete de Python axe-devtools-api para inyectar y ejecutar axe-core
Proporciona una API para inyectar y ejecutar axe-core en una página web.
axe_devtools_api.Axe
Configura cómo se ejecuta axe-core y lo ejecuta en la página.
report = Axe(page).with_rules("document-title", "label").analyze()Axe(page, report_configuration=None, axe_source=None)
Inicialice una instancia de Axe con un adaptador de navegador y una configuración opcional.
page: Un adaptador de navegador, como una AxeDriver instancia de axe-devtools-selenium.
report_configuration: Opcional. Un objeto de configuración de reporte.
axe_source: Opcional. Una cadena de código fuente de axe-core para usar en lugar de la versión incluida.
analyze()
Inyectar axe-core en la página y ejecutar el análisis de accesibilidad.
Devuelve un Results objeto. Ver Generación de informes con Python para la API completa y cómo configurar los metadatos del reporte. Results
report = Axe(page).analyze()including(*selector)
Especifique parte de la página para que axe-core analice.
selector: Uno o más selectores CSS para incluir elementos.
Devuelve este objeto para encadenamiento.
report = Axe(page).including(".sidebar-frame", ".some-class").analyze()excluding(*selector)
Especifique parte de la página para que axe-core omita durante el análisis.
selector: Uno o más selectores CSS para excluir elementos.
Devuelve este objeto para encadenamiento.
report = Axe(page).excluding(".iframe1", ".third-party-ad").analyze()with_rules(*rules)
Especifique reglas (por ID) para que axe-core ejecute. Solo se usan las reglas especificadas. Esta opción es incompatible con with_tags.
rules: Uno o más IDs de reglas. Ver Descripciones de reglas para una lista de IDs válidos.
Devuelve este objeto para encadenamiento.
Lanza RuntimeError si se llama junto con with_tags en la misma instancia.
report = Axe(page).with_rules("document-title", "label").analyze()with_tags(*tags)
Especifique reglas (por etiqueta) para que axe-core ejecute. Solo se usan las reglas especificadas. Esta opción es incompatible con with_rules.
tags: Uno o más nombres de etiquetas. Ver etiquetas de axe-core para una lista de etiquetas válidas.
Devuelve este objeto para encadenamiento.
Lanza RuntimeError si se llama junto con with_rules en la misma instancia.
report = Axe(page).with_tags("best-practice", "wcag2a").analyze()disabling_rules(*rules)
Deshabilite reglas específicas de la ejecución de axe-core.
rules: Uno o más IDs de reglas.
Devuelve este objeto para encadenamiento.
report = Axe(page).disabling_rules("html-has-lang", "label").analyze()run_options(options)
Especifique runOptions para pasar a axe-core al llamar axe.run.
options: Objeto de opciones para pasar a axe-core.
Devuelve este objeto para encadenamiento.
options = {"iframes": False}
report = Axe(page).run_options(options).analyze()configure(spec)
Configure axe-core a través de axe.configure.
spec: Objeto Spec para pasar a axe.configure.
Devuelve este objeto para encadenamiento.
report = Axe(page).configure(spec).analyze()without_iframe_sandboxes()
Elimina el atributo sandbox de los elementos iframepara que axe-core pueda ejecutarse dentro de ellos.
Devuelve este objeto para encadenamiento.
report = Axe(page).without_iframe_sandboxes().analyze()with_config_file(config_path)
Establece la ruta a un archivo de configuración de conjunto de reglas. La ruta predeterminada es config/axe-ruleset.json, o el valor de la variable de entorno $AXE_RULESET_PATH si está configurada.
config_path: Ruta al archivo de configuración.
Devuelve este objeto para encadenamiento.
report = Axe(page).with_config_file("path/to/file.json").analyze()with_ruleset(ruleset_id, enable_best_practices=False)
Usa un conjunto de reglas específico para la ejecución de axe-core.
ruleset_id: ID del conjunto de reglas a utilizar. Conjuntos de reglas disponibles: wcag2, wcag2.1, wcag2.2, wcag2aaa, wcag2.1aaa, wcag2.2aaa, 508, en301549, ttv5, rgaav4.
enable_best_practices: Si se deben habilitar las reglas etiquetadas best-practice. Por defecto es False.
Devuelve este objeto para encadenamiento.
report = Axe(page).with_ruleset("508").analyze()set_legacy_mode(state=True)
Usa axe.run en lugar de axe.runPartial. Tiene implicaciones de origen cruzado.
state: Si se debe habilitar el modo heredado. Por defecto es True.
Devuelve este objeto para encadenamiento.
report = Axe(page).set_legacy_mode().analyze()Servicio de uso
Obtén información sobre las tendencias de uso de Axe DevTools en tu organización. Por defecto, el servicio de uso está deshabilitado. La URL predeterminada es https://usage.deque.com.
Variables de entorno del servicio de uso
Las siguientes variables de entorno configuran el servicio de uso.
| Variable de entorno | Tipo |
|---|---|
| AXE_IS_LOGGED_IN | Booleano |
| AXE_KEYCLOAK_ID | Cadena |
| AXE_USER_ID | Cadena |
| AXE_SESSION_ID | Cadena |
| AXE_USER_STATUS | Cadena |
| AXE_USER_JOB_ROLE | Cadena |
| AXE_DISTINCT_ID | Cadena |
| AXE_IS_DEV_INSTANCE | Booleano |
| AXE_ORGANIZATION | Cadena |
| AXE_APPLICATION | Cadena |
| AXE_METRICS_URL | Cadena |
| AXE_TRACK_USAGE | Booleano |
enable_tracking(state)
Optar por enviar o no datos al servicio de uso.
state: Si el seguimiento está habilitado.
Devuelve este objeto para encadenamiento.
report = Axe(page).enable_tracking(True).analyze()set_tracking_url(url)
Establecer dónde se envían los datos de métricas de uso.
url: URL donde se enviarán los datos.
Devuelve este objeto para encadenamiento.
report = Axe(page).set_tracking_url("https://usage.deque.com").analyze()set_distinct_id(id)
Establecer el ID distinto utilizado al enviar métricas de uso.
id: ID distinto a enviar.
Devuelve este objeto para encadenamiento.
report = Axe(page).set_distinct_id("SOMEUUID").analyze()