hubmap-search-sdk 1.0.0a12__tar.gz → 1.0.0a14__tar.gz

hubmap_search_sdk-1.0.0a14/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "1.0.0-alpha.14"
+}

{hubmap_search_sdk-1.0.0a12 → hubmap_search_sdk-1.0.0a14}/CHANGELOG.md

@@ -1,5 +1,49 @@
 # Changelog
 
+## 1.0.0-alpha.14 (2025-06-28)
+
+Full Changelog: [v1.0.0-alpha.13...v1.0.0-alpha.14](https://github.com/hubmapconsortium/search-python-sdk/compare/v1.0.0-alpha.13...v1.0.0-alpha.14)
+
+### Features
+
+* **client:** add support for aiohttp ([2e47165](https://github.com/hubmapconsortium/search-python-sdk/commit/2e47165ede72e1dbd891097afa5fe5cc23790b79))
+
+
+### Bug Fixes
+
+* **ci:** release-doctor — report correct token name ([33bf6f7](https://github.com/hubmapconsortium/search-python-sdk/commit/33bf6f7dbf29f9b4d2747e09bf9ef848b0411fea))
+* **client:** correctly parse binary response | stream ([e9dc865](https://github.com/hubmapconsortium/search-python-sdk/commit/e9dc8654daf52a63214e8575307e25b9c748506e))
+* **tests:** fix: tests which call HTTP endpoints directly with the example parameters ([854e415](https://github.com/hubmapconsortium/search-python-sdk/commit/854e41578698efee91b595e702721c1570ecebd5))
+
+
+### Chores
+
+* **ci:** enable for pull requests ([e7be8b2](https://github.com/hubmapconsortium/search-python-sdk/commit/e7be8b27cda54e12afc5e2936e1238c8dd3f5657))
+* **ci:** only run for pushes and fork pull requests ([1d726a4](https://github.com/hubmapconsortium/search-python-sdk/commit/1d726a486601f809f7ea796b3e26b288f04422b6))
+* **internal:** update conftest.py ([4ea44f2](https://github.com/hubmapconsortium/search-python-sdk/commit/4ea44f2d19f71d20b997cf49fc659819a80f7786))
+* **readme:** update badges ([82fcb23](https://github.com/hubmapconsortium/search-python-sdk/commit/82fcb23a979d8dd8620ea9a6733f9aa661b6fae5))
+* **tests:** add tests for httpx client instantiation & proxies ([2e2d7ac](https://github.com/hubmapconsortium/search-python-sdk/commit/2e2d7ace3a416e7f6805d75c0ca8878508be9434))
+* **tests:** run tests in parallel ([ada43cc](https://github.com/hubmapconsortium/search-python-sdk/commit/ada43cc98977f550f9c8a8f2a27bd53dcb0a0697))
+* **tests:** skip some failing tests on the latest python versions ([e8a90b8](https://github.com/hubmapconsortium/search-python-sdk/commit/e8a90b8b85442856af633c0c6b663d000c7fc8f8))
+
+
+### Documentation
+
+* **client:** fix httpx.Timeout documentation reference ([5e38f78](https://github.com/hubmapconsortium/search-python-sdk/commit/5e38f78a35147577cbc911fc19804fe430d2cd6f))
+
+## 1.0.0-alpha.13 (2025-06-03)
+
+Full Changelog: [v1.0.0-alpha.12...v1.0.0-alpha.13](https://github.com/hubmapconsortium/search-python-sdk/compare/v1.0.0-alpha.12...v1.0.0-alpha.13)
+
+### Features
+
+* **client:** add follow_redirects request option ([55b10c1](https://github.com/hubmapconsortium/search-python-sdk/commit/55b10c18cfea334e5ea9558f70ded70c2b21e34c))
+
+
+### Chores
+
+* **docs:** remove reference to rye shell ([ef26230](https://github.com/hubmapconsortium/search-python-sdk/commit/ef262304d809361ee6d56932bdb9328157e8aef6))
+
 ## 1.0.0-alpha.12 (2025-05-28)
 
 Full Changelog: [v1.0.0-alpha.11...v1.0.0-alpha.12](https://github.com/hubmapconsortium/search-python-sdk/compare/v1.0.0-alpha.11...v1.0.0-alpha.12)

{hubmap_search_sdk-1.0.0a12 → hubmap_search_sdk-1.0.0a14}/CONTRIBUTING.md

@@ -17,8 +17,7 @@ $ rye sync --all-features
 You can then run scripts using `rye run python script.py` or by activating the virtual environment:
 
 ```sh
-$ rye shell
-# or manually activate - https://docs.python.org/3/library/venv.html#how-venvs-work
+# Activate the virtual environment - https://docs.python.org/3/library/venv.html#how-venvs-work
 $ source .venv/bin/activate
 
 # now you can omit the `rye run` prefix

{hubmap_search_sdk-1.0.0a12 → hubmap_search_sdk-1.0.0a14}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: hubmap_search_sdk
-Version: 1.0.0a12
+Version: 1.0.0a14
 Summary: The official Python library for the hubmap-search-sdk API
 Project-URL: Homepage, https://github.com/hubmapconsortium/search-python-sdk
 Project-URL: Repository, https://github.com/hubmapconsortium/search-python-sdk
@@ -27,11 +27,14 @@ Requires-Dist: httpx<1,>=0.23.0
 Requires-Dist: pydantic<3,>=1.9.0
 Requires-Dist: sniffio
 Requires-Dist: typing-extensions<5,>=4.10
+Provides-Extra: aiohttp
+Requires-Dist: aiohttp; extra == 'aiohttp'
+Requires-Dist: httpx-aiohttp>=0.1.6; extra == 'aiohttp'
 Description-Content-Type: text/markdown
 
 # HuBMAP Search SDK Python API Library
 
-[![PyPI version](https://img.shields.io/pypi/v/hubmap_search_sdk.svg)](https://pypi.org/project/hubmap_search_sdk/)
+[![PyPI version](https://github.com/hubmapconsortium/search-python-sdk/tree/main/<https://img.shields.io/pypi/v/hubmap_search_sdk.svg?label=pypi%20(stable)>)](https://pypi.org/project/hubmap_search_sdk/)
 
 The HuBMAP Search SDK Python library provides convenient access to the HuBMAP Search REST API from any Python 3.8+
 application. The library includes type definitions for all request params and response fields,
@@ -88,6 +91,37 @@ asyncio.run(main())
 
 Functionality between the synchronous and asynchronous clients is otherwise identical.
 
+### With aiohttp
+
+By default, the async client uses `httpx` for HTTP requests. However, for improved concurrency performance you may also use `aiohttp` as the HTTP backend.
+
+You can enable this by installing `aiohttp`:
+
+```sh
+# install from PyPI
+pip install --pre hubmap_search_sdk[aiohttp]
+```
+
+Then you can enable it by instantiating the client with `http_client=DefaultAioHttpClient()`:
+
+```python
+import asyncio
+from hubmap_search_sdk import DefaultAioHttpClient
+from hubmap_search_sdk import AsyncHubmapSearchSDK
+
+
+async def main() -> None:
+    async with AsyncHubmapSearchSDK(
+        bearer_token="My Bearer Token",
+        http_client=DefaultAioHttpClient(),
+    ) as client:
+        indices = await client.indices.list()
+        print(indices.indices)
+
+
+asyncio.run(main())
+```
+
 ## Using types
 
 Nested request parameters are [TypedDicts](https://docs.python.org/3/library/typing.html#typing.TypedDict). Responses are [Pydantic models](https://docs.pydantic.dev) which also provide helper methods for things like:
@@ -162,7 +196,7 @@ client.with_options(max_retries=5).indices.list()
 ### Timeouts
 
 By default requests time out after 1 minute. You can configure this with a `timeout` option,
-which accepts a float or an [`httpx.Timeout`](https://www.python-httpx.org/advanced/#fine-tuning-the-configuration) object:
+which accepts a float or an [`httpx.Timeout`](https://www.python-httpx.org/advanced/timeouts/#fine-tuning-the-configuration) object:
 
 ```python
 from hubmap_search_sdk import HubmapSearchSDK

{hubmap_search_sdk-1.0.0a12 → hubmap_search_sdk-1.0.0a14}/README.md

@@ -1,6 +1,6 @@
 # HuBMAP Search SDK Python API Library
 
-[![PyPI version](https://img.shields.io/pypi/v/hubmap_search_sdk.svg)](https://pypi.org/project/hubmap_search_sdk/)
+[![PyPI version](<https://img.shields.io/pypi/v/hubmap_search_sdk.svg?label=pypi%20(stable)>)](https://pypi.org/project/hubmap_search_sdk/)
 
 The HuBMAP Search SDK Python library provides convenient access to the HuBMAP Search REST API from any Python 3.8+
 application. The library includes type definitions for all request params and response fields,
@@ -57,6 +57,37 @@ asyncio.run(main())
 
 Functionality between the synchronous and asynchronous clients is otherwise identical.
 
+### With aiohttp
+
+By default, the async client uses `httpx` for HTTP requests. However, for improved concurrency performance you may also use `aiohttp` as the HTTP backend.
+
+You can enable this by installing `aiohttp`:
+
+```sh
+# install from PyPI
+pip install --pre hubmap_search_sdk[aiohttp]
+```
+
+Then you can enable it by instantiating the client with `http_client=DefaultAioHttpClient()`:
+
+```python
+import asyncio
+from hubmap_search_sdk import DefaultAioHttpClient
+from hubmap_search_sdk import AsyncHubmapSearchSDK
+
+
+async def main() -> None:
+    async with AsyncHubmapSearchSDK(
+        bearer_token="My Bearer Token",
+        http_client=DefaultAioHttpClient(),
+    ) as client:
+        indices = await client.indices.list()
+        print(indices.indices)
+
+
+asyncio.run(main())
+```
+
 ## Using types
 
 Nested request parameters are [TypedDicts](https://docs.python.org/3/library/typing.html#typing.TypedDict). Responses are [Pydantic models](https://docs.pydantic.dev) which also provide helper methods for things like:
@@ -131,7 +162,7 @@ client.with_options(max_retries=5).indices.list()
 ### Timeouts
 
 By default requests time out after 1 minute. You can configure this with a `timeout` option,
-which accepts a float or an [`httpx.Timeout`](https://www.python-httpx.org/advanced/#fine-tuning-the-configuration) object:
+which accepts a float or an [`httpx.Timeout`](https://www.python-httpx.org/advanced/timeouts/#fine-tuning-the-configuration) object:
 
 ```python
 from hubmap_search_sdk import HubmapSearchSDK

{hubmap_search_sdk-1.0.0a12 → hubmap_search_sdk-1.0.0a14}/bin/check-release-environment

@@ -3,7 +3,7 @@
 errors=()
 
 if [ -z "${PYPI_TOKEN}" ]; then
-  errors+=("The HUBMAP_SEARCH_SDK_PYPI_TOKEN secret has not been set. Please set it in either this repository's secrets or your organization secrets.")
+  errors+=("The PYPI_TOKEN secret has not been set. Please set it in either this repository's secrets or your organization secrets.")
 fi
 
 lenErrors=${#errors[@]}

{hubmap_search_sdk-1.0.0a12 → hubmap_search_sdk-1.0.0a14}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "hubmap_search_sdk"
-version = "1.0.0-alpha.12"
+version = "1.0.0-alpha.14"
 description = "The official Python library for the hubmap-search-sdk API"
 dynamic = ["readme"]
 license = "MIT"
@@ -37,6 +37,8 @@ classifiers = [
 Homepage = "https://github.com/hubmapconsortium/search-python-sdk"
 Repository = "https://github.com/hubmapconsortium/search-python-sdk"
 
+[project.optional-dependencies]
+aiohttp = ["aiohttp", "httpx_aiohttp>=0.1.6"]
 
 [tool.rye]
 managed = true
@@ -54,6 +56,7 @@ dev-dependencies = [
     "importlib-metadata>=6.7.0",
     "rich>=13.7.1",
     "nest_asyncio==1.6.0",
+    "pytest-xdist>=3.6.1",
 ]
 
 [tool.rye.scripts]
@@ -125,7 +128,7 @@ replacement = '[\1](https://github.com/hubmapconsortium/search-python-sdk/tree/m
 
 [tool.pytest.ini_options]
 testpaths = ["tests"]
-addopts = "--tb=short"
+addopts = "--tb=short -n auto"
 xfail_strict = true
 asyncio_mode = "auto"
 asyncio_default_fixture_loop_scope = "session"

{hubmap_search_sdk-1.0.0a12 → hubmap_search_sdk-1.0.0a14}/requirements-dev.lock

@@ -10,6 +10,13 @@
 #   universal: false
 
 -e file:.
+aiohappyeyeballs==2.6.1
+    # via aiohttp
+aiohttp==3.12.8
+    # via httpx-aiohttp
+    # via hubmap-search-sdk
+aiosignal==1.3.2
+    # via aiohttp
 annotated-types==0.6.0
     # via pydantic
 anyio==4.4.0
@@ -17,6 +24,10 @@ anyio==4.4.0
     # via hubmap-search-sdk
 argcomplete==3.1.2
     # via nox
+async-timeout==5.0.1
+    # via aiohttp
+attrs==25.3.0
+    # via aiohttp
 certifi==2023.7.22
     # via httpcore
     # via httpx
@@ -30,18 +41,27 @@ distro==1.8.0
 exceptiongroup==1.2.2
     # via anyio
     # via pytest
+execnet==2.1.1
+    # via pytest-xdist
 filelock==3.12.4
     # via virtualenv
+frozenlist==1.6.2
+    # via aiohttp
+    # via aiosignal
 h11==0.14.0
     # via httpcore
 httpcore==1.0.2
     # via httpx
 httpx==0.28.1
+    # via httpx-aiohttp
     # via hubmap-search-sdk
     # via respx
+httpx-aiohttp==0.1.6
+    # via hubmap-search-sdk
 idna==3.4
     # via anyio
     # via httpx
+    # via yarl
 importlib-metadata==7.0.0
 iniconfig==2.0.0
     # via pytest
@@ -49,6 +69,9 @@ markdown-it-py==3.0.0
     # via rich
 mdurl==0.1.2
     # via markdown-it-py
+multidict==6.4.4
+    # via aiohttp
+    # via yarl
 mypy==1.14.1
 mypy-extensions==1.0.0
     # via mypy
@@ -63,6 +86,9 @@ platformdirs==3.11.0
     # via virtualenv
 pluggy==1.5.0
     # via pytest
+propcache==0.3.1
+    # via aiohttp
+    # via yarl
 pydantic==2.10.3
     # via hubmap-search-sdk
 pydantic-core==2.27.1
@@ -72,7 +98,9 @@ pygments==2.18.0
 pyright==1.1.399
 pytest==8.3.3
     # via pytest-asyncio
+    # via pytest-xdist
 pytest-asyncio==0.24.0
+pytest-xdist==3.7.0
 python-dateutil==2.8.2
     # via time-machine
 pytz==2023.3.post1
@@ -94,11 +122,14 @@ tomli==2.0.2
 typing-extensions==4.12.2
     # via anyio
     # via hubmap-search-sdk
+    # via multidict
     # via mypy
     # via pydantic
     # via pydantic-core
     # via pyright
 virtualenv==20.24.5
     # via nox
+yarl==1.20.0
+    # via aiohttp
 zipp==3.17.0
     # via importlib-metadata

{hubmap_search_sdk-1.0.0a12 → hubmap_search_sdk-1.0.0a14}/requirements.lock

@@ -10,11 +10,22 @@
 #   universal: false
 
 -e file:.
+aiohappyeyeballs==2.6.1
+    # via aiohttp
+aiohttp==3.12.8
+    # via httpx-aiohttp
+    # via hubmap-search-sdk
+aiosignal==1.3.2
+    # via aiohttp
 annotated-types==0.6.0
     # via pydantic
 anyio==4.4.0
     # via httpx
     # via hubmap-search-sdk
+async-timeout==5.0.1
+    # via aiohttp
+attrs==25.3.0
+    # via aiohttp
 certifi==2023.7.22
     # via httpcore
     # via httpx
@@ -22,15 +33,28 @@ distro==1.8.0
     # via hubmap-search-sdk
 exceptiongroup==1.2.2
     # via anyio
+frozenlist==1.6.2
+    # via aiohttp
+    # via aiosignal
 h11==0.14.0
     # via httpcore
 httpcore==1.0.2
     # via httpx
 httpx==0.28.1
+    # via httpx-aiohttp
+    # via hubmap-search-sdk
+httpx-aiohttp==0.1.6
     # via hubmap-search-sdk
 idna==3.4
     # via anyio
     # via httpx
+    # via yarl
+multidict==6.4.4
+    # via aiohttp
+    # via yarl
+propcache==0.3.1
+    # via aiohttp
+    # via yarl
 pydantic==2.10.3
     # via hubmap-search-sdk
 pydantic-core==2.27.1
@@ -41,5 +65,8 @@ sniffio==1.3.0
 typing-extensions==4.12.2
     # via anyio
     # via hubmap-search-sdk
+    # via multidict
     # via pydantic
     # via pydantic-core
+yarl==1.20.0
+    # via aiohttp

{hubmap_search_sdk-1.0.0a12 → hubmap_search_sdk-1.0.0a14}/src/hubmap_search_sdk/__init__.py

@@ -36,7 +36,7 @@ from ._exceptions import (
     UnprocessableEntityError,
     APIResponseValidationError,
 )
-from ._base_client import DefaultHttpxClient, DefaultAsyncHttpxClient
+from ._base_client import DefaultHttpxClient, DefaultAioHttpClient, DefaultAsyncHttpxClient
 from ._utils._logs import setup_logging as _setup_logging
 
 __all__ = [
@@ -78,6 +78,7 @@ __all__ = [
     "DEFAULT_CONNECTION_LIMITS",
     "DefaultHttpxClient",
     "DefaultAsyncHttpxClient",
+    "DefaultAioHttpClient",
 ]
 
 if not _t.TYPE_CHECKING:

{hubmap_search_sdk-1.0.0a12 → hubmap_search_sdk-1.0.0a14}/src/hubmap_search_sdk/_base_client.py

@@ -963,6 +963,9 @@ class SyncAPIClient(BaseClient[httpx.Client, Stream[Any]]):
             if self.custom_auth is not None:
                 kwargs["auth"] = self.custom_auth
 
+            if options.follow_redirects is not None:
+                kwargs["follow_redirects"] = options.follow_redirects
+
             log.debug("Sending HTTP Request: %s %s", request.method, request.url)
 
             response = None
@@ -1080,7 +1083,14 @@ class SyncAPIClient(BaseClient[httpx.Client, Stream[Any]]):
     ) -> ResponseT:
         origin = get_origin(cast_to) or cast_to
 
-        if inspect.isclass(origin) and issubclass(origin, BaseAPIResponse):
+        if (
+            inspect.isclass(origin)
+            and issubclass(origin, BaseAPIResponse)
+            # we only want to actually return the custom BaseAPIResponse class if we're
+            # returning the raw response, or if we're not streaming SSE, as if we're streaming
+            # SSE then `cast_to` doesn't actively reflect the type we need to parse into
+            and (not stream or bool(response.request.headers.get(RAW_RESPONSE_HEADER)))
+        ):
             if not issubclass(origin, APIResponse):
                 raise TypeError(f"API Response types must subclass {APIResponse}; Received {origin}")
 
@@ -1291,6 +1301,24 @@ class _DefaultAsyncHttpxClient(httpx.AsyncClient):
         super().__init__(**kwargs)
 
 
+try:
+    import httpx_aiohttp
+except ImportError:
+
+    class _DefaultAioHttpClient(httpx.AsyncClient):
+        def __init__(self, **_kwargs: Any) -> None:
+            raise RuntimeError("To use the aiohttp client you must have installed the package with the `aiohttp` extra")
+else:
+
+    class _DefaultAioHttpClient(httpx_aiohttp.HttpxAiohttpClient):  # type: ignore
+        def __init__(self, **kwargs: Any) -> None:
+            kwargs.setdefault("timeout", DEFAULT_TIMEOUT)
+            kwargs.setdefault("limits", DEFAULT_CONNECTION_LIMITS)
+            kwargs.setdefault("follow_redirects", True)
+
+            super().__init__(**kwargs)
+
+
 if TYPE_CHECKING:
     DefaultAsyncHttpxClient = httpx.AsyncClient
     """An alias to `httpx.AsyncClient` that provides the same defaults that this SDK
@@ -1299,8 +1327,12 @@ if TYPE_CHECKING:
     This is useful because overriding the `http_client` with your own instance of
     `httpx.AsyncClient` will result in httpx's defaults being used, not ours.
     """
+
+    DefaultAioHttpClient = httpx.AsyncClient
+    """An alias to `httpx.AsyncClient` that changes the default HTTP transport to `aiohttp`."""
 else:
     DefaultAsyncHttpxClient = _DefaultAsyncHttpxClient
+    DefaultAioHttpClient = _DefaultAioHttpClient
 
 
 class AsyncHttpxClientWrapper(DefaultAsyncHttpxClient):
@@ -1472,6 +1504,9 @@ class AsyncAPIClient(BaseClient[httpx.AsyncClient, AsyncStream[Any]]):
             if self.custom_auth is not None:
                 kwargs["auth"] = self.custom_auth
 
+            if options.follow_redirects is not None:
+                kwargs["follow_redirects"] = options.follow_redirects
+
             log.debug("Sending HTTP Request: %s %s", request.method, request.url)
 
             response = None
@@ -1580,7 +1615,14 @@ class AsyncAPIClient(BaseClient[httpx.AsyncClient, AsyncStream[Any]]):
     ) -> ResponseT:
         origin = get_origin(cast_to) or cast_to
 
-        if inspect.isclass(origin) and issubclass(origin, BaseAPIResponse):
+        if (
+            inspect.isclass(origin)
+            and issubclass(origin, BaseAPIResponse)
+            # we only want to actually return the custom BaseAPIResponse class if we're
+            # returning the raw response, or if we're not streaming SSE, as if we're streaming
+            # SSE then `cast_to` doesn't actively reflect the type we need to parse into
+            and (not stream or bool(response.request.headers.get(RAW_RESPONSE_HEADER)))
+        ):
             if not issubclass(origin, AsyncAPIResponse):
                 raise TypeError(f"API Response types must subclass {AsyncAPIResponse}; Received {origin}")
 

{hubmap_search_sdk-1.0.0a12 → hubmap_search_sdk-1.0.0a14}/src/hubmap_search_sdk/_models.py

@@ -737,6 +737,7 @@ class FinalRequestOptionsInput(TypedDict, total=False):
     idempotency_key: str
     json_data: Body
     extra_json: AnyMapping
+    follow_redirects: bool
 
 
 @final
@@ -750,6 +751,7 @@ class FinalRequestOptions(pydantic.BaseModel):
     files: Union[HttpxRequestFiles, None] = None
     idempotency_key: Union[str, None] = None
     post_parser: Union[Callable[[Any], Any], NotGiven] = NotGiven()
+    follow_redirects: Union[bool, None] = None
 
     # It should be noted that we cannot use `json` here as that would override
     # a BaseModel method in an incompatible fashion.

{hubmap_search_sdk-1.0.0a12 → hubmap_search_sdk-1.0.0a14}/src/hubmap_search_sdk/_types.py

@@ -100,6 +100,7 @@ class RequestOptions(TypedDict, total=False):
     params: Query
     extra_json: AnyMapping
     idempotency_key: str
+    follow_redirects: bool
 
 
 # Sentinel class used until PEP 0661 is accepted
@@ -215,3 +216,4 @@ class _GenericAlias(Protocol):
 
 class HttpxSendArgs(TypedDict, total=False):
     auth: httpx.Auth
+    follow_redirects: bool

{hubmap_search_sdk-1.0.0a12 → hubmap_search_sdk-1.0.0a14}/src/hubmap_search_sdk/_version.py

@@ -1,4 +1,4 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 __title__ = "hubmap_search_sdk"
-__version__ = "1.0.0-alpha.12"  # x-release-please-version
+__version__ = "1.0.0-alpha.14"  # x-release-please-version

{hubmap_search_sdk-1.0.0a12 → hubmap_search_sdk-1.0.0a14}/tests/api_resources/test_add.py

@@ -880,7 +880,9 @@ class TestAdd:
 
 
 class TestAsyncAdd:
-    parametrize = pytest.mark.parametrize("async_client", [False, True], indirect=True, ids=["loose", "strict"])
+    parametrize = pytest.mark.parametrize(
+        "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"]
+    )
 
     @pytest.mark.skip()
     @parametrize

{hubmap_search_sdk-1.0.0a12 → hubmap_search_sdk-1.0.0a14}/tests/api_resources/test_clear_docs.py

@@ -175,7 +175,9 @@ class TestClearDocs:
 
 
 class TestAsyncClearDocs:
-    parametrize = pytest.mark.parametrize("async_client", [False, True], indirect=True, ids=["loose", "strict"])
+    parametrize = pytest.mark.parametrize(
+        "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"]
+    )
 
     @pytest.mark.skip()
     @parametrize

{hubmap_search_sdk-1.0.0a12 → hubmap_search_sdk-1.0.0a14}/tests/api_resources/test_indices.py

@@ -47,7 +47,9 @@ class TestIndices:
 
 
 class TestAsyncIndices:
-    parametrize = pytest.mark.parametrize("async_client", [False, True], indirect=True, ids=["loose", "strict"])
+    parametrize = pytest.mark.parametrize(
+        "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"]
+    )
 
     @pytest.mark.skip()
     @parametrize

{hubmap_search_sdk-1.0.0a12 → hubmap_search_sdk-1.0.0a14}/tests/api_resources/test_mapping.py

@@ -88,7 +88,9 @@ class TestMapping:
 
 
 class TestAsyncMapping:
-    parametrize = pytest.mark.parametrize("async_client", [False, True], indirect=True, ids=["loose", "strict"])
+    parametrize = pytest.mark.parametrize(
+        "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"]
+    )
 
     @pytest.mark.skip()
     @parametrize

{hubmap_search_sdk-1.0.0a12 → hubmap_search_sdk-1.0.0a14}/tests/api_resources/test_mget.py

@@ -100,7 +100,9 @@ class TestMget:
 
 
 class TestAsyncMget:
-    parametrize = pytest.mark.parametrize("async_client", [False, True], indirect=True, ids=["loose", "strict"])
+    parametrize = pytest.mark.parametrize(
+        "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"]
+    )
 
     @pytest.mark.skip()
     @parametrize

{hubmap_search_sdk-1.0.0a12 → hubmap_search_sdk-1.0.0a14}/tests/api_resources/test_param_search.py

@@ -69,7 +69,9 @@ class TestParamSearch:
 
 
 class TestAsyncParamSearch:
-    parametrize = pytest.mark.parametrize("async_client", [False, True], indirect=True, ids=["loose", "strict"])
+    parametrize = pytest.mark.parametrize(
+        "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"]
+    )
 
     @pytest.mark.skip()
     @parametrize

{hubmap_search_sdk-1.0.0a12 → hubmap_search_sdk-1.0.0a14}/tests/api_resources/test_reindex.py

@@ -59,7 +59,9 @@ class TestReindex:
 
 
 class TestAsyncReindex:
-    parametrize = pytest.mark.parametrize("async_client", [False, True], indirect=True, ids=["loose", "strict"])
+    parametrize = pytest.mark.parametrize(
+        "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"]
+    )
 
     @pytest.mark.skip()
     @parametrize

{hubmap_search_sdk-1.0.0a12 → hubmap_search_sdk-1.0.0a14}/tests/api_resources/test_scroll_search.py

@@ -75,7 +75,9 @@ class TestScrollSearch:
 
 
 class TestAsyncScrollSearch:
-    parametrize = pytest.mark.parametrize("async_client", [False, True], indirect=True, ids=["loose", "strict"])
+    parametrize = pytest.mark.parametrize(
+        "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"]
+    )
 
     @pytest.mark.skip()
     @parametrize

{hubmap_search_sdk-1.0.0a12 → hubmap_search_sdk-1.0.0a14}/tests/api_resources/test_search.py

@@ -180,7 +180,9 @@ class TestSearch:
 
 
 class TestAsyncSearch:
-    parametrize = pytest.mark.parametrize("async_client", [False, True], indirect=True, ids=["loose", "strict"])
+    parametrize = pytest.mark.parametrize(
+        "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"]
+    )
 
     @pytest.mark.skip()
     @parametrize

{hubmap_search_sdk-1.0.0a12 → hubmap_search_sdk-1.0.0a14}/tests/api_resources/test_update.py

@@ -880,7 +880,9 @@ class TestUpdate:
 
 
 class TestAsyncUpdate:
-    parametrize = pytest.mark.parametrize("async_client", [False, True], indirect=True, ids=["loose", "strict"])
+    parametrize = pytest.mark.parametrize(
+        "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"]
+    )
 
     @pytest.mark.skip()
     @parametrize

{hubmap_search_sdk-1.0.0a12 → hubmap_search_sdk-1.0.0a14}/tests/conftest.py

@@ -1,13 +1,17 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
 from __future__ import annotations
 
 import os
 import logging
 from typing import TYPE_CHECKING, Iterator, AsyncIterator
 
+import httpx
 import pytest
 from pytest_asyncio import is_async_test
 
-from hubmap_search_sdk import HubmapSearchSDK, AsyncHubmapSearchSDK
+from hubmap_search_sdk import HubmapSearchSDK, AsyncHubmapSearchSDK, DefaultAioHttpClient
+from hubmap_search_sdk._utils import is_dict
 
 if TYPE_CHECKING:
     from _pytest.fixtures import FixtureRequest  # pyright: ignore[reportPrivateImportUsage]
@@ -25,6 +29,19 @@ def pytest_collection_modifyitems(items: list[pytest.Function]) -> None:
     for async_test in pytest_asyncio_tests:
         async_test.add_marker(session_scope_marker, append=False)
 
+    # We skip tests that use both the aiohttp client and respx_mock as respx_mock
+    # doesn't support custom transports.
+    for item in items:
+        if "async_client" not in item.fixturenames or "respx_mock" not in item.fixturenames:
+            continue
+
+        if not hasattr(item, "callspec"):
+            continue
+
+        async_client_param = item.callspec.params.get("async_client")
+        if is_dict(async_client_param) and async_client_param.get("http_client") == "aiohttp":
+            item.add_marker(pytest.mark.skip(reason="aiohttp client is not compatible with respx_mock"))
+
 
 base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010")
 
@@ -43,11 +60,25 @@ def client(request: FixtureRequest) -> Iterator[HubmapSearchSDK]:
 
 @pytest.fixture(scope="session")
 async def async_client(request: FixtureRequest) -> AsyncIterator[AsyncHubmapSearchSDK]:
-    strict = getattr(request, "param", True)
-    if not isinstance(strict, bool):
-        raise TypeError(f"Unexpected fixture parameter type {type(strict)}, expected {bool}")
+    param = getattr(request, "param", True)
+
+    # defaults
+    strict = True
+    http_client: None | httpx.AsyncClient = None
+
+    if isinstance(param, bool):
+        strict = param
+    elif is_dict(param):
+        strict = param.get("strict", True)
+        assert isinstance(strict, bool)
+
+        http_client_type = param.get("http_client", "httpx")
+        if http_client_type == "aiohttp":
+            http_client = DefaultAioHttpClient()
+    else:
+        raise TypeError(f"Unexpected fixture parameter type {type(param)}, expected bool or dict")
 
     async with AsyncHubmapSearchSDK(
-        base_url=base_url, bearer_token=bearer_token, _strict_response_validation=strict
+        base_url=base_url, bearer_token=bearer_token, _strict_response_validation=strict, http_client=http_client
     ) as client:
         yield client

{hubmap_search_sdk-1.0.0a12 → hubmap_search_sdk-1.0.0a14}/tests/test_client.py

@@ -24,12 +24,13 @@ from pydantic import ValidationError
 from hubmap_search_sdk import HubmapSearchSDK, AsyncHubmapSearchSDK, APIResponseValidationError
 from hubmap_search_sdk._types import Omit
 from hubmap_search_sdk._models import BaseModel, FinalRequestOptions
-from hubmap_search_sdk._constants import RAW_RESPONSE_HEADER
 from hubmap_search_sdk._exceptions import APIStatusError, APITimeoutError, APIResponseValidationError
 from hubmap_search_sdk._base_client import (
     DEFAULT_TIMEOUT,
     HTTPX_DEFAULT_TIMEOUT,
     BaseClient,
+    DefaultHttpxClient,
+    DefaultAsyncHttpxClient,
     make_request_options,
 )
 
@@ -193,6 +194,7 @@ class TestHubmapSearchSDK:
             copy_param = copy_signature.parameters.get(name)
             assert copy_param is not None, f"copy() signature is missing the {name} param"
 
+    @pytest.mark.skipif(sys.version_info >= (3, 10), reason="fails because of a memory leak that started from 3.12")
     def test_copy_build_request(self) -> None:
         options = FinalRequestOptions(method="get", url="/foo")
 
@@ -738,22 +740,21 @@ class TestHubmapSearchSDK:
 
     @mock.patch("hubmap_search_sdk._base_client.BaseClient._calculate_retry_timeout", _low_retry_timeout)
     @pytest.mark.respx(base_url=base_url)
-    def test_retrying_timeout_errors_doesnt_leak(self, respx_mock: MockRouter) -> None:
+    def test_retrying_timeout_errors_doesnt_leak(self, respx_mock: MockRouter, client: HubmapSearchSDK) -> None:
         respx_mock.get("/indices").mock(side_effect=httpx.TimeoutException("Test timeout error"))
 
         with pytest.raises(APITimeoutError):
-            self.client.get("/indices", cast_to=httpx.Response, options={"headers": {RAW_RESPONSE_HEADER: "stream"}})
+            client.indices.with_streaming_response.list().__enter__()
 
         assert _get_open_connections(self.client) == 0
 
     @mock.patch("hubmap_search_sdk._base_client.BaseClient._calculate_retry_timeout", _low_retry_timeout)
     @pytest.mark.respx(base_url=base_url)
-    def test_retrying_status_errors_doesnt_leak(self, respx_mock: MockRouter) -> None:
+    def test_retrying_status_errors_doesnt_leak(self, respx_mock: MockRouter, client: HubmapSearchSDK) -> None:
         respx_mock.get("/indices").mock(return_value=httpx.Response(500))
 
         with pytest.raises(APIStatusError):
-            self.client.get("/indices", cast_to=httpx.Response, options={"headers": {RAW_RESPONSE_HEADER: "stream"}})
-
+            client.indices.with_streaming_response.list().__enter__()
         assert _get_open_connections(self.client) == 0
 
     @pytest.mark.parametrize("failures_before_success", [0, 2, 4])
@@ -833,6 +834,55 @@ class TestHubmapSearchSDK:
 
         assert response.http_request.headers.get("x-stainless-retry-count") == "42"
 
+    def test_proxy_environment_variables(self, monkeypatch: pytest.MonkeyPatch) -> None:
+        # Test that the proxy environment variables are set correctly
+        monkeypatch.setenv("HTTPS_PROXY", "https://example.org")
+
+        client = DefaultHttpxClient()
+
+        mounts = tuple(client._mounts.items())
+        assert len(mounts) == 1
+        assert mounts[0][0].pattern == "https://"
+
+    @pytest.mark.filterwarnings("ignore:.*deprecated.*:DeprecationWarning")
+    def test_default_client_creation(self) -> None:
+        # Ensure that the client can be initialized without any exceptions
+        DefaultHttpxClient(
+            verify=True,
+            cert=None,
+            trust_env=True,
+            http1=True,
+            http2=False,
+            limits=httpx.Limits(max_connections=100, max_keepalive_connections=20),
+        )
+
+    @pytest.mark.respx(base_url=base_url)
+    def test_follow_redirects(self, respx_mock: MockRouter) -> None:
+        # Test that the default follow_redirects=True allows following redirects
+        respx_mock.post("/redirect").mock(
+            return_value=httpx.Response(302, headers={"Location": f"{base_url}/redirected"})
+        )
+        respx_mock.get("/redirected").mock(return_value=httpx.Response(200, json={"status": "ok"}))
+
+        response = self.client.post("/redirect", body={"key": "value"}, cast_to=httpx.Response)
+        assert response.status_code == 200
+        assert response.json() == {"status": "ok"}
+
+    @pytest.mark.respx(base_url=base_url)
+    def test_follow_redirects_disabled(self, respx_mock: MockRouter) -> None:
+        # Test that follow_redirects=False prevents following redirects
+        respx_mock.post("/redirect").mock(
+            return_value=httpx.Response(302, headers={"Location": f"{base_url}/redirected"})
+        )
+
+        with pytest.raises(APIStatusError) as exc_info:
+            self.client.post(
+                "/redirect", body={"key": "value"}, options={"follow_redirects": False}, cast_to=httpx.Response
+            )
+
+        assert exc_info.value.response.status_code == 302
+        assert exc_info.value.response.headers["Location"] == f"{base_url}/redirected"
+
 
 class TestAsyncHubmapSearchSDK:
     client = AsyncHubmapSearchSDK(base_url=base_url, bearer_token=bearer_token, _strict_response_validation=True)
@@ -972,6 +1022,7 @@ class TestAsyncHubmapSearchSDK:
             copy_param = copy_signature.parameters.get(name)
             assert copy_param is not None, f"copy() signature is missing the {name} param"
 
+    @pytest.mark.skipif(sys.version_info >= (3, 10), reason="fails because of a memory leak that started from 3.12")
     def test_copy_build_request(self) -> None:
         options = FinalRequestOptions(method="get", url="/foo")
 
@@ -1523,26 +1574,25 @@ class TestAsyncHubmapSearchSDK:
 
     @mock.patch("hubmap_search_sdk._base_client.BaseClient._calculate_retry_timeout", _low_retry_timeout)
     @pytest.mark.respx(base_url=base_url)
-    async def test_retrying_timeout_errors_doesnt_leak(self, respx_mock: MockRouter) -> None:
+    async def test_retrying_timeout_errors_doesnt_leak(
+        self, respx_mock: MockRouter, async_client: AsyncHubmapSearchSDK
+    ) -> None:
         respx_mock.get("/indices").mock(side_effect=httpx.TimeoutException("Test timeout error"))
 
         with pytest.raises(APITimeoutError):
-            await self.client.get(
-                "/indices", cast_to=httpx.Response, options={"headers": {RAW_RESPONSE_HEADER: "stream"}}
-            )
+            await async_client.indices.with_streaming_response.list().__aenter__()
 
         assert _get_open_connections(self.client) == 0
 
     @mock.patch("hubmap_search_sdk._base_client.BaseClient._calculate_retry_timeout", _low_retry_timeout)
     @pytest.mark.respx(base_url=base_url)
-    async def test_retrying_status_errors_doesnt_leak(self, respx_mock: MockRouter) -> None:
+    async def test_retrying_status_errors_doesnt_leak(
+        self, respx_mock: MockRouter, async_client: AsyncHubmapSearchSDK
+    ) -> None:
         respx_mock.get("/indices").mock(return_value=httpx.Response(500))
 
         with pytest.raises(APIStatusError):
-            await self.client.get(
-                "/indices", cast_to=httpx.Response, options={"headers": {RAW_RESPONSE_HEADER: "stream"}}
-            )
-
+            await async_client.indices.with_streaming_response.list().__aenter__()
         assert _get_open_connections(self.client) == 0
 
     @pytest.mark.parametrize("failures_before_success", [0, 2, 4])
@@ -1669,3 +1719,52 @@ class TestAsyncHubmapSearchSDK:
                     raise AssertionError("calling get_platform using asyncify resulted in a hung process")
 
                 time.sleep(0.1)
+
+    async def test_proxy_environment_variables(self, monkeypatch: pytest.MonkeyPatch) -> None:
+        # Test that the proxy environment variables are set correctly
+        monkeypatch.setenv("HTTPS_PROXY", "https://example.org")
+
+        client = DefaultAsyncHttpxClient()
+
+        mounts = tuple(client._mounts.items())
+        assert len(mounts) == 1
+        assert mounts[0][0].pattern == "https://"
+
+    @pytest.mark.filterwarnings("ignore:.*deprecated.*:DeprecationWarning")
+    async def test_default_client_creation(self) -> None:
+        # Ensure that the client can be initialized without any exceptions
+        DefaultAsyncHttpxClient(
+            verify=True,
+            cert=None,
+            trust_env=True,
+            http1=True,
+            http2=False,
+            limits=httpx.Limits(max_connections=100, max_keepalive_connections=20),
+        )
+
+    @pytest.mark.respx(base_url=base_url)
+    async def test_follow_redirects(self, respx_mock: MockRouter) -> None:
+        # Test that the default follow_redirects=True allows following redirects
+        respx_mock.post("/redirect").mock(
+            return_value=httpx.Response(302, headers={"Location": f"{base_url}/redirected"})
+        )
+        respx_mock.get("/redirected").mock(return_value=httpx.Response(200, json={"status": "ok"}))
+
+        response = await self.client.post("/redirect", body={"key": "value"}, cast_to=httpx.Response)
+        assert response.status_code == 200
+        assert response.json() == {"status": "ok"}
+
+    @pytest.mark.respx(base_url=base_url)
+    async def test_follow_redirects_disabled(self, respx_mock: MockRouter) -> None:
+        # Test that follow_redirects=False prevents following redirects
+        respx_mock.post("/redirect").mock(
+            return_value=httpx.Response(302, headers={"Location": f"{base_url}/redirected"})
+        )
+
+        with pytest.raises(APIStatusError) as exc_info:
+            await self.client.post(
+                "/redirect", body={"key": "value"}, options={"follow_redirects": False}, cast_to=httpx.Response
+            )
+
+        assert exc_info.value.response.status_code == 302
+        assert exc_info.value.response.headers["Location"] == f"{base_url}/redirected"

hubmap_search_sdk-1.0.0a12/.release-please-manifest.json

@@ -1,3 +0,0 @@
-{
-  ".": "1.0.0-alpha.12"
-}