doc/reference: add CollectReport
CollectReport appears in several hooks, so we should document it. It's runtest equivalent TestReport is already documented.
This commit is contained in:
parent
5e35c86a37
commit
2a38ca8a0c
|
@ -762,6 +762,14 @@ Collector
|
||||||
:members:
|
:members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
|
CollectReport
|
||||||
|
~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. autoclass:: _pytest.runner.CollectReport()
|
||||||
|
:members:
|
||||||
|
:show-inheritance:
|
||||||
|
:inherited-members:
|
||||||
|
|
||||||
Config
|
Config
|
||||||
~~~~~~
|
~~~~~~
|
||||||
|
|
||||||
|
|
|
@ -335,6 +335,8 @@ class TestReport(BaseReport):
|
||||||
|
|
||||||
|
|
||||||
class CollectReport(BaseReport):
|
class CollectReport(BaseReport):
|
||||||
|
"""Collection report object."""
|
||||||
|
|
||||||
when = "collect"
|
when = "collect"
|
||||||
|
|
||||||
def __init__(
|
def __init__(
|
||||||
|
@ -346,11 +348,24 @@ class CollectReport(BaseReport):
|
||||||
sections: Iterable[Tuple[str, str]] = (),
|
sections: Iterable[Tuple[str, str]] = (),
|
||||||
**extra
|
**extra
|
||||||
) -> None:
|
) -> None:
|
||||||
|
#: normalized collection node id
|
||||||
self.nodeid = nodeid
|
self.nodeid = nodeid
|
||||||
|
|
||||||
|
#: test outcome, always one of "passed", "failed", "skipped".
|
||||||
self.outcome = outcome
|
self.outcome = outcome
|
||||||
|
|
||||||
|
#: None or a failure representation.
|
||||||
self.longrepr = longrepr
|
self.longrepr = longrepr
|
||||||
|
|
||||||
|
#: The collected items and collection nodes.
|
||||||
self.result = result or []
|
self.result = result or []
|
||||||
|
|
||||||
|
#: list of pairs ``(str, str)`` of extra information which needs to
|
||||||
|
#: marshallable. Used by pytest to add captured text
|
||||||
|
#: from ``stdout`` and ``stderr``, but may be used by other plugins
|
||||||
|
#: to add arbitrary information to reports.
|
||||||
self.sections = list(sections)
|
self.sections = list(sections)
|
||||||
|
|
||||||
self.__dict__.update(extra)
|
self.__dict__.update(extra)
|
||||||
|
|
||||||
@property
|
@property
|
||||||
|
|
Loading…
Reference in New Issue