From e3a6c639b744797066bd024a43028e0aed140f39 Mon Sep 17 00:00:00 2001 From: Stefaan Lippens Date: Thu, 25 Jul 2024 18:21:19 +0200 Subject: [PATCH 1/6] Include TerminalReporter in reference docs #6649 --- changelog/6649.doc.rst | 1 + doc/en/reference/reference.rst | 7 +++++++ 2 files changed, 8 insertions(+) create mode 100644 changelog/6649.doc.rst diff --git a/changelog/6649.doc.rst b/changelog/6649.doc.rst new file mode 100644 index 00000000000..24394014b81 --- /dev/null +++ b/changelog/6649.doc.rst @@ -0,0 +1 @@ +Added `TerminalReporter` to API reference documentation page. diff --git a/doc/en/reference/reference.rst b/doc/en/reference/reference.rst index 099c8a00260..146022fd4cb 100644 --- a/doc/en/reference/reference.rst +++ b/doc/en/reference/reference.rst @@ -1013,6 +1013,13 @@ PytestPluginManager :inherited-members: :show-inheritance: +TerminalReporter +~~~~~~~~~~~~~~~~ + +.. autoclass:: _pytest.terminal.TerminalReporter + :members: + :inherited-members: + TestReport ~~~~~~~~~~ From c3b18fb07ccb954503bfc79926490dec869c04ae Mon Sep 17 00:00:00 2001 From: Stefaan Lippens Date: Fri, 26 Jul 2024 09:47:26 +0200 Subject: [PATCH 2/6] TerminalReporter: add to pytest namespace and fix docstring (issue #6649, PR #12661) --- changelog/6649.doc.rst | 2 +- src/_pytest/terminal.py | 2 +- src/pytest/__init__.py | 2 ++ 3 files changed, 4 insertions(+), 2 deletions(-) diff --git a/changelog/6649.doc.rst b/changelog/6649.doc.rst index 24394014b81..aa63524b11c 100644 --- a/changelog/6649.doc.rst +++ b/changelog/6649.doc.rst @@ -1 +1 @@ -Added `TerminalReporter` to API reference documentation page. +Added `TerminalReporter` to `pytest` root namespace and to API reference documentation page. diff --git a/src/_pytest/terminal.py b/src/_pytest/terminal.py index 8c722124d04..cdda5a90ea1 100644 --- a/src/_pytest/terminal.py +++ b/src/_pytest/terminal.py @@ -1340,7 +1340,7 @@ def build_summary_stats_line(self) -> tuple[list[tuple[str, dict[str, bool]]], s The summary stats line is the line shown at the end, "=== 12 passed, 2 errors in Xs===". This function builds a list of the "parts" that make up for the text in that line, in - the example above it would be: + the example above it would be:: [ ("12 passed", {"green": True}), diff --git a/src/pytest/__init__.py b/src/pytest/__init__.py index 90abcdab036..92152b7c7b4 100644 --- a/src/pytest/__init__.py +++ b/src/pytest/__init__.py @@ -68,6 +68,7 @@ from _pytest.runner import CallInfo from _pytest.stash import Stash from _pytest.stash import StashKey +from _pytest.terminal import TerminalReporter from _pytest.terminal import TestShortLogReport from _pytest.tmpdir import TempPathFactory from _pytest.warning_types import PytestAssertRewriteWarning @@ -161,6 +162,7 @@ "version_tuple", "TempdirFactory", "TempPathFactory", + "TerminalReporter", "Testdir", "TestReport", "TestShortLogReport", From 666af0817b1ee3749df3a15972daa1a75223f8c7 Mon Sep 17 00:00:00 2001 From: Bruno Oliveira Date: Fri, 26 Jul 2024 08:09:09 -0300 Subject: [PATCH 3/6] Create 6649.trivial.rst --- changelog/6649.trivial.rst | 1 + 1 file changed, 1 insertion(+) create mode 100644 changelog/6649.trivial.rst diff --git a/changelog/6649.trivial.rst b/changelog/6649.trivial.rst new file mode 100644 index 00000000000..3fa03a9da23 --- /dev/null +++ b/changelog/6649.trivial.rst @@ -0,0 +1 @@ +Added :class:`pytest.TerminalReporter` to the public pytest API, as it is part of the signature of the :hook:`pytest_terminal_summary` hook. From a761595b61b37cfa8a913c7b9d1b66508747da34 Mon Sep 17 00:00:00 2001 From: Bruno Oliveira Date: Fri, 26 Jul 2024 08:10:32 -0300 Subject: [PATCH 4/6] Update changelog/6649.doc.rst --- changelog/6649.doc.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/changelog/6649.doc.rst b/changelog/6649.doc.rst index aa63524b11c..670984adff9 100644 --- a/changelog/6649.doc.rst +++ b/changelog/6649.doc.rst @@ -1 +1 @@ -Added `TerminalReporter` to `pytest` root namespace and to API reference documentation page. +Added :class:`pytest.TerminalReporter` to the :ref:`api-reference` documentation page. From bcdbb43a5555e0f86fadf7de059d2ba3456c8ac3 Mon Sep 17 00:00:00 2001 From: Bruno Oliveira Date: Fri, 26 Jul 2024 08:14:46 -0300 Subject: [PATCH 5/6] Rename 6649.trivial.rst to 6649.misc.rst --- changelog/{6649.trivial.rst => 6649.misc.rst} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename changelog/{6649.trivial.rst => 6649.misc.rst} (100%) diff --git a/changelog/6649.trivial.rst b/changelog/6649.misc.rst similarity index 100% rename from changelog/6649.trivial.rst rename to changelog/6649.misc.rst From 83cf0b19bc6188c210270ae5762f6450b099c392 Mon Sep 17 00:00:00 2001 From: Bruno Oliveira Date: Fri, 26 Jul 2024 08:38:20 -0300 Subject: [PATCH 6/6] Fix references --- changelog/6649.doc.rst | 2 +- changelog/6649.misc.rst | 2 +- doc/en/reference/reference.rst | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/changelog/6649.doc.rst b/changelog/6649.doc.rst index 670984adff9..cf5bb781b87 100644 --- a/changelog/6649.doc.rst +++ b/changelog/6649.doc.rst @@ -1 +1 @@ -Added :class:`pytest.TerminalReporter` to the :ref:`api-reference` documentation page. +Added :class:`~pytest.TerminalReporter` to the :ref:`api-reference` documentation page. diff --git a/changelog/6649.misc.rst b/changelog/6649.misc.rst index 3fa03a9da23..cec8c3f4506 100644 --- a/changelog/6649.misc.rst +++ b/changelog/6649.misc.rst @@ -1 +1 @@ -Added :class:`pytest.TerminalReporter` to the public pytest API, as it is part of the signature of the :hook:`pytest_terminal_summary` hook. +Added :class:`~pytest.TerminalReporter` to the public pytest API, as it is part of the signature of the :hook:`pytest_terminal_summary` hook. diff --git a/doc/en/reference/reference.rst b/doc/en/reference/reference.rst index 146022fd4cb..3a5063b6b58 100644 --- a/doc/en/reference/reference.rst +++ b/doc/en/reference/reference.rst @@ -1016,7 +1016,7 @@ PytestPluginManager TerminalReporter ~~~~~~~~~~~~~~~~ -.. autoclass:: _pytest.terminal.TerminalReporter +.. autoclass:: pytest.TerminalReporter :members: :inherited-members: