Context manager for mocking API interactions in tests

docs/source/changelog.rst

@@ -35,6 +35,7 @@ Changelog
   - `PR #373 <https://github.com/gtalarico/pyairtable/pull/373>`_
 * Added command line utility and ORM module generator. See :doc:`cli`.
   - `PR #376 <https://github.com/gtalarico/pyairtable/pull/376>`_
+* Added :class:`pyairtable.testing.MockAirtable` for easier testing.
 
 2.3.3 (2024-03-22)
 ------------------------

pyairtable/api/api.py

@@ -3,6 +3,7 @@
 from typing import Any, Dict, Iterator, List, Optional, Sequence, Tuple, TypeVar, Union
 
 import requests
+from requests import PreparedRequest
 from requests.sessions import Session
 from typing_extensions import TypeAlias
 
@@ -273,14 +274,17 @@ def request(
                 json=json,
             )
 
-        response = self.session.send(prepared, timeout=self.timeout)
-        return self._process_response(response)
+        return self._perform_request(prepared)
 
     get = partialmethod(request, "GET")
     post = partialmethod(request, "POST")
     patch = partialmethod(request, "PATCH")
     delete = partialmethod(request, "DELETE")
 
+    def _perform_request(self, prepared: PreparedRequest) -> Any:
+        response = self.session.send(prepared, timeout=self.timeout)
+        return self._process_response(response)
+
     def _process_response(self, response: requests.Response) -> Any:
         try:
             response.raise_for_status()

pyairtable/api/types.py

@@ -303,6 +303,9 @@ class UpdateRecordDict(TypedDict):
     fields: WritableFields
 
 
+AnyRecordDict: TypeAlias = Union[RecordDict, CreateRecordDict, UpdateRecordDict]
+
+
 class RecordDeletedDict(TypedDict):
     """
     A ``dict`` representing the payload returned by the Airtable API to confirm a deletion.