pytest-dev / pytest-dev/pytest-xdist

Performance issue with LoadScopeScheduling when a node has a large number of tests

Open
#1,212 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
1.9k
Forks
287
Avg merge
9h 30m
Merged PRs (30d)
2

Description

I've noticed the use of index() in this code block causes a significant performance issue when a node has a large number of tests. This can be improved by precomputing a mapping from node ID to index using a dictionary and look it up in the loop.

eg.

index_map = {nodeid: i for i, nodeid in enumerate(worker_collection)}
nodeids_indexes = [
    index_map[nodeid]
    for nodeid, completed in work_unit.items()
    if not completed
]

To reproduce the issue, you can run pytest -n 2 --dist=loadscope with the following test code:

import pytest

@pytest.mark.parametrize("i", range(100000))
def test_something(i):
    pass

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in src/xdist/scheduler/loadscope.py around lines 274-280, where worker collection indexes are built. Reproduce with pytest -n 2 --dist=loadscope and the 100000-case parametrized test from the issue. Done means the scheduling path avoids the reported lookup slowdown while preserving the expected node ID indexes.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
distributed-systems, performance, testing-qa
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.