chore(internal): minor updates

Author: RobertCraigie

README.md

@@ -25,7 +25,7 @@ from openai import OpenAI
 
 client = OpenAI(
     # defaults to os.environ.get("OPENAI_API_KEY")
-    api_key="my api key",
+    api_key="My API Key",
 )
 
 completion = client.chat.completions.create(
@@ -40,8 +40,10 @@ completion = client.chat.completions.create(
 print(completion.choices)
 ```
 
-While you can provide an `api_key` keyword argument, we recommend using [python-dotenv](https://pypi.org/project/python-dotenv/)
-and adding `OPENAI_API_KEY="my api key"` to your `.env` file so that your API Key is not stored in source control.
+While you can provide an `api_key` keyword argument,
+we recommend using [python-dotenv](https://pypi.org/project/python-dotenv/)
+to add `OPENAI_API_KEY="My API Key"` to your `.env` file
+so that your API Key is not stored in source control.
 
 ## Async usage
 
@@ -52,7 +54,7 @@ from openai import AsyncOpenAI
 
 client = AsyncOpenAI(
     # defaults to os.environ.get("OPENAI_API_KEY")
-    api_key="my api key",
+    api_key="My API Key",
 )
 
 

bin/check-test-server

@@ -10,13 +10,13 @@ function prism_is_running() {
 }
 
 function is_overriding_api_base_url() {
-  [ -n "$API_BASE_URL" ]
+  [ -n "$TEST_API_BASE_URL" ]
 }
 
 if is_overriding_api_base_url ; then
   # If someone is running the tests against the live API, we can trust they know
   # what they're doing and exit early.
-  echo -e "${GREEN}✔ Running tests against ${API_BASE_URL}${NC}"
+  echo -e "${GREEN}✔ Running tests against ${TEST_API_BASE_URL}${NC}"
 
   exit 0
 elif prism_is_running ; then

examples/azure.py

@@ -1,6 +1,6 @@
 import os
-from openai import OpenAI
 
+from openai import OpenAI
 
 # The name of your Azure OpenAI Resource.
 # https://learn.microsoft.com/en-us/azure/cognitive-services/openai/how-to/create-resource?pivots=web-portal#create-a-resource

examples/demo.py

@@ -6,30 +6,18 @@
 client = OpenAI()
 
 # Non-streaming:
-print('----- standard request -----')
-completion = client.chat.completions.create(
-    model="gpt-4",
-    messages=[
-        {
-            "role": "user",
-            "content": "Say this is a test",
-        },
-    ],
+completion = client.completions.create(
+    model="text-davinci-003",
+    prompt="Say this is a test",
 )
-print(completion.choices[0].message.content)
+print(completion.choices[0].text)
 
 # Streaming:
-print('----- streaming request -----')
-stream = client.chat.completions.create(
-    model="gpt-4",
-    messages=[
-        {
-            "role": "user",
-            "content": "How do I output all files in a directory using Python?",
-        },
-    ],
+stream = client.completions.create(
+    model="text-davinci-003",
+    prompt="Say this is a test",
     stream=True,
 )
 for completion in stream:
-    print(completion.choices[0].delta.content, end="")
+    print(completion.choices[0].text, end="")
 print()

src/openai/__init__.py

@@ -95,7 +95,7 @@
 
 api_key: str | None = _os.environ.get("OPENAI_API_KEY")
 
-organization: str | None = _os.environ.get("OPENAI_ORG_ID") or None
+organization: str | None = _os.environ.get("OPENAI_ORG_ID")
 
 base_url: str | None = None
 

src/openai/_base_client.py

@@ -3,6 +3,7 @@
 import json
 import time
 import uuid
+import email
 import inspect
 import logging
 import platform
@@ -655,10 +656,22 @@ def _calculate_retry_timeout(
         try:
             # About the Retry-After header: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After
             #
-            # TODO: we may want to handle the case where the header is using the http-date syntax: "Retry-After:
             # <http-date>". See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After#syntax for
             # details.
-            retry_after = -1 if response_headers is None else int(response_headers.get("retry-after"))
+            if response_headers is not None:
+                retry_header = response_headers.get("retry-after")
+                try:
+                    retry_after = int(retry_header)
+                except Exception:
+                    retry_date_tuple = email.utils.parsedate_tz(retry_header)
+                    if retry_date_tuple is None:
+                        retry_after = -1
+                    else:
+                        retry_date = email.utils.mktime_tz(retry_date_tuple)
+                        retry_after = int(retry_date - time.time())
+            else:
+                retry_after = -1
+
         except Exception:
             retry_after = -1
 
@@ -803,7 +816,10 @@ def close(self) -> None:
 
         The client will *not* be usable after this.
         """
-        self._client.close()
+        # If an error is thrown while constructing a client, self._client
+        # may not be present
+        if hasattr(self, "_client"):
+            self._client.close()
 
     def __enter__(self: _T) -> _T:
         return self

src/openai/_client.py

@@ -59,9 +59,9 @@ class OpenAI(SyncAPIClient):
     def __init__(
         self,
         *,
+        api_key: str | None = None,
         organization: str | None = None,
         base_url: Optional[str] = None,
-        api_key: Optional[str] = None,
         timeout: Union[float, Timeout, None, NotGiven] = NOT_GIVEN,
         max_retries: int = DEFAULT_MAX_RETRIES,
         default_headers: Mapping[str, str] | None = None,
@@ -84,15 +84,17 @@ def __init__(
         - `api_key` from `OPENAI_API_KEY`
         - `organization` from `OPENAI_ORG_ID`
         """
-        api_key = api_key or os.environ.get("OPENAI_API_KEY", None)
-        if not api_key:
+        if api_key is None:
+            api_key = os.environ.get("OPENAI_API_KEY")
+        if api_key is None:
             raise OpenAIError(
                 "The api_key client option must be set either by passing api_key to the client or by setting the OPENAI_API_KEY environment variable"
             )
         self.api_key = api_key
 
-        organization_envvar = os.environ.get("OPENAI_ORG_ID", None)
-        self.organization = organization or organization_envvar or None
+        if organization is None:
+            organization = os.environ.get("OPENAI_ORG_ID") or None
+        self.organization = organization
 
         if base_url is None:
             base_url = f"https://api.openai.com/v1"
@@ -142,8 +144,8 @@ def default_headers(self) -> dict[str, str | Omit]:
     def copy(
         self,
         *,
-        organization: str | None = None,
         api_key: str | None = None,
+        organization: str | None = None,
         base_url: str | None = None,
         timeout: float | Timeout | None | NotGiven = NOT_GIVEN,
         http_client: httpx.Client | None = None,
@@ -179,9 +181,9 @@ def copy(
 
         http_client = http_client or self._client
         return self.__class__(
+            api_key=api_key or self.api_key,
             organization=organization or self.organization,
             base_url=base_url or str(self.base_url),
-            api_key=api_key or self.api_key,
             timeout=self.timeout if isinstance(timeout, NotGiven) else timeout,
             http_client=http_client,
             max_retries=max_retries if is_given(max_retries) else self.max_retries,
@@ -256,9 +258,9 @@ class AsyncOpenAI(AsyncAPIClient):
     def __init__(
         self,
         *,
+        api_key: str | None = None,
         organization: str | None = None,
         base_url: Optional[str] = None,
-        api_key: Optional[str] = None,
         timeout: Union[float, Timeout, None, NotGiven] = NOT_GIVEN,
         max_retries: int = DEFAULT_MAX_RETRIES,
         default_headers: Mapping[str, str] | None = None,
@@ -281,15 +283,17 @@ def __init__(
         - `api_key` from `OPENAI_API_KEY`
         - `organization` from `OPENAI_ORG_ID`
         """
-        api_key = api_key or os.environ.get("OPENAI_API_KEY", None)
-        if not api_key:
+        if api_key is None:
+            api_key = os.environ.get("OPENAI_API_KEY")
+        if api_key is None:
             raise OpenAIError(
                 "The api_key client option must be set either by passing api_key to the client or by setting the OPENAI_API_KEY environment variable"
             )
         self.api_key = api_key
 
-        organization_envvar = os.environ.get("OPENAI_ORG_ID", None)
-        self.organization = organization or organization_envvar or None
+        if organization is None:
+            organization = os.environ.get("OPENAI_ORG_ID") or None
+        self.organization = organization
 
         if base_url is None:
             base_url = f"https://api.openai.com/v1"
@@ -339,8 +343,8 @@ def default_headers(self) -> dict[str, str | Omit]:
     def copy(
         self,
         *,
-        organization: str | None = None,
         api_key: str | None = None,
+        organization: str | None = None,
         base_url: str | None = None,
         timeout: float | Timeout | None | NotGiven = NOT_GIVEN,
         http_client: httpx.AsyncClient | None = None,
@@ -376,9 +380,9 @@ def copy(
 
         http_client = http_client or self._client
         return self.__class__(
+            api_key=api_key or self.api_key,
             organization=organization or self.organization,
             base_url=base_url or str(self.base_url),
-            api_key=api_key or self.api_key,
             timeout=self.timeout if isinstance(timeout, NotGiven) else timeout,
             http_client=http_client,
             max_retries=max_retries if is_given(max_retries) else self.max_retries,

src/openai/_utils/__init__.py

@@ -21,6 +21,9 @@
 from ._utils import extract_type_arg as extract_type_arg
 from ._utils import is_required_type as is_required_type
 from ._utils import is_annotated_type as is_annotated_type
+from ._utils import maybe_coerce_float as maybe_coerce_float
+from ._utils import maybe_coerce_boolean as maybe_coerce_boolean
+from ._utils import maybe_coerce_integer as maybe_coerce_integer
 from ._utils import strip_annotated_type as strip_annotated_type
 from ._transform import PropertyInfo as PropertyInfo
 from ._transform import transform as transform

src/openai/_utils/_utils.py

@@ -309,6 +309,24 @@ def coerce_boolean(val: str) -> bool:
     return val == "true" or val == "1" or val == "on"
 
 
+def maybe_coerce_integer(val: str | None) -> int | None:
+    if val is None:
+        return None
+    return coerce_integer(val)
+
+
+def maybe_coerce_float(val: str | None) -> float | None:
+    if val is None:
+        return None
+    return coerce_float(val)
+
+
+def maybe_coerce_boolean(val: str | None) -> bool | None:
+    if val is None:
+        return None
+    return coerce_boolean(val)
+
+
 def removeprefix(string: str, prefix: str) -> str:
     """Remove a prefix from a string.
 

tests/api_resources/audio/test_transcriptions.py

@@ -10,8 +10,8 @@
 from tests.utils import assert_matches_type
 from openai.types.audio import Transcription
 
-base_url = os.environ.get("API_BASE_URL", "http://127.0.0.1:4010")
-api_key = os.environ.get("API_KEY", "something1234")
+base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010")
+api_key = "My API Key"
 
 
 class TestTranscriptions: