Merge pull request #1980 from saleweaver/codex/fix-bug-with-reports.get_report_document-vofa5t

Author: saleweaver

sp_api/api/data_kiosk/data_kiosk.py

@@ -1,9 +1,11 @@
-import httpx
 import urllib.parse
 from io import BytesIO, StringIO
 from typing import Union, BinaryIO, TextIO
 
+import httpx
+
 from sp_api.base import Client, sp_endpoint, fill_query_params, ApiResponse
+from sp_api.base._transport_httpx import _httpx_client_kwargs
 
 
 class DataKiosk(Client):
@@ -197,8 +199,10 @@ def get_document(
         )
         if download or file or ("decrypt" in kwargs and kwargs["decrypt"]):
             with httpx.Client(
-                proxies=self.proxies,
-                verify=self.verify,
+                **_httpx_client_kwargs(
+                    proxies=self.proxies,
+                    verify=self.verify,
+                )
             ) as client:
                 document_response = client.get(res.payload.get("documentUrl"))
                 document = document_response.content

sp_api/api/reports/reports.py

@@ -10,6 +10,7 @@
     ApiResponse,
     Marketplaces,
 )
+from sp_api.base._transport_httpx import _httpx_client_kwargs
 from sp_api.util import (
     normalize_csv_param,
     normalize_datetime_kwargs,
@@ -367,9 +368,11 @@ def get_report_document(
         if download or file or ("decrypt" in kwargs and kwargs["decrypt"]):
             compression_algorithm = res.payload.get("compressionAlgorithm")
             with httpx.Client(
-                proxies=self.proxies,
-                verify=self.verify,
-                timeout=timeout,
+                **_httpx_client_kwargs(
+                    proxies=self.proxies,
+                    verify=self.verify,
+                    timeout=timeout,
+                )
             ) as client:
                 if stream and file:
                     with client.stream("GET", res.payload.get("url")) as document_response:

sp_api/base/_transport_httpx.py

@@ -1,15 +1,32 @@
+import random
+
 import httpx
 
 
+def _httpx_client_kwargs(*, proxies=None, verify=True, timeout=None):
+    client_kwargs = {"verify": verify}
+    if timeout is not None:
+        client_kwargs["timeout"] = timeout
+    if proxies is not None:
+        if isinstance(proxies, (list, tuple)):
+            proxy_value = random.choice(proxies)
+        else:
+            proxy_value = proxies
+        client_kwargs["proxy"] = proxy_value
+    return client_kwargs
+
+
 class HttpxTransport:
     def __init__(
         self, *, timeout=None, proxies=None, proxy=None, verify=True, client=None
     ):
         proxy_config = proxy if proxy is not None else proxies
         self._client = client or httpx.Client(
-            timeout=timeout,
-            proxy=proxy_config,
-            verify=verify,
+            **_httpx_client_kwargs(
+                timeout=timeout,
+                proxies=proxy_config,
+                verify=verify,
+            )
         )
 
     def request(self, method, url, *, params=None, data=None, content=None, headers=None):

tests/api/test_httpx_transport.py

@@ -0,0 +1,24 @@
+import random
+
+from sp_api.base._transport_httpx import _httpx_client_kwargs
+
+
+def test_httpx_client_kwargs_uses_single_proxy_string():
+    proxies = "https://proxy.example"
+
+    kwargs = _httpx_client_kwargs(proxies=proxies, verify=True, timeout=5)
+
+    assert kwargs["proxy"] == "https://proxy.example"
+    assert kwargs["verify"] is True
+    assert kwargs["timeout"] == 5
+
+
+def test_httpx_client_kwargs_selects_proxy_from_list(monkeypatch):
+    proxies = ["https://proxy.example", "https://other.example"]
+
+    monkeypatch.setattr(random, "choice", lambda values: values[0])
+
+    kwargs = _httpx_client_kwargs(proxies=proxies, verify=False)
+
+    assert kwargs["proxy"] == "https://proxy.example"
+    assert kwargs["verify"] is False