Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Get -nauto default from PYTEST_XDIST_AUTO_NUM_WORKERS #829

Merged
merged 2 commits into from
Oct 24, 2022

Conversation

encukou
Copy link
Contributor

@encukou encukou commented Oct 24, 2022

A few additional tests for existing functionality are added too.
And the -n logical option is documented.

Fixes: #792

A few additional tests for existing functionality are added too.
And the ``-n logical`` option is documented.

Fixes: pytest-dev#792
Copy link
Member

@nicoddemus nicoddemus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work, thanks!

src/xdist/plugin.py Outdated Show resolved Hide resolved
@nicoddemus nicoddemus merged commit c168706 into pytest-dev:master Oct 24, 2022
@encukou encukou deleted the auto-envvar branch October 25, 2022 08:31
bors bot added a commit to microsoft/Qcodes that referenced this pull request Oct 26, 2022
4767: Update pytest-xdist requirement from ~=2.5.0 to ~=3.0.2 r=jenshnielsen a=dependabot[bot]

Updates the requirements on [pytest-xdist](https://github.com/pytest-dev/pytest-xdist) to permit the latest version.
<details>
<summary>Changelog</summary>
<p><em>Sourced from <a href="https://github.com/pytest-dev/pytest-xdist/blob/master/CHANGELOG.rst">pytest-xdist's changelog</a>.</em></p>
<blockquote>
<h1>pytest-xdist 3.0.2 (2022-10-25)</h1>
<h2>Bug Fixes</h2>
<ul>
<li><code>[#813](pytest-dev/pytest-xdist#813) &lt;https://github.com/pytest-dev/pytest-xdist/issues/813&gt;</code>_: Cancel shutdown when a crashed worker is restarted.</li>
</ul>
<h2>Deprecations</h2>
<ul>
<li>
<p><code>[#825](pytest-dev/pytest-xdist#825) &lt;https://github.com/pytest-dev/pytest-xdist/issues/825&gt;</code>_: The <code>--rsyncdir</code> command line argument and <code>rsyncdirs</code> config variable are deprecated.</p>
<p>The rsync feature will be removed in pytest-xdist 4.0.</p>
</li>
<li>
<p><code>[#826](pytest-dev/pytest-xdist#826) &lt;https://github.com/pytest-dev/pytest-xdist/issues/826&gt;</code>_: The <code>--looponfail</code> command line argument and <code>looponfailroots</code> config variable are deprecated.</p>
<p>The loop-on-fail feature will be removed in pytest-xdist 4.0.</p>
</li>
</ul>
<h2>Improved Documentation</h2>
<ul>
<li>
<p><code>[#791](pytest-dev/pytest-xdist#791) &lt;https://github.com/pytest-dev/pytest-xdist/issues/791&gt;</code>_: Document the <code>pytest_xdist_auto_num_workers</code> hook.</p>
</li>
<li>
<p><code>[#796](pytest-dev/pytest-xdist#796) &lt;https://github.com/pytest-dev/pytest-xdist/issues/796&gt;</code>_: Added known limitations section to documentation.</p>
</li>
<li>
<p><code>[#829](pytest-dev/pytest-xdist#829) &lt;https://github.com/pytest-dev/pytest-xdist/issues/829&gt;</code>_: Document the <code>-n logical</code> option.</p>
</li>
</ul>
<h2>Features</h2>
<ul>
<li>
<p><code>[#792](pytest-dev/pytest-xdist#792) &lt;https://github.com/pytest-dev/pytest-xdist/issues/792&gt;</code>_: The environment variable <code>PYTEST_XDIST_AUTO_NUM_WORKERS</code> can now be used to
specify the default for <code>-n auto</code> and <code>-n logical</code>.</p>
</li>
<li>
<p><code>[#812](pytest-dev/pytest-xdist#812) &lt;https://github.com/pytest-dev/pytest-xdist/issues/812&gt;</code>_: Partially restore old initial batch distribution algorithm in <code>LoadScheduling</code>.</p>
<p>pytest orders tests for optimal sequential execution - i. e. avoiding
unnecessary setup and teardown of fixtures. So executing tests in consecutive
chunks is important for optimal performance.</p>
<p>In v1.14, initial test distribution in <code>LoadScheduling</code> was changed to
round-robin, optimized for the corner case, when the number of tests is less
than <code>2 * number of nodes</code>. At the same time, it became worse for all other
cases.</p>
<p>For example: if some tests use some &quot;heavy&quot; fixture, and these tests fit into
the initial batch, with round-robin distribution the fixture will be created</p>
</li>
</ul>
<!-- raw HTML omitted -->
</blockquote>
<p>... (truncated)</p>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a href="https://github.com/pytest-dev/pytest-xdist/commit/eed37d4771f7379156303f63e0d09131f1ac8dee"><code>eed37d4</code></a> Update CHANGELOG</li>
<li><a href="https://github.com/pytest-dev/pytest-xdist/commit/3e9284b6e0b474acaf6f25f8f8db68c78c9cd187"><code>3e9284b</code></a> Merge remote-tracking branch 'upstream/master' into release-3.0.0</li>
<li><a href="https://github.com/pytest-dev/pytest-xdist/commit/ccdab727a29cef7075b853e550eb03aa8de076c1"><code>ccdab72</code></a> Merge pull request <a href="https://github-redirect.dependabot.com/pytest-dev/pytest-xdist/issues/831">#831</a> from pytest-dev/fix-setup</li>
<li><a href="https://github.com/pytest-dev/pytest-xdist/commit/0c981d35475ab6eaee2e6a5ead44442bf07d6e61"><code>0c981d3</code></a> fix and update packaging</li>
<li><a href="https://github.com/pytest-dev/pytest-xdist/commit/38dcf52ae69188b0249eb6307fe6745e2e4174dc"><code>38dcf52</code></a> Release 3.0.1</li>
<li><a href="https://github.com/pytest-dev/pytest-xdist/commit/f2633f1b372dbc58a221cd612c9cb4e79f59eea3"><code>f2633f1</code></a> Fetch all tags, as required by setuptools-scm</li>
<li><a href="https://github.com/pytest-dev/pytest-xdist/commit/192193197bee27228e1e4b44855b3777397e31e5"><code>1921931</code></a> Update CHANGELOG for 3.0</li>
<li><a href="https://github.com/pytest-dev/pytest-xdist/commit/0f58a14def50b9b9112ec25cef97b9593ce86b8a"><code>0f58a14</code></a> Fix towncrier command for latest version</li>
<li><a href="https://github.com/pytest-dev/pytest-xdist/commit/bd23c2460f00129fa0ace7151c8ae18c0a70d5ad"><code>bd23c24</code></a> Fix changelog fragments</li>
<li><a href="https://github.com/pytest-dev/pytest-xdist/commit/794f28bcf4a3711acd074e9637ce8674fb6215be"><code>794f28b</code></a> Use modern syntax for towncrier</li>
<li>Additional commits viewable in <a href="https://github.com/pytest-dev/pytest-xdist/compare/v2.5.0...v3.0.2">compare view</a></li>
</ul>
</details>
<br />


You can trigger a rebase of this PR by commenting ``@dependabot` rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- ``@dependabot` rebase` will rebase this PR
- ``@dependabot` recreate` will recreate this PR, overwriting any edits that have been made to it
- ``@dependabot` merge` will merge this PR after your CI passes on it
- ``@dependabot` squash and merge` will squash and merge this PR after your CI passes on it
- ``@dependabot` cancel merge` will cancel a previously requested merge and block automerging
- ``@dependabot` reopen` will reopen this PR if it is closed
- ``@dependabot` close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- ``@dependabot` ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
- ``@dependabot` ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
- ``@dependabot` ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)


</details>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@hroncok
Copy link
Member

hroncok commented Jan 17, 2023

For the record, our RPM package of pytest-xdist started to fail %check because we set PYTEST_XDIST_AUTO_NUM_WORKERS 😆

This should fix it: #870

folex referenced this pull request in fluencelabs/spell Jun 6, 2023
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [pytest-xdist](https://github.com/pytest-dev/pytest-xdist)
([changelog](https://pytest-xdist.readthedocs.io/en/latest/changelog.html))
| `==2.5.0` -> `==3.3.1` |
[![age](https://badges.renovateapi.com/packages/pypi/pytest-xdist/3.3.1/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/pypi/pytest-xdist/3.3.1/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/pypi/pytest-xdist/3.3.1/compatibility-slim/2.5.0)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/pypi/pytest-xdist/3.3.1/confidence-slim/2.5.0)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>pytest-dev/pytest-xdist</summary>

###
[`v3.3.1`](https://github.com/pytest-dev/pytest-xdist/blob/HEAD/CHANGELOG.rst#pytest-xdist-331-2023-05-19)

[Compare
Source](https://github.com/pytest-dev/pytest-xdist/compare/v3.3.0...v3.3.1)

\===============================

## Bug Fixes

- `#&#8203;907
<https://github.com/pytest-dev/pytest-xdist/issues/907>`\_: Avoid remote
calls during startup as `execnet` by default does not ensure remote
affinity with the
main thread and might accidentally schedule the pytest worker into a
non-main thread, which breaks numerous frameworks,
    for example `asyncio`, `anyio`, `PyQt/PySide`, etc.

A more safe correction will require thread affinity in `execnet`
(`pytest-dev/execnet#&#8203;96
<https://github.com/pytest-dev/execnet/issues/96>`\__).

###
[`v3.3.0`](https://github.com/pytest-dev/pytest-xdist/blob/HEAD/CHANGELOG.rst#pytest-xdist-330-2023-05-12)

[Compare
Source](https://github.com/pytest-dev/pytest-xdist/compare/v3.2.1...v3.3.0)

\===============================

## Features

- `#&#8203;555
<https://github.com/pytest-dev/pytest-xdist/issues/555>`\_: Improved
progress output when collecting nodes to be less verbose.

###
[`v3.2.1`](https://github.com/pytest-dev/pytest-xdist/blob/HEAD/CHANGELOG.rst#pytest-xdist-321-2023-03-12)

[Compare
Source](https://github.com/pytest-dev/pytest-xdist/compare/v3.2.0...v3.2.1)

\===============================

## Bug Fixes

- `#&#8203;884
<https://github.com/pytest-dev/pytest-xdist/issues/884>`\_: Fixed hang
in `worksteal` scheduler.

###
[`v3.2.0`](https://github.com/pytest-dev/pytest-xdist/blob/HEAD/CHANGELOG.rst#pytest-xdist-320-2023-02-07)

[Compare
Source](https://github.com/pytest-dev/pytest-xdist/compare/v3.1.0...v3.2.0)

\===============================

## Improved Documentation

- `#&#8203;863
<https://github.com/pytest-dev/pytest-xdist/issues/863>`\_: Document
limitations for debugging due to standard I/O of workers not being
forwarded. Also, mention remote debugging as a possible workaround.

## Features

- `#&#8203;855
<https://github.com/pytest-dev/pytest-xdist/issues/855>`\_: Users can
now configure `load` scheduling precision using `--maxschedchunk`
command
    line option.

- `#&#8203;858
<https://github.com/pytest-dev/pytest-xdist/issues/858>`*: New
`worksteal` scheduler, based on the idea of `work stealing
<https://en.wikipedia.org/wiki/Work_stealing>`*. It's similar to `load`
scheduler, but it should handle tests with significantly differing
duration better, and, at the same time, it should provide similar or
better reuse of fixtures.

## Trivial Changes

- `#&#8203;870
<https://github.com/pytest-dev/pytest-xdist/issues/870>`\_: Make the
tests pass even when `$PYTEST_XDIST_AUTO_NUM_WORKERS` is set.

###
[`v3.1.0`](https://github.com/pytest-dev/pytest-xdist/blob/HEAD/CHANGELOG.rst#pytest-xdist-310-2022-12-01)

[Compare
Source](https://github.com/pytest-dev/pytest-xdist/compare/v3.0.2...v3.1.0)

\===============================

## Features

- `#&#8203;789
<https://github.com/pytest-dev/pytest-xdist/issues/789>`\_: Users can
now set a default distribution mode in their configuration file:

    .. code-block:: ini

        [pytest]
        addopts = --dist loadscope

- `#&#8203;842
<https://github.com/pytest-dev/pytest-xdist/issues/842>`\_: Python 3.11
is now officially supported.

## Removals

- `#&#8203;842
<https://github.com/pytest-dev/pytest-xdist/issues/842>`\_: Python 3.6
is no longer supported.

###
[`v3.0.2`](https://github.com/pytest-dev/pytest-xdist/blob/HEAD/CHANGELOG.rst#pytest-xdist-302-2022-10-25)

[Compare
Source](https://github.com/pytest-dev/pytest-xdist/compare/v2.5.0...v3.0.2)

\===============================

## Bug Fixes

- `#&#8203;813
<https://github.com/pytest-dev/pytest-xdist/issues/813>`\_: Cancel
shutdown when a crashed worker is restarted.

## Deprecations

- `#&#8203;825
<https://github.com/pytest-dev/pytest-xdist/issues/825>`\_: The
`--rsyncdir` command line argument and `rsyncdirs` config variable are
deprecated.

    The rsync feature will be removed in pytest-xdist 4.0.

- `#&#8203;826
<https://github.com/pytest-dev/pytest-xdist/issues/826>`\_: The
`--looponfail` command line argument and `looponfailroots` config
variable are deprecated.

    The loop-on-fail feature will be removed in pytest-xdist 4.0.

## Improved Documentation

- `#&#8203;791
<https://github.com/pytest-dev/pytest-xdist/issues/791>`\_: Document the
`pytest_xdist_auto_num_workers` hook.

- `#&#8203;796
<https://github.com/pytest-dev/pytest-xdist/issues/796>`\_: Added known
limitations section to documentation.

- `#&#8203;829
<https://github.com/pytest-dev/pytest-xdist/issues/829>`\_: Document the
`-n logical` option.

## Features

- `#&#8203;792
<https://github.com/pytest-dev/pytest-xdist/issues/792>`\_: The
environment variable `PYTEST_XDIST_AUTO_NUM_WORKERS` can now be used to
    specify the default for `-n auto` and `-n logical`.

- `#&#8203;812
<https://github.com/pytest-dev/pytest-xdist/issues/812>`\_: Partially
restore old initial batch distribution algorithm in `LoadScheduling`.

pytest orders tests for optimal sequential execution - i. e. avoiding
unnecessary setup and teardown of fixtures. So executing tests in
consecutive
    chunks is important for optimal performance.

In v1.14, initial test distribution in `LoadScheduling` was changed to
round-robin, optimized for the corner case, when the number of tests is
less
than `2 * number of nodes`. At the same time, it became worse for all
other
    cases.

For example: if some tests use some "heavy" fixture, and these tests fit
into
the initial batch, with round-robin distribution the fixture will be
created
`min(n_tests, n_workers)` times, no matter how many other tests there
are.

With the old algorithm (before v1.14), if there are enough tests not
using
    the fixture, the fixture was created only once.

So restore the old behavior for typical cases where the number of tests
is
much greater than the number of workers (or, strictly speaking, when
there
    are at least 2 tests for every node).

## Removals

- `#&#8203;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.

## Trivial Changes

- `#&#8203;468
<https://github.com/pytest-dev/pytest-xdist/issues/468>`\_: The `py`
dependency has been dropped.

- `#&#8203;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).

- `#&#8203;823
<https://github.com/pytest-dev/pytest-xdist/issues/823>`\_: Remove usage
of `py._pydir` as an rsync candidate.

- `#&#8203;824
<https://github.com/pytest-dev/pytest-xdist/issues/824>`\_: Replace
internal usages of `py.path.local` by `pathlib.Path`.

</details>

---

### Configuration

📅 **Schedule**: Branch creation - "every weekend" (UTC), Automerge - At
any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://app.renovatebot.com/dashboard#github/fluencelabs/spell).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNS40MC4wIiwidXBkYXRlZEluVmVyIjoiMzUuOTUuMSIsInRhcmdldEJyYW5jaCI6Im1haW4ifQ==-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Environment variable to specify number of workers for "auto"
3 participants