summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorHugo van Kemenade <1324225+hugovk@users.noreply.github.com>2024-12-05 19:10:46 (GMT)
committerGitHub <noreply@github.com>2024-12-05 19:10:46 (GMT)
commit23f2e8f13c4e4a34106cf96fad9329cbfbf8844d (patch)
treea2f306c0ccd6c05302f4bb5eb279e3f0f6834a65 /Doc
parentd958d9f4a1b71c6d30960bf6c53c41046ea94590 (diff)
downloadcpython-23f2e8f13c4e4a34106cf96fad9329cbfbf8844d.zip
cpython-23f2e8f13c4e4a34106cf96fad9329cbfbf8844d.tar.gz
cpython-23f2e8f13c4e4a34106cf96fad9329cbfbf8844d.tar.bz2
gh-127221: Add colour to unittest output (#127223)
Co-authored-by: Kirill Podoprigora <kirill.bast9@mail.ru>
Diffstat (limited to 'Doc')
-rw-r--r--Doc/conf.py7
-rw-r--r--Doc/library/doctest.rst4
-rw-r--r--Doc/library/traceback.rst4
-rw-r--r--Doc/library/unittest.rst4
-rw-r--r--Doc/using/cmdline.rst8
-rw-r--r--Doc/whatsnew/3.13.rst9
-rw-r--r--Doc/whatsnew/3.14.rst7
7 files changed, 25 insertions, 18 deletions
diff --git a/Doc/conf.py b/Doc/conf.py
index 738c990..9cde394 100644
--- a/Doc/conf.py
+++ b/Doc/conf.py
@@ -78,6 +78,13 @@ rst_epilog = f"""
.. |python_version_literal| replace:: ``Python {version}``
.. |python_x_dot_y_literal| replace:: ``python{version}``
.. |usr_local_bin_python_x_dot_y_literal| replace:: ``/usr/local/bin/python{version}``
+
+.. Apparently this how you hack together a formatted link:
+ (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)
+.. |FORCE_COLOR| replace:: ``FORCE_COLOR``
+.. _FORCE_COLOR: https://force-color.org/
+.. |NO_COLOR| replace:: ``NO_COLOR``
+.. _NO_COLOR: https://no-color.org/
"""
# There are two options for replacing |today|. Either, you set today to some
diff --git a/Doc/library/doctest.rst b/Doc/library/doctest.rst
index 6b0282e..106b0a6 100644
--- a/Doc/library/doctest.rst
+++ b/Doc/library/doctest.rst
@@ -136,6 +136,10 @@ examples of doctests in the standard Python test suite and libraries.
Especially useful examples can be found in the standard test file
:file:`Lib/test/test_doctest/test_doctest.py`.
+.. versionadded:: 3.13
+ Output is colorized by default and can be
+ :ref:`controlled using environment variables <using-on-controlling-color>`.
+
.. _doctest-simple-testmod:
diff --git a/Doc/library/traceback.rst b/Doc/library/traceback.rst
index 8f94fc4..4899ed6 100644
--- a/Doc/library/traceback.rst
+++ b/Doc/library/traceback.rst
@@ -44,6 +44,10 @@ The module's API can be divided into two parts:
necessary for later formatting without holding references to actual exception
and traceback objects.
+.. versionadded:: 3.13
+ Output is colorized by default and can be
+ :ref:`controlled using environment variables <using-on-controlling-color>`.
+
Module-Level Functions
----------------------
diff --git a/Doc/library/unittest.rst b/Doc/library/unittest.rst
index 38bad94..7f8b710 100644
--- a/Doc/library/unittest.rst
+++ b/Doc/library/unittest.rst
@@ -46,7 +46,6 @@ test runner
a textual interface, or return a special value to indicate the results of
executing the tests.
-
.. seealso::
Module :mod:`doctest`
@@ -198,6 +197,9 @@ For a list of all the command-line options::
In earlier versions it was only possible to run individual test methods and
not modules or classes.
+.. versionadded:: 3.14
+ Output is colorized by default and can be
+ :ref:`controlled using environment variables <using-on-controlling-color>`.
Command-line options
~~~~~~~~~~~~~~~~~~~~
diff --git a/Doc/using/cmdline.rst b/Doc/using/cmdline.rst
index 6cf42b2..7db2f48 100644
--- a/Doc/using/cmdline.rst
+++ b/Doc/using/cmdline.rst
@@ -663,14 +663,6 @@ output. To control the color output only in the Python interpreter, the
precedence over ``NO_COLOR``, which in turn takes precedence over
``FORCE_COLOR``.
-.. Apparently this how you hack together a formatted link:
-
-.. |FORCE_COLOR| replace:: ``FORCE_COLOR``
-.. _FORCE_COLOR: https://force-color.org/
-
-.. |NO_COLOR| replace:: ``NO_COLOR``
-.. _NO_COLOR: https://no-color.org/
-
Options you shouldn't use
~~~~~~~~~~~~~~~~~~~~~~~~~
diff --git a/Doc/whatsnew/3.13.rst b/Doc/whatsnew/3.13.rst
index 664b186..9f6d98b 100644
--- a/Doc/whatsnew/3.13.rst
+++ b/Doc/whatsnew/3.13.rst
@@ -252,15 +252,6 @@ Improved error messages
the canonical |NO_COLOR|_ and |FORCE_COLOR|_ environment variables.
(Contributed by Pablo Galindo Salgado in :gh:`112730`.)
-.. Apparently this how you hack together a formatted link:
- (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)
-
-.. |FORCE_COLOR| replace:: ``FORCE_COLOR``
-.. _FORCE_COLOR: https://force-color.org/
-
-.. |NO_COLOR| replace:: ``NO_COLOR``
-.. _NO_COLOR: https://no-color.org/
-
* A common mistake is to write a script with the same name as a
standard library module. When this results in errors, we now
display a more helpful error message:
diff --git a/Doc/whatsnew/3.14.rst b/Doc/whatsnew/3.14.rst
index e83c509..db25c03 100644
--- a/Doc/whatsnew/3.14.rst
+++ b/Doc/whatsnew/3.14.rst
@@ -616,6 +616,13 @@ unicodedata
unittest
--------
+* :mod:`unittest` output is now colored by default.
+ This can be controlled via the :envvar:`PYTHON_COLORS` environment
+ variable as well as the canonical |NO_COLOR|_
+ and |FORCE_COLOR|_ environment variables.
+ See also :ref:`using-on-controlling-color`.
+ (Contributed by Hugo van Kemenade in :gh:`127221`.)
+
* unittest discovery supports :term:`namespace package` as start
directory again. It was removed in Python 3.11.
(Contributed by Jacob Walls in :gh:`80958`.)