[issue39128] Document happy eyeball parameters in loop.create_connection signature docs
New submission from Karthikeyan Singaravelan <tir.karthi@gmail.com>: Created from https://github.com/aio-libs/aiohttp/issues/4451 . happy_eyeballs_delay and interleave are not documented in the signature at [0] though the parameters were explained below . Andrew, feel free to update if there is any additional action needed besides signature update. I guess it could be tagged as a good newcomer friendly issue. [0] https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.create... ---------- assignee: docs@python components: Documentation, asyncio messages: 358840 nosy: asvetlov, docs@python, xtreak, yselivanov priority: normal severity: normal status: open title: Document happy eyeball parameters in loop.create_connection signature docs type: enhancement versions: Python 3.8, Python 3.9 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue39128> _______________________________________
Andrew Svetlov <andrew.svetlov@gmail.com> added the comment: Ideally, a small chapter with a description of Happy Eyeballs algorithm would be nice to have but I don't insist. Updating the method signature is a big step anyway. ---------- keywords: +easy _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue39128> _______________________________________
Change by Ido Michael <michael.ido@gmail.com>: ---------- keywords: +patch pull_requests: +17691 stage: -> patch review pull_request: https://github.com/python/cpython/pull/18315 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue39128> _______________________________________
Ido Michael <michael.ido@gmail.com> added the comment: Created PR added arguments to method signature in doc. GH-18315 ---------- nosy: +Ido Michael _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue39128> _______________________________________
Change by miss-islington <mariatta.wijaya+miss-islington@gmail.com>: ---------- pull_requests: +17804 pull_request: https://github.com/python/cpython/pull/18428 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue39128> _______________________________________
Julien Palard <julien+python@palard.fr> added the comment: New changeset 5305cc9dbfe8a5a0ab666511f3ba7f026c8983f8 by idomic in branch 'master': bpo-39128: Added happy_eyeballs_delay, interleave to function signature (GH-18315) https://github.com/python/cpython/commit/5305cc9dbfe8a5a0ab666511f3ba7f026c8... ---------- nosy: +mdk _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue39128> _______________________________________
miss-islington <mariatta.wijaya+miss-islington@gmail.com> added the comment: New changeset af95d790a86fc46739badfa9edbaeb264ee96600 by Miss Islington (bot) in branch '3.8': bpo-39128: Added happy_eyeballs_delay, interleave to function signature (GH-18315) https://github.com/python/cpython/commit/af95d790a86fc46739badfa9edbaeb264ee... ---------- nosy: +miss-islington _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue39128> _______________________________________
Julien Palard <julien+python@palard.fr> added the comment: I merged the first PR about adding parameter, but I'm not closing this issue yet, as Andrew said, a small chapter with a description of Happy Eyeballs algorithm would be nice, if anyone want to write a PR, go for it. ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue39128> _______________________________________
Ido Michael <michael.ido@gmail.com> added the comment: Thanks Julien, I forgot about this part, will create a new PR. I thought referencing the abstract of the algorithm + a link to the IETF RFC: Happy Eyeballs: Success with Dual-Stack Hosts When a server's IPv4 path and protocol are working, but the server's IPv6 path and protocol are not working, a dual-stack client application experiences significant connection delay compared to an IPv4-only client. This is undesirable because it causes the dual- stack client to have a worse user experience. This document specifies requirements for algorithms that reduce this user-visible delay and provides an algorithm. https://tools.ietf.org/html/rfc6555 ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue39128> _______________________________________
Change by Ido Michael <michael.ido@gmail.com>: ---------- pull_requests: +17900 pull_request: https://github.com/python/cpython/pull/18523 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue39128> _______________________________________
Ido Michael <michael.ido@gmail.com> added the comment: Created 2nd PR with the Algorithm documentation: GH-18523 ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue39128> _______________________________________
Change by Ido Michael <michael.ido@gmail.com>: ---------- pull_requests: +17989 pull_request: https://github.com/python/cpython/pull/18624 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue39128> _______________________________________
Ido Michael <michael.ido@gmail.com> added the comment: Created new PR and removed the old one GH-18624 ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue39128> _______________________________________
miss-islington <mariatta.wijaya+miss-islington@gmail.com> added the comment: New changeset 8af4712a16e4b7d1b60f1faec13cd7a88da95f6a by idomic in branch 'master': bpo-39128: Added algorithm description (GH-18624) https://github.com/python/cpython/commit/8af4712a16e4b7d1b60f1faec13cd7a88da... ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue39128> _______________________________________
Change by miss-islington <mariatta.wijaya+miss-islington@gmail.com>: ---------- pull_requests: +18008 pull_request: https://github.com/python/cpython/pull/18649 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue39128> _______________________________________
Change by Andrew Svetlov <andrew.svetlov@gmail.com>: ---------- resolution: -> fixed stage: patch review -> resolved status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue39128> _______________________________________
Andrew Svetlov <andrew.svetlov@gmail.com> added the comment: Thanks, Ido ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue39128> _______________________________________
miss-islington <mariatta.wijaya+miss-islington@gmail.com> added the comment: New changeset 1f4cf0c22b00fefb17611546755b65d3cb488330 by Miss Islington (bot) in branch '3.8': bpo-39128: Added algorithm description (GH-18624) https://github.com/python/cpython/commit/1f4cf0c22b00fefb17611546755b65d3cb4... ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue39128> _______________________________________
participants (5)
-
Andrew Svetlov -
Ido Michael
-
Julien Palard
-
Karthikeyan Singaravelan
-
miss-islington