Add persistent cookies option to Client

httpx/_client.py

@@ -168,6 +168,7 @@ def __init__(
         cookies: CookieTypes | None = None,
         timeout: TimeoutTypes = DEFAULT_TIMEOUT_CONFIG,
         follow_redirects: bool = False,
+        merge_response_cookies: bool = True,
         max_redirects: int = DEFAULT_MAX_REDIRECTS,
         event_hooks: None | (typing.Mapping[str, list[EventHook]]) = None,
         base_url: URLTypes = "",
@@ -182,6 +183,7 @@ def __init__(
         self._params = QueryParams(params)
         self.headers = Headers(headers)
         self._cookies = Cookies(cookies)
+        self._merge_response_cookies = merge_response_cookies
         self._timeout = Timeout(timeout)
         self.follow_redirects = follow_redirects
         self.max_redirects = max_redirects
@@ -599,6 +601,8 @@ class Client(BaseClient):
     URLs.
     * **timeout** - *(optional)* The timeout configuration to use when sending
     requests.
+    * **merge_response_cookies** - *(optional) A boolean indicating if cookies from the
+    response should be merged into the cookie jar. Defaults to `True`.
     * **limits** - *(optional)* The limits configuration to use.
     * **max_redirects** - *(optional)* The maximum number of redirect responses
     that should be followed.
@@ -631,6 +635,7 @@ def __init__(
         mounts: None | (typing.Mapping[str, BaseTransport | None]) = None,
         timeout: TimeoutTypes = DEFAULT_TIMEOUT_CONFIG,
         follow_redirects: bool = False,
+        merge_response_cookies: bool = True,
         limits: Limits = DEFAULT_LIMITS,
         max_redirects: int = DEFAULT_MAX_REDIRECTS,
         event_hooks: None | (typing.Mapping[str, list[EventHook]]) = None,
@@ -647,6 +652,7 @@ def __init__(
             cookies=cookies,
             timeout=timeout,
             follow_redirects=follow_redirects,
+            merge_response_cookies=merge_response_cookies,
             max_redirects=max_redirects,
             event_hooks=event_hooks,
             base_url=base_url,
@@ -1013,7 +1019,8 @@ def _send_single_request(self, request: Request) -> Response:
         response.stream = BoundSyncStream(
             response.stream, response=response, timer=timer
         )
-        self.cookies.extract_cookies(response)
+        if self._merge_response_cookies:
+            self.cookies.extract_cookies(response)
         response.default_encoding = self._default_encoding
 
         logger.info(
@@ -1337,6 +1344,8 @@ class AsyncClient(BaseClient):
     URLs.
     * **timeout** - *(optional)* The timeout configuration to use when sending
     requests.
+    * **merge_response_cookies** - *(optional) A boolean indicating if cookies from the
+    response should be merged into the cookie jar. Defaults to `True`.
     * **limits** - *(optional)* The limits configuration to use.
     * **max_redirects** - *(optional)* The maximum number of redirect responses
     that should be followed.
@@ -1369,6 +1378,7 @@ def __init__(
         mounts: None | (typing.Mapping[str, AsyncBaseTransport | None]) = None,
         timeout: TimeoutTypes = DEFAULT_TIMEOUT_CONFIG,
         follow_redirects: bool = False,
+        merge_response_cookies: bool = True,
         limits: Limits = DEFAULT_LIMITS,
         max_redirects: int = DEFAULT_MAX_REDIRECTS,
         event_hooks: None
@@ -1386,6 +1396,7 @@ def __init__(
             cookies=cookies,
             timeout=timeout,
             follow_redirects=follow_redirects,
+            merge_response_cookies=merge_response_cookies,
             max_redirects=max_redirects,
             event_hooks=event_hooks,
             base_url=base_url,
@@ -1753,7 +1764,8 @@ async def _send_single_request(self, request: Request) -> Response:
         response.stream = BoundAsyncStream(
             response.stream, response=response, timer=timer
         )
-        self.cookies.extract_cookies(response)
+        if self._merge_response_cookies:
+            self.cookies.extract_cookies(response)
         response.default_encoding = self._default_encoding
 
         logger.info(

tests/client/test_cookies.py

@@ -166,3 +166,26 @@ def test_cookie_persistence() -> None:
     response = client.get("http://example.org/echo_cookies")
     assert response.status_code == 200
     assert response.json() == {"cookies": "example-name=example-value"}
+
+
+def test_cookie_persistence_off() -> None:
+    """
+    Ensure that Client instances do not persist cookies between requests when
+     persistence is off.
+    """
+    client = httpx.Client(
+        transport=httpx.MockTransport(get_and_set_cookies), merge_response_cookies=False
+    )
+
+    response = client.get("http://example.org/echo_cookies")
+    assert response.status_code == 200
+    assert response.json() == {"cookies": None}
+
+    response = client.get("http://example.org/set_cookie")
+    assert response.status_code == 200
+    assert response.cookies["example-name"] == "example-value"
+    assert "example-name" not in client.cookies.keys()
+
+    response = client.get("http://example.org/echo_cookies")
+    assert response.status_code == 200
+    assert response.json() == {"cookies": None}