Skip to content

Make sure caller can get an OpenAI client from get_openai_client() with a custom http_client #45028

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

Merged
dargilco merged 4 commits into from
Feb 5, 2026
Merged

Make sure caller can get an OpenAI client from get_openai_client() with a custom http_client #45028

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
23c41a1
First
dargilco Feb 5, 2026
a394f90
add tests
dargilco Feb 5, 2026
1c45f92
Merge remote-tracking branch 'origin/feature/azure-ai-projects/2.0.0b…
dargilco Feb 5, 2026
6f65615
Merge remote-tracking branch 'origin/feature/azure-ai-projects/2.0.0b…
dargilco Feb 5, 2026
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
207 changes: 107 additions & 100 deletions sdk/ai/azure-ai-projects/azure/ai/projects/_patch.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
"""
import os
import logging
import httpx
from typing import List, Any
from openai import OpenAI
from azure.core.tracing.decorator import distributed_trace
Expand Down Expand Up @@ -106,8 +107,6 @@ def get_openai_client(self, **kwargs: Any) -> "OpenAI": # type: ignore[name-def
:return: An authenticated OpenAI client
:rtype: ~openai.OpenAI

:raises ~azure.core.exceptions.ModuleNotFoundError: if the ``openai`` package
is not installed.
:raises ~azure.core.exceptions.HttpResponseError:
"""

Expand All @@ -118,107 +117,14 @@ def get_openai_client(self, **kwargs: Any) -> "OpenAI": # type: ignore[name-def
base_url,
)

http_client = None

kwargs = kwargs.copy() if kwargs else {}

if self._console_logging_enabled:
try:
import httpx
except ModuleNotFoundError as e:
raise ModuleNotFoundError("Failed to import httpx. Please install it using 'pip install httpx'") from e

class OpenAILoggingTransport(httpx.HTTPTransport):

def _sanitize_auth_header(self, headers) -> None:
"""Sanitize authorization header by redacting sensitive information.

:param headers: Dictionary of HTTP headers to sanitize
:type headers: dict
"""

if "authorization" in headers:
auth_value = headers["authorization"]
if len(auth_value) >= 7:
headers["authorization"] = auth_value[:7] + "<REDACTED>"
else:
headers["authorization"] = "<ERROR>"

def handle_request(self, request: httpx.Request) -> httpx.Response:
"""
Log HTTP request and response details to console, in a nicely formatted way,
for OpenAI / Azure OpenAI clients.

:param request: The HTTP request to handle and log
:type request: httpx.Request

:return: The HTTP response received
:rtype: httpx.Response
"""

print(f"\n==> Request:\n{request.method} {request.url}")
headers = dict(request.headers)
self._sanitize_auth_header(headers)
print("Headers:")
for key, value in sorted(headers.items()):
print(f" {key}: {value}")

self._log_request_body(request)

response = super().handle_request(request)

print(f"\n<== Response:\n{response.status_code} {response.reason_phrase}")
print("Headers:")
for key, value in sorted(dict(response.headers).items()):
print(f" {key}: {value}")

content = response.read()
if content is None or content == b"":
print("Body: [No content]")
else:
try:
print(f"Body:\n {content.decode('utf-8')}")
except Exception: # pylint: disable=broad-exception-caught
print(f"Body (raw):\n {content!r}")
print("\n")

return response

def _log_request_body(self, request: httpx.Request) -> None:
"""Log request body content safely, handling binary data and streaming content.

:param request: The HTTP request object containing the body to log
:type request: httpx.Request
"""

# Check content-type header to identify file uploads
content_type = request.headers.get("content-type", "").lower()
if "multipart/form-data" in content_type:
print("Body: [Multipart form data - file upload, not logged]")
return

# Safely check if content exists without accessing it
if not hasattr(request, "content"):
print("Body: [No content attribute]")
return

# Very careful content access - wrap in try-catch immediately
try:
content = request.content
except Exception as access_error: # pylint: disable=broad-exception-caught
print(f"Body: [Cannot access content: {access_error}]")
return

if content is None or content == b"":
print("Body: [No content]")
return

try:
print(f"Body:\n {content.decode('utf-8')}")
except Exception: # pylint: disable=broad-exception-caught
print(f"Body (raw):\n {content!r}")

if "http_client" in kwargs:
http_client = kwargs.pop("http_client")
elif self._console_logging_enabled:
http_client = httpx.Client(transport=OpenAILoggingTransport())
else:
http_client = None

default_headers = dict[str, str](kwargs.pop("default_headers", None) or {})

Expand Down Expand Up @@ -256,6 +162,107 @@ def _create_openai_client(**kwargs) -> OpenAI:
return client


class OpenAILoggingTransport(httpx.HTTPTransport):
"""Custom HTTP transport that logs OpenAI API requests and responses to the console.

This transport wraps httpx.HTTPTransport to intercept all HTTP traffic and print
detailed request/response information for debugging purposes. It automatically
redacts sensitive authorization headers and handles various content types including
multipart form data (file uploads).

Used internally by AIProjectClient when console logging is enabled via the
AZURE_AI_PROJECTS_CONSOLE_LOGGING environment variable.
"""

def _sanitize_auth_header(self, headers) -> None:
"""Sanitize authorization header by redacting sensitive information.

:param headers: Dictionary of HTTP headers to sanitize
:type headers: dict
"""

if "authorization" in headers:
auth_value = headers["authorization"]
if len(auth_value) >= 7:
headers["authorization"] = auth_value[:7] + "<REDACTED>"
else:
headers["authorization"] = "<ERROR>"

def handle_request(self, request: httpx.Request) -> httpx.Response:
"""
Log HTTP request and response details to console, in a nicely formatted way,
for OpenAI / Azure OpenAI clients.

:param request: The HTTP request to handle and log
:type request: httpx.Request

:return: The HTTP response received
:rtype: httpx.Response
"""

print(f"\n==> Request:\n{request.method} {request.url}")
headers = dict(request.headers)
self._sanitize_auth_header(headers)
print("Headers:")
for key, value in sorted(headers.items()):
print(f" {key}: {value}")

self._log_request_body(request)

response = super().handle_request(request)

print(f"\n<== Response:\n{response.status_code} {response.reason_phrase}")
print("Headers:")
for key, value in sorted(dict(response.headers).items()):
print(f" {key}: {value}")

content = response.read()
if content is None or content == b"":
print("Body: [No content]")
else:
try:
print(f"Body:\n {content.decode('utf-8')}")
except Exception: # pylint: disable=broad-exception-caught
print(f"Body (raw):\n {content!r}")
print("\n")

return response

def _log_request_body(self, request: httpx.Request) -> None:
"""Log request body content safely, handling binary data and streaming content.

:param request: The HTTP request object containing the body to log
:type request: httpx.Request
"""

# Check content-type header to identify file uploads
content_type = request.headers.get("content-type", "").lower()
if "multipart/form-data" in content_type:
print("Body: [Multipart form data - file upload, not logged]")
return

# Safely check if content exists without accessing it
if not hasattr(request, "content"):
print("Body: [No content attribute]")
return

# Very careful content access - wrap in try-catch immediately
try:
content = request.content
except Exception as access_error: # pylint: disable=broad-exception-caught
print(f"Body: [Cannot access content: {access_error}]")
return

if content is None or content == b"":
print("Body: [No content]")
return

try:
print(f"Body:\n {content.decode('utf-8')}")
except Exception: # pylint: disable=broad-exception-caught
print(f"Body (raw):\n {content!r}")


__all__: List[str] = [
"AIProjectClient",
] # Add all objects you want publicly available to users at this package level
Expand Down
Loading
Loading