[Python-checkins] gh-87497: Document that urllib.request sends headers in camel case (GH-24661)

[miss-islington]

https://github.com/python/cpython/commit/0ab5e83ff78e5e871768440ab0a7030bc825398f
commit: 0ab5e83ff78e5e871768440ab0a7030bc825398f
branch: 3.9
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: miss-islington <31488909+miss-islington at users.noreply.github.com>
date: 2022-04-13T19:45:56-07:00
summary:

gh-87497: Document that urllib.request sends headers in camel case (GH-24661)


Co-authored-by: Jelle Zijlstra <jelle.zijlstra at gmail.com>
(cherry picked from commit 325d6f50357474c7d9fd2475be0e2481f7ae0476)

Co-authored-by: Alix Lourme <alix.lourme at gmail.com>

files:
M Doc/library/urllib.request.rst
M Lib/test/test_urllib2_localnet.py

diff --git a/Doc/library/urllib.request.rst b/Doc/library/urllib.request.rst
index bfb994e315468..1307143a04f1d 100644
--- a/Doc/library/urllib.request.rst
+++ b/Doc/library/urllib.request.rst
@@ -213,6 +213,7 @@ The following classes are provided:
    (X11; U; Linux i686) Gecko/20071127 Firefox/2.0.0.11"``, while
    :mod:`urllib`'s default user agent string is
    ``"Python-urllib/2.6"`` (on Python 2.6).
+   All header keys are sent in camel case.
 
    An appropriate ``Content-Type`` header should be included if the *data*
    argument is present.  If this header has not been provided and *data*
diff --git a/Lib/test/test_urllib2_localnet.py b/Lib/test/test_urllib2_localnet.py
index 74374c08684da..162e356d1f1bb 100644
--- a/Lib/test/test_urllib2_localnet.py
+++ b/Lib/test/test_urllib2_localnet.py
@@ -613,6 +613,15 @@ def test_sending_headers(self):
             pass
         self.assertEqual(handler.headers_received["Range"], "bytes=20-39")
 
+    def test_sending_headers_camel(self):
+        handler = self.start_server()
+        req = urllib.request.Request("http://localhost:%s/" % handler.port,
+                                     headers={"X-SoMe-hEader": "foobar"})
+        with urllib.request.urlopen(req):
+            pass
+        self.assertIn("X-Some-Header", handler.headers_received.keys())
+        self.assertNotIn("X-SoMe-hEader", handler.headers_received.keys())
+
     def test_basic(self):
         handler = self.start_server()
         with urllib.request.urlopen("http://localhost:%s" % handler.port) as open_url: