gh-135056: Rename custom headers to extra_response_headers.

Author: aisipos

Doc/library/http.server.rst

@@ -362,7 +362,7 @@ instantiation, of which this module provides three different variants:
          delays, it now always returns the IP address.
 
 
-.. class:: SimpleHTTPRequestHandler(request, client_address, server, directory=None, response_headers=None)
+.. class:: SimpleHTTPRequestHandler(request, client_address, server, directory=None, extra_response_headers=None)
 
    This class serves files from the directory *directory* and below,
    or the current directory if *directory* is not provided, directly
@@ -399,9 +399,9 @@ instantiation, of which this module provides three different variants:
          This dictionary is no longer filled with the default system mappings,
          but only contains overrides.
 
-   .. attribute:: response_headers
+   .. attribute:: extra_response_headers
 
-      A sequence of ``(name, value)`` pairs containing user specified custom
+      A sequence of ``(name, value)`` pairs containing user specified extra
       HTTP response headers to add to each successful HTTP status 200 response.
       All other status code responses will not include these headers.
 
@@ -438,8 +438,8 @@ instantiation, of which this module provides three different variants:
       followed by a ``'Content-Length:'`` header with the file's size and a
       ``'Last-Modified:'`` header with the file's modification time.
 
-      The instance attribute ``response_headers`` is a sequence of
-      ``(name, value)`` pairs containing user specified custom response headers.
+      The instance attribute ``extra_response_headers`` is a sequence of
+      ``(name, value)`` pairs containing user specified extra response headers.
 
       Then follows a blank line signifying the end of the headers, and then the
       contents of the file are output.
@@ -558,7 +558,7 @@ The following options are accepted:
 
 .. option:: -H, --header <header> <value>
 
-   Specify an additional custom HTTP Response Header to send on successful HTTP
+   Specify an additional extra HTTP Response Header to send on successful HTTP
    200 responses. Can be used multiple times to send additional custom response
    headers.
 

Doc/whatsnew/3.15.rst

@@ -112,7 +112,7 @@ difflib
 http.server
 -----------
 
-* Added a new ``response_headers`` keyword argument to
+* Added a new ``extra_response_headers`` keyword argument to
   :class:`SimpleHTTPRequestHandler` to support custom headers in HTTP responses.
   (Contributed by Anton I. Sipos in :gh:`135057`.)
 

Lib/http/server.py

@@ -692,11 +692,11 @@ class SimpleHTTPRequestHandler(BaseHTTPRequestHandler):
         '.xz': 'application/x-xz',
     }
 
-    def __init__(self, *args, directory=None, response_headers=None, **kwargs):
+    def __init__(self, *args, directory=None, extra_response_headers=None, **kwargs):
         if directory is None:
             directory = os.getcwd()
         self.directory = os.fspath(directory)
-        self.response_headers = response_headers
+        self.extra_response_headers = extra_response_headers
         super().__init__(*args, **kwargs)
 
     def do_GET(self):
@@ -714,11 +714,10 @@ def do_HEAD(self):
         if f:
             f.close()
 
-    def send_custom_response_headers(self):
-        """Send the headers stored in self.response_headers"""
-        # User specified response_headers
-        if self.response_headers is not None:
-            for header, value in self.response_headers:
+    def _send_extra_response_headers(self):
+        """Send the headers stored in self.extra_response_headers"""
+        if self.extra_response_headers is not None:
+            for header, value in self.extra_response_headers:
                 self.send_header(header, value)
 
     def send_head(self):
@@ -803,7 +802,7 @@ def send_head(self):
             self.send_header("Content-Length", str(fs[6]))
             self.send_header("Last-Modified",
                 self.date_time_string(fs.st_mtime))
-            self.send_custom_response_headers()
+            self._send_extra_response_headers()
             self.end_headers()
             return f
         except:
@@ -868,7 +867,7 @@ def list_directory(self, path):
         self.send_response(HTTPStatus.OK)
         self.send_header("Content-type", "text/html; charset=%s" % enc)
         self.send_header("Content-Length", str(len(encoded)))
-        self.send_custom_response_headers()
+        self._send_extra_response_headers()
         self.end_headers()
         return f
 
@@ -1076,7 +1075,7 @@ def server_bind(self):
         def finish_request(self, request, client_address):
             self.RequestHandlerClass(request, client_address, self,
                                      directory=args.directory,
-                                     response_headers=args.header)
+                                     extra_response_headers=args.header)
 
     class HTTPDualStackServer(DualStackServerMixin, ThreadingHTTPServer):
         pass

Lib/test/test_httpservers.py

@@ -466,9 +466,9 @@ def test_err(self):
 
 
 class CustomHeaderSimpleHTTPRequestHandler(SimpleHTTPRequestHandler):
-    custom_headers = None
-    def __init__(self, *args, directory=None, response_headers=None, **kwargs):
-        super().__init__(*args, response_headers=self.custom_headers, **kwargs)
+    extra_response_headers = None
+    def __init__(self, *args, directory=None, extra_response_headers=None, **kwargs):
+        super().__init__(*args, extra_response_headers=self.extra_response_headers, **kwargs)
 
 
 class SimpleHTTPServerTestCase(BaseTestCase):
@@ -829,17 +829,17 @@ def test_path_without_leading_slash(self):
         self.assertEqual(response.getheader("Location"),
                          self.tempdir_name + "/?hi=1")
 
-    def test_custom_headers_list_dir(self):
-        with mock.patch.object(self.request_handler, 'custom_headers', new=[
+    def test_extra_headers_list_dir(self):
+        with mock.patch.object(self.request_handler, 'extra_response_headers', new=[
             ('X-Test1', 'test1'),
             ('X-Test2', 'test2'),
         ]):
             response = self.request(self.base_url + '/')
             self.assertEqual(response.getheader("X-Test1"), 'test1')
             self.assertEqual(response.getheader("X-Test2"), 'test2')
 
-    def test_custom_headers_get_file(self):
-        with mock.patch.object(self.request_handler, 'custom_headers', new=[
+    def test_extra_response_headers_get_file(self):
+        with mock.patch.object(self.request_handler, 'extra_response_headers', new=[
             ('Set-Cookie', 'test1=value1'),
             ('Set-Cookie', 'test2=value2'),
             ('X-Test1', 'value3'),
@@ -1491,7 +1491,7 @@ def test_unknown_flag(self, _):
 
     @mock.patch('http.server._make_server', wraps=server._make_server)
     @mock.patch.object(HTTPServer, 'serve_forever')
-    def test_response_headers_arg(self, _, mock_make_server):
+    def test_extra_response_headers_arg(self, _, mock_make_server):
         server._main(
             ['-H', 'Set-Cookie', 'k=v', '-H', 'Set-Cookie', 'k2=v2', '8080']
         )
@@ -1508,11 +1508,11 @@ def test_response_headers_arg(self, _, mock_make_server):
         ) as mock_handler_init:
             mock_handler_init.return_value = None
             # finish_request instantiates a request handler class,
-            # ensure response_headers are passed to it
+            # ensure extra_response_headers are passed to it
             httpd.finish_request(mock.Mock(), '127.0.0.1')
             mock_handler_init.assert_called_once_with(
                 mock.ANY, mock.ANY, mock.ANY, directory=mock.ANY,
-                response_headers=[
+                extra_response_headers=[
                     ['Set-Cookie', 'k=v'], ['Set-Cookie', 'k2=v2']
                 ]
             )