kyfx
/
pytest-xdist
mirror of https://github.com/pytest-dev/pytest-xdist.git
4
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix '-n logical' inconsistencies and review --help formatting (#1022) 

Fix #1021 and review formatting of the --help messages, following pytest's rules for consistency.
This commit is contained in:
Bruno Oliveira 2024-02-25 11:49:41 -03:00 committed by GitHub
parent ce9b01e50c
commit f57c65839b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 38 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/distribution.rst
View File

@ -11,11 +11,11 @@ This can lead to considerable speed ups, especially if your test suite takes a
noticeable amount of time. noticeable amount of time.
With ``-n auto``, pytest-xdist will use as many processes as your computer With ``-n auto``, pytest-xdist will use as many processes as your computer
has CPU cores. has physical CPU cores.
Use ``-n logical`` to use the number of *logical* CPU cores rather than Use ``-n logical`` to use the number of *logical* CPU cores rather than
physical ones. This currently requires the ``psutil`` package to be installed; physical ones. This currently requires the `psutil <https://pypi.org/project/psutil/>`__ package to be installed;
if it is not, pytest-xdist will fall back to ``-n auto`` behavior. if it is not or if it fails to determine the number of logical CPUs, fall back to ``-n auto`` behavior.
Pass a number, e.g. ``-n 8``, to specify the number of processes explicitly. Pass a number, e.g. ``-n 8``, to specify the number of processes explicitly.

4
src/xdist/looponfail.py
View File

@ -29,8 +29,8 @@ def pytest_addoption(parser):
action="store_true", action="store_true",
dest="looponfail", dest="looponfail",
default=False, default=False,
help="run tests in subprocess, wait for modified files " help="Run tests in subprocess: wait for files to be modified, then "
"and re-run failing test set until all pass.", "re-run failing test set until all pass.",
) )

60
src/xdist/plugin.py
View File

@ -61,6 +61,10 @@ def parse_numprocesses(s):
@pytest.hookimpl @pytest.hookimpl
def pytest_addoption(parser): def pytest_addoption(parser):
# 'Help' formatting (same rules as pytest's):
# Start with capitalized letters.
# If a single phrase, do not end with period. If more than one phrase, all phrases end with periods.
# Use \n to separate logical lines.
group = parser.getgroup("xdist", "distributed and subprocess testing") group = parser.getgroup("xdist", "distributed and subprocess testing")
group._addoption( group._addoption(
"-n", "-n",
@ -69,10 +73,11 @@ def pytest_addoption(parser):
metavar="numprocesses", metavar="numprocesses",
action="store", action="store",
type=parse_numprocesses, type=parse_numprocesses,
help="Shortcut for '--dist=load --tx=NUM*popen'. With 'auto', attempt " help="Shortcut for '--dist=load --tx=NUM*popen'.\n"
"to detect physical CPU count. With 'logical', detect logical CPU " "With 'logical', attempt to detect logical CPU count (requires psutil, falls back to 'auto').\n"
"count. If physical CPU count cannot be found, falls back to logical " "With 'auto', attempt to detect physical CPU count. If physical CPU count cannot be determined, "
"count. This will be 0 when used with --pdb.", "falls back to 1.\n"
"Forced to 0 (disabled) when used with --pdb.",
) )
group.addoption( group.addoption(
"--maxprocesses", "--maxprocesses",
@ -80,14 +85,15 @@ def pytest_addoption(parser):
metavar="maxprocesses", metavar="maxprocesses",
action="store", action="store",
type=int, type=int,
help="limit the maximum number of workers to process the tests when using --numprocesses=auto", help="Limit the maximum number of workers to process the tests when using --numprocesses "
"with 'auto' or 'logical'",
) )
group.addoption( group.addoption(
"--max-worker-restart", "--max-worker-restart",
action="store", action="store",
default=None, default=None,
dest="maxworkerrestart", dest="maxworkerrestart",
help="maximum number of workers that can be restarted " help="Maximum number of workers that can be restarted "
"when crashed (set to zero to disable this feature)", "when crashed (set to zero to disable this feature)",
) )
group.addoption( group.addoption(
@ -106,18 +112,18 @@ def pytest_addoption(parser):
dest="dist", dest="dist",
default="no", default="no",
help=( help=(
"set mode for distributing tests to exec environments.\n\n" "Set mode for distributing tests to exec environments.\n\n"
"each: send each test to all available environments.\n\n" "each: Send each test to all available environments.\n\n"
"load: load balance by sending any pending test to any" "load: Load balance by sending any pending test to any"
" available environment.\n\n" " available environment.\n\n"
"loadscope: load balance by sending pending groups of tests in" "loadscope: Load balance by sending pending groups of tests in"
" the same scope to any available environment.\n\n" " the same scope to any available environment.\n\n"
"loadfile: load balance by sending test grouped by file" "loadfile: Load balance by sending test grouped by file"
" to any available environment.\n\n" " to any available environment.\n\n"
"loadgroup: like load, but sends tests marked with 'xdist_group' to the same worker.\n\n" "loadgroup: Like 'load', but sends tests marked with 'xdist_group' to the same worker.\n\n"
"worksteal: split the test suite between available environments," "worksteal: Split the test suite between available environments,"
" then rebalance when any worker runs out of tests.\n\n" " then re-balance when any worker runs out of tests.\n\n"
"(default) no: run tests inprocess, don't distribute." "(default) no: Run tests inprocess, don't distribute."
), ),
) )
group.addoption( group.addoption(
@ -127,8 +133,8 @@ def pytest_addoption(parser):
default=[], default=[],
metavar="xspec", metavar="xspec",
help=( help=(
"add a test execution environment. some examples: " "Add a test execution environment. Some examples:\n"
"--tx popen//python=python2.5 --tx socket=192.168.1.102:8888 " "--tx popen//python=python2.5 --tx socket=192.168.1.102:8888\n"
"--tx ssh=user@codespeak.net//chdir=testcache" "--tx ssh=user@codespeak.net//chdir=testcache"
), ),
) )
@ -137,29 +143,29 @@ def pytest_addoption(parser):
action="store_true", action="store_true",
dest="distload", dest="distload",
default=False, default=False,
help="load-balance tests. shortcut for '--dist=load'", help="Load-balance tests. Shortcut for '--dist=load'.",
) )
group.addoption( group.addoption(
"--rsyncdir", "--rsyncdir",
action="append", action="append",
default=[], default=[],
metavar="DIR", metavar="DIR",
help="add directory for rsyncing to remote tx nodes.", help="Add directory for rsyncing to remote tx nodes",
) )
group.addoption( group.addoption(
"--rsyncignore", "--rsyncignore",
action="append", action="append",
default=[], default=[],
metavar="GLOB", metavar="GLOB",
help="add expression for ignores when rsyncing to remote tx nodes.", help="Add expression for ignores when rsyncing to remote tx nodes",
) )
group.addoption( group.addoption(
"--testrunuid", "--testrunuid",
action="store", action="store",
help=( help=(
"provide an identifier shared amongst all workers as the value of " "Provide an identifier shared amongst all workers as the value of "
"the 'testrun_uid' fixture,\n\n," "the 'testrun_uid' fixture.\n"
"if not provided, 'testrun_uid' is filled with a new unique string " "If not provided, 'testrun_uid' is filled with a new unique string "
"on every test run." "on every test run."
), ),
) )
@ -168,13 +174,13 @@ def pytest_addoption(parser):
action="store", action="store",
type=int, type=int,
help=( help=(
"Maximum number of tests scheduled in one step for --dist=load. " "Maximum number of tests scheduled in one step for --dist=load.\n"
"Setting it to 1 will force pytest to send tests to workers one by " "Setting it to 1 will force pytest to send tests to workers one by "
"one - might be useful for a small number of slow tests. " "one - might be useful for a small number of slow tests.\n"
"Larger numbers will allow the scheduler to submit consecutive " "Larger numbers will allow the scheduler to submit consecutive "
"chunks of tests to workers - allows reusing fixtures. " "chunks of tests to workers - allows reusing fixtures.\n"
"Due to implementation reasons, at least 2 tests are scheduled per " "Due to implementation reasons, at least 2 tests are scheduled per "
"worker at the start. Only later tests can be scheduled one by one. " "worker at the start. Only later tests can be scheduled one by one.\n"
"Unlimited if not set." "Unlimited if not set."
), ),
) )