mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-11-01 10:45:30 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 15

bpo-43293: Doc: move note about GIL to top of threading module (GH-24622)

Browse source 
The note about the GIL was buried pretty deep in the threading documentation,
and this made it hard for first time users to discover why their attempts
at using threading to parallelizing their application did not work.

In this commit, the note is moved to the top of the module documention for
visibility.
This commit is contained in:
Guanzhong Chen 2021-02-24 13:39:38 -05:00 • committed by GitHub
parent 1f433406bd
commit 32181be608
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

26
Doc/library/threading.rst
View file

@ -21,6 +21,19 @@ level :mod:`_thread` module. See also the :mod:`queue` module.
supported by this module.
.. impl-detail::
In CPython, due to the :term:`Global Interpreter Lock
<global interpreter lock>`, only one thread
can execute Python code at once (even though certain performance-oriented
libraries might overcome this limitation).
If you want your application to make better use of the computational
resources of multi-core machines, you are advised to use
:mod:`multiprocessing` or :class:`concurrent.futures.ProcessPoolExecutor`.
However, threading is still an appropriate model if you want to run
multiple I/O-bound tasks simultaneously.
This module defines the following functions:
@ -424,19 +437,6 @@ since it is impossible to detect the termination of alien threads.
property instead.
.. impl-detail::
In CPython, due to the :term:`Global Interpreter Lock
<global interpreter lock>`, only one thread
can execute Python code at once (even though certain performance-oriented
libraries might overcome this limitation).
If you want your application to make better use of the computational
resources of multi-core machines, you are advised to use
:mod:`multiprocessing` or :class:`concurrent.futures.ProcessPoolExecutor`.
However, threading is still an appropriate model if you want to run
multiple I/O-bound tasks simultaneously.
.. _lock-objects:
Lock Objects