Merge pull request #51 from foarsitter/refactor

Rename response to raw_response and next() to next_from_response()

src/requestmodel/model.py

@@ -88,26 +88,26 @@ def request_args_for_values(self) -> RequestArgs:
 
 
 class RequestModel(BaseRequestModel[ResponseType]):
-    response: Optional[Response] = None
+    raw_response: Optional[Response] = None
 
     def handle_error(self, response: Response) -> None:
         response.raise_for_status()
 
     def send(self, client: Client) -> ResponseType:
         """Send the request synchronously"""
         r = self.as_request(client)
-        self.response = client.send(r)
-        self.handle_error(self.response)
+        self.raw_response = client.send(r)
+        self.handle_error(self.raw_response)
         if isinstance(self.response_model, TypeAdapter):
-            return self.response_model.validate_python(self.response.json())
-        return self.response_model.model_validate(self.response.json())
+            return self.response_model.validate_python(self.raw_response.json())
+        return self.response_model.model_validate(self.raw_response.json())
 
     async def asend(self, client: AsyncClient) -> ResponseType:
         """Send the request asynchronously"""
         r = self.as_request(client)
-        self.response = await client.send(r)
-        self.handle_error(self.response)
-        return self.response_model.model_validate(self.response.json())
+        self.raw_response = await client.send(r)
+        self.handle_error(self.raw_response)
+        return self.response_model.model_validate(self.raw_response.json())
 
     def as_request(self, client: BaseClient) -> Request:
         """Transform the properties of the object into a request"""
@@ -119,17 +119,25 @@ def as_request(self, client: BaseClient) -> Request:
 
 
 class IteratorRequestModel(RequestModel[ResponseType]):
-    response: Optional[Response] = None
+    raw_response: Optional[Response] = None
 
-    def next(self, response: ResponseType) -> bool:  # pragma: no cover
+    def next_from_response(self, response: ResponseType) -> bool:  # pragma: no cover
+        """
+        Prepare the current object for the next request and return true
+
+        In case of cursor pagination set the next token
+        In case of offset pagination increment the offset
+
+        """
         raise NotImplementedError
 
     @override
     def send(self, client: Client) -> Iterator[ResponseType]:  # type: ignore[override]
         response = super().send(client)
         yield response
-        self.response = None
-        while self.next(response):
-            self.response = None
+
+        while self.next_from_response(response):
+            # avoid serializing the response
+            self.raw_response = None
             response = super().send(client)
             yield response

tests/test_param_types.py

@@ -22,7 +22,7 @@ class PaginatedRequest(IteratorRequestModel[PaginatedResponse]):
     page: int
     size: int
 
-    def next(self, response: PaginatedResponse) -> bool:
+    def next_from_response(self, response: PaginatedResponse) -> bool:
         self.page = response.page + 1
         if self.page * response.size > response.total:
             return False