Better method names in HTTP/2.

Author: Lukasa

docs/source/advanced.rst

@@ -17,7 +17,7 @@ you decide you want to avoid keeping the connection open, you can use the
 
     with HTTP20Connection('twitter.com:443') as conn:
         conn.request('GET', '/')
-        data = conn.getresponse().read()
+        data = conn.get_response().read()
 
     analyse(data)
 
@@ -130,7 +130,7 @@ In order to receive pushed resources, the
 with ``enable_push=True``.
 
 You may retrieve the push promises that the server has sent *so far* by calling
-:meth:`getpushes() <hyper.HTTP20Connection.getpushes>`, which returns a
+:meth:`get_pushes() <hyper.HTTP20Connection.get_pushes>`, which returns a
 generator that yields :class:`HTTP20Push <hyper.HTTP20Push>` objects. Note that
 this method is not idempotent; promises returned in one call will not be
 returned in subsequent calls. If ``capture_all=False`` is passed (the default),
@@ -143,11 +143,11 @@ the original response, or when also processing the original response in a
 separate thread (N.B. do not do this; ``hyper`` is not yet thread-safe)::
 
     conn.request('GET', '/')
-    response = conn.getresponse()
-    for push in conn.getpushes(): # all pushes promised before response headers
+    response = conn.get_response()
+    for push in conn.get_pushes(): # all pushes promised before response headers
         print(push.path)
     conn.read()
-    for push in conn.getpushes(): # all other pushes
+    for push in conn.get_pushes(): # all other pushes
         print(push.path)
 
 To cancel an in-progress pushed stream (for example, if the user already has

docs/source/index.rst

@@ -18,7 +18,7 @@ improved speed, lower bandwidth usage, better connection management, and more.
 
     conn = HTTP20Connection('twitter.com:443')
     conn.request('GET', '/')
-    resp = conn.getresponse()
+    resp = conn.get_response()
 
     print(resp.read())
 

docs/source/quickstart.rst

@@ -61,7 +61,7 @@ Begin by getting the Twitter homepage::
     >>> c = HTTP20Connection('twitter.com:443')
     >>> c.request('GET', '/')
     1
-    >>> resp = c.getresponse()
+    >>> resp = c.get_response()
 
 Used in this way, ``hyper`` behaves exactly like ``http.client``. You can make
 sequential requests using the exact same API you're accustomed to. The only
@@ -103,9 +103,9 @@ For example::
     >>> first = c.request('GET', '/')
     >>> second = c.request('GET', '/lukasaoz')
     >>> third = c.request('GET', '/about')
-    >>> second_response = c.getresponse(second)
-    >>> first_response = c.getresponse(first)
-    >>> third_response = c.getresponse(third)
+    >>> second_response = c.get_response(second)
+    >>> first_response = c.get_response(first)
+    >>> third_response = c.get_response(third)
 
 ``hyper`` will ensure that each response is matched to the correct request.
 

hyper/cli.py

@@ -216,7 +216,7 @@ def get_content_type_and_charset(response):
 def request(args):
     conn = HTTP20Connection(args.url.host, args.url.port)
     conn.request(args.method, args.url.path, args.body, args.headers)
-    response = conn.getresponse()
+    response = conn.get_response()
     log.debug('Response Headers:\n%s', pformat(response.getheaders()))
     ctype, charset = get_content_type_and_charset(response)
     data = response.read().decode(charset)

hyper/contrib.py

@@ -58,7 +58,7 @@ def send(self, request, stream=False, **kwargs):
             request.body,
             request.headers
         )
-        resp = conn.getresponse(stream_id)
+        resp = conn.get_response(stream_id)
 
         r = self.build_response(request, resp)
 

hyper/http20/connection.py

@@ -50,7 +50,7 @@ class HTTP20Connection(object):
         will be used.
     :param enable_push: (optional) Whether the server is allowed to push
         resources to the client (see
-        :meth:`getpushes() <hyper.HTTP20Connection.getpushes>`).
+        :meth:`get_pushes() <hyper.HTTP20Connection.get_pushes>`).
     """
     def __init__(self, host, port=None, window_manager=None, enable_push=False,
                  **kwargs):
@@ -156,7 +156,7 @@ def _get_stream(self, stream_id):
         return (self.streams[stream_id] if stream_id is not None
                 else self.recent_stream)
 
-    def getresponse(self, stream_id=None):
+    def get_response(self, stream_id=None):
         """
         Should be called after a request is sent to get a response from the
         server. If sending multiple parallel requests, pass the stream ID of
@@ -172,7 +172,7 @@ def getresponse(self, stream_id=None):
         stream = self._get_stream(stream_id)
         return HTTP20Response(stream.getheaders(), stream)
 
-    def getpushes(self, stream_id=None, capture_all=False):
+    def get_pushes(self, stream_id=None, capture_all=False):
         """
         Returns a generator that yields push promises from the server. **Note
         that this method is not idempotent**: promises returned in one call
@@ -191,7 +191,7 @@ def getpushes(self, stream_id=None, capture_all=False):
             corresponding to the streams pushed by the server.
         """
         stream = self._get_stream(stream_id)
-        for promised_stream_id, headers in stream.getpushes(capture_all):
+        for promised_stream_id, headers in stream.get_pushes(capture_all):
             yield HTTP20Push(
                 HTTPHeaderMap(headers), self.streams[promised_stream_id]
             )

hyper/http20/response.py

@@ -181,7 +181,7 @@ def __init__(self, request_headers, stream):
 
         self._stream = stream
 
-    def getresponse(self):
+    def get_response(self):
         """
         Get the pushed response provided by the server.
 

hyper/http20/stream.py

@@ -324,7 +324,7 @@ def gettrailers(self):
 
         return self.response_trailers
 
-    def getpushes(self, capture_all=False):
+    def get_pushes(self, capture_all=False):
         """
         Returns a generator that yields push promises from the server. Note that
         this method is not idempotent; promises returned in one call will not be

test/test_cli.py

@@ -51,7 +51,7 @@ def __init__(self, host, port):
     def request(self, method, path, body, headers):
         return method, path, body, headers
 
-    def getresponse(self):
+    def get_response(self):
         return self.response
 
 

test/test_hyper.py

@@ -1213,8 +1213,8 @@ def test_read_headers_out_of_order(self):
         r1 = c.request('GET', '/a')
         r3 = c.request('GET', '/b')
 
-        assert c.getresponse(r3).headers == HTTPHeaderMap([('content-type', 'baz/qux')])
-        assert c.getresponse(r1).headers == HTTPHeaderMap([('content-type', 'foo/bar')])
+        assert c.get_response(r3).headers == HTTPHeaderMap([('content-type', 'baz/qux')])
+        assert c.get_response(r1).headers == HTTPHeaderMap([('content-type', 'foo/bar')])
 
     def test_headers_with_continuation(self):
         e = Encoder()
@@ -1233,7 +1233,7 @@ def test_headers_with_continuation(self):
         c._sock = sock
         r = c.request('GET', '/')
 
-        assert set(c.getresponse(r).headers.iter_raw()) == set([(b'content-type', b'foo/bar'), (b'content-length', b'0')])
+        assert set(c.get_response(r).headers.iter_raw()) == set([(b'content-type', b'foo/bar'), (b'content-length', b'0')])
 
     def test_receive_unexpected_frame(self):
         # RST_STREAM frames are never defined on connections, so send one of
@@ -1275,7 +1275,7 @@ def test_window_increments_appropriately(self):
         c.window_manager.window_size = 1000
         c.window_manager.initial_window_size = 1000
         c.request('GET', '/')
-        resp = c.getresponse()
+        resp = c.get_response()
         resp.read()
 
         queue = list(map(decode_frame, map(memoryview, sock.queue)))
@@ -1371,12 +1371,12 @@ def request(self):
         self.conn.request('GET', '/')
 
     def assert_response(self):
-        self.response = self.conn.getresponse()
+        self.response = self.conn.get_response()
         assert self.response.status == 200
         assert dict(self.response.headers) == {b'content-type': [b'text/html']}
 
     def assert_pushes(self):
-        self.pushes = list(self.conn.getpushes())
+        self.pushes = list(self.conn.get_pushes())
         assert len(self.pushes) == 1
         assert self.pushes[0].method == b'GET'
         assert self.pushes[0].scheme == b'https'
@@ -1386,7 +1386,7 @@ def assert_pushes(self):
         assert dict(self.pushes[0].request_headers) == expected_headers
 
     def assert_push_response(self):
-        push_response = self.pushes[0].getresponse()
+        push_response = self.pushes[0].get_response()
         assert push_response.status == 200
         assert dict(push_response.headers) == {b'content-type': [b'application/javascript']}
         assert push_response.read() == b'bar'
@@ -1399,7 +1399,7 @@ def test_promise_before_headers(self):
         self.add_data_frame(2, b'bar', end_stream=True)
 
         self.request()
-        assert len(list(self.conn.getpushes())) == 0
+        assert len(list(self.conn.get_pushes())) == 0
         self.assert_response()
         self.assert_pushes()
         assert self.response.read() == b'foo'
@@ -1413,9 +1413,9 @@ def test_promise_after_headers(self):
         self.add_data_frame(2, b'bar', end_stream=True)
 
         self.request()
-        assert len(list(self.conn.getpushes())) == 0
+        assert len(list(self.conn.get_pushes())) == 0
         self.assert_response()
-        assert len(list(self.conn.getpushes())) == 0
+        assert len(list(self.conn.get_pushes())) == 0
         assert self.response.read() == b'foo'
         self.assert_pushes()
         self.assert_push_response()
@@ -1429,9 +1429,9 @@ def test_promise_after_data(self):
         self.add_data_frame(2, b'bar', end_stream=True)
 
         self.request()
-        assert len(list(self.conn.getpushes())) == 0
+        assert len(list(self.conn.get_pushes())) == 0
         self.assert_response()
-        assert len(list(self.conn.getpushes())) == 0
+        assert len(list(self.conn.get_pushes())) == 0
         assert self.response.read() == b'foo'
         self.assert_pushes()
         self.assert_push_response()
@@ -1447,13 +1447,13 @@ def test_capture_all_promises(self):
         self.add_data_frame(2, b'one', end_stream=True)
 
         self.request()
-        assert len(list(self.conn.getpushes())) == 0
-        pushes = list(self.conn.getpushes(capture_all=True))
+        assert len(list(self.conn.get_pushes())) == 0
+        pushes = list(self.conn.get_pushes(capture_all=True))
         assert len(pushes) == 2
         assert pushes[0].path == b'/one'
         assert pushes[1].path == b'/two'
-        assert pushes[0].getresponse().read() == b'one'
-        assert pushes[1].getresponse().read() == b'two'
+        assert pushes[0].get_response().read() == b'one'
+        assert pushes[1].get_response().read() == b'two'
         self.assert_response()
         assert self.response.read() == b'foo'
 
@@ -1462,8 +1462,8 @@ def test_cancel_push(self):
         self.add_headers_frame(1, [(':status', '200'), ('content-type', 'text/html')])
 
         self.request()
-        self.conn.getresponse()
-        list(self.conn.getpushes())[0].cancel()
+        self.conn.get_response()
+        list(self.conn.get_pushes())[0].cancel()
 
         f = RstStreamFrame(2)
         f.error_code = 8
@@ -1475,7 +1475,7 @@ def test_reset_pushed_streams_when_push_disabled(self):
 
         self.request()
         self.conn._enable_push = False
-        self.conn.getresponse()
+        self.conn.get_response()
 
         f = RstStreamFrame(2)
         f.error_code = 7