Enhance loadscope options: add --loadscope-reorder to align the param behaviour with argparse

Author: darwintree

changelog/1083.improvement.rst

@@ -1,3 +1,5 @@
-Add ``--no-loadscope-reorder`` option to disable automatic reordering of tests in loadscope for tests where relative ordering matters. This only applies when using ``loadscope``. 
+Add ``--no-loadscope-reorder`` and ``--loadscope-reorder`` option to control whether to automatically reorder tests in loadscope for tests where relative ordering matters. This only applies when using ``loadscope``. 
 
 For example, [test_file_1, test_file_2, ..., test_file_n] are given as input test files, if ``--no-loadscope-reorder`` is used, for either worker, the ``test_file_a`` will be executed before ``test_file_b`` only if ``a < b``.
+
+The default behavior is to reorder the tests to maximize the number of tests that can be executed in parallel.

src/xdist/plugin.py

@@ -127,11 +127,23 @@ def pytest_addoption(parser: pytest.Parser) -> None:
             "(default) no: Run tests inprocess, don't distribute."
         ),
     )
+    group.addoption(
+        "--loadscope-reorder",
+        dest="loadscopereorder",
+        action="store_true",
+        default=True,
+        help=(
+            "Pytest-xdist will default reorder tests by number of tests per scope "
+            "when used in conjunction with loadscope.\n"
+            "This option will enable loadscope reorder which will improve the "
+            "parallelism of the test suite.\n"
+            "However, the partial order of tests might not be retained.\n"
+        ),
+    )
     group.addoption(
         "--no-loadscope-reorder",
         dest="loadscopereorder",
         action="store_false",
-        default=True,
         help=(
             "Pytest-xdist will default reorder tests by number of tests per scope "
             "when used in conjunction with loadscope.\n"