rename zyte_api_response into zyte_api

BurnzZ · BurnzZ · commit 48a476683be9 · 2022-05-19T16:38:23.000+08:00
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -7,7 +7,7 @@ TBD
 * Introduce ``ZyteAPIResponse`` and ``ZyteAPITextResponse`` which are subclasses
   of ``scrapy.http.Response`` and ``scrapy.http.TextResponse`` respectively.
   These new response classes hold the raw Zyte API response in its
-  ``zyte_api_response`` attribute.
+  ``zyte_api`` attribute.
 
 0.1.0 (2022-02-03)
 ------------------
diff --git a/README.rst b/README.rst
@@ -94,7 +94,7 @@ key to download a request using Zyte API. Full list of parameters is provided in
         def parse(self, response):
             yield {"URL": response.url, "status": response.status, "HTML": response.body}
 
-            print(response.zyte_api_response)
+            print(response.zyte_api)
             # {
             #     'url': 'https://quotes.toscrape.com/',
             #     'browserHtml': '<html> ... </html>',
@@ -113,7 +113,7 @@ key to download a request using Zyte API. Full list of parameters is provided in
             #     'download_slot': 'quotes.toscrape.com'
             # }
 
-The raw Zyte API Response can be accessed via the ``zyte_api_response`` attribute
+The raw Zyte API Response can be accessed via the ``zyte_api`` attribute
 of the response object. Note that such responses are of ``ZyteAPIResponse`` and
 ``ZyteAPITextResponse`` which are respectively subclasses of ``scrapy.http.Response``
 and ``scrapy.http.TextResponse``. Such classes are needed to hold the raw Zyte API
diff --git a/scrapy_zyte_api/responses.py b/scrapy_zyte_api/responses.py
@@ -16,9 +16,9 @@ class ZyteAPIMixin:
         "content-encoding"
     }
 
-    def __init__(self, *args, zyte_api_response: Dict = None, **kwargs):
+    def __init__(self, *args, zyte_api: Dict = None, **kwargs):
         super().__init__(*args, **kwargs)
-        self._zyte_api_response = zyte_api_response
+        self._zyte_api = zyte_api
 
     def replace(self, *args, **kwargs):
         """Create a new response with the same attributes except for those given
@@ -27,13 +27,13 @@ def replace(self, *args, **kwargs):
         return super().replace(*args, **kwargs)
 
     @property
-    def zyte_api_response(self) -> Optional[Dict]:
+    def zyte_api(self) -> Optional[Dict]:
         """Contains the raw API response from Zyte API.
 
         To see the full list of parameters and their description, kindly refer to the
         `Zyte API Specification <https://docs.zyte.com/zyte-api/openapi.html#zyte-openapi-spec>`_.
         """
-        return self._zyte_api_response
+        return self._zyte_api
 
     @classmethod
     def _prepare_headers(cls, init_headers: Optional[List[Dict[str, str]]]):
@@ -60,7 +60,7 @@ def from_api_response(cls, api_response: Dict, *, request: Request = None):
             request=request,
             flags=["zyte-api"],
             headers=cls._prepare_headers(api_response.get("httpResponseHeaders")),
-            zyte_api_response=api_response,
+            zyte_api=api_response,
         )
 
 
@@ -77,5 +77,5 @@ def from_api_response(cls, api_response: Dict, *, request: Request = None):
             request=request,
             flags=["zyte-api"],
             headers=cls._prepare_headers(api_response.get("httpResponseHeaders")),
-            zyte_api_response=api_response,
+            zyte_api=api_response,
         )
diff --git a/tests/test_responses.py b/tests/test_responses.py
@@ -45,8 +45,8 @@ def api_response_body():
     ],
 )
 def test_init(api_response, cls):
-    response = cls(URL, zyte_api_response=api_response())
-    assert response.zyte_api_response == api_response()
+    response = cls(URL, zyte_api=api_response())
+    assert response.zyte_api == api_response()
 
     assert response.url == URL
     assert response.status == 200
@@ -68,7 +68,7 @@ def test_init(api_response, cls):
 )
 def test_text_from_api_response(api_response, cls):
     response = cls.from_api_response(api_response())
-    assert response.zyte_api_response == api_response()
+    assert response.zyte_api == api_response()
 
     assert response.url == URL
     assert response.status == 200
@@ -107,18 +107,18 @@ def test_response_replace(api_response, cls):
         (api_response_body, ZyteAPIResponse),
     ],
 )
-def test_response_replace_zyte_api_response(api_response, cls):
+def test_response_replace_zyte_api(api_response, cls):
     orig_response = cls.from_api_response(api_response())
 
-    # The ``zyte_api_response`` should not be replaced.
-    new_zyte_api_response = {"overridden": "value"}
-    new_response = orig_response.replace(zyte_api_response=new_zyte_api_response)
-    assert new_response.zyte_api_response == api_response()
+    # The ``zyte_api`` should not be replaced.
+    new_zyte_api = {"overridden": "value"}
+    new_response = orig_response.replace(zyte_api=new_zyte_api)
+    assert new_response.zyte_api == api_response()
 
 
 def test_non_utf8_response():
     content = "<html><body>Some non-ASCII ✨ chars</body></html>"
-    sample_zyte_api_response = {
+    sample_zyte_api = {
         "url": URL,
         "browserHtml": content,
         "httpResponseHeaders": [
@@ -132,7 +132,7 @@ def test_non_utf8_response():
     # for it. This is the default encoding for the "browserHtml" contents from
     # Zyte API. Thus, even if the Response Headers or <meta> tags indicate a
     # different encoding, it should still be treated as "utf-8".
-    response = ZyteAPITextResponse.from_api_response(sample_zyte_api_response)
+    response = ZyteAPITextResponse.from_api_response(sample_zyte_api)
     assert response.text == content
     assert response.encoding == "utf-8"
 
@@ -148,7 +148,7 @@ def test_response_headers_removal(api_response, cls):
     """Headers like 'Content-Encoding' should be removed later in the response
     instance returned to Scrapy.
 
-    However, it should still be present inside 'zyte_api_response.headers'.
+    However, it should still be present inside 'zyte_api.headers'.
     """
     additional_headers = [
         {"name": "Content-Encoding", "value": "gzip"},
@@ -161,6 +161,5 @@ def test_response_headers_removal(api_response, cls):
 
     assert response.headers == {b"X-Some-Other-Value": [b"123"]}
     assert (
-        response.zyte_api_response["httpResponseHeaders"]
-        == raw_response["httpResponseHeaders"]
+        response.zyte_api["httpResponseHeaders"] == raw_response["httpResponseHeaders"]
     )
