Skip to content

Commit

Permalink
Merge pull request pytest-dev#2567 from nicoddemus/add-report-section…
Browse files Browse the repository at this point in the history
…-docs

Add docs for Item.add_report_section in the docs
  • Loading branch information
RonnyPfannschmidt authored Jul 13, 2017
2 parents 81cec9f + 73b07e1 commit 771cedd
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions _pytest/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -518,6 +518,21 @@ def __init__(self, name, parent=None, config=None, session=None):
self._report_sections = []

def add_report_section(self, when, key, content):
"""
Adds a new report section, similar to what's done internally to add stdout and
stderr captured output::
item.add_report_section("call", "stdout", "report section contents")
:param str when:
One of the possible capture states, ``"setup"``, ``"call"``, ``"teardown"``.
:param str key:
Name of the section, can be customized at will. Pytest uses ``"stdout"`` and
``"stderr"`` internally.
:param str content:
The full contents as a string.
"""
if content:
self._report_sections.append((when, key, content))

Expand Down

0 comments on commit 771cedd

Please sign in to comment.