Skip to content

Commit

Permalink
[3.12] gh-112169: Documented getaddrinfo/getnameinfo default loop exe…
Browse files Browse the repository at this point in the history
…cutor usage and implications. (GH-112191) (#120936)

gh-112169: Documented getaddrinfo/getnameinfo default loop executor usage and implications. (GH-112191)
(cherry picked from commit fc297b4)

Co-authored-by: Alek Kowalczyk <alek.kowalczyk@gmail.com>
Co-authored-by: Guido van Rossum <gvanrossum@gmail.com>
Co-authored-by: Kumar Aditya <kumaraditya@python.org>
Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
  • Loading branch information
5 people authored Jun 24, 2024
1 parent 69bd1a8 commit 3afb856
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions Doc/library/asyncio-eventloop.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1139,6 +1139,14 @@ DNS

Asynchronous version of :meth:`socket.getnameinfo`.

.. note::
Both *getaddrinfo* and *getnameinfo* internally utilize their synchronous
versions through the loop's default thread pool executor.
When this executor is saturated, these methods may experience delays,
which higher-level networking libraries may report as increased timeouts.
To mitigate this, consider using a custom executor for other user tasks,
or setting a default executor with a larger number of workers.

.. versionchanged:: 3.7
Both *getaddrinfo* and *getnameinfo* methods were always documented
to return a coroutine, but prior to Python 3.7 they were, in fact,
Expand Down

0 comments on commit 3afb856

Please sign in to comment.