mirror of
https://github.com/python/cpython.git
synced 2025-08-04 17:08:35 +00:00
[3.13] gh-135110: Fix misleading generator.close()
documentation (GH-135152) (GH-135986)
Some checks are pending
Tests / Windows MSI (push) Blocked by required conditions
Tests / (push) Blocked by required conditions
Tests / Check if the ABI has changed (push) Blocked by required conditions
Tests / Change detection (push) Waiting to run
Tests / Docs (push) Blocked by required conditions
Tests / Check if Autoconf files are up to date (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 / 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
Some checks are pending
Tests / Windows MSI (push) Blocked by required conditions
Tests / (push) Blocked by required conditions
Tests / Check if the ABI has changed (push) Blocked by required conditions
Tests / Change detection (push) Waiting to run
Tests / Docs (push) Blocked by required conditions
Tests / Check if Autoconf files are up to date (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 / 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
gh-135110: Fix misleading `generator.close()` documentation (GH-135152)
The documentation incorrectly stated that generator.close() 'raises' a
GeneratorExit exception. This was misleading because the method doesn't
raise the exception to the caller - it sends the exception internally
to the generator and returns None.
(cherry picked from commit 0d76dccc3b
)
Co-authored-by: Connor Denihan <188690869+cdenihan@users.noreply.github.com>
This commit is contained in:
parent
3789d8d7d7
commit
a7246323a2
2 changed files with 5 additions and 3 deletions
|
@ -602,7 +602,7 @@ generators:
|
|||
raise an exception inside the generator; the exception is raised by the
|
||||
``yield`` expression where the generator's execution is paused.
|
||||
|
||||
* :meth:`~generator.close` raises a :exc:`GeneratorExit` exception inside the
|
||||
* :meth:`~generator.close` sends a :exc:`GeneratorExit` exception to the
|
||||
generator to terminate the iteration. On receiving this exception, the
|
||||
generator's code must either raise :exc:`GeneratorExit` or
|
||||
:exc:`StopIteration`; catching the exception and doing anything else is
|
||||
|
|
|
@ -627,8 +627,10 @@ is already executing raises a :exc:`ValueError` exception.
|
|||
|
||||
.. method:: generator.close()
|
||||
|
||||
Raises a :exc:`GeneratorExit` at the point where the generator function was
|
||||
paused. If the generator function catches the exception and returns a
|
||||
Raises a :exc:`GeneratorExit` exception at the point where the generator
|
||||
function was paused (equivalent to calling ``throw(GeneratorExit)``).
|
||||
The exception is raised by the yield expression where the generator was paused.
|
||||
If the generator function catches the exception and returns a
|
||||
value, this value is returned from :meth:`close`. If the generator function
|
||||
is already closed, or raises :exc:`GeneratorExit` (by not catching the
|
||||
exception), :meth:`close` returns :const:`None`. If the generator yields a
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue