Merge pull request #12563 from webknjaz/maintenance/hotfixes/note/12264--reraise-with-original-tb

📝🚑 Polish the PR #12264 changelog entry

.coveragerc

@@ -29,3 +29,5 @@ exclude_lines =
 
     ^\s*if TYPE_CHECKING:
     ^\s*@overload( |$)
+
+    ^\s*@pytest\.mark\.xfail

.git-blame-ignore-revs

@@ -31,3 +31,5 @@ c9df77cbd6a365dcb73c39618e4842711817e871
 4546d5445aaefe6a03957db028c263521dfb5c4b
 # Migration to ruff / ruff format
 4588653b2497ed25976b7aaff225b889fb476756
+# Use format specifiers instead of percent format
+4788165e69d08e10fc6b9c0124083fb358e2e9b0

.github/chronographer.yml

@@ -0,0 +1,20 @@
+---
+
+branch-protection-check-name: Changelog entry
+action-hints:
+  check-title-prefix: "Chronographer: "
+  external-docs-url: >-
+    https://docs.pytest.org/en/latest/contributing.html#preparing-pull-requests
+  inline-markdown: >-
+    See
+    https://docs.pytest.org/en/latest/contributing.html#preparing-pull-requests
+    for details.
+enforce-name:
+  suffix: .rst
+exclude:
+  humans:
+  - pyup-bot
+labels:
+  skip-changelog: skip news
+
+...

.github/patchback.yml

@@ -0,0 +1,7 @@
+---
+
+backport_branch_prefix: patchback/backports/
+backport_label_prefix: 'backport '  # IMPORTANT: the labels are space-delimited
+# target_branch_prefix: ''  # The project's backport branches are non-prefixed
+
+...

.github/workflows/backport.yml

@@ -1,51 +0,0 @@
-name: backport
-
-on:
-  # Note that `pull_request_target` has security implications:
-  # https://securitylab.github.com/research/github-actions-preventing-pwn-requests/
-  # In particular:
-  # - Only allow triggers that can be used only be trusted users
-  # - Don't execute any code from the target branch
-  # - Don't use cache
-  pull_request_target:
-    types: [labeled]
-
-# Set permissions at the job level.
-permissions: {}
-
-jobs:
-  backport:
-    if: startsWith(github.event.label.name, 'backport ') && github.event.pull_request.merged
-    runs-on: ubuntu-latest
-    permissions:
-      contents: write
-      pull-requests: write
-
-    steps:
-    - uses: actions/checkout@v4
-      with:
-        fetch-depth: 0
-        persist-credentials: true
-
-    - name: Create backport PR
-      run: |
-        set -eux
-
-        git config --global user.name "pytest bot"
-        git config --global user.email "pytestbot@gmail.com"
-
-        label='${{ github.event.label.name }}'
-        target_branch="${label#backport }"
-        backport_branch=backport-${{ github.event.number }}-to-"${target_branch}"
-        subject="[$target_branch] $(gh pr view --json title -q .title ${{ github.event.number }})"
-
-        git checkout origin/"${target_branch}" -b "${backport_branch}"
-        git cherry-pick -x --mainline 1 ${{ github.event.pull_request.merge_commit_sha }}
-        git commit --amend --message "$subject"
-        git push --set-upstream origin --force-with-lease "${backport_branch}"
-        gh pr create \
-          --base "${target_branch}" \
-          --title "${subject}" \
-          --body "Backport of PR #${{ github.event.number }} to $target_branch branch. PR created by backport workflow."
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/deploy.yml

@@ -19,6 +19,11 @@ jobs:
       SETUPTOOLS_SCM_PRETEND_VERSION: ${{ github.event.inputs.version }}
     timeout-minutes: 10
 
+    # Required by attest-build-provenance-github.
+    permissions:
+      id-token: write
+      attestations: write
+
     steps:
     - uses: actions/checkout@v4
       with:
@@ -26,7 +31,9 @@ jobs:
         persist-credentials: false
 
     - name: Build and Check Package
-      uses: hynek/build-and-inspect-python-package@v2.4.0
+      uses: hynek/build-and-inspect-python-package@v2.6.0
+      with:
+        attest-build-provenance-github: 'true'
 
   deploy:
     if: github.repository == 'pytest-dev/pytest'
@@ -47,7 +54,7 @@ jobs:
         path: dist
 
     - name: Publish package to PyPI
-      uses: pypa/gh-action-pypi-publish@v1.8.14
+      uses: pypa/gh-action-pypi-publish@v1.9.0
 
     - name: Push tag
       run: |

.github/workflows/test.yml

@@ -14,6 +14,11 @@ on:
     branches:
       - main
       - "[0-9]+.[0-9]+.x"
+    types:
+    - opened  # default
+    - synchronize  # default
+    - reopened  # default
+    - ready_for_review  # used in PRs created from the release workflow
 
 env:
   PYTEST_ADDOPTS: "--color=yes"
@@ -35,7 +40,7 @@ jobs:
         fetch-depth: 0
         persist-credentials: false
     - name: Build and Check Package
-      uses: hynek/build-and-inspect-python-package@v2.4.0
+      uses: hynek/build-and-inspect-python-package@v2.6.0
 
   build:
     needs: [package]
@@ -55,6 +60,7 @@ jobs:
           "windows-py310",
           "windows-py311",
           "windows-py312",
+          "windows-py313",
 
           "ubuntu-py38",
           "ubuntu-py38-pluggy",
@@ -63,12 +69,14 @@ jobs:
           "ubuntu-py310",
           "ubuntu-py311",
           "ubuntu-py312",
+          "ubuntu-py313",
           "ubuntu-pypy3",
 
           "macos-py38",
           "macos-py39",
           "macos-py310",
           "macos-py312",
+          "macos-py313",
 
           "doctesting",
           "plugins",
@@ -97,9 +105,13 @@ jobs:
             os: windows-latest
             tox_env: "py311"
           - name: "windows-py312"
-            python: "3.12-dev"
+            python: "3.12"
             os: windows-latest
             tox_env: "py312"
+          - name: "windows-py313"
+            python: "3.13-dev"
+            os: windows-latest
+            tox_env: "py313"
 
           - name: "ubuntu-py38"
             python: "3.8"
@@ -128,10 +140,15 @@ jobs:
             tox_env: "py311"
             use_coverage: true
           - name: "ubuntu-py312"
-            python: "3.12-dev"
+            python: "3.12"
             os: ubuntu-latest
             tox_env: "py312"
             use_coverage: true
+          - name: "ubuntu-py313"
+            python: "3.13-dev"
+            os: ubuntu-latest
+            tox_env: "py313"
+            use_coverage: true
           - name: "ubuntu-pypy3"
             python: "pypy-3.8"
             os: ubuntu-latest
@@ -151,9 +168,13 @@ jobs:
             os: macos-latest
             tox_env: "py310-xdist"
           - name: "macos-py312"
-            python: "3.12-dev"
+            python: "3.12"
             os: macos-latest
             tox_env: "py312-xdist"
+          - name: "macos-py313"
+            python: "3.13-dev"
+            os: macos-latest
+            tox_env: "py313-xdist"
 
           - name: "plugins"
             python: "3.12"
@@ -166,6 +187,26 @@ jobs:
             tox_env: "doctesting"
             use_coverage: true
 
+    continue-on-error: >-
+      ${{
+        contains(
+          fromJSON(
+            '[
+              "windows-py38-pluggy",
+              "windows-py313",
+              "ubuntu-py38-pluggy",
+              "ubuntu-py38-freeze",
+              "ubuntu-py313",
+              "macos-py38",
+              "macos-py313"
+            ]'
+          ),
+          matrix.name
+        )
+        && true
+        || false
+      }}
+
     steps:
     - uses: actions/checkout@v4
       with:
@@ -206,8 +247,21 @@ jobs:
     - name: Upload coverage to Codecov
       if: "matrix.use_coverage"
       uses: codecov/codecov-action@v4
-      continue-on-error: true
       with:
-        fail_ci_if_error: true
+        fail_ci_if_error: false
         files: ./coverage.xml
         verbose: true
+
+  check:  # This job does nothing and is only used for the branch protection
+    if: always()
+
+    needs:
+    - build
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Decide whether the needed jobs succeeded or failed
+      uses: re-actors/alls-green@223e4bb7a751b91f43eda76992bcfbf23b8b0302
+      with:
+        jobs: ${{ toJSON(needs) }}

.github/workflows/update-plugin-list.yml

@@ -46,7 +46,8 @@ jobs:
         run: python scripts/update-plugin-list.py
 
       - name: Create Pull Request
-        uses: peter-evans/create-pull-request@9153d834b60caba6d51c9b9510b087acf9f33f83
+        id: pr
+        uses: peter-evans/create-pull-request@c5a7806660adbe173f04e3e038b0ccdcd758773c
         with:
           commit-message: '[automated] Update plugin list'
           author: 'pytest bot <pytestbot@users.noreply.github.com>'
@@ -55,3 +56,13 @@ jobs:
           branch-suffix: short-commit-hash
           title: '[automated] Update plugin list'
           body: '[automated] Update plugin list'
+          draft: true
+
+      - name: Instruct the maintainers to trigger CI by undrafting the PR
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
+        run: >-
+          gh pr comment
+          --body 'Please mark the PR as ready for review to trigger PR checks.'
+          --repo '${{ github.repository }}'
+          '${{ steps.pr.outputs.pull-request-number }}'

.gitignore

@@ -25,7 +25,6 @@ src/_pytest/_version.py
 
 doc/*/_build
 doc/*/.doctrees
-doc/*/_changelog_towncrier_draft.rst
 build/
 dist/
 *.egg-info

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
 - repo: https://github.com/astral-sh/ruff-pre-commit
-  rev: "v0.4.1"
+  rev: "v0.4.10"
   hooks:
     - id: ruff
       args: ["--fix"]
@@ -10,12 +10,7 @@ repos:
     hooks:
     -   id: trailing-whitespace
     -   id: end-of-file-fixer
-    -   id: fix-encoding-pragma
-        args: [--remove]
     -   id: check-yaml
-    -   id: debug-statements
-        exclude: _pytest/(debugging|hookspec).py
-        language_version: python3
 -   repo: https://github.com/adamchainz/blacken-docs
     rev: 1.16.0
     hooks:
@@ -26,7 +21,7 @@ repos:
     hooks:
     -   id: python-use-type-annotations
 -   repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.9.0
+    rev: v1.10.0
     hooks:
     -   id: mypy
         files: ^(src/|testing/|scripts/)
@@ -43,20 +38,25 @@ repos:
             # on <3.11
           - exceptiongroup>=1.0.0rc8
 - repo: https://github.com/tox-dev/pyproject-fmt
-  rev: "1.8.0"
+  rev: "2.1.3"
   hooks:
     - id: pyproject-fmt
       # https://pyproject-fmt.readthedocs.io/en/latest/#calculating-max-supported-python-version
       additional_dependencies: ["tox>=4.9"]
+-   repo: https://github.com/asottile/pyupgrade
+    rev: v3.16.0
+    hooks:
+    -   id: pyupgrade
+        stages: [manual]
 -   repo: local
     hooks:
-    - id: pylint
+    -   id: pylint
-      name: pylint
+        name: pylint
-      entry: pylint
+        entry: pylint
-      language: system
+        language: system
-      types: [python]
+        types: [python]
-      args: ["-rn", "-sn", "--fail-on=I"]
+        args: ["-rn", "-sn", "--fail-on=I"]
-      stages: [manual]
+        stages: [manual]
     -   id: rst
         name: rst
         entry: rst-lint --encoding utf-8
@@ -66,9 +66,50 @@ repos:
     -   id: changelogs-rst
         name: changelog filenames
         language: fail
-        entry: 'changelog files must be named ####.(breaking|bugfix|deprecation|doc|feature|improvement|trivial|vendor).rst'
+        entry: >-
-        exclude: changelog/(\d+\.(breaking|bugfix|deprecation|doc|feature|improvement|trivial|vendor).rst|README.rst|_template.rst)
+          changelog files must be named
+          ####.(
+          breaking
+          | deprecation
+          | feature
+          | improvement
+          | bugfix
+          | vendor
+          | doc
+          | packaging
+          | contrib
+          | misc
+          )(.#)?(.rst)?
+        exclude: >-
+          (?x)
+          ^
+            changelog/(
+              \.gitignore
+              |\d+\.(
+                breaking
+                |deprecation
+                |feature
+                |improvement
+                |bugfix
+                |vendor
+                |doc
+                |packaging
+                |contrib
+                |misc
+              )(\.\d+)?(\.rst)?
+              |README\.rst
+              |_template\.rst
+            )
+          $
         files: ^changelog/
+    -   id: changelogs-user-role
+        name: Changelog files should use a non-broken :user:`name` role
+        language: pygrep
+        entry: :user:([^`]+`?|`[^`]+[\s,])
+        pass_filenames: true
+        types:
+          - file
+          - rst
     -   id: py-deprecated
         name: py library is deprecated
         language: pygrep

.readthedocs.yaml

@@ -14,11 +14,16 @@ sphinx:
   fail_on_warning: true
 
 build:
-  os: ubuntu-20.04
+  os: ubuntu-24.04
   tools:
-    python: "3.9"
+    python: >-
+      3.12
   apt_packages:
     - inkscape
+  jobs:
+    post_checkout:
+      - git fetch --unshallow || true
+      - git fetch --tags || true
 
 formats:
   - epub

AUTHORS

@@ -36,6 +36,7 @@ Andrey Paramonov
 Andrzej Klajnert
 Andrzej Ostrowski
 Andy Freeland
+Anita Hammer
 Anthon van der Neut
 Anthony Shaw
 Anthony Sottile
@@ -148,6 +149,7 @@ Evgeny Seliverstov
 Fabian Sturm
 Fabien Zarifian
 Fabio Zadrozny
+Farbod Ahmadian
 faph
 Felix Hofstätter
 Felix Nieuwenhuizen
@@ -191,6 +193,7 @@ Jake VanderPlas
 Jakob van Santen
 Jakub Mitoraj
 James Bourbeau
+James Frost
 Jan Balster
 Janne Vanhala
 Jason R. Coombs
@@ -210,6 +213,7 @@ Jordan Guymon
 Jordan Moldow
 Jordan Speicher
 Joseph Hunkeler
+Joseph Sawaya
 Josh Karpel
 Joshua Bronson
 Jurko Gospodnetić
@@ -242,6 +246,7 @@ Levon Saldamli
 Lewis Cowles
 Llandy Riveron Del Risco
 Loic Esteve
+lovetheguitar
 Lukas Bednar
 Luke Murphy
 Maciek Fijalkowski
@@ -257,6 +262,7 @@ Marc Bresson
 Marco Gorelli
 Mark Abramowitz
 Mark Dickinson
+Mark Vong
 Marko Pacak
 Markus Unterwaditzer
 Martijn Faassen
@@ -277,6 +283,7 @@ Michael Droettboom
 Michael Goerz
 Michael Krebs
 Michael Seifert
+Michael Vogt
 Michal Wajszczuk
 Michał Górny
 Michał Zięba
@@ -288,6 +295,7 @@ Mike Lundy
 Milan Lesnek
 Miro Hrončok
 mrbean-bremen
+Nathan Goldbaum
 Nathaniel Compton
 Nathaniel Waisbrot
 Ned Batchelder
@@ -297,6 +305,7 @@ Nicholas Devenish
 Nicholas Murphy
 Niclas Olofsson
 Nicolas Delaby
+Nico Vidal
 Nikolay Kondratyev
 Nipunn Koorapati
 Oleg Pidsadnyi
@@ -357,6 +366,7 @@ Sadra Barikbin
 Saiprasad Kale
 Samuel Colvin
 Samuel Dion-Girardeau
+Samuel Jirovec
 Samuel Searles-Bryant
 Samuel Therrien (Avasam)
 Samuele Pedroni
@@ -385,6 +395,7 @@ Stefano Taschini
 Steffen Allner
 Stephan Obermann
 Sven-Hendrik Haase
+Sviatoslav Sydorenko
 Sylvain Marié
 Tadek Teleżyński
 Takafumi Arakaki
@@ -419,6 +430,7 @@ Victor Rodriguez
 Victor Uriarte
 Vidar T. Fauske
 Vijay Arora
+Virendra Patil
 Virgil Dupras
 Vitaly Lashmanov
 Vivaan Verma
@@ -440,8 +452,10 @@ Yao Xiao
 Yoav Caspi
 Yuliang Shao
 Yusuke Kadowaki
+Yutian Li
 Yuval Shimon
 Zac Hatfield-Dodds
+Zach Snicker
 Zachary Kneupper
 Zachary OBrien
 Zhouxin Qiu

CONTRIBUTING.rst

@@ -1,14 +1,10 @@
 ============================
-Contribution getting started
+Contributing
 ============================
 
 Contributions are highly welcomed and appreciated.  Every little bit of help counts,
 so do not hesitate!
 
-.. contents::
-   :depth: 2
-   :backlinks: none
-
 
 .. _submitfeedback:
 
@@ -128,7 +124,7 @@ For example:
 Submitting Plugins to pytest-dev
 --------------------------------
 
-Pytest development of the core, some plugins and support code happens
+Development of the pytest core, support code, and some plugins happens
 in repositories living under the ``pytest-dev`` organisations:
 
 - `pytest-dev on GitHub <https://github.com/pytest-dev>`_

bench/bench.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import sys
 
 
@@ -8,7 +10,7 @@ if __name__ == "__main__":
     import pytest  # noqa: F401
 
     script = sys.argv[1:] if len(sys.argv) > 1 else ["empty.py"]
-    cProfile.run("pytest.cmdline.main(%r)" % script, "prof")
+    cProfile.run(f"pytest.cmdline.main({script!r})", "prof")
     p = pstats.Stats("prof")
     p.strip_dirs()
     p.sort_stats("cumulative")

bench/bench_argcomplete.py

@@ -2,6 +2,8 @@
 #                      2.7.5     3.3.2
 # FilesCompleter       75.1109   69.2116
 # FastFilesCompleter    0.7383    1.0760
+from __future__ import annotations
+
 import timeit
 
 

bench/empty.py

@@ -1,2 +1,5 @@
+from __future__ import annotations
+
+
 for i in range(1000):
     exec("def test_func_%d(): pass" % i)

bench/manyparam.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import pytest
 
 

bench/skip.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import pytest
 
 

bench/unit_test.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from unittest import TestCase  # noqa: F401
 
 

bench/xunit.py

@@ -1,3 +1,6 @@
+from __future__ import annotations
+
+
 for i in range(5000):
     exec(
         f"""

changelog/.gitignore

@@ -0,0 +1,34 @@
+*
+!.gitignore
+!_template.rst
+!README.rst
+!*.bugfix
+!*.bugfix.rst
+!*.bugfix.*.rst
+!*.breaking
+!*.breaking.rst
+!*.breaking.*.rst
+!*.contrib
+!*.contrib.rst
+!*.contrib.*.rst
+!*.deprecation
+!*.deprecation.rst
+!*.deprecation.*.rst
+!*.doc
+!*.doc.rst
+!*.doc.*.rst
+!*.feature
+!*.feature.rst
+!*.feature.*.rst
+!*.improvement
+!*.improvement.rst
+!*.improvement.*.rst
+!*.misc
+!*.misc.rst
+!*.misc.*.rst
+!*.packaging
+!*.packaging.rst
+!*.packaging.*.rst
+!*.vendor
+!*.vendor.rst
+!*.vendor.*.rst

changelog/11523.improvement.rst

@@ -1,5 +0,0 @@
-:func:`pytest.importorskip` will now issue a warning if the module could be found, but raised :class:`ImportError` instead of :class:`ModuleNotFoundError`.
-
-The warning can be suppressed by passing ``exc_type=ImportError`` to :func:`pytest.importorskip`.
-
-See :ref:`import-or-skip-import-error` for details.

changelog/11706.bugfix.rst

@@ -0,0 +1,4 @@
+Fix reporting of teardown errors in higher-scoped fixtures when using `--maxfail` or `--stepwise`.
+
+Originally added in pytest 8.0.0, but reverted in 8.0.2 due to a regression in pytest-xdist.
+This regression was fixed in pytest-xdist 3.6.1.

changelog/11728.improvement.rst

@@ -1 +0,0 @@
-For ``unittest``-based tests, exceptions during class cleanup (as raised by functions registered with :meth:`TestCase.addClassCleanup <unittest.TestCase.addClassCleanup>`) are now reported instead of silently failing.

changelog/11777.improvement.rst

@@ -1 +0,0 @@
-Text is no longer truncated in the ``short test summary info`` section when ``-vv`` is given.

changelog/11797.bugfix.rst

@@ -0,0 +1 @@
+:func:`pytest.approx` now correctly handles :class:`Sequence <collections.abc.Sequence>`-like objects.

changelog/11871.feature.rst

@@ -1 +0,0 @@
-Added support for reading command line arguments from a file using the prefix character ``@``, like e.g.: ``pytest @tests.txt``. The file must have one argument per line.

changelog/12065.bugfix.rst

@@ -1,4 +0,0 @@
-Fixed a regression in pytest 8.0.0 where test classes containing ``setup_method`` and tests using ``@staticmethod`` or ``@classmethod`` would crash with ``AttributeError: 'NoneType' object has no attribute 'setup_method'``.
-
-Now the :attr:`request.instance <pytest.FixtureRequest.instance>` attribute of tests using ``@staticmethod`` and ``@classmethod`` is no longer ``None``, but a fresh instance of the class, like in non-static methods.
-Previously it was ``None``, and all fixtures of such tests would share a single ``self``.

changelog/12069.deprecation.rst

@@ -1,12 +0,0 @@
-A deprecation warning is now raised when implementations of one of the following hooks request a deprecated ``py.path.local`` parameter instead of the ``pathlib.Path`` parameter which replaced it:
-
-- :hook:`pytest_ignore_collect` - the ``path`` parameter - use ``collection_path`` instead.
-- :hook:`pytest_collect_file` - the ``path`` parameter - use ``file_path`` instead.
-- :hook:`pytest_pycollect_makemodule` - the ``path`` parameter - use ``module_path`` instead.
-- :hook:`pytest_report_header` - the ``startdir`` parameter - use ``start_path`` instead.
-- :hook:`pytest_report_collectionfinish` - the ``startdir`` parameter - use ``start_path`` instead.
-
-The replacement parameters are available since pytest 7.0.0.
-The old parameters will be removed in pytest 9.0.0.
-
-See :ref:`legacy-path-hooks-deprecated` for more details.

changelog/12069.trivial.rst

@@ -1 +0,0 @@
-``pluggy>=1.5.0`` is now required.

changelog/12112.improvement.rst

@@ -1 +0,0 @@
-Improve namespace packages detection when :confval:`consider_namespace_packages` is enabled, covering more situations (like editable installs).

changelog/12135.bugfix.rst

@@ -1 +0,0 @@
-Fix fixtures adding their finalizer multiple times to fixtures they request, causing unreliable and non-intuitive teardown ordering in some instances.

changelog/12153.doc.rst

@@ -0,0 +1 @@
+Documented using :envvar:`PYTEST_VERSION` to detect if code is running from within a pytest run.

changelog/12167.trivial.rst

@@ -1 +0,0 @@
-cache: create cache directory supporting files (``CACHEDIR.TAG``, ``.gitignore``, etc.) in a temporary directory to provide atomic semantics.

changelog/12194.bugfix.rst

@@ -1 +0,0 @@
-Fixed a bug with ``--importmode=importlib`` and ``--doctest-modules`` where child modules did not appear as attributes in parent modules.

changelog/12204.bugfix.rst

@@ -0,0 +1,11 @@
+Fixed a regression in pytest 8.0 where tracebacks get longer and longer when multiple
+tests fail due to a shared higher-scope fixture which raised -- by :user:`bluetech`.
+
+Also fixed a similar regression in pytest 5.4 for collectors which raise during setup.
+
+The fix necessitated internal changes which may affect some plugins:
+
+* ``FixtureDef.cached_result[2]`` is now a tuple ``(exc, tb)``
+  instead of ``exc``.
+* ``SetupState.stack`` failures are now a tuple ``(exc, tb)``
+  instead of ``exc``.

changelog/12231.feature.rst

@@ -0,0 +1,11 @@
+Added `--xfail-tb` flag, which turns on traceback output for XFAIL results.
+
+* If the `--xfail-tb` flag is not sent, tracebacks for XFAIL results are NOT shown.
+* The style of traceback for XFAIL is set with `--tb`, and can be `auto|long|short|line|native|no`.
+* Note: Even if you have `--xfail-tb` set, you won't see them if `--tb=no`.
+
+Some history:
+
+With pytest 8.0, `-rx` or `-ra` would not only turn on summary reports for xfail, but also report the tracebacks for xfail results. This caused issues with some projects that utilize xfail, but don't want to see all of the xfail tracebacks.
+
+This change detaches xfail tracebacks from `-rx`, and now we turn on xfail tracebacks with `--xfail-tb`. With this, the default `-rx`/ `-ra` behavior is identical to pre-8.0 with respect to xfail tracebacks. While this is a behavior change, it brings default behavior back to pre-8.0.0 behavior, which ultimately was considered the better course of action.

changelog/12264.bugfix.rst

@@ -0,0 +1 @@
+12204.bugfix.rst

changelog/12275.bugfix.rst

@@ -0,0 +1 @@
+Fix collection error upon encountering an :mod:`abstract <abc>` class, including abstract `unittest.TestCase` subclasses.

changelog/12281.feature.rst

@@ -0,0 +1,8 @@
+Added support for keyword matching in marker expressions.
+
+Now tests can be selected by marker keyword arguments.
+Supported values are :class:`int`, (unescaped) :class:`str`, :class:`bool` & :data:`None`.
+
+See :ref:`marker examples <marker_keyword_expression_example>` for more information.
+
+-- by :user:`lovetheguitar`

changelog/12328.bugfix.rst

@@ -0,0 +1 @@
+Fix a regression in pytest 8.0.0 where package-scoped parameterized items were not correctly reordered to minimize setups/teardowns in some cases.

changelog/12424.bugfix.rst

@@ -0,0 +1 @@
+Fix crash with `assert testcase is not None` assertion failure when re-running unittest tests using plugins like pytest-rerunfailures. Regressed in 8.2.2.

changelog/12467.improvement.rst

@@ -0,0 +1,3 @@
+Migrated all internal type-annotations to the python3.10+ style by using the `annotations` future import.
+
+-- by :user:`RonnyPfannschmidt`

changelog/12469.doc.rst

@@ -0,0 +1,6 @@
+The external plugin mentions in the documentation now avoid mentioning
+:std:doc:`setuptools entry-points <setuptools:index>` as the concept is
+much more generic nowadays. Instead, the terminology of "external",
+"installed", or "third-party" plugins (or packages) replaces that.
+
+-- by :user:`webknjaz`

changelog/12469.improvement.rst

@@ -0,0 +1,4 @@
+The console output now uses the "third-party plugins" terminology,
+replacing the previously established but confusing and outdated
+reference to :std:doc:`setuptools <setuptools:index>`
+-- by :user:`webknjaz`.

changelog/12472.bugfix.rst

@@ -0,0 +1 @@
+Fixed a crash when returning category ``"error"`` or ``"failed"`` with a custom test status from :hook:`pytest_report_teststatus` hook -- :user:`pbrezina`.

changelog/12493.contrib.rst

@@ -0,0 +1,13 @@
+The change log draft preview integration has been refactored to use a
+third party extension ``sphinxcontib-towncrier``. The previous in-repo
+script was putting the change log preview file at
+:file:`doc/en/_changelog_towncrier_draft.rst`. Said file is no longer
+ignored in Git and might show up among untracked files in the
+development environments of the contributors. To address that, the
+contributors can run the following command that will clean it up:
+
+.. code-block:: console
+
+   $ git clean -x -i -- doc/en/_changelog_towncrier_draft.rst
+
+-- by :user:`webknjaz`

changelog/12498.contrib.rst

@@ -0,0 +1,5 @@
+All the undocumented ``tox`` environments now have descriptions.
+They can be listed in one's development environment by invoking
+``tox -av`` in a terminal.
+
+-- by :user:`webknjaz`

changelog/12501.contrib.rst

@@ -0,0 +1,11 @@
+The changelog configuration has been updated to introduce more accurate
+audience-tailored categories. Previously, there was a ``trivial``
+change log fragment type with an unclear and broad meaning. It was
+removed and we now have ``contrib``, ``misc`` and ``packaging`` in
+place of it.
+
+The new change note types target the readers who are downstream
+packagers and project contributors. Additionally, the miscellaneous
+section is kept for unspecified updates that do not fit anywhere else.
+
+-- by :user:`webknjaz`

changelog/12502.contrib.rst

@@ -0,0 +1,7 @@
+The UX of the GitHub automation making pull requests to update the
+plugin list has been updated. Previously, the maintainers had to close
+the automatically created pull requests and re-open them to trigger the
+CI runs. From now on, they only need to click the `Ready for review`
+button instead.
+
+-- by :user:`webknjaz`

changelog/12505.bugfix.rst

@@ -0,0 +1 @@
+Improve handling of invalid regex patterns in :func:`pytest.raises(match=r'...') <pytest.raises>` by providing a clear error message.

changelog/12522.contrib.rst

@@ -0,0 +1,4 @@
+The ``:pull:`` RST role has been replaced with a shorter
+``:pr:`` due to starting to use the implementation from
+the third-party :pypi:`sphinx-issues` Sphinx extension
+-- by :user:`webknjaz`.

changelog/12531.contrib.rst

@@ -0,0 +1,6 @@
+The coverage reporting configuration has been updated to exclude
+pytest's own tests marked as expected to fail from the coverage
+report. This has an effect of reducing the influence of flaky
+tests on the resulting number.
+
+-- by :user:`webknjaz`

changelog/12533.contrib.rst

@@ -0,0 +1,7 @@
+The ``extlinks`` Sphinx extension is no longer enabled. The ``:bpo:``
+role it used to declare has been removed with that. BPO itself has
+migrated to GitHub some years ago and it is possible to link the
+respective issues by using their GitHub issue numbers and the
+``:issue:`` role that the ``sphinx-issues`` extension implements.
+
+-- by :user:`webknjaz`

changelog/12544.improvement.rst

@@ -0,0 +1,3 @@
+The ``_in_venv()`` function now detects Python virtual environments by
+checking for a :file:`pyvenv.cfg` file, ensuring reliable detection on
+various platforms -- by :user:`zachsnickers`.

changelog/12545.improvement.rst

@@ -0,0 +1 @@
+12544.improvement.rst

changelog/12562.contrib.rst

@@ -0,0 +1,2 @@
+Possible typos in using the ``:user:`` RST role is now being linted
+through the pre-commit tool integration -- by :user:`webknjaz`.

changelog/1489.bugfix.rst

@@ -1 +0,0 @@
-Fix some instances where teardown of higher-scoped fixtures was not happening in the reverse order they were initialized in.

changelog/2871.improvement.rst

@@ -0,0 +1 @@
+Do not truncate arguments to functions in output when running with `-vvv`.

changelog/389.improvement.rst

@@ -0,0 +1,38 @@
+The readability of assertion introspection of bound methods has been enhanced
+-- by :user:`farbodahm`, :user:`webknjaz`, :user:`obestwalter`, :user:`flub`
+and :user:`glyphack`.
+
+Earlier, it was like:
+
+.. code-block:: console
+
+    =================================== FAILURES ===================================
+    _____________________________________ test _____________________________________
+
+        def test():
+    >       assert Help().fun() == 2
+    E       assert 1 == 2
+    E        +  where 1 = <bound method Help.fun of <example.Help instance at 0x256a830>>()
+    E        +    where <bound method Help.fun of <example.Help instance at 0x256a830>> = <example.Help instance at 0x256a830>.fun
+    E        +      where <example.Help instance at 0x256a830> = Help()
+
+    example.py:7: AssertionError
+    =========================== 1 failed in 0.03 seconds ===========================
+
+
+And now it's like:
+
+.. code-block:: console
+
+    =================================== FAILURES ===================================
+    _____________________________________ test _____________________________________
+
+        def test():
+    >       assert Help().fun() == 2
+    E       assert 1 == 2
+    E        +  where 1 = fun()
+    E        +    where fun = <test_local.Help object at 0x1074be230>.fun
+    E        +      where <test_local.Help object at 0x1074be230> = Help()
+
+    test_local.py:13: AssertionError
+    =========================== 1 failed in 0.03 seconds ===========================

changelog/7166.bugfix.rst

@@ -0,0 +1 @@
+Fixed progress percentages (the ``[ 87%]`` at the edge of the screen) sometimes not aligning correctly when running with pytest-xdist ``-n``.

changelog/7662.improvement.rst

@@ -0,0 +1 @@
+Added timezone information to the testsuite timestamp in the JUnit XML report.

changelog/9502.improvement.rst

@@ -1 +0,0 @@
-Added :envvar:`PYTEST_VERSION` environment variable which is defined at the start of the pytest session and undefined afterwards. It contains the value of ``pytest.__version__``, and among other things can be used to easily check if code is running from within a pytest run.

changelog/README.rst

@@ -20,10 +20,22 @@ Each file should be named like ``<ISSUE>.<TYPE>.rst``, where
 * ``deprecation``: feature deprecation.
 * ``breaking``: a change which may break existing suites, such as feature removal or behavior change.
 * ``vendor``: changes in packages vendored in pytest.
-* ``trivial``: fixing a small typo or internal change that might be noteworthy.
+* ``packaging``: notes for downstreams about unobvious side effects
+  and tooling. changes in the test invocation considerations and
+  runtime assumptions.
+* ``contrib``: stuff that affects the contributor experience. e.g.
+  Running tests, building the docs, setting up the development
+  environment.
+* ``misc``: changes that are hard to assign to any of the above
+  categories.
 
 So for example: ``123.feature.rst``, ``456.bugfix.rst``.
 
+.. tip::
+
+   See :file:`pyproject.toml` for all available categories
+   (``tool.towncrier.type``).
+
 If your PR fixes an issue, use that number here. If there is no issue,
 then after you submit the PR and get the PR number you can add a
 changelog using that instead.

codecov.yml

@@ -1,4 +1,9 @@
 # reference: https://docs.codecov.io/docs/codecovyml-reference
+---
+
+codecov:
+  token: 1eca3b1f-31a2-4fb8-a8c3-138b441b50a7 #repo token
+
 coverage:
   status:
     patch: true

doc/en/_templates/sidebar/brand.html

@@ -0,0 +1,7 @@
+<style>
+    .logo {text-align: center;}
+</style>
+
+<a class="logo" href="{{ pathto('contents') }}">
+    <img src="{{ pathto('_static/pytest1.png', 1) }}" width="70%" height="70%" text="Pytest Logo"/>
+</a>

doc/en/_templates/slim_searchbox.html

@@ -1,14 +0,0 @@
-{#
-    basic/searchbox.html with heading removed.
-#}
-{%- if pagename != "search" and builder != "singlehtml" %}
-<div id="searchbox" style="display: none" role="search">
-  <div class="searchformwrapper">
-    <form class="search" action="{{ pathto('search') }}" method="get">
-      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
-      <input type="submit" value="{{ _('Go') }}" />
-    </form>
-  </div>
-</div>
-<script>document.getElementById('searchbox').style.display = "block"</script>
-{%- endif %}

doc/en/_templates/style.html

@@ -0,0 +1,7 @@
+<style>
+    ul {list-style: none;}
+    li {margin: 0.4em 0;}
+    @media (min-width: 46em) {
+        #features {width: 50%;}
+    }
+</style>

doc/en/announce/index.rst

@@ -6,6 +6,9 @@ Release announcements
    :maxdepth: 2
 
 
+   release-8.2.2
+   release-8.2.1
+   release-8.2.0
    release-8.1.2
    release-8.1.1
    release-8.1.0

doc/en/announce/release-2.0.0.rst

@@ -62,7 +62,7 @@ New Features
 - new "-q" option which decreases verbosity and prints a more
   nose/unittest-style "dot" output.
 
-- many many more detailed improvements details
+- many, many, more detailed improvements details
 
 Fixes
 -----------------------
@@ -109,7 +109,7 @@ Important Notes
     in conftest.py files.  They will cause nothing special.
   - removed support for calling the pre-1.0 collection API of "run()" and "join"
   - removed reading option values from conftest.py files or env variables.
-    This can now be done much much better and easier through the ini-file
+    This can now be done much, much, better and easier through the ini-file
     mechanism and the "addopts" entry in particular.
   - removed the "disabled" attribute in test classes.  Use the skipping
     and pytestmark mechanism to skip or xfail a test class.

doc/en/announce/release-2.2.2.rst

@@ -4,7 +4,7 @@ pytest-2.2.2: bug fixes
 pytest-2.2.2 (updated to 2.2.3 to fix packaging issues) is a minor
 backward-compatible release of the versatile py.test testing tool.   It
 contains bug fixes and a few refinements particularly to reporting with
-"--collectonly", see below for betails.
+"--collectonly", see below for details.
 
 For general information see here:
 

doc/en/announce/release-2.4.0.rst

@@ -181,7 +181,7 @@ Bug fixes:
   partially failed (finalizers would not always be called before)
 
 - fix issue320 - fix class scope for fixtures when mixed with
-  module-level functions.  Thanks Anatloy Bubenkoff.
+  module-level functions.  Thanks Anatoly Bubenkoff.
 
 - you can specify "-q" or "-qq" to get different levels of "quieter"
   reporting (thanks Katarzyna Jachim)

doc/en/announce/release-2.5.0.rst

@@ -83,7 +83,7 @@ holger krekel
   Thanks Ralph Schmitt for the precise failure example.
 
 - fix issue244 by implementing special index for parameters to only use
-  indices for paramentrized test ids
+  indices for parametrized test ids
 
 - fix issue287 by running all finalizers but saving the exception
   from the first failing finalizer and re-raising it so teardown will

doc/en/announce/release-2.6.0.rst

@@ -73,7 +73,7 @@ holger krekel
 - cleanup setup.py a bit and specify supported versions. Thanks Jurko
   Gospodnetic for the PR.
 
-- change XPASS colour to yellow rather then red when tests are run
+- change XPASS colour to yellow rather than red when tests are run
   with -v.
 
 - fix issue473: work around mock putting an unbound method into a class

doc/en/announce/release-2.7.0.rst

@@ -55,7 +55,7 @@ holger krekel
   github.  See https://pytest.org/en/stable/contributing.html .
   Thanks to Anatoly for pushing and initial work on this.
 
-- fix issue650: new option ``--docttest-ignore-import-errors`` which
+- fix issue650: new option ``--doctest-ignore-import-errors`` which
   will turn import errors in doctests into skips.  Thanks Charles Cloud
   for the complete PR.
 

doc/en/announce/release-2.9.0.rst

@@ -45,7 +45,7 @@ The py.test Development Team
 **New Features**
 
 * New ``pytest.mark.skip`` mark, which unconditionally skips marked tests.
-  Thanks :user:`MichaelAquilina` for the complete PR (:pull:`1040`).
+  Thanks :user:`MichaelAquilina` for the complete PR (:pr:`1040`).
 
 * ``--doctest-glob`` may now be passed multiple times in the command-line.
   Thanks :user:`jab` and :user:`nicoddemus` for the PR.

doc/en/announce/release-2.9.1.rst

@@ -44,7 +44,7 @@ The py.test Development Team
   Thanks :user:`nicoddemus` for the PR.
 
 * Fix (:issue:`469`): junit parses report.nodeid incorrectly, when params IDs
-  contain ``::``. Thanks :user:`tomviner` for the PR (:pull:`1431`).
+  contain ``::``. Thanks :user:`tomviner` for the PR (:pr:`1431`).
 
 * Fix (:issue:`578`): SyntaxErrors
   containing non-ascii lines at the point of failure generated an internal

doc/en/announce/release-2.9.2.rst

@@ -44,14 +44,14 @@ The py.test Development Team
 
 * Fix Xfail does not work with condition keyword argument.
   Thanks :user:`astraw38` for reporting the issue (:issue:`1496`) and :user:`tomviner`
-  for PR the (:pull:`1524`).
+  for PR the (:pr:`1524`).
 
 * Fix win32 path issue when putting custom config file with absolute path
   in ``pytest.main("-c your_absolute_path")``.
 
 * Fix maximum recursion depth detection when raised error class is not aware
   of unicode/encoded bytes.
-  Thanks :user:`prusse-martin` for the PR (:pull:`1506`).
+  Thanks :user:`prusse-martin` for the PR (:pr:`1506`).
 
 * Fix ``pytest.mark.skip`` mark when used in strict mode.
   Thanks :user:`pquentin` for the PR and :user:`RonnyPfannschmidt` for

doc/en/announce/release-8.2.0.rst

@@ -0,0 +1,43 @@
+pytest-8.2.0
+=======================================
+
+The pytest team is proud to announce the 8.2.0 release!
+
+This release contains new features, improvements, and bug fixes,
+the full list of changes is available in the changelog:
+
+    https://docs.pytest.org/en/stable/changelog.html
+
+For complete documentation, please visit:
+
+    https://docs.pytest.org/en/stable/
+
+As usual, you can upgrade from PyPI via:
+
+    pip install -U pytest
+
+Thanks to all of the contributors to this release:
+
+* Bruno Oliveira
+* Daniel Miller
+* Florian Bruhin
+* HolyMagician03-UMich
+* John Litborn
+* Levon Saldamli
+* Linghao Zhang
+* Manuel López-Ibáñez
+* Pierre Sassoulas
+* Ran Benita
+* Ronny Pfannschmidt
+* Sebastian Meyer
+* Shekhar verma
+* Tamir Duberstein
+* Tobias Stoeckmann
+* dj
+* jakkdl
+* poulami-sau
+* tserg
+
+
+Happy testing,
+The pytest Development Team

doc/en/announce/release-8.2.1.rst

@@ -0,0 +1,19 @@
+pytest-8.2.1
+=======================================
+
+pytest 8.2.1 has just been released to PyPI.
+
+This is a bug-fix release, being a drop-in replacement. To upgrade::
+
+  pip install --upgrade pytest
+
+The full changelog is available at https://docs.pytest.org/en/stable/changelog.html.
+
+Thanks to all of the contributors to this release:
+
+* Bruno Oliveira
+* Ran Benita
+
+
+Happy testing,
+The pytest Development Team

doc/en/announce/release-8.2.2.rst

@@ -0,0 +1,19 @@
+pytest-8.2.2
+=======================================
+
+pytest 8.2.2 has just been released to PyPI.
+
+This is a bug-fix release, being a drop-in replacement. To upgrade::
+
+  pip install --upgrade pytest
+
+The full changelog is available at https://docs.pytest.org/en/stable/changelog.html.
+
+Thanks to all of the contributors to this release:
+
+* Bruno Oliveira
+* Ran Benita
+
+
+Happy testing,
+The pytest Development Team

doc/en/announce/sprint2016.rst

@@ -49,7 +49,7 @@ place on 20th, 21st, 22nd, 24th and 25th. On the 23rd we took a break
 day for some hot hiking in the Black Forest.
 
 Sprint activity was organised heavily around pairing, with plenty of group
-discusssions to take advantage of the high bandwidth, and lightning talks
+discussions to take advantage of the high bandwidth, and lightning talks
 as well.
 
 

doc/en/backwards-compatibility.rst

@@ -5,30 +5,26 @@ Backwards Compatibility Policy
 
 .. versionadded: 6.0
 
-pytest is actively evolving and is a project that has been decades in the making,
+Pytest is an actively evolving project that has been decades in the making.
-we keep learning about new and better structures to express different details about testing.
+We keep learning about new and better structures to express different details about testing.
 
-While we implement those modifications we try to ensure an easy transition and don't want to impose unnecessary churn on our users and community/plugin authors.
+While we implement those modifications, we try to ensure an easy transition and don't want to impose unnecessary churn on our users and community/plugin authors.
 
 As of now, pytest considers multiple types of backward compatibility transitions:
 
-a) trivial: APIs which trivially translate to the new mechanism,
+a) trivial: APIs that trivially translate to the new mechanism and do not cause problematic changes.
-   and do not cause problematic changes.
 
-   We try to support those indefinitely while encouraging users to switch to newer/better mechanisms through documentation.
+   We try to support those indefinitely while encouraging users to switch to newer or better mechanisms through documentation.
 
-b) transitional: the old and new API don't conflict
+b) transitional: the old and new APIs don't conflict, and we can help users transition by using warnings while supporting both for a prolonged period of time.
-   and we can help users transition by using warnings, while supporting both for a prolonged time.
 
-   We will only start the removal of deprecated functionality in major releases (e.g. if we deprecate something in 3.0 we will start to remove it in 4.0), and keep it around for at least two minor releases (e.g. if we deprecate something in 3.9 and 4.0 is the next release, we start to remove it in 5.0, not in 4.0).
+   We will only start the removal of deprecated functionality in major releases (e.g., if we deprecate something in 3.0, we will start to remove it in 4.0), and keep it around for at least two minor releases (e.g., if we deprecate something in 3.9 and 4.0 is the next release, we start to remove it in 5.0, not in 4.0).
 
    A deprecated feature scheduled to be removed in major version X will use the warning class `PytestRemovedInXWarning` (a subclass of :class:`~pytest.PytestDeprecationWarning`).
 
-   When the deprecation expires (e.g. 4.0 is released), we won't remove the deprecated functionality immediately, but will use the standard warning filters to turn `PytestRemovedInXWarning` (e.g. `PytestRemovedIn4Warning`) into **errors** by default. This approach makes it explicit that removal is imminent, and still gives you time to turn the deprecated feature into a warning instead of an error so it can be dealt with in your own time. In the next minor release (e.g. 4.1), the feature will be effectively removed.
+   When the deprecation expires (e.g., 4.0 is released), we won't remove the deprecated functionality immediately but will use the standard warning filters to turn `PytestRemovedInXWarning` (e.g., `PytestRemovedIn4Warning`) into **errors** by default. This approach makes it explicit that removal is imminent and still gives you time to turn the deprecated feature into a warning instead of an error so it can be dealt with in your own time. In the next minor release (e.g., 4.1), the feature will be effectively removed.
 
-
+c) True breakage should only be considered when a normal transition is unreasonably unsustainable and would offset important developments or features by years. In addition, they should be limited to APIs where the number of actual users is very small (for example, only impacting some plugins) and can be coordinated with the community in advance.
-c) true breakage: should only be considered when normal transition is unreasonably unsustainable and would offset important development/features by years.
-   In addition, they should be limited to APIs where the number of actual users is very small (for example only impacting some plugins), and can be coordinated with the community in advance.
 
    Examples for such upcoming changes:
 
@@ -62,11 +58,11 @@ Focus primary on smooth transition - stance (pre 6.0)
 
 Keeping backwards compatibility has a very high priority in the pytest project. Although we have deprecated functionality over the years, most of it is still supported. All deprecations in pytest were done because simpler or more efficient ways of accomplishing the same tasks have emerged, making the old way of doing things unnecessary.
 
-With the pytest 3.0 release we introduced a clear communication scheme for when we will actually remove the old busted joint and politely ask you to use the new hotness instead, while giving you enough time to adjust your tests or raise concerns if there are valid reasons to keep deprecated functionality around.
+With the pytest 3.0 release, we introduced a clear communication scheme for when we will actually remove the old busted joint and politely ask you to use the new hotness instead, while giving you enough time to adjust your tests or raise concerns if there are valid reasons to keep deprecated functionality around.
 
-To communicate changes we issue deprecation warnings using a custom warning hierarchy (see :ref:`internal-warnings`). These warnings may be suppressed using the standard means: ``-W`` command-line flag or ``filterwarnings`` ini options (see :ref:`warnings`), but we suggest to use these sparingly and temporarily, and heed the warnings when possible.
+To communicate changes, we issue deprecation warnings using a custom warning hierarchy (see :ref:`internal-warnings`). These warnings may be suppressed using the standard means: ``-W`` command-line flag or ``filterwarnings`` ini options (see :ref:`warnings`), but we suggest to use these sparingly and temporarily, and heed the warnings when possible.
 
-We will only start the removal of deprecated functionality in major releases (e.g. if we deprecate something in 3.0 we will start to remove it in 4.0), and keep it around for at least two minor releases (e.g. if we deprecate something in 3.9 and 4.0 is the next release, we start to remove it in 5.0, not in 4.0).
+We will only start the removal of deprecated functionality in major releases (e.g. if we deprecate something in 3.0, we will start to remove it in 4.0), and keep it around for at least two minor releases (e.g. if we deprecate something in 3.9 and 4.0 is the next release, we start to remove it in 5.0, not in 4.0).
 
 When the deprecation expires (e.g. 4.0 is released), we won't remove the deprecated functionality immediately, but will use the standard warning filters to turn them into **errors** by default. This approach makes it explicit that removal is imminent, and still gives you time to turn the deprecated feature into a warning instead of an error so it can be dealt with in your own time. In the next minor release (e.g. 4.1), the feature will be effectively removed.
 

doc/en/builtin.rst

@@ -22,7 +22,7 @@ For information about fixtures, see :ref:`fixtures`. To see a complete list of a
     cachedir: .pytest_cache
     rootdir: /home/sweet/project
     collected 0 items
-    cache -- .../_pytest/cacheprovider.py:527
+    cache -- .../_pytest/cacheprovider.py:560
         Return a cache object that can persist state between testing sessions.
 
         cache.get(key, default)
@@ -33,7 +33,7 @@ For information about fixtures, see :ref:`fixtures`. To see a complete list of a
 
         Values can be any object handled by the json stdlib module.
 
-    capsysbinary -- .../_pytest/capture.py:1008
+    capsysbinary -- .../_pytest/capture.py:1003
         Enable bytes capturing of writes to ``sys.stdout`` and ``sys.stderr``.
 
         The captured output is made available via ``capsysbinary.readouterr()``
@@ -50,7 +50,7 @@ For information about fixtures, see :ref:`fixtures`. To see a complete list of a
                 captured = capsysbinary.readouterr()
                 assert captured.out == b"hello\n"
 
-    capfd -- .../_pytest/capture.py:1035
+    capfd -- .../_pytest/capture.py:1030
         Enable text capturing of writes to file descriptors ``1`` and ``2``.
 
         The captured output is made available via ``capfd.readouterr()`` method
@@ -67,7 +67,7 @@ For information about fixtures, see :ref:`fixtures`. To see a complete list of a
                 captured = capfd.readouterr()
                 assert captured.out == "hello\n"
 
-    capfdbinary -- .../_pytest/capture.py:1062
+    capfdbinary -- .../_pytest/capture.py:1057
         Enable bytes capturing of writes to file descriptors ``1`` and ``2``.
 
         The captured output is made available via ``capfd.readouterr()`` method
@@ -84,7 +84,7 @@ For information about fixtures, see :ref:`fixtures`. To see a complete list of a
                 captured = capfdbinary.readouterr()
                 assert captured.out == b"hello\n"
 
-    capsys -- .../_pytest/capture.py:981
+    capsys -- .../_pytest/capture.py:976
         Enable text capturing of writes to ``sys.stdout`` and ``sys.stderr``.
 
         The captured output is made available via ``capsys.readouterr()`` method
@@ -101,7 +101,7 @@ For information about fixtures, see :ref:`fixtures`. To see a complete list of a
                 captured = capsys.readouterr()
                 assert captured.out == "hello\n"
 
-    doctest_namespace [session scope] -- .../_pytest/doctest.py:737
+    doctest_namespace [session scope] -- .../_pytest/doctest.py:738
         Fixture that returns a :py:class:`dict` that will be injected into the
         namespace of doctests.
 
@@ -115,7 +115,7 @@ For information about fixtures, see :ref:`fixtures`. To see a complete list of a
 
         For more details: :ref:`doctest_namespace`.
 
-    pytestconfig [session scope] -- .../_pytest/fixtures.py:1346
+    pytestconfig [session scope] -- .../_pytest/fixtures.py:1338
         Session-scoped fixture that returns the session's :class:`pytest.Config`
         object.
 
@@ -125,7 +125,7 @@ For information about fixtures, see :ref:`fixtures`. To see a complete list of a
                 if pytestconfig.getoption("verbose") > 0:
                     ...
 
-    record_property -- .../_pytest/junitxml.py:283
+    record_property -- .../_pytest/junitxml.py:284
         Add extra properties to the calling test.
 
         User properties become part of the test report and are available to the
@@ -139,13 +139,13 @@ For information about fixtures, see :ref:`fixtures`. To see a complete list of a
             def test_function(record_property):
                 record_property("example_key", 1)
 
-    record_xml_attribute -- .../_pytest/junitxml.py:306
+    record_xml_attribute -- .../_pytest/junitxml.py:307
         Add extra xml attributes to the tag for the calling test.
 
         The fixture is callable with ``name, value``. The value is
         automatically XML-encoded.
 
-    record_testsuite_property [session scope] -- .../_pytest/junitxml.py:344
+    record_testsuite_property [session scope] -- .../_pytest/junitxml.py:345
         Record a new ``<property>`` tag as child of the root ``<testsuite>``.
 
         This is suitable to writing global information regarding the entire test
@@ -192,7 +192,7 @@ For information about fixtures, see :ref:`fixtures`. To see a complete list of a
 
         .. _legacy_path: https://py.readthedocs.io/en/latest/path.html
 
-    caplog -- .../_pytest/logging.py:601
+    caplog -- .../_pytest/logging.py:602
         Access and control log capturing.
 
         Captured logs are available through the following properties/methods::
@@ -203,7 +203,7 @@ For information about fixtures, see :ref:`fixtures`. To see a complete list of a
         * caplog.record_tuples   -> list of (logger_name, level, message) tuples
         * caplog.clear()         -> clear captured records and formatted log output string
 
-    monkeypatch -- .../_pytest/monkeypatch.py:32
+    monkeypatch -- .../_pytest/monkeypatch.py:33
         A convenient fixture for monkey-patching.
 
         The fixture provides these methods to modify objects, dictionaries, or
@@ -227,16 +227,16 @@ For information about fixtures, see :ref:`fixtures`. To see a complete list of a
         To undo modifications done by the fixture in a contained scope,
         use :meth:`context() <pytest.MonkeyPatch.context>`.
 
-    recwarn -- .../_pytest/recwarn.py:31
+    recwarn -- .../_pytest/recwarn.py:32
         Return a :class:`WarningsRecorder` instance that records all warnings emitted by test functions.
 
         See https://docs.pytest.org/en/latest/how-to/capture-warnings.html for information
         on warning categories.
 
-    tmp_path_factory [session scope] -- .../_pytest/tmpdir.py:241
+    tmp_path_factory [session scope] -- .../_pytest/tmpdir.py:242
         Return a :class:`pytest.TempPathFactory` instance for the test session.
 
-    tmp_path -- .../_pytest/tmpdir.py:256
+    tmp_path -- .../_pytest/tmpdir.py:257
         Return a temporary directory path object which is unique to each test
         function invocation, created as a sub directory of the base temporary
         directory.

doc/en/changelog.rst

@@ -19,15 +19,178 @@ with advance notice in the **Deprecations** section of releases.
     we named the news folder changelog
 
 
-.. only:: changelog_towncrier_draft
+.. only:: not is_release
 
-    .. The 'changelog_towncrier_draft' tag is included by our 'tox -e docs',
+   To be included in v\ |release| (if present)
-       but not on readthedocs.
+   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-    .. include:: _changelog_towncrier_draft.rst
+   .. towncrier-draft-entries:: |release| [UNRELEASED DRAFT]
+
+   Released versions
+   ^^^^^^^^^^^^^^^^^
 
 .. towncrier release notes start
 
+pytest 8.2.2 (2024-06-04)
+=========================
+
+Bug Fixes
+---------
+
+- `#12355 <https://github.com/pytest-dev/pytest/issues/12355>`_: Fix possible catastrophic performance slowdown on a certain parametrization pattern involving many higher-scoped parameters.
+
+
+- `#12367 <https://github.com/pytest-dev/pytest/issues/12367>`_: Fix a regression in pytest 8.2.0 where unittest class instances (a fresh one is created for each test) were not released promptly on test teardown but only on session teardown.
+
+
+- `#12381 <https://github.com/pytest-dev/pytest/issues/12381>`_: Fix possible "Directory not empty" crashes arising from concurent cache dir (``.pytest_cache``) creation. Regressed in pytest 8.2.0.
+
+
+
+Improved Documentation
+----------------------
+
+- `#12290 <https://github.com/pytest-dev/pytest/issues/12290>`_: Updated Sphinx theme to use Furo instead of Flask, enabling Dark mode theme.
+
+
+- `#12356 <https://github.com/pytest-dev/pytest/issues/12356>`_: Added a subsection to the documentation for debugging flaky tests to mention
+  lack of thread safety in pytest as a possible source of flakyness.
+
+
+- `#12363 <https://github.com/pytest-dev/pytest/issues/12363>`_: The documentation webpages now links to a canonical version to reduce outdated documentation in search engine results.
+
+
+pytest 8.2.1 (2024-05-19)
+=========================
+
+Improvements
+------------
+
+- `#12334 <https://github.com/pytest-dev/pytest/issues/12334>`_: Support for Python 3.13 (beta1 at the time of writing).
+
+
+
+Bug Fixes
+---------
+
+- `#12120 <https://github.com/pytest-dev/pytest/issues/12120>`_: Fix `PermissionError` crashes arising from directories which are not selected on the command-line.
+
+
+- `#12191 <https://github.com/pytest-dev/pytest/issues/12191>`_: Keyboard interrupts and system exits are now properly handled during the test collection.
+
+
+- `#12300 <https://github.com/pytest-dev/pytest/issues/12300>`_: Fixed handling of 'Function not implemented' error under squashfuse_ll, which is a different way to say that the mountpoint is read-only.
+
+
+- `#12308 <https://github.com/pytest-dev/pytest/issues/12308>`_: Fix a regression in pytest 8.2.0 where the permissions of automatically-created ``.pytest_cache`` directories became ``rwx------`` instead of the expected ``rwxr-xr-x``.
+
+
+
+Trivial/Internal Changes
+------------------------
+
+- `#12333 <https://github.com/pytest-dev/pytest/issues/12333>`_: pytest releases are now attested using the recent `Artifact Attestation <https://github.blog/2024-05-02-introducing-artifact-attestations-now-in-public-beta/>`_ support from GitHub, allowing users to verify the provenance of pytest's sdist and wheel artifacts.
+
+
+pytest 8.2.0 (2024-04-27)
+=========================
+
+Breaking Changes
+----------------
+
+- `#12089 <https://github.com/pytest-dev/pytest/pull/12089>`_: pytest now requires that :class:`unittest.TestCase` subclasses can be instantiated freely using ``MyTestCase('runTest')``.
+
+  If the class doesn't allow this, you may see an error during collection such as ``AttributeError: 'MyTestCase' object has no attribute 'runTest'``.
+
+  Classes which do not override ``__init__``, or do not access the test method in ``__init__`` using ``getattr`` or similar, are unaffected.
+
+  Classes which do should take care to not crash when ``"runTest"`` is given, as is shown in `unittest.TestCases's implementation <https://github.com/python/cpython/blob/51aefc5bf907ddffaaf083ded0de773adcdf08c8/Lib/unittest/case.py#L419-L426>`_.
+  Alternatively, consider using :meth:`setUp <unittest.TestCase.setUp>` instead of ``__init__``.
+
+  If you run into this issue using ``tornado.AsyncTestCase``, please see `issue 12263 <https://github.com/pytest-dev/pytest/issues/12263>`_.
+
+  If you run into this issue using an abstract ``TestCase`` subclass, please see `issue 12275 <https://github.com/pytest-dev/pytest/issues/12275>`_.
+
+  Historical note: the effect of this change on custom TestCase implementations was not properly considered initially, this is why it was done in a minor release. We apologize for the inconvenience.
+
+Deprecations
+------------
+
+- `#12069 <https://github.com/pytest-dev/pytest/issues/12069>`_: A deprecation warning is now raised when implementations of one of the following hooks request a deprecated ``py.path.local`` parameter instead of the ``pathlib.Path`` parameter which replaced it:
+
+  - :hook:`pytest_ignore_collect` - the ``path`` parameter - use ``collection_path`` instead.
+  - :hook:`pytest_collect_file` - the ``path`` parameter - use ``file_path`` instead.
+  - :hook:`pytest_pycollect_makemodule` - the ``path`` parameter - use ``module_path`` instead.
+  - :hook:`pytest_report_header` - the ``startdir`` parameter - use ``start_path`` instead.
+  - :hook:`pytest_report_collectionfinish` - the ``startdir`` parameter - use ``start_path`` instead.
+
+  The replacement parameters are available since pytest 7.0.0.
+  The old parameters will be removed in pytest 9.0.0.
+
+  See :ref:`legacy-path-hooks-deprecated` for more details.
+
+
+
+Features
+--------
+
+- `#11871 <https://github.com/pytest-dev/pytest/issues/11871>`_: Added support for reading command line arguments from a file using the prefix character ``@``, like e.g.: ``pytest @tests.txt``. The file must have one argument per line.
+
+  See :ref:`Read arguments from file <args-from-file>` for details.
+
+
+
+Improvements
+------------
+
+- `#11523 <https://github.com/pytest-dev/pytest/issues/11523>`_: :func:`pytest.importorskip` will now issue a warning if the module could be found, but raised :class:`ImportError` instead of :class:`ModuleNotFoundError`.
+
+  The warning can be suppressed by passing ``exc_type=ImportError`` to :func:`pytest.importorskip`.
+
+  See :ref:`import-or-skip-import-error` for details.
+
+
+- `#11728 <https://github.com/pytest-dev/pytest/issues/11728>`_: For ``unittest``-based tests, exceptions during class cleanup (as raised by functions registered with :meth:`TestCase.addClassCleanup <unittest.TestCase.addClassCleanup>`) are now reported instead of silently failing.
+
+
+- `#11777 <https://github.com/pytest-dev/pytest/issues/11777>`_: Text is no longer truncated in the ``short test summary info`` section when ``-vv`` is given.
+
+
+- `#12112 <https://github.com/pytest-dev/pytest/issues/12112>`_: Improved namespace packages detection when :confval:`consider_namespace_packages` is enabled, covering more situations (like editable installs).
+
+
+- `#9502 <https://github.com/pytest-dev/pytest/issues/9502>`_: Added :envvar:`PYTEST_VERSION` environment variable which is defined at the start of the pytest session and undefined afterwards. It contains the value of ``pytest.__version__``, and among other things can be used to easily check if code is running from within a pytest run.
+
+
+
+Bug Fixes
+---------
+
+- `#12065 <https://github.com/pytest-dev/pytest/issues/12065>`_: Fixed a regression in pytest 8.0.0 where test classes containing ``setup_method`` and tests using ``@staticmethod`` or ``@classmethod`` would crash with ``AttributeError: 'NoneType' object has no attribute 'setup_method'``.
+
+  Now the :attr:`request.instance <pytest.FixtureRequest.instance>` attribute of tests using ``@staticmethod`` and ``@classmethod`` is no longer ``None``, but a fresh instance of the class, like in non-static methods.
+  Previously it was ``None``, and all fixtures of such tests would share a single ``self``.
+
+
+- `#12135 <https://github.com/pytest-dev/pytest/issues/12135>`_: Fixed issue where fixtures adding their finalizer multiple times to fixtures they request would cause unreliable and non-intuitive teardown ordering in some instances.
+
+
+- `#12194 <https://github.com/pytest-dev/pytest/issues/12194>`_: Fixed a bug with ``--importmode=importlib`` and ``--doctest-modules`` where child modules did not appear as attributes in parent modules.
+
+
+- `#1489 <https://github.com/pytest-dev/pytest/issues/1489>`_: Fixed some instances where teardown of higher-scoped fixtures was not happening in the reverse order they were initialized in.
+
+
+
+Trivial/Internal Changes
+------------------------
+
+- `#12069 <https://github.com/pytest-dev/pytest/issues/12069>`_: ``pluggy>=1.5.0`` is now required.
+
+
+- `#12167 <https://github.com/pytest-dev/pytest/issues/12167>`_: :ref:`cache <cache>`: create supporting files (``CACHEDIR.TAG``, ``.gitignore``, etc.) in a temporary directory to provide atomic semantics.
+
+
 pytest 8.1.2 (2024-04-26)
 =========================
 
@@ -69,7 +232,7 @@ Improvements
 - `#11311 <https://github.com/pytest-dev/pytest/issues/11311>`_: When using ``--override-ini`` for paths in invocations without a configuration file defined, the current working directory is used
   as the relative directory.
 
-  Previoulsy this would raise an :class:`AssertionError`.
+  Previously this would raise an :class:`AssertionError`.
 
 
 - `#11475 <https://github.com/pytest-dev/pytest/issues/11475>`_: :ref:`--import-mode=importlib <import-mode-importlib>` now tries to import modules using the standard import mechanism (but still without changing :py:data:`sys.path`), falling back to importing modules directly only if that fails.
@@ -105,7 +268,7 @@ Bug Fixes
 
 - `#11904 <https://github.com/pytest-dev/pytest/issues/11904>`_: Fixed a regression in pytest 8.0.0 that would cause test collection to fail due to permission errors when using ``--pyargs``.
 
-  This change improves the collection tree for tests specified using ``--pyargs``, see :pull:`12043` for a comparison with pytest 8.0 and <8.
+  This change improves the collection tree for tests specified using ``--pyargs``, see :pr:`12043` for a comparison with pytest 8.0 and <8.
 
 
 - `#12011 <https://github.com/pytest-dev/pytest/issues/12011>`_: Fixed a regression in 8.0.1 whereby ``setup_module`` xunit-style fixtures are not executed when ``--doctest-modules`` is passed.
@@ -1259,7 +1422,7 @@ Bug Fixes
       tests/link -> tests/real
 
   running ``pytest tests`` now imports the conftest twice, once as ``tests/real/conftest.py`` and once as ``tests/link/conftest.py``.
-  This is a fix to match a similar change made to test collection itself in pytest 6.0 (see :pull:`6523` for details).
+  This is a fix to match a similar change made to test collection itself in pytest 6.0 (see :pr:`6523` for details).
 
 
 - `#9626 <https://github.com/pytest-dev/pytest/issues/9626>`_: Fixed count of selected tests on terminal collection summary when there were errors or skipped modules.
@@ -1312,7 +1475,7 @@ Deprecations
   ``__init__`` method, they should take ``**kwargs``. See
   :ref:`uncooperative-constructors-deprecated` for details.
 
-  Note that a deprection warning is only emitted when there is a conflict in the
+  Note that a deprecation warning is only emitted when there is a conflict in the
   arguments pytest expected to pass. This deprecation was already part of pytest
   7.0.0rc1 but wasn't documented.
 
@@ -1354,7 +1517,7 @@ Breaking Changes
 - `#7259 <https://github.com/pytest-dev/pytest/issues/7259>`_: The :ref:`Node.reportinfo() <non-python tests>` function first return value type has been expanded from `py.path.local | str` to `os.PathLike[str] | str`.
 
   Most plugins which refer to `reportinfo()` only define it as part of a custom :class:`pytest.Item` implementation.
-  Since `py.path.local` is an `os.PathLike[str]`, these plugins are unaffacted.
+  Since `py.path.local` is an `os.PathLike[str]`, these plugins are unaffected.
 
   Plugins and users which call `reportinfo()`, use the first return value and interact with it as a `py.path.local`, would need to adjust by calling `py.path.local(fspath)`.
   Although preferably, avoid the legacy `py.path.local` and use `pathlib.Path`, or use `item.location` or `item.path`, instead.
@@ -1862,7 +2025,7 @@ Bug Fixes
   the ``tmp_path``/``tmpdir`` fixture). Now the directories are created with
   private permissions.
 
-  pytest used to silently use a pre-existing ``/tmp/pytest-of-<username>`` directory,
+  pytest used to silently use a preexisting ``/tmp/pytest-of-<username>`` directory,
   even if owned by another user. This means another user could pre-create such a
   directory and gain control of another user's temporary directory. Now such a
   condition results in an error.
@@ -2428,7 +2591,7 @@ Breaking Changes
   Resolving symlinks for the current directory and during collection was introduced as a bugfix in 3.9.0, but it actually is a new feature which had unfortunate consequences in Windows and surprising results in other platforms.
 
   The team decided to step back on resolving symlinks at all, planning to review this in the future with a more solid solution (see discussion in
-  :pull:`6523` for details).
+  :pr:`6523` for details).
 
   This might break test suites which made use of this feature; the fix is to create a symlink
   for the entire test tree, and not only to partial files/tress as it was possible previously.
@@ -2589,7 +2752,7 @@ Features
   also changes ``sys.modules`` as a side-effect), which works but has a number of drawbacks, like requiring test modules
   that don't live in packages to have unique names (as they need to reside under a unique name in ``sys.modules``).
 
-  ``--import-mode=importlib`` uses more fine grained import mechanisms from ``importlib`` which don't
+  ``--import-mode=importlib`` uses more fine-grained import mechanisms from ``importlib`` which don't
   require pytest to change ``sys.path`` or ``sys.modules`` at all, eliminating much of the drawbacks
   of the previous mode.
 
@@ -2606,7 +2769,7 @@ Improvements
 ------------
 
 - :issue:`4375`: The ``pytest`` command now suppresses the ``BrokenPipeError`` error message that
-  is printed to stderr when the output of ``pytest`` is piped and and the pipe is
+  is printed to stderr when the output of ``pytest`` is piped and the pipe is
   closed by the piped-to program (common examples are ``less`` and ``head``).
 
 
@@ -2711,7 +2874,7 @@ Bug Fixes
 - :issue:`6871`: Fix crash with captured output when using :fixture:`capsysbinary`.
 
 
-- :issue:`6909`: Revert the change introduced by :pull:`6330`, which required all arguments to ``@pytest.mark.parametrize`` to be explicitly defined in the function signature.
+- :issue:`6909`: Revert the change introduced by :pr:`6330`, which required all arguments to ``@pytest.mark.parametrize`` to be explicitly defined in the function signature.
 
   The intention of the original change was to remove what was expected to be an unintended/surprising behavior, but it turns out many people relied on it, so the restriction has been reverted.
 
@@ -2881,7 +3044,7 @@ pytest 5.4.1 (2020-03-13)
 Bug Fixes
 ---------
 
-- :issue:`6909`: Revert the change introduced by :pull:`6330`, which required all arguments to ``@pytest.mark.parametrize`` to be explicitly defined in the function signature.
+- :issue:`6909`: Revert the change introduced by :pr:`6330`, which required all arguments to ``@pytest.mark.parametrize`` to be explicitly defined in the function signature.
 
   The intention of the original change was to remove what was expected to be an unintended/surprising behavior, but it turns out many people relied on it, so the restriction has been reverted.
 
@@ -2908,7 +3071,7 @@ Breaking Changes
   This hook has been marked as deprecated and not been even called by pytest for over 10 years now.
 
 
-- :issue:`6673`: Reversed / fix meaning of "+/-" in error diffs.  "-" means that sth. expected is missing in the result and "+" means that there are unexpected extras in the result.
+- :issue:`6673`: Reversed / fix meaning of "+/-" in error diffs.  "-" means that something expected is missing in the result and "+" means that there are unexpected extras in the result.
 
 
 - :issue:`6737`: The ``cached_result`` attribute of ``FixtureDef`` is now set to ``None`` when
@@ -3197,7 +3360,9 @@ Bug Fixes
 - :issue:`5914`: pytester: fix :py:func:`~pytest.LineMatcher.no_fnmatch_line` when used after positive matching.
 
 
-- :issue:`6082`: Fix line detection for doctest samples inside :py:class:`python:property` docstrings, as a workaround to :bpo:`17446`.
+- :issue:`6082`: Fix line detection for doctest samples inside
+  :py:class:`python:property` docstrings, as a workaround to
+  :issue:`python/cpython#61648`.
 
 
 - :issue:`6254`: Fix compatibility with pytest-parallel (regression in pytest 5.3.0).
@@ -3904,7 +4069,7 @@ Bug Fixes
   (``--collect-only``) when ``--log-cli-level`` is used.
 
 
-- :issue:`5389`: Fix regressions of :pull:`5063` for ``importlib_metadata.PathDistribution`` which have their ``files`` attribute being ``None``.
+- :issue:`5389`: Fix regressions of :pr:`5063` for ``importlib_metadata.PathDistribution`` which have their ``files`` attribute being ``None``.
 
 
 - :issue:`5390`: Fix regression where the ``obj`` attribute of ``TestCase`` items was no longer bound to methods.
@@ -4105,7 +4270,7 @@ Bug Fixes
   (``--collect-only``) when ``--log-cli-level`` is used.
 
 
-- :issue:`5389`: Fix regressions of :pull:`5063` for ``importlib_metadata.PathDistribution`` which have their ``files`` attribute being ``None``.
+- :issue:`5389`: Fix regressions of :pr:`5063` for ``importlib_metadata.PathDistribution`` which have their ``files`` attribute being ``None``.
 
 
 - :issue:`5390`: Fix regression where the ``obj`` attribute of ``TestCase`` items was no longer bound to methods.
@@ -4513,7 +4678,7 @@ Bug Fixes
 Improved Documentation
 ----------------------
 
-- :issue:`4974`: Update docs for ``pytest_cmdline_parse`` hook to note availability liminations
+- :issue:`4974`: Update docs for ``pytest_cmdline_parse`` hook to note availability limitations
 
 
 
@@ -6371,7 +6536,7 @@ Features
 Bug Fixes
 ---------
 
-- Fix hanging pexpect test on MacOS by using flush() instead of wait().
+- Fix hanging pexpect test on macOS by using flush() instead of wait().
   (:issue:`2022`)
 
 - Fix restoring Python state after in-process pytest runs with the
@@ -6419,7 +6584,7 @@ Trivial/Internal Changes
 ------------------------
 
 - Show a simple and easy error when keyword expressions trigger a syntax error
-  (for example, ``"-k foo and import"`` will show an error that you can not use
+  (for example, ``"-k foo and import"`` will show an error that you cannot use
   the ``import`` keyword in expressions). (:issue:`2953`)
 
 - Change parametrized automatic test id generation to use the ``__name__``
@@ -7066,10 +7231,10 @@ New Features
 * Added ``junit_suite_name`` ini option to specify root ``<testsuite>`` name for JUnit XML reports (:issue:`533`).
 
 * Added an ini option ``doctest_encoding`` to specify which encoding to use for doctest files.
-  Thanks :user:`wheerd` for the PR (:pull:`2101`).
+  Thanks :user:`wheerd` for the PR (:pr:`2101`).
 
 * ``pytest.warns`` now checks for subclass relationship rather than
-  class equality. Thanks :user:`lesteve` for the PR (:pull:`2166`)
+  class equality. Thanks :user:`lesteve` for the PR (:pr:`2166`)
 
 * ``pytest.raises`` now asserts that the error message matches a text or regex
   with the ``match`` keyword argument. Thanks :user:`Kriechi` for the PR.
@@ -7097,7 +7262,7 @@ Changes
   the failure. (:issue:`2228`) Thanks to :user:`kkoukiou` for the PR.
 
 * Testcase reports with a ``url`` attribute will now properly write this to junitxml.
-  Thanks :user:`fushi` for the PR (:pull:`1874`).
+  Thanks :user:`fushi` for the PR (:pr:`1874`).
 
 * Remove common items from dict comparison output when verbosity=1. Also update
   the truncation message to make it clearer that pytest truncates all
@@ -7106,7 +7271,7 @@ Changes
 
 * ``--pdbcls`` no longer implies ``--pdb``. This makes it possible to use
   ``addopts=--pdbcls=module.SomeClass`` on ``pytest.ini``. Thanks :user:`davidszotten` for
-  the PR (:pull:`1952`).
+  the PR (:pr:`1952`).
 
 * fix :issue:`2013`: turn RecordedWarning into ``namedtuple``,
   to give it a comprehensible repr while preventing unwarranted modification.
@@ -7360,7 +7525,7 @@ Bug Fixes
   a sequence of strings) when modules are considered for assertion rewriting.
   Due to this bug, much more modules were being rewritten than necessary
   if a test suite uses ``pytest_plugins`` to load internal plugins (:issue:`1888`).
-  Thanks :user:`jaraco` for the report and :user:`nicoddemus` for the PR (:pull:`1891`).
+  Thanks :user:`jaraco` for the report and :user:`nicoddemus` for the PR (:pr:`1891`).
 
 * Do not call tearDown and cleanups when running tests from
   ``unittest.TestCase`` subclasses with ``--pdb``
@@ -7415,12 +7580,12 @@ time or change existing behaviors in order to make them less surprising/more use
   * ``--nomagic``: use ``--assert=plain`` instead;
   * ``--report``: use ``-r`` instead;
 
-  Thanks to :user:`RedBeardCode` for the PR (:pull:`1664`).
+  Thanks to :user:`RedBeardCode` for the PR (:pr:`1664`).
 
 * ImportErrors in plugins now are a fatal error instead of issuing a
   pytest warning (:issue:`1479`). Thanks to :user:`The-Compiler` for the PR.
 
-* Removed support code for Python 3 versions < 3.3 (:pull:`1627`).
+* Removed support code for Python 3 versions < 3.3 (:pr:`1627`).
 
 * Removed all ``py.test-X*`` entry points. The versioned, suffixed entry points
   were never documented and a leftover from a pre-virtualenv era. These entry
@@ -7431,19 +7596,19 @@ time or change existing behaviors in order to make them less surprising/more use
 * ``pytest.skip()`` now raises an error when used to decorate a test function,
   as opposed to its original intent (to imperatively skip a test inside a test function). Previously
   this usage would cause the entire module to be skipped (:issue:`607`).
-  Thanks :user:`omarkohl` for the complete PR (:pull:`1519`).
+  Thanks :user:`omarkohl` for the complete PR (:pr:`1519`).
 
 * Exit tests if a collection error occurs. A poll indicated most users will hit CTRL-C
   anyway as soon as they see collection errors, so pytest might as well make that the default behavior (:issue:`1421`).
   A ``--continue-on-collection-errors`` option has been added to restore the previous behaviour.
-  Thanks :user:`olegpidsadnyi` and :user:`omarkohl` for the complete PR (:pull:`1628`).
+  Thanks :user:`olegpidsadnyi` and :user:`omarkohl` for the complete PR (:pr:`1628`).
 
 * Renamed the pytest ``pdb`` module (plugin) into ``debugging`` to avoid clashes with the builtin ``pdb`` module.
 
 * Raise a helpful failure message when requesting a parametrized fixture at runtime,
   e.g. with ``request.getfixturevalue``. Previously these parameters were simply
   never defined, so a fixture decorated like ``@pytest.fixture(params=[0, 1, 2])``
-  only ran once (:pull:`460`).
+  only ran once (:pr:`460`).
   Thanks to :user:`nikratio` for the bug report, :user:`RedBeardCode` and :user:`tomviner` for the PR.
 
 * ``_pytest.monkeypatch.monkeypatch`` class has been renamed to ``_pytest.monkeypatch.MonkeyPatch``
@@ -7461,7 +7626,7 @@ time or change existing behaviors in order to make them less surprising/more use
 
 * New ``doctest_namespace`` fixture for injecting names into the
   namespace in which doctests run.
-  Thanks :user:`milliams` for the complete PR (:pull:`1428`).
+  Thanks :user:`milliams` for the complete PR (:pr:`1428`).
 
 * New ``--doctest-report`` option available to change the output format of diffs
   when running (failing) doctests (implements :issue:`1749`).
@@ -7469,23 +7634,23 @@ time or change existing behaviors in order to make them less surprising/more use
 
 * New ``name`` argument to ``pytest.fixture`` decorator which allows a custom name
   for a fixture (to solve the funcarg-shadowing-fixture problem).
-  Thanks :user:`novas0x2a` for the complete PR (:pull:`1444`).
+  Thanks :user:`novas0x2a` for the complete PR (:pr:`1444`).
 
 * New ``approx()`` function for easily comparing floating-point numbers in
   tests.
-  Thanks :user:`kalekundert` for the complete PR (:pull:`1441`).
+  Thanks :user:`kalekundert` for the complete PR (:pr:`1441`).
 
 * Ability to add global properties in the final xunit output file by accessing
   the internal ``junitxml`` plugin (experimental).
-  Thanks :user:`tareqalayan` for the complete PR :pull:`1454`).
+  Thanks :user:`tareqalayan` for the complete PR :pr:`1454`).
 
 * New ``ExceptionInfo.match()`` method to match a regular expression on the
   string representation of an exception (:issue:`372`).
-  Thanks :user:`omarkohl` for the complete PR (:pull:`1502`).
+  Thanks :user:`omarkohl` for the complete PR (:pr:`1502`).
 
 * ``__tracebackhide__`` can now also be set to a callable which then can decide
   whether to filter the traceback based on the ``ExceptionInfo`` object passed
-  to it. Thanks :user:`The-Compiler` for the complete PR (:pull:`1526`).
+  to it. Thanks :user:`The-Compiler` for the complete PR (:pr:`1526`).
 
 * New ``pytest_make_parametrize_id(config, val)`` hook which can be used by plugins to provide
   friendly strings for custom types.
@@ -7503,7 +7668,7 @@ time or change existing behaviors in order to make them less surprising/more use
 * Introduce ``pytest`` command as recommended entry point. Note that ``py.test``
   still works and is not scheduled for removal. Closes proposal
   :issue:`1629`. Thanks :user:`obestwalter` and :user:`davehunt` for the complete PR
-  (:pull:`1633`).
+  (:pr:`1633`).
 
 * New cli flags:
 
@@ -7547,19 +7712,19 @@ time or change existing behaviors in order to make them less surprising/more use
 
 * Change ``report.outcome`` for ``xpassed`` tests to ``"passed"`` in non-strict
   mode and ``"failed"`` in strict mode. Thanks to :user:`hackebrot` for the PR
-  (:pull:`1795`) and :user:`gprasad84` for report (:issue:`1546`).
+  (:pr:`1795`) and :user:`gprasad84` for report (:issue:`1546`).
 
 * Tests marked with ``xfail(strict=False)`` (the default) now appear in
   JUnitXML reports as passing tests instead of skipped.
-  Thanks to :user:`hackebrot` for the PR (:pull:`1795`).
+  Thanks to :user:`hackebrot` for the PR (:pr:`1795`).
 
 * Highlight path of the file location in the error report to make it easier to copy/paste.
-  Thanks :user:`suzaku` for the PR (:pull:`1778`).
+  Thanks :user:`suzaku` for the PR (:pr:`1778`).
 
 * Fixtures marked with ``@pytest.fixture`` can now use ``yield`` statements exactly like
   those marked with the ``@pytest.yield_fixture`` decorator. This change renders
   ``@pytest.yield_fixture`` deprecated and makes ``@pytest.fixture`` with ``yield`` statements
-  the preferred way to write teardown code (:pull:`1461`).
+  the preferred way to write teardown code (:pr:`1461`).
   Thanks :user:`csaftoiu` for bringing this to attention and :user:`nicoddemus` for the PR.
 
 * Explicitly passed parametrize ids do not get escaped to ascii (:issue:`1351`).
@@ -7570,11 +7735,11 @@ time or change existing behaviors in order to make them less surprising/more use
   Thanks :user:`nicoddemus` for the PR.
 
 * ``pytest_terminal_summary`` hook now receives the ``exitstatus``
-  of the test session as argument. Thanks :user:`blueyed` for the PR (:pull:`1809`).
+  of the test session as argument. Thanks :user:`blueyed` for the PR (:pr:`1809`).
 
 * Parametrize ids can accept ``None`` as specific test id, in which case the
   automatically generated id for that argument will be used.
-  Thanks :user:`palaviv` for the complete PR (:pull:`1468`).
+  Thanks :user:`palaviv` for the complete PR (:pr:`1468`).
 
 * The parameter to xunit-style setup/teardown methods (``setup_method``,
   ``setup_module``, etc.) is now optional and may be omitted.
@@ -7582,32 +7747,32 @@ time or change existing behaviors in order to make them less surprising/more use
 
 * Improved automatic id generation selection in case of duplicate ids in
   parametrize.
-  Thanks :user:`palaviv` for the complete PR (:pull:`1474`).
+  Thanks :user:`palaviv` for the complete PR (:pr:`1474`).
 
 * Now pytest warnings summary is shown up by default. Added a new flag
   ``--disable-pytest-warnings`` to explicitly disable the warnings summary (:issue:`1668`).
 
 * Make ImportError during collection more explicit by reminding
   the user to check the name of the test module/package(s) (:issue:`1426`).
-  Thanks :user:`omarkohl` for the complete PR (:pull:`1520`).
+  Thanks :user:`omarkohl` for the complete PR (:pr:`1520`).
 
 * Add ``build/`` and ``dist/`` to the default ``--norecursedirs`` list. Thanks
   :user:`mikofski` for the report and :user:`tomviner` for the PR (:issue:`1544`).
 
 * ``pytest.raises`` in the context manager form accepts a custom
   ``message`` to raise when no exception occurred.
-  Thanks :user:`palaviv` for the complete PR (:pull:`1616`).
+  Thanks :user:`palaviv` for the complete PR (:pr:`1616`).
 
 * ``conftest.py`` files now benefit from assertion rewriting; previously it
   was only available for test modules. Thanks :user:`flub`, :user:`sober7` and
   :user:`nicoddemus` for the PR (:issue:`1619`).
 
 * Text documents without any doctests no longer appear as "skipped".
-  Thanks :user:`graingert` for reporting and providing a full PR (:pull:`1580`).
+  Thanks :user:`graingert` for reporting and providing a full PR (:pr:`1580`).
 
 * Ensure that a module within a namespace package can be found when it
   is specified on the command line together with the ``--pyargs``
-  option.  Thanks to :user:`taschini` for the PR (:pull:`1597`).
+  option.  Thanks to :user:`taschini` for the PR (:pr:`1597`).
 
 * Always include full assertion explanation during assertion rewriting. The previous behaviour was hiding
   sub-expressions that happened to be ``False``, assuming this was redundant information.
@@ -7623,20 +7788,20 @@ time or change existing behaviors in order to make them less surprising/more use
   Thanks :user:`nicoddemus` for the PR.
 
 * ``[pytest]`` sections in ``setup.cfg`` files should now be named ``[tool:pytest]``
-  to avoid conflicts with other distutils commands (see :pull:`567`). ``[pytest]`` sections in
+  to avoid conflicts with other distutils commands (see :pr:`567`). ``[pytest]`` sections in
   ``pytest.ini`` or ``tox.ini`` files are supported and unchanged.
   Thanks :user:`nicoddemus` for the PR.
 
 * Using ``pytest_funcarg__`` prefix to declare fixtures is considered deprecated and will be
-  removed in pytest-4.0 (:pull:`1684`).
+  removed in pytest-4.0 (:pr:`1684`).
   Thanks :user:`nicoddemus` for the PR.
 
 * Passing a command-line string to ``pytest.main()`` is considered deprecated and scheduled
-  for removal in pytest-4.0. It is recommended to pass a list of arguments instead (:pull:`1723`).
+  for removal in pytest-4.0. It is recommended to pass a list of arguments instead (:pr:`1723`).
 
 * Rename ``getfuncargvalue`` to ``getfixturevalue``. ``getfuncargvalue`` is
   still present but is now considered deprecated. Thanks to :user:`RedBeardCode` and :user:`tomviner`
-  for the PR (:pull:`1626`).
+  for the PR (:pr:`1626`).
 
 * ``optparse`` type usage now triggers DeprecationWarnings (:issue:`1740`).
 
@@ -7694,11 +7859,11 @@ time or change existing behaviors in order to make them less surprising/more use
   :user:`tomviner` for the PR.
 
 * ``ConftestImportFailure`` now shows the traceback making it easier to
-  identify bugs in ``conftest.py`` files (:pull:`1516`). Thanks :user:`txomon` for
+  identify bugs in ``conftest.py`` files (:pr:`1516`). Thanks :user:`txomon` for
   the PR.
 
 * Text documents without any doctests no longer appear as "skipped".
-  Thanks :user:`graingert` for reporting and providing a full PR (:pull:`1580`).
+  Thanks :user:`graingert` for reporting and providing a full PR (:pr:`1580`).
 
 * Fixed collection of classes with custom ``__new__`` method.
   Fixes :issue:`1579`. Thanks to :user:`Stranger6667` for the PR.
@@ -7706,7 +7871,7 @@ time or change existing behaviors in order to make them less surprising/more use
 * Fixed scope overriding inside metafunc.parametrize (:issue:`634`).
   Thanks to :user:`Stranger6667` for the PR.
 
-* Fixed the total tests tally in junit xml output (:pull:`1798`).
+* Fixed the total tests tally in junit xml output (:pr:`1798`).
   Thanks to :user:`cboelsen` for the PR.
 
 * Fixed off-by-one error with lines from ``request.node.warn``.
@@ -7723,14 +7888,14 @@ time or change existing behaviors in order to make them less surprising/more use
 
 * Fix Xfail does not work with condition keyword argument.
   Thanks :user:`astraw38` for reporting the issue (:issue:`1496`) and :user:`tomviner`
-  for PR the (:pull:`1524`).
+  for PR the (:pr:`1524`).
 
 * Fix win32 path issue when putting custom config file with absolute path
   in ``pytest.main("-c your_absolute_path")``.
 
 * Fix maximum recursion depth detection when raised error class is not aware
   of unicode/encoded bytes.
-  Thanks :user:`prusse-martin` for the PR (:pull:`1506`).
+  Thanks :user:`prusse-martin` for the PR (:pr:`1506`).
 
 * Fix ``pytest.mark.skip`` mark when used in strict mode.
   Thanks :user:`pquentin` for the PR and :user:`RonnyPfannschmidt` for
@@ -7757,7 +7922,7 @@ time or change existing behaviors in order to make them less surprising/more use
   Thanks :user:`nicoddemus` for the PR.
 
 * Fix (:issue:`469`): junit parses report.nodeid incorrectly, when params IDs
-  contain ``::``. Thanks :user:`tomviner` for the PR (:pull:`1431`).
+  contain ``::``. Thanks :user:`tomviner` for the PR (:pr:`1431`).
 
 * Fix (:issue:`578`): SyntaxErrors
   containing non-ascii lines at the point of failure generated an internal
@@ -7778,7 +7943,7 @@ time or change existing behaviors in order to make them less surprising/more use
 **New Features**
 
 * New ``pytest.mark.skip`` mark, which unconditionally skips marked tests.
-  Thanks :user:`MichaelAquilina` for the complete PR (:pull:`1040`).
+  Thanks :user:`MichaelAquilina` for the complete PR (:pr:`1040`).
 
 * ``--doctest-glob`` may now be passed multiple times in the command-line.
   Thanks :user:`jab` and :user:`nicoddemus` for the PR.
@@ -7789,14 +7954,14 @@ time or change existing behaviors in order to make them less surprising/more use
 * ``pytest.mark.xfail`` now has a ``strict`` option, which makes ``XPASS``
   tests to fail the test suite (defaulting to ``False``). There's also a
   ``xfail_strict`` ini option that can be used to configure it project-wise.
-  Thanks :user:`rabbbit` for the request and :user:`nicoddemus` for the PR (:pull:`1355`).
+  Thanks :user:`rabbbit` for the request and :user:`nicoddemus` for the PR (:pr:`1355`).
 
 * ``Parser.addini`` now supports options of type ``bool``.
   Thanks :user:`nicoddemus` for the PR.
 
 * New ``ALLOW_BYTES`` doctest option. This strips ``b`` prefixes from byte strings
   in doctest output (similar to ``ALLOW_UNICODE``).
-  Thanks :user:`jaraco` for the request and :user:`nicoddemus` for the PR (:pull:`1287`).
+  Thanks :user:`jaraco` for the request and :user:`nicoddemus` for the PR (:pr:`1287`).
 
 * Give a hint on ``KeyboardInterrupt`` to use the ``--fulltrace`` option to show the errors.
   Fixes :issue:`1366`.
@@ -7828,7 +7993,7 @@ time or change existing behaviors in order to make them less surprising/more use
 
 * Removed code and documentation for Python 2.5 or lower versions,
   including removal of the obsolete ``_pytest.assertion.oldinterpret`` module.
-  Thanks :user:`nicoddemus` for the PR (:pull:`1226`).
+  Thanks :user:`nicoddemus` for the PR (:pr:`1226`).
 
 * Comparisons now always show up in full when ``CI`` or ``BUILD_NUMBER`` is
   found in the environment, even when ``-vv`` isn't used.
@@ -8195,7 +8360,7 @@ time or change existing behaviors in order to make them less surprising/more use
   one will also have a "reprec" attribute with the recorded events/reports.
 
 - fix monkeypatch.setattr("x.y", raising=False) to actually not raise
-  if "y" is not a pre-existing attribute. Thanks Florian Bruhin.
+  if "y" is not a preexisting attribute. Thanks Florian Bruhin.
 
 - fix issue741: make running output from testdir.run copy/pasteable
   Thanks Bruno Oliveira.
@@ -8251,7 +8416,7 @@ time or change existing behaviors in order to make them less surprising/more use
 
 - fix issue854: autouse yield_fixtures defined as class members of
   unittest.TestCase subclasses now work as expected.
-  Thannks xmo-odoo for the report and Bruno Oliveira for the PR.
+  Thanks xmo-odoo for the report and Bruno Oliveira for the PR.
 
 - fix issue833: --fixtures now shows all fixtures of collected test files, instead of just the
   fixtures declared on the first one.
@@ -8355,7 +8520,7 @@ time or change existing behaviors in order to make them less surprising/more use
   github.  See https://pytest.org/en/stable/contributing.html .
   Thanks to Anatoly for pushing and initial work on this.
 
-- fix issue650: new option ``--docttest-ignore-import-errors`` which
+- fix issue650: new option ``--doctest-ignore-import-errors`` which
   will turn import errors in doctests into skips.  Thanks Charles Cloud
   for the complete PR.
 
@@ -8543,7 +8708,7 @@ time or change existing behaviors in order to make them less surprising/more use
 - cleanup setup.py a bit and specify supported versions. Thanks Jurko
   Gospodnetic for the PR.
 
-- change XPASS colour to yellow rather then red when tests are run
+- change XPASS colour to yellow rather than red when tests are run
   with -v.
 
 - fix issue473: work around mock putting an unbound method into a class
@@ -8716,7 +8881,7 @@ time or change existing behaviors in order to make them less surprising/more use
   Thanks Ralph Schmitt for the precise failure example.
 
 - fix issue244 by implementing special index for parameters to only use
-  indices for paramentrized test ids
+  indices for parametrized test ids
 
 - fix issue287 by running all finalizers but saving the exception
   from the first failing finalizer and re-raising it so teardown will
@@ -8724,7 +8889,7 @@ time or change existing behaviors in order to make them less surprising/more use
   it might be the cause for other finalizers to fail.
 
 - fix ordering when mock.patch or other standard decorator-wrappings
-  are used with test methods.  This fixues issue346 and should
+  are used with test methods.  This fixes issue346 and should
   help with random "xdist" collection failures.  Thanks to
   Ronny Pfannschmidt and Donald Stufft for helping to isolate it.
 
@@ -8981,7 +9146,7 @@ Bug fixes:
   partially failed (finalizers would not always be called before)
 
 - fix issue320 - fix class scope for fixtures when mixed with
-  module-level functions.  Thanks Anatloy Bubenkoff.
+  module-level functions.  Thanks Anatoly Bubenkoff.
 
 - you can specify "-q" or "-qq" to get different levels of "quieter"
   reporting (thanks Katarzyna Jachim)
@@ -9403,7 +9568,7 @@ Bug fixes:
   unexpected exceptions
 - fix issue47: timing output in junitxml for test cases is now correct
 - fix issue48: typo in MarkInfo repr leading to exception
-- fix issue49: avoid confusing error when initizaliation partially fails
+- fix issue49: avoid confusing error when initialization partially fails
 - fix issue44: env/username expansion for junitxml file path
 - show releaselevel information in test runs for pypy
 - reworked doc pages for better navigation and PDF generation
@@ -9528,7 +9693,7 @@ Bug fixes:
   collection-before-running semantics were not
   setup as with pytest 1.3.4.  Note, however, that
   the recommended and much cleaner way to do test
-  parametraization remains the "pytest_generate_tests"
+  parameterization remains the "pytest_generate_tests"
   mechanism, see the docs.
 
 2.0.0 (2010-11-25)

doc/en/conf.py

@@ -15,19 +15,33 @@
 #
 # The full version, including alpha/beta/rc tags.
 # The short X.Y version.
+from __future__ import annotations
+
 import os
+from pathlib import Path
 import shutil
-import sys
 from textwrap import dedent
 from typing import TYPE_CHECKING
 
-from _pytest import __version__ as version
+from _pytest import __version__ as full_version
 
 
+version = full_version.split("+")[0]
+
 if TYPE_CHECKING:
     import sphinx.application
 
 
+PROJECT_ROOT_DIR = Path(__file__).parents[2].resolve()
+IS_RELEASE_ON_RTD = (
+    os.getenv("READTHEDOCS", "False") == "True"
+    and os.environ["READTHEDOCS_VERSION_TYPE"] == "tag"
+)
+if IS_RELEASE_ON_RTD:
+    tags: set[str]
+    # pylint: disable-next=used-before-assignment
+    tags.add("is_release")  # noqa: F821
+
 release = ".".join(version.split(".")[:2])
 
 # If extensions (or modules to document with autodoc) are in another directory,
@@ -65,16 +79,16 @@ latex_elements = {
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = [
-    "pallets_sphinx_themes",
     "pygments_pytest",
     "sphinx.ext.autodoc",
     "sphinx.ext.autosummary",
-    "sphinx.ext.extlinks",
     "sphinx.ext.intersphinx",
     "sphinx.ext.todo",
     "sphinx.ext.viewcode",
     "sphinx_removed_in",
     "sphinxcontrib_trio",
+    "sphinxcontrib.towncrier.ext",  # provides `towncrier-draft-entries` directive
+    "sphinx_issues",  # implements `:issue:`, `:pr:` and other GH-related roles
 ]
 
 # Building PDF docs on readthedocs requires inkscape for svg to pdf
@@ -140,10 +154,6 @@ add_module_names = False
 # output. They are ignored by default.
 # show_authors = False
 
-# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = "sphinx"
-
-
 # A list of ignored prefixes for module index sorting.
 # modindex_common_prefix = []
 
@@ -160,16 +170,6 @@ linkcheck_ignore = [
 linkcheck_workers = 5
 
 
-_repo = "https://github.com/pytest-dev/pytest"
-extlinks = {
-    "bpo": ("https://bugs.python.org/issue%s", "bpo-%s"),
-    "pypi": ("https://pypi.org/project/%s/", "%s"),
-    "issue": (f"{_repo}/issues/%s", "issue #%s"),
-    "pull": (f"{_repo}/pull/%s", "pull request #%s"),
-    "user": ("https://github.com/%s", "@%s"),
-}
-
-
 nitpicky = True
 nitpick_ignore = [
     # TODO (fix in pluggy?)
@@ -183,6 +183,7 @@ nitpick_ignore = [
     ("py:class", "SubRequest"),
     ("py:class", "TerminalReporter"),
     ("py:class", "_pytest._code.code.TerminalRepr"),
+    ("py:class", "TerminalRepr"),
     ("py:class", "_pytest.fixtures.FixtureFunctionMarker"),
     ("py:class", "_pytest.logging.LogCaptureHandler"),
     ("py:class", "_pytest.mark.structures.ParameterSet"),
@@ -204,24 +205,24 @@ nitpick_ignore = [
     ("py:class", "_PluggyPlugin"),
     # TypeVars
     ("py:class", "_pytest._code.code.E"),
+    ("py:class", "E"),  # due to delayed annotation
     ("py:class", "_pytest.fixtures.FixtureFunction"),
     ("py:class", "_pytest.nodes._NodeType"),
+    ("py:class", "_NodeType"),  # due to delayed annotation
     ("py:class", "_pytest.python_api.E"),
     ("py:class", "_pytest.recwarn.T"),
     ("py:class", "_pytest.runner.TResult"),
     ("py:obj", "_pytest.fixtures.FixtureValue"),
     ("py:obj", "_pytest.stash.T"),
+    ("py:class", "_ScopeName"),
 ]
 
 
 # -- Options for HTML output ---------------------------------------------------
 
-sys.path.append(os.path.abspath("_themes"))
-html_theme_path = ["_themes"]
-
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = "flask"
+html_theme = "furo"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
@@ -236,7 +237,7 @@ html_theme = "flask"
 html_title = "pytest documentation"
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
-html_short_title = "pytest-%s" % release
+html_short_title = f"pytest-{release}"
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
@@ -266,18 +267,24 @@ html_favicon = "img/favicon.png"
 
 html_sidebars = {
     "index": [
-        "slim_searchbox.html",
+        "sidebar/brand.html",
+        "sidebar/search.html",
+        "sidebar/scroll-start.html",
         "sidebarintro.html",
         "globaltoc.html",
         "links.html",
-        "sourcelink.html",
+        "sidebar/scroll-end.html",
+        "style.html",
     ],
     "**": [
-        "slim_searchbox.html",
+        "sidebar/brand.html",
+        "sidebar/search.html",
+        "sidebar/scroll-start.html",
         "globaltoc.html",
         "relations.html",
         "links.html",
-        "sourcelink.html",
+        "sidebar/scroll-end.html",
+        "style.html",
     ],
 }
 
@@ -316,6 +323,9 @@ html_show_sourcelink = False
 # Output file base name for HTML help builder.
 htmlhelp_basename = "pytestdoc"
 
+# The base URL which points to the root of the HTML documentation. It is used
+# to indicate the location of document using the canonical link relation (#12363).
+html_baseurl = "https://docs.pytest.org/en/stable/"
 
 # -- Options for LaTeX output --------------------------------------------------
 
@@ -337,10 +347,6 @@ latex_documents = [
     )
 ]
 
-# The name of an image file (relative to this directory) to place at the top of
-# the title page.
-latex_logo = "img/pytest1.png"
-
 # For "manual" documents, if this is true, then toplevel headings are parts,
 # not chapters.
 # latex_use_parts = False
@@ -427,6 +433,18 @@ texinfo_documents = [
     )
 ]
 
+# -- Options for towncrier_draft extension -----------------------------------
+
+towncrier_draft_autoversion_mode = "draft"  # or: 'sphinx-version', 'sphinx-release'
+towncrier_draft_include_empty = True
+towncrier_draft_working_directory = PROJECT_ROOT_DIR
+towncrier_draft_config_path = "pyproject.toml"  # relative to cwd
+
+
+# -- Options for sphinx_issues extension -----------------------------------
+
+issues_github_path = "pytest-dev/pytest"
+
 
 intersphinx_mapping = {
     "pluggy": ("https://pluggy.readthedocs.io/en/stable", None),
@@ -440,31 +458,7 @@ intersphinx_mapping = {
 }
 
 
-def configure_logging(app: "sphinx.application.Sphinx") -> None:
+def setup(app: sphinx.application.Sphinx) -> None:
-    """Configure Sphinx's WarningHandler to handle (expected) missing include."""
-    import logging
-
-    import sphinx.util.logging
-
-    class WarnLogFilter(logging.Filter):
-        def filter(self, record: logging.LogRecord) -> bool:
-            """Ignore warnings about missing include with "only" directive.
-
-            Ref: https://github.com/sphinx-doc/sphinx/issues/2150."""
-            if (
-                record.msg.startswith('Problems with "include" directive path:')
-                and "_changelog_towncrier_draft.rst" in record.msg
-            ):
-                return False
-            return True
-
-    logger = logging.getLogger(sphinx.util.logging.NAMESPACE)
-    warn_handler = [x for x in logger.handlers if x.level == logging.WARNING]
-    assert len(warn_handler) == 1, warn_handler
-    warn_handler[0].filters.insert(0, WarnLogFilter())
-
-
-def setup(app: "sphinx.application.Sphinx") -> None:
     app.add_crossref_type(
         "fixture",
         "fixture",
@@ -493,8 +487,6 @@ def setup(app: "sphinx.application.Sphinx") -> None:
         indextemplate="pair: %s; hook",
     )
 
-    configure_logging(app)
-
     # legacypath.py monkey-patches pytest.Testdir in. Import the file so
     # that autodoc can discover references to it.
     import _pytest.legacypath  # noqa: F401

doc/en/conftest.py

@@ -1 +1,4 @@
+from __future__ import annotations
+
+
 collect_ignore = ["conf.py"]

doc/en/contact.rst

@@ -22,23 +22,16 @@ Contact channels
   requests to GitHub.
 
 - ``#pytest`` `on irc.libera.chat <ircs://irc.libera.chat:6697/#pytest>`_ IRC
-  channel for random questions (using an IRC client, `via webchat
+  channel for random questions (using an IRC client, or `via webchat
-  <https://web.libera.chat/#pytest>`_, or `via Matrix
+  <https://web.libera.chat/#pytest>`)
-  <https://matrix.to/#/%23pytest:libera.chat>`_).
+- ``#pytest`` `on Matrix https://matrix.to/#/#pytest:matrix.org>`.
 
-- private mail to Holger.Krekel at gmail com if you want to communicate sensitive issues
-
-
-- `merlinux.eu`_ offers pytest and tox-related professional teaching and
-  consulting.
 
 .. _`pytest issue tracker`: https://github.com/pytest-dev/pytest/issues
 .. _`old issue tracker`: https://bitbucket.org/hpk42/py-trunk/issues/
 
 .. _`pytest discussions`: https://github.com/pytest-dev/pytest/discussions
 
-.. _`merlinux.eu`: https://merlinux.eu/
-
 .. _`get an account`:
 
 .. _tetamap: https://tetamap.wordpress.com/

doc/en/deprecations.rst

@@ -7,10 +7,6 @@ This page lists all pytest features that are currently deprecated or have been r
 The objective is to give users a clear rationale why a certain feature has been removed, and what alternatives
 should be used instead.
 
-.. contents::
-    :depth: 3
-    :local:
-
 
 Deprecated Features
 -------------------
@@ -462,7 +458,7 @@ Now :class:`~pytest.Class` collects the test methods directly.
 Most plugins which reference ``Instance`` do so in order to ignore or skip it,
 using a check such as ``if isinstance(node, Instance): return``.
 Such plugins should simply remove consideration of ``Instance`` on pytest>=7.
-However, to keep such uses working, a dummy type has been instanted in ``pytest.Instance`` and ``_pytest.python.Instance``,
+However, to keep such uses working, a dummy type has been instanced in ``pytest.Instance`` and ``_pytest.python.Instance``,
 and importing it emits a deprecation warning. This was removed in pytest 8.
 
 

doc/en/example/assertion/failure_demo.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import pytest
 from pytest import raises
 

doc/en/example/assertion/global_testmodule_config/conftest.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import os.path
 
 import pytest

doc/en/example/assertion/global_testmodule_config/test_hello_world.py

@@ -1,3 +1,6 @@
+from __future__ import annotations
+
+
 hello = "world"
 
 

doc/en/example/assertion/test_failures.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import os.path
 import shutil
 

doc/en/example/assertion/test_setup_flow_example.py

@@ -1,3 +1,6 @@
+from __future__ import annotations
+
+
 def setup_module(module):
     module.TestStateFullThing.classcount = 0
 

doc/en/example/conftest.py

@@ -1 +1,4 @@
+from __future__ import annotations
+
+
 collect_ignore = ["nonpython", "customdirectory"]

doc/en/example/customdirectory/conftest.py

@@ -1,4 +1,6 @@
 # content of conftest.py
+from __future__ import annotations
+
 import json
 
 import pytest
@@ -21,7 +23,7 @@ class ManifestDirectory(pytest.Directory):
 
 @pytest.hookimpl
 def pytest_collect_directory(path, parent):
-    # Use our custom collector for directories containing a `mainfest.json` file.
+    # Use our custom collector for directories containing a `manifest.json` file.
     if path.joinpath("manifest.json").is_file():
         return ManifestDirectory.from_parent(parent=parent, path=path)
     # Otherwise fallback to the standard behavior.

doc/en/example/customdirectory/tests/test_first.py

@@ -1,3 +1,6 @@
 # content of test_first.py
+from __future__ import annotations
+
+
 def test_1():
     pass

doc/en/example/customdirectory/tests/test_second.py

@@ -1,3 +1,6 @@
 # content of test_second.py
+from __future__ import annotations
+
+
 def test_2():
     pass

doc/en/example/customdirectory/tests/test_third.py

@@ -1,3 +1,6 @@
 # content of test_third.py
+from __future__ import annotations
+
+
 def test_3():
     pass