From d3502ac4d8610288c74722d0067ef0d3b26abc16 Mon Sep 17 00:00:00 2001 From: Roberto Aldera <51328612+roberto-aldera@users.noreply.github.com> Date: Sun, 14 May 2023 18:40:30 +0200 Subject: [PATCH] Add docstring --- src/_pytest/terminal.py | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/src/_pytest/terminal.py b/src/_pytest/terminal.py index d8a9ceb86..d7fad458c 100644 --- a/src/_pytest/terminal.py +++ b/src/_pytest/terminal.py @@ -547,6 +547,15 @@ class TerminalReporter: self.flush() class TestStatus(NamedTuple): + """Used to store the test status result category, shortletter and verbose word. + For example ``"rerun", "R", ("RERUN", {"yellow": True})``. + + category: the class of result, for example “passed”, “skipped”, “error”, or the empty string + letter: the shortletter shown as testing progresses, for example ".", "s", "E", or the empty string. + word: verbose word is shown as testing progresses in verbose mode, for example "PASSED", "SKIPPED", + "ERROR", or the empty string. + """ + category: str letter: str word: Union[str, Tuple[str, Mapping[str, bool]]]