Merge pull request #2330 from VWS-Python/move-response

Move Response and add raw field

Author: adamtheturtle

CHANGELOG.rst

@@ -4,8 +4,8 @@ Changelog
 Next
 ----
 
-2024.09.03.1
-------------
+* Move ``Response`` from ``vws.exceptions.response`` to ``vws.types``.
+* Add ``raw`` field to ``Response``.
 
 2024.09.03
 ------------

docs/source/api-reference.rst

@@ -12,3 +12,7 @@ API Reference
 .. automodule:: vws.include_target_data
    :undoc-members:
    :members:
+
+.. automodule:: vws.types
+   :undoc-members:
+   :members:

docs/source/exceptions.rst

@@ -36,10 +36,3 @@ Custom exceptions
    :show-inheritance:
    :inherited-members: Exception
    :exclude-members: errno, filename, filename2, strerror
-
-Response
---------
-
-.. automodule:: vws.exceptions.response
-   :undoc-members:
-   :members:

src/vws/exceptions/base_exceptions.py

@@ -5,7 +5,7 @@
 
 from beartype import beartype
 
-from .response import Response
+from vws.types import Response
 
 
 @beartype

src/vws/exceptions/custom_exceptions.py

@@ -6,7 +6,7 @@
 
 from beartype import beartype
 
-from .response import Response
+from vws.types import Response
 
 
 @beartype

src/vws/query.py

@@ -25,9 +25,9 @@
     RequestEntityTooLargeError,
     ServerError,
 )
-from vws.exceptions.response import Response
 from vws.include_target_data import CloudRecoIncludeTargetData
 from vws.reports import QueryResult, TargetData
+from vws.types import Response
 
 _ImageType = io.BytesIO | BinaryIO
 
@@ -154,6 +154,7 @@ def query(
             status_code=requests_response.status_code,
             headers=dict(requests_response.headers),
             request_body=requests_response.request.body,
+            raw=requests_response.raw,
         )
 
         if response.status_code == HTTPStatus.REQUEST_ENTITY_TOO_LARGE:

src/vws/exceptions/response.py renamed to src/vws/types.py

@@ -1,4 +1,4 @@
-"""Responses for exceptions."""
+"""Responses for requests to VWS and VWQ."""
 
 from dataclasses import dataclass
 
@@ -17,3 +17,4 @@ class Response:
     status_code: int
     headers: dict[str, str]
     request_body: bytes | str | None
+    raw: bytes

src/vws/vws.py

@@ -46,8 +46,7 @@
     TargetStatuses,
     TargetSummaryReport,
 )
-
-from .exceptions.response import Response
+from vws.types import Response
 
 _ImageType = io.BytesIO | BinaryIO
 
@@ -126,6 +125,7 @@ def _target_api_request(
         status_code=requests_response.status_code,
         headers=dict(requests_response.headers),
         request_body=requests_response.request.body,
+        raw=requests_response.raw,
     )