gh-112169: Documented getaddrinfo/getnameinfo default loop executor usage and implications. (#112191)

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>
This commit is contained in:
Alek Kowalczyk 2024-06-24 10:35:02 +02:00 committed by GitHub
parent 1500a23f33
commit fc297b4ba4
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -1155,6 +1155,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,