Generieren von Berichten mit Python

axe-devtools-api erzeugt Ergebnisse in einem Format, das mit dem [Axe DevTools Reporter] kompatibel ist.(cli-reports)

Reporterkompatibles JSON erstellen

Axe::analyze gibt ein Objekt in der richtigen Form zur Verwendung mit dem Axe DevTools-Reporter zurück. Es kann kann über die Methode Results::to_json umgewandelt werden.

Hier ist ein Beispiel, bei dem wir eine Seite analysieren und die Ergebnisse in einer Datei speichern:

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

Konfigurieren des Berichts

Berichtsmetadaten werden über die ReportConfiguration Klasse konfiguriert. Nachfolgend finden Sie Methoden zur Metadaten konfigurieren.

Sobald ein ReportConfiguration Objekt den gewünschten Zustand erreicht hat, kann es in zwei Schritten auf einen Scan angewendet werden. Möglichkeiten:

1. Es kann auf einen einzelnen Scan angewendet werden, indem es über ein einzelnes Axe Objekt gebunden wird Axe::__init__

   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. Es kann auf alle Scans angewendet werden, die nicht einzeln überschrieben werden, indem eine Instanz von ReportConfiguration als Standard festgelegt wird.

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

Sie können die ReportConfiguration Instanz, die derzeit als Standard dient, abrufen, indem Sie ReportConfiguration.get_default aufrufen

ReportConfiguration API

@staticmethod
def get_default():
    """Gets the current default configuration. Note that the default can be changed.

    Returns:
        The current default
    """

def set_as_default(self):
    """Sets this object as the default"""

@staticmethod
def reset_default():
    """Resets the default to its initial state"""

def test_suite_name(self, name):
    """Sets the test suite name

    Args:
        name: The name

    Returns:
        This object for chaining
    """

def ui_state(self, id):
    """Specify the ui-state for this set of tests. Used as ID.

    Args:
        id: State id

    Returns:
        This object for chaining
    """

def user_agent(self, ua):
    """Set the user agent used when testing

    Args:
        ua: The user agent string

    Returns:
        This object for chaining
    """

def test_machine(self, t_machine):
    """Sets the machine the tests were run on

    Args:
        t_machine: Id for the machine

    Returns:
        This object for chaining
    """

Siehe auch

– Hochladen von JSON-Zugänglichkeitsergebnissen in axe Reports beschreibt, wie Sie Ihre Ergebnisse in axe Reports hochladen.

• Erhalten eines API-Schlüssels für axe Reports erklärt, wie Sie einen API-Schlüssel erhalten, um mit der Verwendung von axe Reports zu beginnen.

– Berichte erstellen und filtern zeigt, wie Sie aus Ihren JSON-Zugänglichkeitsergebnissen Zugänglichkeitsberichte im CSV-, XML- oder HTML-Format erstellen können. Mit diesem Tool können Sie Ihre Ausgabe auch nach Schweregrad filtern. – So werden JSON-Ergebnisse auf der Festplatte gespeichert beschreibt die Dateibenennungskonventionen für JSON-Zugänglichkeitsergebnisse.