bpo-35153: Add headers parameter to xmlrpc.client.ServerProxy (GH-10308)
Allow to add HTTP headers to XML-RPC requests sent to the server.
diff --git a/Lib/test/test_xmlrpc.py b/Lib/test/test_xmlrpc.py
index 32263f7..916e9c4 100644
--- a/Lib/test/test_xmlrpc.py
+++ b/Lib/test/test_xmlrpc.py
@@ -1170,6 +1170,67 @@
xmlrpclib.gzip_decode(encoded, max_decode=-1)
+class HeadersServerTestCase(BaseServerTestCase):
+ class RequestHandler(xmlrpc.server.SimpleXMLRPCRequestHandler):
+ test_headers = None
+
+ def do_POST(self):
+ self.__class__.test_headers = self.headers
+ return super().do_POST()
+ requestHandler = RequestHandler
+ standard_headers = [
+ 'Host', 'Accept-Encoding', 'Content-Type', 'User-Agent',
+ 'Content-Length']
+
+ def setUp(self):
+ self.RequestHandler.test_headers = None
+ return super().setUp()
+
+ def assertContainsAdditionalHeaders(self, headers, additional):
+ expected_keys = sorted(self.standard_headers + list(additional.keys()))
+ self.assertListEqual(sorted(headers.keys()), expected_keys)
+
+ for key, value in additional.items():
+ self.assertEqual(headers.get(key), value)
+
+ def test_header(self):
+ p = xmlrpclib.ServerProxy(URL, headers=[('X-Test', 'foo')])
+ self.assertEqual(p.pow(6, 8), 6**8)
+
+ headers = self.RequestHandler.test_headers
+ self.assertContainsAdditionalHeaders(headers, {'X-Test': 'foo'})
+
+ def test_header_many(self):
+ p = xmlrpclib.ServerProxy(
+ URL, headers=[('X-Test', 'foo'), ('X-Test-Second', 'bar')])
+ self.assertEqual(p.pow(6, 8), 6**8)
+
+ headers = self.RequestHandler.test_headers
+ self.assertContainsAdditionalHeaders(
+ headers, {'X-Test': 'foo', 'X-Test-Second': 'bar'})
+
+ def test_header_empty(self):
+ p = xmlrpclib.ServerProxy(URL, headers=[])
+ self.assertEqual(p.pow(6, 8), 6**8)
+
+ headers = self.RequestHandler.test_headers
+ self.assertContainsAdditionalHeaders(headers, {})
+
+ def test_header_tuple(self):
+ p = xmlrpclib.ServerProxy(URL, headers=(('X-Test', 'foo'),))
+ self.assertEqual(p.pow(6, 8), 6**8)
+
+ headers = self.RequestHandler.test_headers
+ self.assertContainsAdditionalHeaders(headers, {'X-Test': 'foo'})
+
+ def test_header_items(self):
+ p = xmlrpclib.ServerProxy(URL, headers={'X-Test': 'foo'}.items())
+ self.assertEqual(p.pow(6, 8), 6**8)
+
+ headers = self.RequestHandler.test_headers
+ self.assertContainsAdditionalHeaders(headers, {'X-Test': 'foo'})
+
+
#Test special attributes of the ServerProxy object
class ServerProxyTestCase(unittest.TestCase):
def setUp(self):
@@ -1396,7 +1457,7 @@
BinaryTestCase, FaultTestCase, UseBuiltinTypesTestCase,
SimpleServerTestCase, SimpleServerEncodingTestCase,
KeepaliveServerTestCase1, KeepaliveServerTestCase2,
- GzipServerTestCase, GzipUtilTestCase,
+ GzipServerTestCase, GzipUtilTestCase, HeadersServerTestCase,
MultiPathServerTestCase, ServerProxyTestCase, FailingServerTestCase,
CGIHandlerTestCase, SimpleXMLRPCDispatcherTestCase)
diff --git a/Lib/xmlrpc/client.py b/Lib/xmlrpc/client.py
index ddab76f..a0e923a 100644
--- a/Lib/xmlrpc/client.py
+++ b/Lib/xmlrpc/client.py
@@ -1131,10 +1131,12 @@
# that they can decode such a request
encode_threshold = None #None = don't encode
- def __init__(self, use_datetime=False, use_builtin_types=False):
+ def __init__(self, use_datetime=False, use_builtin_types=False,
+ *, headers=()):
self._use_datetime = use_datetime
self._use_builtin_types = use_builtin_types
self._connection = (None, None)
+ self._headers = list(headers)
self._extra_headers = []
##
@@ -1265,7 +1267,7 @@
def send_request(self, host, handler, request_body, debug):
connection = self.make_connection(host)
- headers = self._extra_headers[:]
+ headers = self._headers + self._extra_headers
if debug:
connection.set_debuglevel(1)
if self.accept_gzip_encoding and gzip:
@@ -1347,9 +1349,11 @@
class SafeTransport(Transport):
"""Handles an HTTPS transaction to an XML-RPC server."""
- def __init__(self, use_datetime=False, use_builtin_types=False, *,
- context=None):
- super().__init__(use_datetime=use_datetime, use_builtin_types=use_builtin_types)
+ def __init__(self, use_datetime=False, use_builtin_types=False,
+ *, headers=(), context=None):
+ super().__init__(use_datetime=use_datetime,
+ use_builtin_types=use_builtin_types,
+ headers=headers)
self.context = context
# FIXME: mostly untested
@@ -1409,7 +1413,7 @@
def __init__(self, uri, transport=None, encoding=None, verbose=False,
allow_none=False, use_datetime=False, use_builtin_types=False,
- *, context=None):
+ *, headers=(), context=None):
# establish a "logical" server connection
# get the url
@@ -1429,6 +1433,7 @@
extra_kwargs = {}
transport = handler(use_datetime=use_datetime,
use_builtin_types=use_builtin_types,
+ headers=headers,
**extra_kwargs)
self.__transport = transport