@@ -164,6 +164,11 @@ def basic(
164
164
) -> AsyncAuthManager :
165
165
"""Create an auth manager handling basic auth password rotation.
166
166
167
+ This factory wraps the provider function in an auth manager
168
+ implementation that caches the provides auth info until either the
169
+ server notifies the driver that the auth info is expired (by returning
170
+ an error that indicates that basic auth has changed).
171
+
167
172
.. warning::
168
173
169
174
The provider function **must not** interact with the driver in any
@@ -202,9 +207,8 @@ async def auth_provider():
202
207
:returns:
203
208
An instance of an implementation of :class:`.AsyncAuthManager` that
204
209
returns auth info from the given provider and refreshes it, calling
205
- the provider again, when the auth info expires (either because it's
206
- reached its expiry time or because the server flagged it as
207
- expired).
210
+ the provider again, when the auth info expires (because the server
211
+ flagged it as expired).
208
212
209
213
.. versionadded:: 5.12
210
214
"""
@@ -226,6 +230,12 @@ def bearer(
226
230
) -> AsyncAuthManager :
227
231
"""Create an auth manager for potentially expiring bearer auth tokens.
228
232
233
+ This factory wraps the provider function in an auth manager
234
+ implementation that caches the provides auth info until either the
235
+ ``ExpiringAuth.expires_at`` is exceeded the server notifies the driver
236
+ that the auth info is expired (by returning an error that indicates
237
+ that the bearer auth token has expired).
238
+
229
239
.. warning::
230
240
231
241
The provider function **must not** interact with the driver in any
0 commit comments