Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions src/openai/_base_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -833,6 +833,9 @@ def _idempotency_key(self) -> str:

class _DefaultHttpxClient(httpx.Client):
def __init__(self, **kwargs: Any) -> None:
from ._utils import sanitize_proxy_env_vars

sanitize_proxy_env_vars()
kwargs.setdefault("timeout", DEFAULT_TIMEOUT)
kwargs.setdefault("limits", DEFAULT_CONNECTION_LIMITS)
kwargs.setdefault("follow_redirects", True)
Expand Down Expand Up @@ -1420,6 +1423,9 @@ def get_api_list(

class _DefaultAsyncHttpxClient(httpx.AsyncClient):
def __init__(self, **kwargs: Any) -> None:
from ._utils import sanitize_proxy_env_vars

sanitize_proxy_env_vars()
kwargs.setdefault("timeout", DEFAULT_TIMEOUT)
kwargs.setdefault("limits", DEFAULT_CONNECTION_LIMITS)
kwargs.setdefault("follow_redirects", True)
Expand All @@ -1437,6 +1443,9 @@ def __init__(self, **_kwargs: Any) -> None:

class _DefaultAioHttpClient(httpx_aiohttp.HttpxAiohttpClient): # type: ignore
def __init__(self, **kwargs: Any) -> None:
from ._utils import sanitize_proxy_env_vars

sanitize_proxy_env_vars()
kwargs.setdefault("timeout", DEFAULT_TIMEOUT)
kwargs.setdefault("limits", DEFAULT_CONNECTION_LIMITS)
kwargs.setdefault("follow_redirects", True)
Expand Down
13 changes: 9 additions & 4 deletions src/openai/_models.py
Original file line number Diff line number Diff line change
Expand Up @@ -657,8 +657,11 @@ def construct_type(*, value: object, type_: object, metadata: Optional[List[Any]
if not is_mapping(value):
return value

_, items_type = get_args(type_) # Dict[_, items_type]
return {key: construct_type(value=item, type_=items_type) for key, item in value.items()}
dict_args = get_args(type_)
if len(dict_args) >= 2:
items_type = dict_args[1]
return {key: construct_type(value=item, type_=items_type) for key, item in value.items()}
return dict(value)

if (
not is_literal_type(type_)
Expand All @@ -678,8 +681,10 @@ def construct_type(*, value: object, type_: object, metadata: Optional[List[Any]
if not is_list(value):
return value

inner_type = args[0] # List[inner_type]
return [construct_type(value=entry, type_=inner_type) for entry in value]
if args:
inner_type = args[0] # List[inner_type]
return [construct_type(value=entry, type_=inner_type) for entry in value]
return list(value)

if origin == float:
if isinstance(value, int):
Expand Down
1 change: 1 addition & 0 deletions src/openai/_utils/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
get_async_library as get_async_library,
maybe_coerce_float as maybe_coerce_float,
get_required_header as get_required_header,
sanitize_proxy_env_vars as sanitize_proxy_env_vars,
maybe_coerce_boolean as maybe_coerce_boolean,
maybe_coerce_integer as maybe_coerce_integer,
is_async_azure_client as is_async_azure_client,
Expand Down
26 changes: 22 additions & 4 deletions src/openai/_utils/_transform.py
Original file line number Diff line number Diff line change
Expand Up @@ -180,8 +180,11 @@ def _transform_recursive(
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()}
args = get_args(stripped_type)
if len(args) >= 2:
items_type = args[1]
return {key: _transform_recursive(value, annotation=items_type) for key, value in data.items()}
return dict(data)

if (
# List[T]
Expand All @@ -196,6 +199,12 @@ def _transform_recursive(
if isinstance(data, dict):
return cast(object, data)

# bare list/iterable/sequence with no type args - return as-is
if not get_args(stripped_type):
if is_list(data):
return data
return list(data)

inner_type = extract_type_arg(stripped_type, 0)
if _no_transform_needed(inner_type):
# for some types there is no need to transform anything, so we can get a small
Expand Down Expand Up @@ -346,8 +355,11 @@ async def _async_transform_recursive(
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()}
args = get_args(stripped_type)
if len(args) >= 2:
items_type = args[1]
return {key: _transform_recursive(value, annotation=items_type) for key, value in data.items()}
return dict(data)

if (
# List[T]
Expand All @@ -362,6 +374,12 @@ async def _async_transform_recursive(
if isinstance(data, dict):
return cast(object, data)

# bare list/iterable/sequence with no type args - return as-is
if not get_args(stripped_type):
if is_list(data):
return data
return list(data)

inner_type = extract_type_arg(stripped_type, 0)
if _no_transform_needed(inner_type):
# for some types there is no need to transform anything, so we can get a small
Expand Down
29 changes: 29 additions & 0 deletions src/openai/_utils/_utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -447,3 +447,32 @@ def is_async_azure_client(client: object) -> TypeGuard[AsyncAzureOpenAI]:
from ..lib.azure import AsyncAzureOpenAI

return isinstance(client, AsyncAzureOpenAI)


_PROXY_ENV_VARS = (
"HTTP_PROXY",
"http_proxy",
"HTTPS_PROXY",
"https_proxy",
"ALL_PROXY",
"all_proxy",
"NO_PROXY",
"no_proxy",
)


def sanitize_proxy_env_vars() -> None:
"""Sanitize proxy-related environment variables by removing newline characters.

This works around an issue where httpx's proxy parsing only splits by comma
and fails with InvalidURL when newlines are present in the value.
"""
for var in _PROXY_ENV_VARS:
value = os.environ.get(var)
if value and ("\n" in value or "\r" in value):
sanitized = ",".join(
part.strip()
for part in value.replace("\n", ",").replace("\r", ",").split(",")
if part.strip()
)
os.environ[var] = sanitized
14 changes: 9 additions & 5 deletions src/openai/types/responses/response_function_web_search.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,15 @@
class ActionSearchSource(BaseModel):
"""A source used in the search."""

type: Literal["url"]
"""The type of source. Always `url`."""
type: Literal["url", "api"]
"""The type of source. `url` for a web page, `api` for a built-in OpenAI data source."""

url: str
"""The URL of the source."""
url: Optional[str] = None
"""The URL of the source. Present when type is `url`."""

name: Optional[str] = None
"""The name of the built-in data source (e.g. `oai-weather`, `oai-sports`, `oai-finance`).
Present when type is `api`."""


class ActionSearch(BaseModel):
Expand Down Expand Up @@ -78,7 +82,7 @@ class ResponseFunctionWebSearch(BaseModel):
id: str
"""The unique ID of the web search tool call."""

action: Action
action: Optional[Action] = None

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Allow null web-search actions in input params

When the API returns action: null (the scenario this line now accepts), the corresponding input-item type still goes through ResponseFunctionWebSearchParam, where action remains Required[Action]. That leaves users unable to type a replay/round-trip of a web-search item with a null action into responses.create(input=...); please make the param field nullable and non-required in sync with the response model.

Useful? React with 👍 / 👎.

"""
An object describing the specific action taken in this web search call. Includes
details on how the model used the web (search, open_page, find_in_page).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,15 @@
class ActionSearchSource(TypedDict, total=False):
"""A source used in the search."""

type: Required[Literal["url"]]
"""The type of source. Always `url`."""
type: Required[Literal["url", "api"]]
"""The type of source. `url` for a web page, `api` for a built-in OpenAI data source."""

url: Required[str]
"""The URL of the source."""
url: str
"""The URL of the source. Required when type is `url`."""

name: str
"""The name of the built-in data source (e.g. `oai-weather`, `oai-sports`, `oai-finance`).
Required when type is `api`."""


class ActionSearch(TypedDict, total=False):
Expand Down
22 changes: 22 additions & 0 deletions tests/test_models.py
Original file line number Diff line number Diff line change
Expand Up @@ -1015,3 +1015,25 @@ class Model(BaseModel):
# falls back to list of chars rather than calling str(["h", "e", "l", "l", "o"])
assert m.data["items"] == ["h", "e", "l", "l", "o"]
assert m.model_dump()["data"]["items"] == ["h", "e", "l", "l", "o"]


def test_bare_dict_annotation() -> None:
result = construct_type(value={"key": "value"}, type_=dict)
assert result == {"key": "value"}

result = construct_type(value={"a": 1, "b": 2}, type_=dict)
assert result == {"a": 1, "b": 2}

result = construct_type(value="not a dict", type_=dict)
assert result == "not a dict"


def test_bare_list_annotation() -> None:
result = construct_type(value=[1, 2, 3], type_=list)
assert result == [1, 2, 3]

result = construct_type(value=["a", "b"], type_=list)
assert result == ["a", "b"]

result = construct_type(value="not a list", type_=list)
assert result == "not a list"
Loading