Merge pull request #74 from steel-dev/release-please--branches--main--changes--next

hussufo · web-flow · commit fcaf9a796e4c · 2025-02-21T17:09:43.000-05:00
release: 0.1.0-beta.9
diff --git a/.release-please-manifest.json b/.release-please-manifest.json
@@ -1,3 +1,3 @@
 {
-  ".": "0.1.0-beta.8"
+  ".": "0.1.0-beta.9"
 }
diff --git a/.stats.yml b/.stats.yml
@@ -1,2 +1,2 @@
 configured_endpoints: 9
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/nen-labs%2Fsteel-6e32c08e5d67ffd976fafcf67f671bb69024a4a827f22e89988098d682ed5c60.yml
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/nen-labs%2Fsteel-9b418de74a20cd1828e67c620c627a54e0f57219d44cba0a48c9e644f5336c9e.yml
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,31 @@
 # Changelog
 
+## 0.1.0-beta.9 (2025-02-21)
+
+Full Changelog: [v0.1.0-beta.8...v0.1.0-beta.9](https://github.com/steel-dev/steel-python/compare/v0.1.0-beta.8...v0.1.0-beta.9)
+
+### Features
+
+* **api:** api update ([#82](https://github.com/steel-dev/steel-python/issues/82)) ([c2b468e](https://github.com/steel-dev/steel-python/commit/c2b468ea3fbdd36633d3539fda857164b4407d32))
+* **client:** allow passing `NotGiven` for body ([#81](https://github.com/steel-dev/steel-python/issues/81)) ([5634d78](https://github.com/steel-dev/steel-python/commit/5634d78a94c580216e7c2a96a5de34b308320f65))
+* **client:** send `X-Stainless-Read-Timeout` header ([#75](https://github.com/steel-dev/steel-python/issues/75)) ([9c82e52](https://github.com/steel-dev/steel-python/commit/9c82e52cac086b4dfef6f4c531990887c0d06cd6))
+
+
+### Bug Fixes
+
+* asyncify on non-asyncio runtimes ([#79](https://github.com/steel-dev/steel-python/issues/79)) ([5dc2c1e](https://github.com/steel-dev/steel-python/commit/5dc2c1eb47698bce547a4d65899b4723f299b1be))
+* **client:** mark some request bodies as optional ([5634d78](https://github.com/steel-dev/steel-python/commit/5634d78a94c580216e7c2a96a5de34b308320f65))
+
+
+### Chores
+
+* **internal:** bummp ruff dependency ([#73](https://github.com/steel-dev/steel-python/issues/73)) ([549e327](https://github.com/steel-dev/steel-python/commit/549e32725828a1549827a774334e9d5b6efdfc33))
+* **internal:** change default timeout to an int ([#72](https://github.com/steel-dev/steel-python/issues/72)) ([571a926](https://github.com/steel-dev/steel-python/commit/571a92692803a75b4a34b80ec76ecd1d75dea899))
+* **internal:** fix type traversing dictionary params ([#76](https://github.com/steel-dev/steel-python/issues/76)) ([f116d3d](https://github.com/steel-dev/steel-python/commit/f116d3dba8ae1ca3f576f7f533d2aeb62693b14d))
+* **internal:** minor type handling changes ([#77](https://github.com/steel-dev/steel-python/issues/77)) ([f5a1ec4](https://github.com/steel-dev/steel-python/commit/f5a1ec481228186b388cf86b75f0d14c067ad818))
+* **internal:** update client tests ([#78](https://github.com/steel-dev/steel-python/issues/78)) ([03074e5](https://github.com/steel-dev/steel-python/commit/03074e5bf7f08e50debff7d7c7ecf78149d8cd8d))
+* **internal:** update client tests ([#80](https://github.com/steel-dev/steel-python/issues/80)) ([e076ecf](https://github.com/steel-dev/steel-python/commit/e076ecfa88045ead462069385b8dc07408d85911))
+
 ## 0.1.0-beta.8 (2025-01-29)
 
 Full Changelog: [v0.1.0-beta.7...v0.1.0-beta.8](https://github.com/steel-dev/steel-python/compare/v0.1.0-beta.7...v0.1.0-beta.8)
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [project]
 name = "steel-sdk"
-version = "0.1.0-beta.8"
+version = "0.1.0-beta.9"
 description = "The official Python library for the steel API"
 dynamic = ["readme"]
 license = "Apache-2.0"
@@ -177,7 +177,7 @@ select = [
   "T201",
   "T203",
   # misuse of typing.TYPE_CHECKING
-  "TCH004",
+  "TC004",
   # import rules
   "TID251",
 ]
diff --git a/requirements-dev.lock b/requirements-dev.lock
@@ -78,7 +78,7 @@ pytz==2023.3.post1
     # via dirty-equals
 respx==0.22.0
 rich==13.7.1
-ruff==0.6.9
+ruff==0.9.4
 setuptools==68.2.2
     # via nodeenv
 six==1.16.0
diff --git a/scripts/utils/ruffen-docs.py b/scripts/utils/ruffen-docs.py
@@ -47,7 +47,7 @@ def _md_match(match: Match[str]) -> str:
         with _collect_error(match):
             code = format_code_block(code)
         code = textwrap.indent(code, match["indent"])
-        return f'{match["before"]}{code}{match["after"]}'
+        return f"{match['before']}{code}{match['after']}"
 
     def _pycon_match(match: Match[str]) -> str:
         code = ""
@@ -97,7 +97,7 @@ def finish_fragment() -> None:
     def _md_pycon_match(match: Match[str]) -> str:
         code = _pycon_match(match)
         code = textwrap.indent(code, match["indent"])
-        return f'{match["before"]}{code}{match["after"]}'
+        return f"{match['before']}{code}{match['after']}"
 
     src = MD_RE.sub(_md_match, src)
     src = MD_PYCON_RE.sub(_md_pycon_match, src)
diff --git a/src/steel/_base_client.py b/src/steel/_base_client.py
@@ -418,10 +418,17 @@ def _build_headers(self, options: FinalRequestOptions, *, retries_taken: int = 0
         if idempotency_header and options.method.lower() != "get" and idempotency_header not in headers:
             headers[idempotency_header] = options.idempotency_key or self._idempotency_key()
 
-        # Don't set the retry count header if it was already set or removed by the caller. We check
+        # Don't set these headers if they were already set or removed by the caller. We check
         # `custom_headers`, which can contain `Omit()`, instead of `headers` to account for the removal case.
-        if "x-stainless-retry-count" not in (header.lower() for header in custom_headers):
+        lower_custom_headers = [header.lower() for header in custom_headers]
+        if "x-stainless-retry-count" not in lower_custom_headers:
             headers["x-stainless-retry-count"] = str(retries_taken)
+        if "x-stainless-read-timeout" not in lower_custom_headers:
+            timeout = self.timeout if isinstance(options.timeout, NotGiven) else options.timeout
+            if isinstance(timeout, Timeout):
+                timeout = timeout.read
+            if timeout is not None:
+                headers["x-stainless-read-timeout"] = str(timeout)
 
         return headers
 
@@ -511,7 +518,7 @@ def _build_request(
             # so that passing a `TypedDict` doesn't cause an error.
             # https://github.com/microsoft/pyright/issues/3526#event-6715453066
             params=self.qs.stringify(cast(Mapping[str, Any], params)) if params else None,
-            json=json_data,
+            json=json_data if is_given(json_data) else None,
             files=files,
             **kwargs,
         )
diff --git a/src/steel/_constants.py b/src/steel/_constants.py
@@ -6,7 +6,7 @@
 OVERRIDE_CAST_TO_HEADER = "____stainless_override_cast_to"
 
 # default timeout is 1 minute
-DEFAULT_TIMEOUT = httpx.Timeout(timeout=60.0, connect=5.0)
+DEFAULT_TIMEOUT = httpx.Timeout(timeout=60, connect=5.0)
 DEFAULT_MAX_RETRIES = 2
 DEFAULT_CONNECTION_LIMITS = httpx.Limits(max_connections=100, max_keepalive_connections=20)
 
diff --git a/src/steel/_models.py b/src/steel/_models.py
@@ -172,7 +172,7 @@ def to_json(
     @override
     def __str__(self) -> str:
         # mypy complains about an invalid self arg
-        return f'{self.__repr_name__()}({self.__repr_str__(", ")})'  # type: ignore[misc]
+        return f"{self.__repr_name__()}({self.__repr_str__(', ')})"  # type: ignore[misc]
 
     # Override the 'construct' method in a way that supports recursive parsing without validation.
     # Based on https://github.com/samuelcolvin/pydantic/issues/1168#issuecomment-817742836.
@@ -426,10 +426,16 @@ def construct_type(*, value: object, type_: object) -> object:
 
     If the given value does not match the expected type then it is returned as-is.
     """
+
+    # store a reference to the original type we were given before we extract any inner
+    # types so that we can properly resolve forward references in `TypeAliasType` annotations
+    original_type = None
+
     # we allow `object` as the input type because otherwise, passing things like
     # `Literal['value']` will be reported as a type error by type checkers
     type_ = cast("type[object]", type_)
     if is_type_alias_type(type_):
+        original_type = type_  # type: ignore[unreachable]
         type_ = type_.__value__  # type: ignore[unreachable]
 
     # unwrap `Annotated[T, ...]` -> `T`
@@ -446,7 +452,7 @@ def construct_type(*, value: object, type_: object) -> object:
 
     if is_union(origin):
         try:
-            return validate_type(type_=cast("type[object]", type_), value=value)
+            return validate_type(type_=cast("type[object]", original_type or type_), value=value)
         except Exception:
             pass
 
diff --git a/src/steel/_utils/_sync.py b/src/steel/_utils/_sync.py
@@ -7,16 +7,20 @@
 from typing import Any, TypeVar, Callable, Awaitable
 from typing_extensions import ParamSpec
 
+import anyio
+import sniffio
+import anyio.to_thread
+
 T_Retval = TypeVar("T_Retval")
 T_ParamSpec = ParamSpec("T_ParamSpec")
 
 
 if sys.version_info >= (3, 9):
-    to_thread = asyncio.to_thread
+    _asyncio_to_thread = asyncio.to_thread
 else:
     # backport of https://docs.python.org/3/library/asyncio-task.html#asyncio.to_thread
     # for Python 3.8 support
-    async def to_thread(
+    async def _asyncio_to_thread(
         func: Callable[T_ParamSpec, T_Retval], /, *args: T_ParamSpec.args, **kwargs: T_ParamSpec.kwargs
     ) -> Any:
         """Asynchronously run function *func* in a separate thread.
@@ -34,6 +38,17 @@ async def to_thread(
         return await loop.run_in_executor(None, func_call)
 
 
+async def to_thread(
+    func: Callable[T_ParamSpec, T_Retval], /, *args: T_ParamSpec.args, **kwargs: T_ParamSpec.kwargs
+) -> T_Retval:
+    if sniffio.current_async_library() == "asyncio":
+        return await _asyncio_to_thread(func, *args, **kwargs)
+
+    return await anyio.to_thread.run_sync(
+        functools.partial(func, *args, **kwargs),
+    )
+
+
 # inspired by `asyncer`, https://github.com/tiangolo/asyncer
 def asyncify(function: Callable[T_ParamSpec, T_Retval]) -> Callable[T_ParamSpec, Awaitable[T_Retval]]:
     """
diff --git a/src/steel/_utils/_transform.py b/src/steel/_utils/_transform.py
@@ -25,7 +25,7 @@
     is_annotated_type,
     strip_annotated_type,
 )
-from .._compat import model_dump, is_typeddict
+from .._compat import get_origin, model_dump, is_typeddict
 
 _T = TypeVar("_T")
 
@@ -164,9 +164,14 @@ def _transform_recursive(
         inner_type = annotation
 
     stripped_type = strip_annotated_type(inner_type)
+    origin = get_origin(stripped_type) or stripped_type
     if is_typeddict(stripped_type) and is_mapping(data):
         return _transform_typeddict(data, stripped_type)
 
+    if origin == dict and is_mapping(data):
+        items_type = get_args(stripped_type)[1]
+        return {key: _transform_recursive(value, annotation=items_type) for key, value in data.items()}
+
     if (
         # List[T]
         (is_list_type(stripped_type) and is_list(data))
@@ -307,9 +312,14 @@ async def _async_transform_recursive(
         inner_type = annotation
 
     stripped_type = strip_annotated_type(inner_type)
+    origin = get_origin(stripped_type) or stripped_type
     if is_typeddict(stripped_type) and is_mapping(data):
         return await _async_transform_typeddict(data, stripped_type)
 
+    if origin == dict and is_mapping(data):
+        items_type = get_args(stripped_type)[1]
+        return {key: _transform_recursive(value, annotation=items_type) for key, value in data.items()}
+
     if (
         # List[T]
         (is_list_type(stripped_type) and is_list(data))
diff --git a/src/steel/_version.py b/src/steel/_version.py
@@ -1,4 +1,4 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 __title__ = "steel"
-__version__ = "0.1.0-beta.8"  # x-release-please-version
+__version__ = "0.1.0-beta.9"  # x-release-please-version
diff --git a/src/steel/types/session_create_params.py b/src/steel/types/session_create_params.py
@@ -3,11 +3,11 @@
 from __future__ import annotations
 
 from typing import Dict, Iterable
-from typing_extensions import Required, Annotated, TypedDict
+from typing_extensions import Literal, Required, Annotated, TypedDict
 
 from .._utils import PropertyInfo
 
-__all__ = ["SessionCreateParams", "Dimensions", "SessionContext"]
+__all__ = ["SessionCreateParams", "Dimensions", "SessionContext", "SessionContextCookie"]
 
 
 class SessionCreateParams(TypedDict, total=False):
@@ -66,9 +66,35 @@ class Dimensions(TypedDict, total=False):
     """Width of the session"""
 
 
+class SessionContextCookie(TypedDict, total=False):
+    domain: Required[str]
+    """Domain the cookie belongs to"""
+
+    name: Required[str]
+    """Name of the cookie"""
+
+    value: Required[str]
+    """Value of the cookie"""
+
+    expires: float
+    """Unix timestamp when the cookie expires"""
+
+    http_only: Annotated[bool, PropertyInfo(alias="httpOnly")]
+    """Whether the cookie is HTTP only"""
+
+    path: str
+    """Path the cookie is valid for"""
+
+    same_site: Annotated[Literal["Strict", "Lax", "None"], PropertyInfo(alias="sameSite")]
+    """SameSite attribute of the cookie"""
+
+    secure: bool
+    """Whether the cookie requires HTTPS"""
+
+
 class SessionContext(TypedDict, total=False):
-    cookies: Iterable[Dict[str, object]]
+    cookies: Iterable[SessionContextCookie]
     """Cookies to initialize in the session"""
 
-    local_storage: Annotated[Iterable[Dict[str, object]], PropertyInfo(alias="localStorage")]
-    """Local storage items to initialize in the session"""
+    local_storage: Annotated[Dict[str, Dict[str, object]], PropertyInfo(alias="localStorage")]
+    """Domain-specific localStorage items to initialize in the session"""
diff --git a/tests/api_resources/test_sessions.py b/tests/api_resources/test_sessions.py
@@ -41,8 +41,19 @@ def test_method_create_with_all_params(self, client: Steel) -> None:
             is_selenium=True,
             proxy_url="proxyUrl",
             session_context={
-                "cookies": [{"foo": "bar"}],
-                "local_storage": [{"foo": "bar"}],
+                "cookies": [
+                    {
+                        "domain": "domain",
+                        "name": "name",
+                        "value": "value",
+                        "expires": 0,
+                        "http_only": True,
+                        "path": "path",
+                        "same_site": "Strict",
+                        "secure": True,
+                    }
+                ],
+                "local_storage": {"foo": {"foo": "bar"}},
             },
             session_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
             solve_captcha=True,
@@ -266,8 +277,19 @@ async def test_method_create_with_all_params(self, async_client: AsyncSteel) ->
             is_selenium=True,
             proxy_url="proxyUrl",
             session_context={
-                "cookies": [{"foo": "bar"}],
-                "local_storage": [{"foo": "bar"}],
+                "cookies": [
+                    {
+                        "domain": "domain",
+                        "name": "name",
+                        "value": "value",
+                        "expires": 0,
+                        "http_only": True,
+                        "path": "path",
+                        "same_site": "Strict",
+                        "secure": True,
+                    }
+                ],
+                "local_storage": {"foo": {"foo": "bar"}},
             },
             session_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
             solve_captcha=True,
diff --git a/tests/test_client.py b/tests/test_client.py
@@ -23,10 +23,12 @@
 
 from steel import Steel, AsyncSteel, APIResponseValidationError
 from steel._types import Omit
+from steel._utils import maybe_transform
 from steel._models import BaseModel, FinalRequestOptions
 from steel._constants import RAW_RESPONSE_HEADER
 from steel._exceptions import APIStatusError, APITimeoutError, APIResponseValidationError
 from steel._base_client import DEFAULT_TIMEOUT, HTTPX_DEFAULT_TIMEOUT, BaseClient, make_request_options
+from steel.types.session_create_params import SessionCreateParams
 
 from .utils import update_env
 
@@ -745,7 +747,7 @@ def test_retrying_timeout_errors_doesnt_leak(self, respx_mock: MockRouter) -> No
         with pytest.raises(APITimeoutError):
             self.client.post(
                 "/v1/sessions",
-                body=cast(object, dict()),
+                body=cast(object, maybe_transform({}, SessionCreateParams)),
                 cast_to=httpx.Response,
                 options={"headers": {RAW_RESPONSE_HEADER: "stream"}},
             )
@@ -760,7 +762,7 @@ def test_retrying_status_errors_doesnt_leak(self, respx_mock: MockRouter) -> Non
         with pytest.raises(APIStatusError):
             self.client.post(
                 "/v1/sessions",
-                body=cast(object, dict()),
+                body=cast(object, maybe_transform({}, SessionCreateParams)),
                 cast_to=httpx.Response,
                 options={"headers": {RAW_RESPONSE_HEADER: "stream"}},
             )
@@ -1542,7 +1544,7 @@ async def test_retrying_timeout_errors_doesnt_leak(self, respx_mock: MockRouter)
         with pytest.raises(APITimeoutError):
             await self.client.post(
                 "/v1/sessions",
-                body=cast(object, dict()),
+                body=cast(object, maybe_transform({}, SessionCreateParams)),
                 cast_to=httpx.Response,
                 options={"headers": {RAW_RESPONSE_HEADER: "stream"}},
             )
@@ -1557,7 +1559,7 @@ async def test_retrying_status_errors_doesnt_leak(self, respx_mock: MockRouter)
         with pytest.raises(APIStatusError):
             await self.client.post(
                 "/v1/sessions",
-                body=cast(object, dict()),
+                body=cast(object, maybe_transform({}, SessionCreateParams)),
                 cast_to=httpx.Response,
                 options={"headers": {RAW_RESPONSE_HEADER: "stream"}},
             )
diff --git a/tests/test_transform.py b/tests/test_transform.py

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`{`
`2`		`- ".": "0.1.0-beta.8"`
	`2`	`+ ".": "0.1.0-beta.9"`
`3`	`3`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`	`1`	`configured_endpoints: 9`
`2`		`-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/nen-labs%2Fsteel-6e32c08e5d67ffd976fafcf67f671bb69024a4a827f22e89988098d682ed5c60.yml`
	`2`	`+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/nen-labs%2Fsteel-9b418de74a20cd1828e67c620c627a54e0f57219d44cba0a48c9e644f5336c9e.yml`