Skip to content

docs: recommend parallel test execution #1917

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.

Sign up for GitHub

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

Open
harshit-s-gowda wants to merge 1 commit into
base: main
Choose a base branch
from
+6 −25
Open

docs: recommend parallel test execution #1917

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 6 additions & 25 deletions testing/run-write-tests.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,29 +17,29 @@ Running and writing tests
Running
=======

The shortest, simplest way of running the test suite is the following command
from the root directory of your checkout (after you have
:ref:`built Python <compiling>`):
The shortest, simplest way of running the test suite is the following command,
which runs tests in parallel, from the root directory of your checkout
(after you have :ref:`built Python <compiling>`):

.. tab:: Unix

.. code-block:: shell

./python -m test
./python -m test -j0

.. tab:: macOS

.. code-block:: shell

./python.exe -m test
./python.exe -m test -j0

This works on :ref:`most <mac-python.exe>` macOS systems.

.. tab:: Windows

.. code-block:: dosbatch

.\python.bat -m test
.\python.bat -m test -j0

This will run the majority of tests, but exclude a small portion of them; these
excluded tests use special kinds of resources: for example, accessing the
Expand Down Expand Up @@ -139,26 +139,7 @@ But, there are several important notes:
In other words: if some module does not have ``unittest.main()``, then
most likely it does not support direct invocation.

If you have a multi-core or multi-CPU machine, you can enable parallel testing

@StanFromIreland StanFromIreland Oct 21, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Can you please add a section expanding how to run tests not in parallel?

using several Python processes so as to speed up things:

.. tab:: Unix

.. code-block:: shell

./python -m test -j0

.. tab:: macOS

.. code-block:: shell

./python.exe -m test -j0

.. tab:: Windows

.. code-block:: dosbatch

.\python.bat -m test -j0

.. _strenuous_testing:

Expand Down
Loading