From 536b66f8fa6f8374bd8083ff2ce6a5796791b45f Mon Sep 17 00:00:00 2001 From: "Miss Islington (bot)" <31488909+miss-islington@users.noreply.github.com> Date: Tue, 23 Jan 2024 02:07:34 +0100 Subject: [PATCH] [3.12] gh-66944: Note that the `contextlib.closing` example is for illustrative purposes (GH-112198) (#114458) --- Doc/library/contextlib.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/Doc/library/contextlib.rst b/Doc/library/contextlib.rst index aab319cbe74..b73373bc236 100644 --- a/Doc/library/contextlib.rst +++ b/Doc/library/contextlib.rst @@ -182,6 +182,14 @@ Functions and classes provided: without needing to explicitly close ``page``. Even if an error occurs, ``page.close()`` will be called when the :keyword:`with` block is exited. + .. note:: + + Most types managing resources support the :term:`context manager` protocol, + which closes *thing* on leaving the :keyword:`with` statment. + As such, :func:`!closing` is most useful for third party types that don't + support context managers. + This example is purely for illustration purposes, + as :func:`~urllib.request.urlopen` would normally be used in a context manager. .. function:: aclosing(thing)