[3.13] Mention the "context manager" keyword in concurrent.futures documentation (GH-130976) (#137811)
Some checks are pending
Tests / Sanitizers (push) Blocked by required conditions
Tests / (push) Blocked by required conditions
Tests / Check if Autoconf files are up to date (push) Blocked by required conditions
Tests / Windows MSI (push) Blocked by required conditions
Tests / Change detection (push) Waiting to run
Tests / Docs (push) Blocked by required conditions
Tests / Check if the ABI has changed (push) Blocked by required conditions
Tests / Check if generated files are up to date (push) Blocked by required conditions
Tests / Ubuntu SSL tests with OpenSSL (push) Blocked by required conditions
Tests / Android (aarch64) (push) Blocked by required conditions
Tests / Android (x86_64) (push) Blocked by required conditions
Tests / WASI (push) Blocked by required conditions
Tests / Hypothesis tests on Ubuntu (push) Blocked by required conditions
Tests / Address sanitizer (push) Blocked by required conditions
Tests / CIFuzz (push) Blocked by required conditions
Tests / All required checks pass (push) Blocked by required conditions
Lint / lint (push) Waiting to run

Mention the "context manager" keyword in concurrent.futures documentation (GH-130976)
(cherry picked from commit 095bc775ec)

Co-authored-by: Jakub Stasiak <jakub@stasiak.at>
This commit is contained in:
Miss Islington (bot) 2025-08-15 16:11:04 +02:00 committed by GitHub
parent 929a77cfce
commit 2c614a8264
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -92,10 +92,10 @@ Executor Objects
executor has started running will be completed prior to this method
returning. The remaining futures are cancelled.
You can avoid having to call this method explicitly if you use the
:keyword:`with` statement, which will shutdown the :class:`Executor`
(waiting as if :meth:`Executor.shutdown` were called with *wait* set to
``True``)::
You can avoid having to call this method explicitly if you use the executor
as a :term:`context manager` via the :keyword:`with` statement, which
will shutdown the :class:`Executor` (waiting as if :meth:`Executor.shutdown`
were called with *wait* set to ``True``)::
import shutil
with ThreadPoolExecutor(max_workers=4) as e: