Clarify urllib.request.add_header documentation

[epicfaace]

BPO	46439
Nosy	@merwok, @epicfaace
PRs	bpo-46439: Clarify urllib.request.add_header documentation #30708

^{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 = None
created_at = <Date 2022-01-19.21:00:26.411>
labels = ['docs']
title = 'Clarify urllib.request.add_header documentation'
updated_at = <Date 2022-01-21.19:26:45.818>
user = 'https://github.com/epicfaace'

bugs.python.org fields:

activity = <Date 2022-01-21.19:26:45.818>
actor = 'epicfaace'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2022-01-19.21:00:26.411>
creator = 'epicfaace'
dependencies = []
files = []
hgrepos = []
issue_num = 46439
keywords = ['patch']
message_count = 3.0
messages = ['410983', '411173', '411174']
nosy_count = 3.0
nosy_names = ['eric.araujo', 'docs@python', 'epicfaace']
pr_nums = ['30708']
priority = 'normal'
resolution = None
stage = 'patch review'
status = 'open'
superseder = None
type = None
url = 'https://bugs.python.org/issue46439'
versions = []

[epicfaace]

We should add a note that headers added via urllib.request.add_header are added to redirected requests. It isn't immediately clear upon reading the documentation that this is the case.

[merwok]

I think the doc assumes that people will expect headers to be added for redirections, and if not the existence of the method add_unredirected_header that’s documented just after would tell it.

That said, the addition does no harm, so why not be explicit.

[epicfaace]

Yes -- additionally, since other http libraries (I believe) usually don't forward headers on redirections by default, the default for urllib.request is counterintuitive (and maybe even not ideal for security reasons?) and would benefit from additional clarification.

[merwok]

@slateny what’s the reason for closing this easy doc issue?

[slateny]

@merwok I think it's resolved by the PR in the issue body

[merwok]

Oh right! I missed that, and there wasn’t any automatic linking message or human note to the author in the messages.