Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Doc][urllib.request] Explicit the fact that header keys are sent in Camel case #87497

Closed
axel3rd mannequin opened this issue Feb 26, 2021 · 2 comments
Closed

[Doc][urllib.request] Explicit the fact that header keys are sent in Camel case #87497

axel3rd mannequin opened this issue Feb 26, 2021 · 2 comments
Labels
3.10 only security fixes docs Documentation in the Doc dir type-bug An unexpected behavior, bug, or error

Comments

@axel3rd
Copy link
Mannequin

axel3rd mannequin commented Feb 26, 2021

BPO 43331
Nosy @axel3rd
PRs
  • gh-87497: Explicit that headers sent in camel-case #24661
  • 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 2021-02-26.19:07:45.617>
    labels = ['type-bug', '3.10', 'docs']
    title = '[Doc][urllib.request] Explicit the fact that header keys are sent in Camel case'
    updated_at = <Date 2021-02-26.19:14:45.575>
    user = 'https://github.com/axel3rd'

    bugs.python.org fields:

    activity = <Date 2021-02-26.19:14:45.575>
    actor = 'axel3rd'
    assignee = 'docs@python'
    closed = False
    closed_date = None
    closer = None
    components = ['Documentation']
    creation = <Date 2021-02-26.19:07:45.617>
    creator = 'axel3rd'
    dependencies = []
    files = []
    hgrepos = []
    issue_num = 43331
    keywords = ['patch']
    message_count = 1.0
    messages = ['387736']
    nosy_count = 2.0
    nosy_names = ['docs@python', 'axel3rd']
    pr_nums = ['24661']
    priority = 'normal'
    resolution = None
    stage = 'patch review'
    status = 'open'
    superseder = None
    type = 'behavior'
    url = 'https://bugs.python.org/issue43331'
    versions = ['Python 3.10']

    @axel3rd
    Copy link
    Mannequin Author

    axel3rd mannequin commented Feb 26, 2021

    Currently, the Request (https://docs.python.org/3/library/urllib.request.html#urllib.request.Request) send header keys in Camel case.

    This is a choice strategy (no problem with that) and even if headers should be considered insensitively (RFC 7230 - 3.2. Header Fields: https://tools.ietf.org/html/rfc7230#section-3.2), this is not always the case.

    The fact that header keys are "rewritten" (in Camel case) could occurs complexity in troubleshooting (for sample: probot/adapter-aws-lambda-serverless#62).

    Having a note/mention about that in documentation would be nice.

    PR will come.

    @axel3rd axel3rd mannequin added the 3.10 only security fixes label Feb 26, 2021
    @axel3rd axel3rd mannequin assigned docspython Feb 26, 2021
    @axel3rd axel3rd mannequin added docs Documentation in the Doc dir type-bug An unexpected behavior, bug, or error 3.10 only security fixes labels Feb 26, 2021
    @axel3rd axel3rd mannequin assigned docspython Feb 26, 2021
    @axel3rd axel3rd mannequin added docs Documentation in the Doc dir type-bug An unexpected behavior, bug, or error labels Feb 26, 2021
    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    miss-islington pushed a commit to miss-islington/cpython that referenced this issue Apr 14, 2022
    …ase (pythonGH-24661)
    
    Co-authored-by: Jelle Zijlstra <[email protected]>
    (cherry picked from commit 325d6f5)
    
    Co-authored-by: Alix Lourme <[email protected]>
    miss-islington added a commit that referenced this issue Apr 14, 2022
    …H-24661)
    
    Co-authored-by: Jelle Zijlstra <[email protected]>
    (cherry picked from commit 325d6f5)
    
    Co-authored-by: Alix Lourme <[email protected]>
    JelleZijlstra pushed a commit that referenced this issue Apr 20, 2022
    …H-24661) (#91517)
    
    Co-authored-by: Jelle Zijlstra <[email protected]>
    (cherry picked from commit 325d6f5)
    
    Co-authored-by: Alix Lourme <[email protected]>
    @hauntsaninja
    Copy link
    Contributor

    Thanks, this is now mentioned in the documentation :-)

    hello-adam pushed a commit to hello-adam/cpython that referenced this issue Jun 2, 2022
    …ase (pythonGH-24661)
    
    Co-authored-by: Jelle Zijlstra <[email protected]>
    (cherry picked from commit 325d6f5)
    
    Co-authored-by: Alix Lourme <[email protected]>
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    3.10 only security fixes docs Documentation in the Doc dir type-bug An unexpected behavior, bug, or error
    Projects
    None yet
    Development

    No branches or pull requests

    1 participant