Skip to content

fix: sanitize NO_PROXY newlines before httpx client init #3395

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
TasadduqB wants to merge 1 commit into
base: main
Choose a base branch
from
+103 −1
Open

fix: sanitize NO_PROXY newlines before httpx client init #3395

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 19 additions & 1 deletion src/openai/_base_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
from __future__ import annotations

import os
import sys
import json
import time
Expand Down Expand Up @@ -831,11 +832,27 @@ def _idempotency_key(self) -> str:
return f"stainless-python-retry-{uuid.uuid4()}"


def _sanitize_proxy_env() -> None:
"""Sanitize proxy-related environment variables that may contain newline characters.

Some environments (Docker .env files, shell scripts) introduce newline characters
into NO_PROXY / no_proxy values. httpx only splits these by comma, so newlines
end up embedded in hostnames and trigger ``httpx.InvalidURL``.
"""
for key in ("NO_PROXY", "no_proxy"):
value = os.environ.get(key)
if value and "\n" in value:
os.environ[key] = ",".join(
part.strip() for part in value.replace("\n", ",").split(",") if part.strip()
)


class _DefaultHttpxClient(httpx.Client):
def __init__(self, **kwargs: Any) -> None:
kwargs.setdefault("timeout", DEFAULT_TIMEOUT)
kwargs.setdefault("limits", DEFAULT_CONNECTION_LIMITS)
kwargs.setdefault("follow_redirects", True)
_sanitize_proxy_env()
super().__init__(**kwargs)


Expand Down Expand Up @@ -1423,6 +1440,7 @@ def __init__(self, **kwargs: Any) -> None:
kwargs.setdefault("timeout", DEFAULT_TIMEOUT)
kwargs.setdefault("limits", DEFAULT_CONNECTION_LIMITS)
kwargs.setdefault("follow_redirects", True)
_sanitize_proxy_env()
super().__init__(**kwargs)


Expand All @@ -1440,7 +1458,7 @@ def __init__(self, **kwargs: Any) -> None:
kwargs.setdefault("timeout", DEFAULT_TIMEOUT)
kwargs.setdefault("limits", DEFAULT_CONNECTION_LIMITS)
kwargs.setdefault("follow_redirects", True)

_sanitize_proxy_env()
super().__init__(**kwargs)


Expand Down
84 changes: 84 additions & 0 deletions tests/test_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1292,6 +1292,48 @@ def test_proxy_environment_variables(self, monkeypatch: pytest.MonkeyPatch) -> N
assert len(mounts) == 1
assert mounts[0][0].pattern == "https://"

def test_no_proxy_newline_sanitized(self, monkeypatch: pytest.MonkeyPatch) -> None:
monkeypatch.setenv("NO_PROXY", "localhost\n192.168.1.1")
monkeypatch.delenv("HTTP_PROXY", raising=False)
monkeypatch.delenv("HTTPS_PROXY", raising=False)
monkeypatch.delenv("ALL_PROXY", raising=False)
monkeypatch.delenv("http_proxy", raising=False)
monkeypatch.delenv("https_proxy", raising=False)
monkeypatch.delenv("all_proxy", raising=False)
monkeypatch.delenv("no_proxy", raising=False)

client = DefaultHttpxClient()
assert client is not None
assert os.environ["NO_PROXY"] == "localhost,192.168.1.1"

def test_no_proxy_lowercase_newline_sanitized(self, monkeypatch: pytest.MonkeyPatch) -> None:
monkeypatch.setenv("no_proxy", "localhost\n192.168.1.1\n10.0.0.0/8")
monkeypatch.delenv("HTTP_PROXY", raising=False)
monkeypatch.delenv("HTTPS_PROXY", raising=False)
monkeypatch.delenv("ALL_PROXY", raising=False)
monkeypatch.delenv("NO_PROXY", raising=False)
monkeypatch.delenv("http_proxy", raising=False)
monkeypatch.delenv("https_proxy", raising=False)
monkeypatch.delenv("all_proxy", raising=False)

client = DefaultHttpxClient()
assert client is not None
assert os.environ["no_proxy"] == "localhost,192.168.1.1,10.0.0.0/8"

def test_no_proxy_without_newlines_unchanged(self, monkeypatch: pytest.MonkeyPatch) -> None:
monkeypatch.setenv("NO_PROXY", "localhost,192.168.1.1")
monkeypatch.delenv("HTTP_PROXY", raising=False)
monkeypatch.delenv("HTTPS_PROXY", raising=False)
monkeypatch.delenv("ALL_PROXY", raising=False)
monkeypatch.delenv("http_proxy", raising=False)
monkeypatch.delenv("https_proxy", raising=False)
monkeypatch.delenv("all_proxy", raising=False)
monkeypatch.delenv("no_proxy", raising=False)

client = DefaultHttpxClient()
assert client is not None
assert os.environ["NO_PROXY"] == "localhost,192.168.1.1"

@pytest.mark.filterwarnings("ignore:.*deprecated.*:DeprecationWarning")
def test_default_client_creation(self) -> None:
# Ensure that the client can be initialized without any exceptions
Expand Down Expand Up @@ -2552,6 +2594,48 @@ async def test_proxy_environment_variables(self, monkeypatch: pytest.MonkeyPatch
assert len(mounts) == 1
assert mounts[0][0].pattern == "https://"

async def test_no_proxy_newline_sanitized(self, monkeypatch: pytest.MonkeyPatch) -> None:
monkeypatch.setenv("NO_PROXY", "localhost\n192.168.1.1")
monkeypatch.delenv("HTTP_PROXY", raising=False)
monkeypatch.delenv("HTTPS_PROXY", raising=False)
monkeypatch.delenv("ALL_PROXY", raising=False)
monkeypatch.delenv("http_proxy", raising=False)
monkeypatch.delenv("https_proxy", raising=False)
monkeypatch.delenv("all_proxy", raising=False)
monkeypatch.delenv("no_proxy", raising=False)

client = DefaultAsyncHttpxClient()
assert client is not None
assert os.environ["NO_PROXY"] == "localhost,192.168.1.1"

async def test_no_proxy_lowercase_newline_sanitized(self, monkeypatch: pytest.MonkeyPatch) -> None:
monkeypatch.setenv("no_proxy", "localhost\n192.168.1.1\n10.0.0.0/8")
monkeypatch.delenv("HTTP_PROXY", raising=False)
monkeypatch.delenv("HTTPS_PROXY", raising=False)
monkeypatch.delenv("ALL_PROXY", raising=False)
monkeypatch.delenv("NO_PROXY", raising=False)
monkeypatch.delenv("http_proxy", raising=False)
monkeypatch.delenv("https_proxy", raising=False)
monkeypatch.delenv("all_proxy", raising=False)

client = DefaultAsyncHttpxClient()
assert client is not None
assert os.environ["no_proxy"] == "localhost,192.168.1.1,10.0.0.0/8"

async def test_no_proxy_without_newlines_unchanged(self, monkeypatch: pytest.MonkeyPatch) -> None:
monkeypatch.setenv("NO_PROXY", "localhost,192.168.1.1")
monkeypatch.delenv("HTTP_PROXY", raising=False)
monkeypatch.delenv("HTTPS_PROXY", raising=False)
monkeypatch.delenv("ALL_PROXY", raising=False)
monkeypatch.delenv("http_proxy", raising=False)
monkeypatch.delenv("https_proxy", raising=False)
monkeypatch.delenv("all_proxy", raising=False)
monkeypatch.delenv("no_proxy", raising=False)

client = DefaultAsyncHttpxClient()
assert client is not None
assert os.environ["NO_PROXY"] == "localhost,192.168.1.1"

@pytest.mark.filterwarnings("ignore:.*deprecated.*:DeprecationWarning")
async def test_default_client_creation(self) -> None:
# Ensure that the client can be initialized without any exceptions
Expand Down