Visitar URL original
bpo-29595: Expose max_queue_size in ThreadPoolExecutor by prayerslayer 路 Pull Request #143 路 python/cpython 路 GitHub
Skip to content

bpo-29595: Expose max_queue_size in ThreadPoolExecutor #143

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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
prayerslayer wants to merge 10 commits into from
Closed

bpo-29595: Expose max_queue_size in ThreadPoolExecutor #143

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
66c0031
expose max_queue_size in threadpoolexecutor
prayerslayer Feb 17, 2017
693689c
tests
prayerslayer Feb 18, 2017
e76e9a7
wording
prayerslayer Feb 18, 2017
c2079a7
review fixes
prayerslayer Feb 19, 2017
6103533
update docs
prayerslayer Feb 20, 2017
edcf3f9
fix whitespace
prayerslayer Feb 27, 2017
cde3edd
Merge branch 'master' into expose-max-queue-size-in-threadpoolexecutor
Oct 30, 2017
f10a6f9
Document blocking behavior
Oct 30, 2017
2338991
Add highlevel test for threadpool queue size
Oct 30, 2017
9d1a24b
Add news entry
Oct 30, 2017
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
Prev Previous commit
Next Next commit
update docs
  • Loading branch information
@prayerslayer
prayerslayer authored Feb 20, 2017
commit 6103533b364c19c48f5d61eb1dbef8cfc71c9727
11 changes: 9 additions & 2 deletions Doc/library/concurrent.futures.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,10 +124,11 @@ And::
executor.submit(wait_on_future)


.. class:: ThreadPoolExecutor(max_workers=None, thread_name_prefix='')
.. class:: ThreadPoolExecutor(max_workers=None, thread_name_prefix='', max_queue_size=0)

An :class:`Executor` subclass that uses a pool of at most *max_workers*
threads to execute calls asynchronously.
threads to execute calls asynchronously. If all worker threads are busy it
buffers new work items using a queue of maximum size *max_queue_size*.

@pitrou pitrou Apr 1, 2017

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.

Please document that map and submit will block if the queue size is reached.


.. versionchanged:: 3.5
If *max_workers* is ``None`` or
Expand All @@ -141,6 +142,12 @@ And::
The *thread_name_prefix* argument was added to allow users to
control the threading.Thread names for worker threads created by
the pool for easier debugging.

.. versionadded:: 3.7

@pitrou pitrou Oct 31, 2017

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.

For a new function parameter, this should be versionchanged (versionadded means the function itself is new). Unfortunately, it seems we did the same mistake above for thread_name_prefix...

The *max_queue_size* argument was added to allow users to control
the maximum queue size to not accidentally run out of memory when
new work items are added at a higher rate than what the worker
threads can handle.

.. _threadpoolexecutor-example:

Expand Down