Adding a third return value from connection.perform_request - headers

This will be used to implement deserializing based on mimetype

Author: honzakral

Changelog.rst

@@ -13,6 +13,9 @@ Changelog
  * `helpers.bulk` and `helpers.streaming_bulk` are no longer limitted to just
    index operations.
  * unicode body (for `incices.analyze` for example) is now handled correctly
+ * changed `perform_request` on `Connection` classes to return headers as well.
+   This is a backwards incompatible change for people who have developed their own
+   connection class.
 
 0.4.3
 -----

elasticsearch/connection/http_requests.py

@@ -58,4 +58,4 @@ def perform_request(self, method, url, params=None, body=None, timeout=None, ign
 
         self.log_request_success(method, url, response.request.path_url, body, response.status_code, raw_data, duration)
 
-        return response.status_code, raw_data
+        return response.status_code, response.headers, raw_data

elasticsearch/connection/http_urllib3.py

@@ -57,7 +57,5 @@ def perform_request(self, method, url, params=None, body=None, timeout=None, ign
         self.log_request_success(method, full_url, url, body, response.status,
             raw_data, duration)
 
-        return response.status, raw_data
-
-
+        return response.status, response.getheaders(), raw_data
 

elasticsearch/connection/memcached.py

@@ -77,7 +77,7 @@ def perform_request(self, method, url, params=None, body=None, timeout=None, ign
         self.log_request_success(method, full_url, url, body, status,
             response, duration)
 
-        return status, response
+        return status, {}, response
 
 
 

elasticsearch/connection/thrift.py

@@ -73,7 +73,5 @@ def perform_request(self, method, url, params=None, body=None, timeout=None, ign
         self.log_request_success(method, url, url, body, response.status,
             response.body, duration)
 
-        return response.status, response.body
-
-
+        return response.status, response.headers or {}, response.body
 

elasticsearch/transport.py

@@ -154,7 +154,7 @@ def sniff_hosts(self):
             for c in self.connection_pool.connections + self.seed_connections:
                 try:
                     # use small timeout for the sniffing request, should be a fast api call
-                    _, node_info = c.perform_request('GET', '/_cluster/nodes', timeout=.1)
+                    _, headers, node_info = c.perform_request('GET', '/_cluster/nodes', timeout=.1)
                     node_info = self.serializer.loads(node_info)
                     break
                 except (ConnectionError, SerializationError):
@@ -251,7 +251,7 @@ def perform_request(self, method, url, params=None, body=None):
             connection = self.get_connection()
 
             try:
-                status, raw_data = connection.perform_request(method, url, params, body, ignore=ignore)
+                status, headers, raw_data = connection.perform_request(method, url, params, body, ignore=ignore)
             except ConnectionError:
                 self.mark_dead(connection)
 

test_elasticsearch/test_connection.py

@@ -62,7 +62,7 @@ def _dummy_send(*args, **kwargs):
         return con
 
     def _get_request(self, connection, *args, **kwargs):
-        status, data = connection.perform_request(*args, **kwargs)
+        status, headers, data = connection.perform_request(*args, **kwargs)
         self.assertEquals(200, status)
         self.assertEquals(u'{}', data)
 
@@ -129,7 +129,7 @@ def test_failed_request_logs_and_traces(self, logger, tracer):
     @patch('elasticsearch.connection.base.logger')
     def test_success_logs_and_traces(self, logger, tracer):
         con = self._get_mock_connection(response_body='''{"answer": "that's it!"}''')
-        status, data = con.perform_request('GET', '/', {'param': 42}, '''{"question": "what's that?"}''')
+        status, headers, data = con.perform_request('GET', '/', {'param': 42}, '''{"question": "what's that?"}''')
 
         # trace request
         self.assertEquals(1, tracer.info.call_count)

test_elasticsearch/test_transport.py

@@ -11,14 +11,15 @@ class DummyConnection(Connection):
     def __init__(self, **kwargs):
         self.exception = kwargs.pop('exception', None)
         self.status, self.data = kwargs.pop('status', 200), kwargs.pop('data', '{}')
+        self.headers = kwargs.pop('headers', {})
         self.calls = []
         super(DummyConnection, self).__init__(**kwargs)
 
     def perform_request(self, *args, **kwargs):
         self.calls.append((args, kwargs))
         if self.exception:
             raise self.exception
-        return self.status, self.data
+        return self.status, self.headers, self.data
 
 CLUSTER_NODES = '''{
     "ok" : true,