[PYTHON] Geben Sie die Testfunktion docstring mit pytest-html in den Bericht ein

Hier finden Sie eine Zusammenfassung der Ausgabe eines Dokumentstrings in einen pytest-html-Bericht als detaillierte Informationen zur Testfunktion.

1. Bearbeiten Sie conftest.py

Fügen Sie conftest.py (erstellt, falls nicht vorhanden) die folgenden Einstellungen direkt unter dem Testverzeichnis hinzu. Der Titel wird in die dritte Spalte des Tabellenkopfs eingefügt, und die Informationen der Testfunktion docstring werden in die dritte Spalte des Tabellenkörpers eingefügt.

conftest.py

import pytest
from py.xml import html


def pytest_html_results_table_header(cells):
    cells.insert(2, html.th('Description'))

def pytest_html_results_table_row(report, cells):
    cells.insert(2, html.td(report.description))

@pytest.hookimpl(hookwrapper=True)
def pytest_runtest_makereport(item, call):
    outcome = yield
    report = outcome.get_result()
    report.description = str(item.function.__doc__)

2. Schreiben Sie eine Dokumentzeichenfolge in Ihren Testcode

def test_one(self):
    """
Dies ist Test 1
    """
    assert True

def test_two(self):
    """
Dies ist Test 2
    """
    assert False

3. Testausführung

$ pytest --html=report.html

4. Ergebnis

Die Dokumentzeichenfolge für jede Testfunktion wird in der dritten Spalte der Tabelle angezeigt.

Referenz

• https://github.com/pytest-dev/pytest-html