Skip to content

Commit 1921931

Browse files
committed
Update CHANGELOG for 3.0
1 parent 0f58a14 commit 1921931

14 files changed

+78
-39
lines changed

CHANGELOG.rst

+78
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,81 @@
1+
pytest-xdist 3.0.0 (2022-10-24)
2+
===============================
3+
4+
Bug Fixes
5+
---------
6+
7+
- `#813 <https://github.com/pytest-dev/pytest-xdist/issues/813>`_: Cancel shutdown when a crashed worker is restarted.
8+
9+
10+
Deprecations
11+
------------
12+
13+
- `#825 <https://github.com/pytest-dev/pytest-xdist/issues/825>`_: The ``--rsyncdir`` command line argument and ``rsyncdirs`` config variable are deprecated.
14+
15+
The rsync feature will be removed in pytest-xdist 4.0.
16+
17+
- `#826 <https://github.com/pytest-dev/pytest-xdist/issues/826>`_: The ``--looponfail`` command line argument and ``looponfailroots`` config variable are deprecated.
18+
19+
The loop-on-fail feature will be removed in pytest-xdist 4.0.
20+
21+
22+
Improved Documentation
23+
----------------------
24+
25+
- `#791 <https://github.com/pytest-dev/pytest-xdist/issues/791>`_: Document the ``pytest_xdist_auto_num_workers`` hook.
26+
27+
- `#796 <https://github.com/pytest-dev/pytest-xdist/issues/796>`_: Added known limitations section to documentation.
28+
29+
- `#829 <https://github.com/pytest-dev/pytest-xdist/issues/829>`_: Document the ``-n logical`` option.
30+
31+
32+
Features
33+
--------
34+
35+
- `#792 <https://github.com/pytest-dev/pytest-xdist/issues/792>`_: The environment variable ``PYTEST_XDIST_AUTO_NUM_WORKERS`` can now be used to
36+
specify the default for ``-n auto`` and ``-n logical``.
37+
38+
- `#812 <https://github.com/pytest-dev/pytest-xdist/issues/812>`_: Partially restore old initial batch distribution algorithm in ``LoadScheduling``.
39+
40+
pytest orders tests for optimal sequential execution - i. e. avoiding
41+
unnecessary setup and teardown of fixtures. So executing tests in consecutive
42+
chunks is important for optimal performance.
43+
44+
In v1.14, initial test distribution in ``LoadScheduling`` was changed to
45+
round-robin, optimized for the corner case, when the number of tests is less
46+
than ``2 * number of nodes``. At the same time, it became worse for all other
47+
cases.
48+
49+
For example: if some tests use some "heavy" fixture, and these tests fit into
50+
the initial batch, with round-robin distribution the fixture will be created
51+
``min(n_tests, n_workers)`` times, no matter how many other tests there are.
52+
53+
With the old algorithm (before v1.14), if there are enough tests not using
54+
the fixture, the fixture was created only once.
55+
56+
So restore the old behavior for typical cases where the number of tests is
57+
much greater than the number of workers (or, strictly speaking, when there
58+
are at least 2 tests for every node).
59+
60+
61+
Removals
62+
--------
63+
64+
- `#468 <https://github.com/pytest-dev/pytest-xdist/issues/468>`_: The ``--boxed`` command-line option has been removed. If you still need this functionality, install `pytest-forked <https://pypi.org/project/pytest-forked>`__ separately.
65+
66+
67+
Trivial Changes
68+
---------------
69+
70+
- `#468 <https://github.com/pytest-dev/pytest-xdist/issues/468>`_: The ``py`` dependency has been dropped.
71+
72+
- `#822 <https://github.com/pytest-dev/pytest-xdist/issues/822>`_: Replace internal usage of ``py.log`` with a custom solution (but with the same interface).
73+
74+
- `#823 <https://github.com/pytest-dev/pytest-xdist/issues/823>`_: Remove usage of ``py._pydir`` as an rsync candidate.
75+
76+
- `#824 <https://github.com/pytest-dev/pytest-xdist/issues/824>`_: Replace internal usages of ``py.path.local`` by ``pathlib.Path``.
77+
78+
179
pytest-xdist 2.5.0 (2021-12-10)
280
===============================
381

changelog/468.removal.rst

-1
This file was deleted.

changelog/468.trivial.rst

-1
This file was deleted.

changelog/791.doc

-1
This file was deleted.

changelog/792.feature

-2
This file was deleted.

changelog/796.doc.rst

-1
This file was deleted.

changelog/812.feature

-22
This file was deleted.

changelog/813.bugfix

-1
This file was deleted.

changelog/822.trivial.rst

-1
This file was deleted.

changelog/823.trivial.rst

-1
This file was deleted.

changelog/824.trivial.rst

-1
This file was deleted.

changelog/825.deprecation.rst

-3
This file was deleted.

changelog/826.deprecation.rst

-3
This file was deleted.

changelog/829.doc

-1
This file was deleted.

0 commit comments

Comments
 (0)