Merge branch 'main' into 13737-require-unique-paramset-ids

Author: gomri15

AUTHORS

@@ -39,6 +39,7 @@ Andrzej Klajnert
 Andrzej Ostrowski
 Andy Freeland
 Anita Hammer
+Anna Tasiopoulou
 Anthon van der Neut
 Anthony Shaw
 Anthony Sottile
@@ -227,6 +228,7 @@ Jon Parise
 Jon Sonesen
 Jonas Obrist
 Jordan Guymon
+Jordan Macdonald
 Jordan Moldow
 Jordan Speicher
 Joseph Hunkeler

changelog/13072.feature.rst

@@ -0,0 +1,8 @@
+Added support for displaying test session progress in the terminal tab using the `OSC 9;4; <https://conemu.github.io/en/AnsiEscapeCodes.html#ConEmu_specific_OSC>`_ ANSI sequence.
+When pytest runs in a supported terminal emulator like ConEmu, Gnome Terminal, Ptyxis, Windows Terminal, Kitty or Ghostty,
+you'll see the progress in the terminal tab or window,
+allowing you to monitor pytest's progress at a glance.
+
+This feature is automatically enabled when running in a TTY. It is implemented as an internal plugin. If needed, it can be disabled as follows:
+- On a user level, using ``-p no:terminalprogress`` on the command line or via an environment variable ``PYTEST_ADDOPTS='-p no:terminalprogress'``.
+- On a project configuration level, using ``addopts = "-p no:terminalprogress"``.

changelog/13766.breaking.rst

@@ -0,0 +1,2 @@
+Previously, pytest would assume it was running in a CI/CD environment if either of the environment variables `$CI` or `$BUILD_NUMBER` was defined;
+now, CI mode is only activated if at least one of those variables is defined and set to a *non-empty* value.

doc/en/explanation/ci.rst

@@ -17,8 +17,7 @@ adapt some of its behaviours.
 How CI is detected
 ------------------
 
-Pytest knows it is in a CI environment when either one of these environment variables are set,
-regardless of their value:
+Pytest knows it is in a CI environment when either one of these environment variables are set to a non-empty value:
 
 * `CI`: used by many CI systems.
 * `BUILD_NUMBER`: used by Jenkins.

doc/en/reference/reference.rst

@@ -1165,11 +1165,11 @@ Environment variables that can be used to change pytest's behavior.
 
 .. envvar:: CI
 
-When set (regardless of value), pytest acknowledges that is running in a CI process. Alternative to ``BUILD_NUMBER`` variable. See also :ref:`ci-pipelines`.
+When set to a non-empty value, pytest acknowledges that is running in a CI process. See also :ref:`ci-pipelines`.
 
 .. envvar:: BUILD_NUMBER
 
-When set (regardless of value), pytest acknowledges that is running in a CI process. Alternative to CI variable. See also :ref:`ci-pipelines`.
+When set to a non-empty value, pytest acknowledges that is running in a CI process. Alternative to :envvar:`CI`. See also :ref:`ci-pipelines`.
 
 .. envvar:: PYTEST_ADDOPTS
 
@@ -2412,7 +2412,7 @@ All the command-line flags can be obtained by running ``pytest --help``::
                             Plugins that must be present for pytest to run
 
     Environment variables:
-      CI                       When set (regardless of value), pytest knows it is running in a CI process and does not truncate summary info
+      CI                       When set to a non-empty value, pytest knows it is running in a CI process and does not truncate summary info
       BUILD_NUMBER             Equivalent to CI
       PYTEST_ADDOPTS           Extra command line options
       PYTEST_PLUGINS           Comma-separated plugins to load during startup

src/_pytest/_io/terminalwriter.py

@@ -161,20 +161,23 @@ def write(self, msg: str, *, flush: bool = False, **markup: bool) -> None:
 
             msg = self.markup(msg, **markup)
 
-            try:
-                self._file.write(msg)
-            except UnicodeEncodeError:
-                # Some environments don't support printing general Unicode
-                # strings, due to misconfiguration or otherwise; in that case,
-                # print the string escaped to ASCII.
-                # When the Unicode situation improves we should consider
-                # letting the error propagate instead of masking it (see #7475
-                # for one brief attempt).
-                msg = msg.encode("unicode-escape").decode("ascii")
-                self._file.write(msg)
-
-            if flush:
-                self.flush()
+            self.write_raw(msg, flush=flush)
+
+    def write_raw(self, msg: str, *, flush: bool = False) -> None:
+        try:
+            self._file.write(msg)
+        except UnicodeEncodeError:
+            # Some environments don't support printing general Unicode
+            # strings, due to misconfiguration or otherwise; in that case,
+            # print the string escaped to ASCII.
+            # When the Unicode situation improves we should consider
+            # letting the error propagate instead of masking it (see #7475
+            # for one brief attempt).
+            msg = msg.encode("unicode-escape").decode("ascii")
+            self._file.write(msg)
+
+        if flush:
+            self.flush()
 
     def line(self, s: str = "", **markup: bool) -> None:
         self.write(s, **markup)

src/_pytest/assertion/truncate.py

@@ -6,7 +6,7 @@
 
 from __future__ import annotations
 
-from _pytest.assertion import util
+from _pytest.compat import running_on_ci
 from _pytest.config import Config
 from _pytest.nodes import Item
 
@@ -43,7 +43,7 @@ def _get_truncation_parameters(item: Item) -> tuple[bool, int, int]:
 
     verbose = item.config.get_verbosity(Config.VERBOSITY_ASSERTIONS)
 
-    should_truncate = verbose < 2 and not util.running_on_ci()
+    should_truncate = verbose < 2 and not running_on_ci()
     should_truncate = should_truncate and (max_lines > 0 or max_chars > 0)
 
     return should_truncate, max_lines, max_chars

src/_pytest/assertion/util.py

@@ -9,7 +9,6 @@
 from collections.abc import Mapping
 from collections.abc import Sequence
 from collections.abc import Set as AbstractSet
-import os
 import pprint
 from typing import Any
 from typing import Literal
@@ -21,6 +20,7 @@
 from _pytest._io.pprint import PrettyPrinter
 from _pytest._io.saferepr import saferepr
 from _pytest._io.saferepr import saferepr_unlimited
+from _pytest.compat import running_on_ci
 from _pytest.config import Config
 
 
@@ -613,9 +613,3 @@ def _notin_text(term: str, text: str, verbose: int = 0) -> list[str]:
         else:
             newdiff.append(line)
     return newdiff
-
-
-def running_on_ci() -> bool:
-    """Check if we're currently running on a CI system."""
-    env_vars = ["CI", "BUILD_NUMBER"]
-    return any(var in os.environ for var in env_vars)

src/_pytest/cacheprovider.py

@@ -1,5 +1,5 @@
 # mypy: allow-untyped-defs
-"""Python version compatibility code."""
+"""Python version compatibility code and random general utilities."""
 
 from __future__ import annotations
 
@@ -278,39 +278,12 @@ def get_user_id() -> int | None:
         return uid if uid != ERROR else None
 
 
-# Perform exhaustiveness checking.
-#
-# Consider this example:
-#
-#     MyUnion = Union[int, str]
-#
-#     def handle(x: MyUnion) -> int {
-#         if isinstance(x, int):
-#             return 1
-#         elif isinstance(x, str):
-#             return 2
-#         else:
-#             raise Exception('unreachable')
-#
-# Now suppose we add a new variant:
-#
-#     MyUnion = Union[int, str, bytes]
-#
-# After doing this, we must remember ourselves to go and update the handle
-# function to handle the new variant.
-#
-# With `assert_never` we can do better:
-#
-#     // raise Exception('unreachable')
-#     return assert_never(x)
-#
-# Now, if we forget to handle the new variant, the type-checker will emit a
-# compile-time error, instead of the runtime error we would have gotten
-# previously.
-#
-# This also work for Enums (if you use `is` to compare) and Literals.
-def assert_never(value: NoReturn) -> NoReturn:
-    assert False, f"Unhandled value: {value} ({type(value).__name__})"
+if sys.version_info >= (3, 11):
+    from typing import assert_never
+else:
+
+    def assert_never(value: NoReturn) -> NoReturn:
+        assert False, f"Unhandled value: {value} ({type(value).__name__})"
 
 
 class CallableBool:
@@ -331,3 +304,10 @@ def __bool__(self) -> bool:
 
     def __call__(self) -> bool:
         return self._value
+
+
+def running_on_ci() -> bool:
+    """Check if we're currently running on a CI system."""
+    # Only enable CI mode if one of these env variables is defined and non-empty.
+    env_vars = ["CI", "BUILD_NUMBER"]
+    return any(os.environ.get(var) for var in env_vars)