classification
Title: asyncio doc: 'socket' transport extra info is not mandatory
Type: Stage: resolved
Components: asyncio Versions: Python 3.6, Python 3.4, Python 3.5
process
Status: closed Resolution: rejected
Dependencies: Superseder:
Assigned To: Nosy List: gvanrossum, vstinner, yselivanov
Priority: normal Keywords:

Created on 2015-11-12 09:55 by vstinner, last changed 2017-06-28 01:17 by vstinner. This issue is now closed.

Messages (5)
msg254527 - (view) Author: STINNER Victor (vstinner) * (Python committer) Date: 2015-11-12 09:55
Not all implementations of asyncio event loops can provide the "socket" transport extra info. See for example this discussion on libuv:
https://github.com/python/asyncio/issues/286

The information should be marked as "optional", or at least we should document that it can miss depending on the event loop.

I guess that other info should be marked as optional.
msg254541 - (view) Author: Guido van Rossum (gvanrossum) * (Python committer) Date: 2015-11-12 18:04
The word 'optional' is literally the second word of the description of get_extra_info(). WHat more do you want?
msg254554 - (view) Author: STINNER Victor (vstinner) * (Python committer) Date: 2015-11-12 20:27
Guido van Rossum added the comment:
> The word 'optional' is literally the second word of the description of get_extra_info(). WHat more do you want?

Hum, it can be surprising for users that an application works on
"asyncio" but doesn't work on "libuv asyncio".

We should explicitly explain that the availability of some information
depend on the event loop.
msg254555 - (view) Author: Guido van Rossum (gvanrossum) * (Python committer) Date: 2015-11-12 20:37
Well I don't know how adding a note to the doc is going to change that
much (those users probably don't read the docs but copy some example),
but go ahead and add something.
msg297109 - (view) Author: STINNER Victor (vstinner) * (Python committer) Date: 2017-06-28 01:17
It seems like Guido doesn't like the idea, so I just close the issue :-)
History
Date User Action Args
2017-06-28 01:17:53vstinnersetstatus: open -> closed
resolution: rejected
messages: + msg297109

stage: resolved
2015-11-12 20:37:08gvanrossumsetmessages: + msg254555
2015-11-12 20:27:08vstinnersetmessages: + msg254554
2015-11-12 18:04:04gvanrossumsetmessages: + msg254541
2015-11-12 09:55:28vstinnercreate