summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2022-03-31 14:24:39 (GMT)
committerGitHub <noreply@github.com>2022-03-31 14:24:39 (GMT)
commit98d57737de73342d33d1b90dc0285f586465d22b (patch)
tree574d4396bc49c55edefad7890ac5cd4b0d949d4f /Doc
parentd04a21344ae69c66f5a6df69ee6fa6988a69b89d (diff)
downloadcpython-98d57737de73342d33d1b90dc0285f586465d22b.zip
cpython-98d57737de73342d33d1b90dc0285f586465d22b.tar.gz
cpython-98d57737de73342d33d1b90dc0285f586465d22b.tar.bz2
bpo-14911: Corrected generator.throw() documentation (GH-32207)
Co-authored-by: Andrew Svetlov <andrew.svetlov@gmail.com> (cherry picked from commit 8be7c2bc5ad5e295f0f855bb31db412eef2c7c92) Co-authored-by: Dave Goncalves <davegoncalves@gmail.com>
Diffstat (limited to 'Doc')
-rw-r--r--Doc/howto/functional.rst2
-rw-r--r--Doc/reference/datamodel.rst3
-rw-r--r--Doc/reference/expressions.rst17
3 files changed, 18 insertions, 4 deletions
diff --git a/Doc/howto/functional.rst b/Doc/howto/functional.rst
index c7f8bc8..695b9b3 100644
--- a/Doc/howto/functional.rst
+++ b/Doc/howto/functional.rst
@@ -589,7 +589,7 @@ generator function.
In addition to :meth:`~generator.send`, there are two other methods on
generators:
-* :meth:`throw(type, value=None, traceback=None) <generator.throw>` is used to
+* :meth:`throw(value) <generator.throw>` is used to
raise an exception inside the generator; the exception is raised by the
``yield`` expression where the generator's execution is paused.
diff --git a/Doc/reference/datamodel.rst b/Doc/reference/datamodel.rst
index 84320f4..033d65f 100644
--- a/Doc/reference/datamodel.rst
+++ b/Doc/reference/datamodel.rst
@@ -2854,7 +2854,8 @@ generators, coroutines do not directly support iteration.
:exc:`StopIteration`, or other exception) is the same as when
iterating over the :meth:`__await__` return value, described above.
-.. method:: coroutine.throw(type[, value[, traceback]])
+.. method:: coroutine.throw(value)
+ coroutine.throw(type[, value[, traceback]])
Raises the specified exception in the coroutine. This method delegates
to the :meth:`~generator.throw` method of the iterator that caused
diff --git a/Doc/reference/expressions.rst b/Doc/reference/expressions.rst
index 4ffb651..502c022 100644
--- a/Doc/reference/expressions.rst
+++ b/Doc/reference/expressions.rst
@@ -557,14 +557,27 @@ is already executing raises a :exc:`ValueError` exception.
could receive the value.
-.. method:: generator.throw(type[, value[, traceback]])
+.. method:: generator.throw(value)
+ generator.throw(type[, value[, traceback]])
- Raises an exception of type ``type`` at the point where the generator was paused,
+ Raises an exception at the point where the generator was paused,
and returns the next value yielded by the generator function. If the generator
exits without yielding another value, a :exc:`StopIteration` exception is
raised. If the generator function does not catch the passed-in exception, or
raises a different exception, then that exception propagates to the caller.
+ In typical use, this is called with a single exception instance similar to the
+ way the :keyword:`raise` keyword is used.
+
+ For backwards compatability, however, the second signature is
+ supported, following a convention from older versions of Python.
+ The *type* argument should be an exception class, and *value*
+ should be an exception instance. If the *value* is not provided, the
+ *type* constructor is called to get an instance. If *traceback*
+ is provided, it is set on the exception, otherwise any existing
+ :attr:`~BaseException.__traceback__` attribute stored in *value* may
+ be cleared.
+
.. index:: exception: GeneratorExit