Repository navigation
Document happy eyeball parameters in loop.create_connection signature docs #83309
Description
Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.
Show more details
GitHub fields:
assignee = None
closed_at = <Date 2020-02-24.15:01:22.452>
created_at = <Date 2019-12-24.06:38:19.875>
labels = ['easy', 'expert-asyncio', '3.8', '3.9', 'type-feature', 'docs']
title = 'Document happy eyeball parameters in loop.create_connection signature docs'
updated_at = <Date 2020-02-24.15:06:06.654>
user = 'https://github.com/tirkarthi'bugs.python.org fields:
activity = <Date 2020-02-24.15:06:06.654>
actor = 'miss-islington'
assignee = 'docs@python'
closed = True
closed_date = <Date 2020-02-24.15:01:22.452>
closer = 'asvetlov'
components = ['Documentation', 'asyncio']
creation = <Date 2019-12-24.06:38:19.875>
creator = 'xtreak'
dependencies = []
files = []
hgrepos = []
issue_num = 39128
keywords = ['patch', 'easy']
message_count = 12.0
messages = ['358840', '358844', '361241', '361677', '361678', '361679', '361692', '362087', '362515', '362590', '362591', '362592']
nosy_count = 7.0
nosy_names = ['asvetlov', 'docs@python', 'yselivanov', 'mdk', 'miss-islington', 'xtreak', 'Ido Michael']
pr_nums = ['18315', '18428', '18523', '18624', '18649']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue39128'
versions = ['Python 3.8', 'Python 3.9']
Activity
tirkarthi commentedon Dec 24, 2019
Created from aio-libs/aiohttp#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_connection
asvetlov commentedon Dec 24, 2019
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.
idomic commentedon Feb 2, 2020
Created PR added arguments to method signature in doc.
#62515
JulienPalard commentedon Feb 10, 2020
New changeset 5305cc9 by idomic in branch 'master':
bpo-39128: Added happy_eyeballs_delay, interleave to function signature (GH-18315)
5305cc9
miss-islington commentedon Feb 10, 2020
New changeset af95d79 by Miss Islington (bot) in branch '3.8':
bpo-39128: Added happy_eyeballs_delay, interleave to function signature (GH-18315)
af95d79
JulienPalard commentedon Feb 10, 2020
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.
idomic commentedon Feb 10, 2020
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
idomic commentedon Feb 16, 2020
Created 2nd PR with the Algorithm documentation:
#62723
idomic commentedon Feb 23, 2020
Created new PR and removed the old one #62824
miss-islington commentedon Feb 24, 2020
New changeset 8af4712 by idomic in branch 'master':
bpo-39128: Added algorithm description (GH-18624)
8af4712
asvetlov commentedon Feb 24, 2020
Thanks, Ido
miss-islington commentedon Feb 24, 2020
New changeset 1f4cf0c by Miss Islington (bot) in branch '3.8':
bpo-39128: Added algorithm description (GH-18624)
1f4cf0c