NEW: add the __content__ pseudo-field, resolves #15

kpn · Mar 31, 2023 · dd58ea3 · dd58ea3
1 parent a671020
commit dd58ea3
Show file tree

Hide file tree

Showing 6 changed files with 15 additions and 6 deletions.
diff --git a/.github/release.yml b/.github/release.yml
@@ -3,12 +3,9 @@ changelog:
     - title: 💥 Breaking changes
       labels:
         - breaking-change
-    - title: ✨ New features
-      labels:
-        - enhancement
     - title: ⚡️Improvements
       labels:
-        - improvement
+        - enhancement
         - documentation
     - title: 🎨 Other changes
       labels:

diff --git a/.idea/inspectionProfiles/Project_Default.xml b/.idea/inspectionProfiles/Project_Default.xml
diff --git a/.idea/inspectionProfiles/profiles_settings.xml b/.idea/inspectionProfiles/profiles_settings.xml
diff --git a/.idea/misc.xml b/.idea/misc.xml
diff --git a/combadge/support/http/aliases.py b/combadge/support/http/aliases.py
@@ -13,3 +13,8 @@
 REASON_ALIAS = "__reason__"
 Reason: TypeAlias = Annotated[_ReasonT, Field(alias=REASON_ALIAS)]
 """HTTP reason phrase. Alias for the `__reason__` pseudo-field."""
+
+_ContentT = TypeVar("_ContentT", bound=bytes)
+CONTENT_ALIAS = "__content__"
+Content: TypeAlias = Annotated[_ContentT, Field(alias=CONTENT_ALIAS)]
+"""Original response content. Alias for the `__content__` pseudo-field."""
diff --git a/combadge/support/httpx/backends/base.py b/combadge/support/httpx/backends/base.py
@@ -7,7 +7,7 @@
 
 from combadge.core.interfaces import ProvidesBinder
 from combadge.core.typevars import ResponseT
-from combadge.support.http.aliases import REASON_ALIAS, STATUS_CODE_ALIAS
+from combadge.support.http.aliases import CONTENT_ALIAS, REASON_ALIAS, STATUS_CODE_ALIAS
 
 _ClientT = TypeVar("_ClientT", Client, AsyncClient)
 
@@ -18,6 +18,7 @@ class BaseHttpxBackend(ProvidesBinder, Generic[_ClientT]):
 
     # Available response aliases
 
+    - [`Content`][combadge.support.http.aliases.Content]: HTTP response content
     - [`StatusCode`][combadge.support.http.aliases.StatusCode]: HTTP response status code
     - [`Reason`][combadge.support.http.aliases.Reason]: HTTP reason phrase
     """
@@ -35,6 +36,7 @@ def _parse_response(cls, from_response: Response, to_type: Type[ResponseT]) -> R
             {
                 STATUS_CODE_ALIAS: from_response.status_code,
                 REASON_ALIAS: from_response.reason_phrase,
+                CONTENT_ALIAS: from_response.content,
                 **from_response.json(),
             },
         )