From d4cbbebe2d3659f8a83e2d8996fbe7bd0a32db26 Mon Sep 17 00:00:00 2001 From: Yury Selivanov Date: Sun, 31 May 2015 17:13:08 -0400 Subject: Issue 24180: Document sys.(set|get)_coroutine_wrapper --- Doc/library/sys.rst | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/Doc/library/sys.rst b/Doc/library/sys.rst index 3080b69..3e8fd82 100644 --- a/Doc/library/sys.rst +++ b/Doc/library/sys.rst @@ -576,6 +576,18 @@ always available. *service_pack_major*, *suite_mask*, and *product_type*. +.. function:: get_coroutine_wrapper() + + Returns ``None``, or a wrapper set by :func:`set_coroutine_wrapper`. + + .. versionadded:: 3.5 + See :pep:`492` for more details. + + .. note:: + This function has been added on a provisional basis (see :pep:`411` + for details.) Use it only for debug purposes. + + .. data:: hash_info A :term:`struct sequence` giving parameters of the numeric hash @@ -1061,6 +1073,28 @@ always available. thus not likely to be implemented elsewhere. +.. function:: set_coroutine_wrapper(wrapper) + + Allows to intercept creation of :term:`coroutine` objects. + + *wrapper* must be either: + + * a callable that accepts one argument (a coroutine object); + * ``None``, to reset the wrapper. + + If called twice, the new wrapper replaces the previous one. The function + is thread-specific. + + See also :func:`get_coroutine_wrapper`. + + .. versionadded:: 3.5 + See :pep:`492` for more details. + + .. note:: + This function has been added on a provisional basis (see :pep:`411` + for details.) Use it only for debug purposes. + + .. data:: stdin stdout stderr -- cgit v0.12