Add refresh auth headers (sync and async) as alternate approach to allow bearer tokens to be refreshed #17
Conversation
…low bearer tokens to be updated
|
|
||
| @override | ||
| def _prepare_options(self, options: FinalRequestOptions) -> FinalRequestOptions: | ||
| self.refresh_auth_headers() |
There was a problem hiding this comment.
It is not great to. have to remember to call refresh_auth_headers before accessing them. But since the current implementation is a (sync) property, we have to somehow allow for async refresh.
We could do the refresh in the sync context, but I believe that the asymmetry between sync and async is worse than splitting it apart for both sync and async clients....
| @@ -122,11 +125,12 @@ def __init__( | |||
| """ | |||
| if api_key is None: | |||
| api_key = os.environ.get("OPENAI_API_KEY") | |||
| if api_key is None: | |||
| if api_key is None and bearer_token_provider 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" | |||
There was a problem hiding this comment.
Should we update the error message to include bearer_token_provider?
There was a problem hiding this comment.
Also, should we error if both are provided?
| @property | ||
| @override | ||
| def qs(self) -> Querystring: | ||
| return Querystring(array_format="brackets") | ||
|
|
||
| def refresh_auth_headers(self): | ||
| bearer_token = self.bearer_token_provider() if self.bearer_token_provider else self.api_key |
There was a problem hiding this comment.
I don't have context for the change, but it looks like if the api_key or token is an empty string, they've updated the code to not send the header: https://github.com/openai/openai-python/blob/main/src/openai/_client.py#L286
Changes being requested
Provide callable to allow refresh of the bearer token. The callable must support IO calls being made and thus has to be async in an asynchronous context.
Additional context & links