Referência da API Python do axe-devtools-api
Referência da API para o pacote Python axe-devtools-api para injetar e executar o axe-core
Fornece uma API com a qual é possível injetar e executar o axe-core em uma página web.
axe_devtools_api.Axe
Configura como o axe-core é executado e o executa na página.
report = Axe(page).with_rules("document-title", "label").analyze()Axe(page, report_configuration=None, axe_source=None)
Inicialize uma instância de Axe com um adaptador de navegador e configuração opcional.
page: Um adaptador de navegador, como uma instância de AxeDriver de axe-devtools-selenium.
report_configuration: Opcional. Um objeto de configuração de relatório.
axe_source: Opcional. Uma string do código-fonte do axe-core para usar em vez da versão incorporada.
analyze()
Injete o axe-core na página e execute a análise de acessibilidade.
Retorna um objeto Results. Veja Gerando Relatórios com Python para a API completa de Results e como configurar os metadados dos relatórios.
report = Axe(page).analyze()including(*selector)
Especifique parte da página para o axe-core analisar.
selector: Um ou mais seletores CSS para elementos a incluir.
Retorna este objeto para encadeamento.
report = Axe(page).including(".sidebar-frame", ".some-class").analyze()excluding(*selector)
Especifique parte da página para o axe-core pular durante a análise.
selector: Um ou mais seletores CSS para elementos a excluir.
Retorna este objeto para encadeamento.
report = Axe(page).excluding(".iframe1", ".third-party-ad").analyze()with_rules(*rules)
Especifique regras (por ID) para o axe-core executar. Apenas as regras especificadas são usadas. Esta opção é incompatível com with_tags.
rules: Um ou mais IDs de regras. Veja Descrições de Regras para uma lista de IDs válidos.
Retorna este objeto para encadeamento.
Levanta RuntimeError se chamado junto com with_tags na mesma instância.
report = Axe(page).with_rules("document-title", "label").analyze()with_tags(*tags)
Especifique regras (por tag) para o axe-core executar. Apenas as regras especificadas são usadas. Esta opção é incompatível com with_rules.
tags: Um ou mais nomes de tags. Veja etiquetas do axe-core para uma lista de tags válidas.
Retorna este objeto para encadeamento.
Levanta RuntimeError se chamado junto com with_rules na mesma instância.
report = Axe(page).with_tags("best-practice", "wcag2a").analyze()disabling_rules(*rules)
Desative regras específicas da execução do axe-core.
rules: Um ou mais IDs de regras.
Retorna este objeto para encadeamento.
report = Axe(page).disabling_rules("html-has-lang", "label").analyze()run_options(options)
Especifique opções de execução para passar para o axe-core ao chamar axe.run.
options: Objeto de opções para passar ao axe-core.
Retorna este objeto para encadeamento.
options = {"iframes": False}
report = Axe(page).run_options(options).analyze()configure(spec)
Configure o axe-core via axe.configure.
spec: Objeto spec para passar para axe.configure.
Retorna este objeto para encadeamento.
report = Axe(page).configure(spec).analyze()without_iframe_sandboxes()
Remova o atributo sandbox dos iframes para que o axe-core possa ser executado dentro deles.
Retorna este objeto para encadeamento.
report = Axe(page).without_iframe_sandboxes().analyze()with_config_file(config_path)
Defina o caminho para um arquivo de configuração de conjunto de regras. O caminho padrão é config/axe-ruleset.json, ou o valor da variável de ambiente $AXE_RULESET_PATH se definido.
config_path: Caminho para o arquivo de configuração.
Retorna este objeto para encadeamento.
report = Axe(page).with_config_file("path/to/file.json").analyze()with_ruleset(ruleset_id, enable_best_practices=False)
Use um conjunto de regras específico para a execução do axe-core.
ruleset_id: ID do conjunto de regras a ser usado. Conjuntos de regras disponíveis: wcag2, wcag2.1, wcag2.2, wcag2aaa, wcag2.1aaa, wcag2.2aaa, 508, en301549, ttv5, rgaav4.
enable_best_practices: Se as regras marcadas como best-practice devem ser ativadas. O padrão é False.
Retorna este objeto para encadeamento.
report = Axe(page).with_ruleset("508").analyze()set_legacy_mode(state=True)
Use axe.run em vez de axe.runPartial. Traz implicações de origem cruzada.
state: Se o modo legado deve ser ativado. O padrão é True.
Retorna este objeto para encadeamento.
report = Axe(page).set_legacy_mode().analyze()Serviço de Uso
Obtenha insights sobre as tendências de uso do Axe DevTools dentro de sua organização. Por padrão, o serviço de uso está desativado. A URL padrão é https://usage.deque.com.
Variáveis de ambiente do serviço de uso
Essas variáveis de ambiente permitem configurar o serviço de uso e alterar as propriedades dos eventos relatados.
| Nome | Tipo | Pode Sobrescrever | Descrição |
|---|---|---|---|
AXE_DISTINCT_ID |
String | — | Um identificador UUID que permanece o mesmo para o usuário logado (a menos que seja regenerado) |
AXE_METRICS_URL |
String | — | A URL do endpoint de uso REST |
AXE_TRACK_USAGE |
Boolean | — | Ativa o relatório de serviço de uso (padrão é false) |
AXE_APPLICATION |
String | false | O aplicativo que foi utilizado para verificar erros de acessibilidade |
AXE_DEV_INSTANCE |
Boolean | true | Indica se este evento é resultante das ações de um desenvolvedor de software. Útil para marcar e posteriormente remover eventos registrados durante o desenvolvimento ou teste. |
AXE_DEPARTMENT |
String | true | O departamento do usuário dentro da organização |
AXE_KEYCLOAK_ID |
String | false | O ID Keycloak do usuário |
AXE_LOGGED_IN |
Boolean | false | Registra se o usuário está logado na aplicação em teste |
AXE_ORGANIZATION |
String | true | A organização do usuário |
AXE_SESSION_ID |
String | false | Um UUID identificando a sessão do usuário |
AXE_USER_ID |
String | false | A identidade específica de usuário, como nome ou ID de login |
AXE_USER_JOB_ROLE |
String | false | O cargo do usuário |
AXE_USER_STATUS |
String | false | Informações de status que você deseja associar ao usuário |
enable_tracking(state)
Optar por enviar ou não dados ao serviço de uso.
state: Se o rastreamento está ativado.
Retorna este objeto para encadeamento.
report = Axe(page).enable_tracking(True).analyze()set_tracking_url(url)
Definir para onde os dados das métricas de uso são enviados.
url: URL para onde os dados serão enviados.
Retorna este objeto para encadeamento.
report = Axe(page).set_tracking_url("https://usage.deque.com").analyze()set_distinct_id(id)
Definir o ID distinto usado ao enviar métricas de uso.
id: ID distinto a ser enviado.
Retorna este objeto para encadeamento.
report = Axe(page).set_distinct_id("SOMEUUID").analyze()