Skip to content

allow for passing requests.Session #390

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.

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
merged 1 commit into from
Apr 27, 2023
Merged
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
7 changes: 6 additions & 1 deletion openai/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

import os
import sys
from typing import TYPE_CHECKING, Optional
from typing import TYPE_CHECKING, Optional, Union, Callable

from contextvars import ContextVar

Expand Down Expand Up @@ -36,6 +36,7 @@
from openai.version import VERSION

if TYPE_CHECKING:
import requests
from aiohttp import ClientSession

api_key = os.environ.get("OPENAI_API_KEY")
Expand All @@ -58,6 +59,10 @@
debug = False
log = None # Set to either 'debug' or 'info', controls console logging

requestssession: Optional[
Union["requests.Session", Callable[[], "requests.Session"]]
] = None # Provide a requests.Session or Session factory.

aiosession: ContextVar[Optional["ClientSession"]] = ContextVar(
"aiohttp-session", default=None
) # Acts as a global aiohttp ClientSession that reuses connections.
Expand Down
4 changes: 4 additions & 0 deletions openai/api_requestor.py
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,10 @@ def _aiohttp_proxies_arg(proxy) -> Optional[str]:


def _make_session() -> requests.Session:
if openai.requestssession:
if isinstance(openai.requestssession, requests.Session):
return openai.requestssession
return openai.requestssession()
if not openai.verify_ssl_certs:
warnings.warn("verify_ssl_certs is ignored; openai always verifies.")
s = requests.Session()
Expand Down
30 changes: 30 additions & 0 deletions openai/tests/test_endpoints.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
import json

import pytest
import requests

import openai
from openai import error
Expand Down Expand Up @@ -86,3 +87,32 @@ def test_timeout_does_not_error():
model="ada",
request_timeout=10,
)


def test_user_session():
with requests.Session() as session:
openai.requestssession = session

completion = openai.Completion.create(
prompt="hello world",
model="ada",
)
assert completion


def test_user_session_factory():
def factory():
session = requests.Session()
session.mount(
"https://",
requests.adapters.HTTPAdapter(max_retries=4),
)
return session

openai.requestssession = factory

completion = openai.Completion.create(
prompt="hello world",
model="ada",
)
assert completion