Merge branch 'pytest-dev:main' into bugfix-12625-ignorebuild

Author: sus-pe

.github/workflows/deploy.yml

@@ -31,7 +31,7 @@ jobs:
         persist-credentials: false
 
     - name: Build and Check Package
-      uses: hynek/build-and-inspect-python-package@v2.9.0
+      uses: hynek/build-and-inspect-python-package@v2.10.0
       with:
         attest-build-provenance-github: 'true'
 

.github/workflows/test.yml

@@ -40,7 +40,7 @@ jobs:
         fetch-depth: 0
         persist-credentials: false
     - name: Build and Check Package
-      uses: hynek/build-and-inspect-python-package@v2.9.0
+      uses: hynek/build-and-inspect-python-package@v2.10.0
 
   build:
     needs: [package]

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
 - repo: https://github.com/astral-sh/ruff-pre-commit
-  rev: "v0.6.9"
+  rev: "v0.7.2"
   hooks:
     - id: ruff
       args: ["--fix"]
@@ -12,7 +12,7 @@ repos:
     -   id: end-of-file-fixer
     -   id: check-yaml
 -   repo: https://github.com/adamchainz/blacken-docs
-    rev: 1.19.0
+    rev: 1.19.1
     hooks:
     -   id: blacken-docs
         additional_dependencies: [black==24.1.1]
@@ -28,7 +28,7 @@ repos:
     hooks:
     -   id: python-use-type-annotations
 -   repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.11.2
+    rev: v1.13.0
     hooks:
     -   id: mypy
         files: ^(src/|testing/|scripts/)
@@ -44,13 +44,13 @@ repos:
             # on <3.11
           - exceptiongroup>=1.0.0rc8
 - repo: https://github.com/tox-dev/pyproject-fmt
-  rev: "2.3.1"
+  rev: "v2.5.0"
   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.18.0
+    rev: v3.19.0
     hooks:
     -   id: pyupgrade
         stages: [manual]
@@ -61,7 +61,8 @@ repos:
         entry: pylint
         language: system
         types: [python]
-        args: ["-rn", "-sn", "--fail-on=I"]
+        args: ["-rn", "-sn", "--fail-on=I", "--enable-all-extentions"]
+        require_serial: true
         stages: [manual]
     -   id: rst
         name: rst

changelog/10829.doc.rst

@@ -0,0 +1 @@
+Improve documentation on the current handling of the ``--basetemp`` option and its lack of retention functionality (:ref:`temporary directory location and retention`).

changelog/11372.improvement.rst renamed to changelog/11372.breaking.rst

@@ -133,27 +133,47 @@ API for details.
 Temporary directory location and retention
 ------------------------------------------
 
-Temporary directories are by default created as sub-directories of
-the system temporary directory.  The base name will be ``pytest-NUM`` where
-``NUM`` will be incremented with each test run.
-By default, entries older than 3 temporary directories will be removed.
-This behavior can be configured with :confval:`tmp_path_retention_count` and
-:confval:`tmp_path_retention_policy`.
+The temporary directories,
+as returned by the :fixture:`tmp_path` and (now deprecated) :fixture:`tmpdir` fixtures,
+are automatically created under a base temporary directory,
+in a structure that depends on the ``--basetemp`` option:
 
-Using the ``--basetemp``
-option will remove the directory before every run, effectively meaning the temporary directories
-of only the most recent run will be kept.
+- By default (when the ``--basetemp`` option is not set),
+  the temporary directories will follow this template:
 
-You can override the default temporary directory setting like this:
+  .. code-block:: text
 
-.. code-block:: bash
+      {temproot}/pytest-of-{user}/pytest-{num}/{testname}/
 
-    pytest --basetemp=mydir
+  where:
 
-.. warning::
+  - ``{temproot}`` is the system temporary directory
+    as determined by :py:func:`tempfile.gettempdir`.
+    It can be overridden by the :envvar:`PYTEST_DEBUG_TEMPROOT` environment variable.
+  - ``{user}`` is the user name running the tests,
+  - ``{num}`` is a number that is incremented with each test suite run
+  - ``{testname}`` is a sanitized version of :py:attr:`the name of the current test <_pytest.nodes.Node.name>`.
 
-    The contents of ``mydir`` will be completely removed, so make sure to use a directory
-    for that purpose only.
+  The auto-incrementing ``{num}`` placeholder provides a basic retention feature
+  and avoids that existing results of previous test runs are blindly removed.
+  By default, the last 3 temporary directories are kept,
+  but this behavior can be configured with
+  :confval:`tmp_path_retention_count` and :confval:`tmp_path_retention_policy`.
+
+- When the ``--basetemp`` option is used (e.g. ``pytest --basetemp=mydir``),
+  it will be used directly as base temporary directory:
+
+  .. code-block:: text
+
+      {basetemp}/{testname}/
+
+  Note that there is no retention feature in this case:
+  only the results of the most recent run will be kept.
+
+  .. warning::
+
+      The directory given to ``--basetemp`` will be cleared blindly before each test run,
+      so make sure to use a directory for that purpose only.
 
 When distributing tests on the local machine using ``pytest-xdist``, care is taken to
 automatically configure a `basetemp` directory for the sub processes such that all temporary