Repository navigation
Expand file tree
/
Copy pathhttp_client.py
More file actions
600 lines (530 loc) · 22.7 KB
/
Copy pathhttp_client.py
File metadata and controls
600 lines (530 loc) · 22.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
# This file was auto-generated by Fern from our API Definition.
import asyncio
import email.utils
import re
import time
import typing
import urllib.parse
from contextlib import asynccontextmanager, contextmanager
from random import random
import httpx
from .file import File, convert_file_dict_to_httpx_tuples
from .force_multipart import FORCE_MULTIPART
from .jsonable_encoder import jsonable_encoder
from .query_encoder import encode_query
from .remove_none_from_dict import remove_none_from_dict as remove_none_from_dict
from .request_options import RequestOptions
from httpx._types import RequestFiles
INITIAL_RETRY_DELAY_SECONDS = 1.0
MAX_RETRY_DELAY_SECONDS = 60.0
JITTER_FACTOR = 0.2 # 20% random jitter
def _parse_retry_after(response_headers: httpx.Headers) -> typing.Optional[float]:
"""
This function parses the `Retry-After` header in a HTTP response and returns the number of seconds to wait.
Inspired by the urllib3 retry implementation.
"""
retry_after_ms = response_headers.get("retry-after-ms")
if retry_after_ms is not None:
try:
return int(retry_after_ms) / 1000 if retry_after_ms > 0 else 0
except Exception:
pass
retry_after = response_headers.get("retry-after")
if retry_after is None:
return None
# Attempt to parse the header as an int.
if re.match(r"^\s*[0-9]+\s*$", retry_after):
seconds = float(retry_after)
# Fallback to parsing it as a date.
else:
retry_date_tuple = email.utils.parsedate_tz(retry_after)
if retry_date_tuple is None:
return None
if retry_date_tuple[9] is None: # Python 2
# Assume UTC if no timezone was specified
# On Python2.7, parsedate_tz returns None for a timezone offset
# instead of 0 if no timezone is given, where mktime_tz treats
# a None timezone offset as local time.
retry_date_tuple = retry_date_tuple[:9] + (0,) + retry_date_tuple[10:]
retry_date = email.utils.mktime_tz(retry_date_tuple)
seconds = retry_date - time.time()
if seconds < 0:
seconds = 0
return seconds
def _add_positive_jitter(delay: float) -> float:
"""Add positive jitter (0-20%) to prevent thundering herd."""
jitter_multiplier = 1 + random() * JITTER_FACTOR
return delay * jitter_multiplier
def _add_symmetric_jitter(delay: float) -> float:
"""Add symmetric jitter (±10%) for exponential backoff."""
jitter_multiplier = 1 + (random() - 0.5) * JITTER_FACTOR
return delay * jitter_multiplier
def _parse_x_ratelimit_reset(response_headers: httpx.Headers) -> typing.Optional[float]:
"""
Parse the X-RateLimit-Reset header (Unix timestamp in seconds).
Returns seconds to wait, or None if header is missing/invalid.
"""
reset_time_str = response_headers.get("x-ratelimit-reset")
if reset_time_str is None:
return None
try:
reset_time = int(reset_time_str)
delay = reset_time - time.time()
if delay > 0:
return delay
except (ValueError, TypeError):
pass
return None
def _retry_timeout(response: httpx.Response, retries: int) -> float:
"""
Determine the amount of time to wait before retrying a request.
This function begins by trying to parse a retry-after header from the response, and then proceeds to use exponential backoff
with a jitter to determine the number of seconds to wait.
"""
# 1. Check Retry-After header first
retry_after = _parse_retry_after(response.headers)
if retry_after is not None and retry_after > 0:
return min(retry_after, MAX_RETRY_DELAY_SECONDS)
# 2. Check X-RateLimit-Reset header (with positive jitter)
ratelimit_reset = _parse_x_ratelimit_reset(response.headers)
if ratelimit_reset is not None:
return _add_positive_jitter(min(ratelimit_reset, MAX_RETRY_DELAY_SECONDS))
# 3. Fall back to exponential backoff (with symmetric jitter)
backoff = min(INITIAL_RETRY_DELAY_SECONDS * pow(2.0, retries), MAX_RETRY_DELAY_SECONDS)
return _add_symmetric_jitter(backoff)
def _should_retry(response: httpx.Response) -> bool:
retryable_400s = [429, 408, 409]
return response.status_code >= 500 or response.status_code in retryable_400s
def _maybe_filter_none_from_multipart_data(
data: typing.Optional[typing.Any],
request_files: typing.Optional[RequestFiles],
force_multipart: typing.Optional[bool],
) -> typing.Optional[typing.Any]:
"""
Filter None values from data body for multipart/form requests.
This prevents httpx from converting None to empty strings in multipart encoding.
Only applies when files are present or force_multipart is True.
"""
if data is not None and isinstance(data, typing.Mapping) and (request_files or force_multipart):
return remove_none_from_dict(data)
return data
def remove_omit_from_dict(
original: typing.Dict[str, typing.Optional[typing.Any]],
omit: typing.Optional[typing.Any],
) -> typing.Dict[str, typing.Any]:
if omit is None:
return original
new: typing.Dict[str, typing.Any] = {}
for key, value in original.items():
if value is not omit:
new[key] = value
return new
def maybe_filter_request_body(
data: typing.Optional[typing.Any],
request_options: typing.Optional[RequestOptions],
omit: typing.Optional[typing.Any],
) -> typing.Optional[typing.Any]:
if data is None:
return (
jsonable_encoder(request_options.get("additional_body_parameters", {})) or {}
if request_options is not None
else None
)
elif not isinstance(data, typing.Mapping):
data_content = jsonable_encoder(data)
else:
data_content = {
**(jsonable_encoder(remove_omit_from_dict(data, omit))), # type: ignore
**(
jsonable_encoder(request_options.get("additional_body_parameters", {})) or {}
if request_options is not None
else {}
),
}
return data_content
# Abstracted out for testing purposes
def get_request_body(
*,
json: typing.Optional[typing.Any],
data: typing.Optional[typing.Any],
request_options: typing.Optional[RequestOptions],
omit: typing.Optional[typing.Any],
) -> typing.Tuple[typing.Optional[typing.Any], typing.Optional[typing.Any]]:
json_body = None
data_body = None
if data is not None:
data_body = maybe_filter_request_body(data, request_options, omit)
else:
# If both data and json are None, we send json data in the event extra properties are specified
json_body = maybe_filter_request_body(json, request_options, omit)
# If you have an empty JSON body, you should just send None
return (json_body if json_body != {} else None), data_body if data_body != {} else None
class HttpClient:
def __init__(
self,
*,
httpx_client: httpx.Client,
base_timeout: typing.Callable[[], typing.Optional[float]],
base_headers: typing.Callable[[], typing.Dict[str, str]],
base_url: typing.Optional[typing.Callable[[], str]] = None,
):
self.base_url = base_url
self.base_timeout = base_timeout
self.base_headers = base_headers
self.httpx_client = httpx_client
def get_base_url(self, maybe_base_url: typing.Optional[str]) -> str:
base_url = maybe_base_url
if self.base_url is not None and base_url is None:
base_url = self.base_url()
if base_url is None:
raise ValueError("A base_url is required to make this request, please provide one and try again.")
return base_url
def request(
self,
path: typing.Optional[str] = None,
*,
method: str,
base_url: typing.Optional[str] = None,
params: typing.Optional[typing.Dict[str, typing.Any]] = None,
json: typing.Optional[typing.Any] = None,
data: typing.Optional[typing.Any] = None,
content: typing.Optional[typing.Union[bytes, typing.Iterator[bytes], typing.AsyncIterator[bytes]]] = None,
files: typing.Optional[
typing.Union[
typing.Dict[str, typing.Optional[typing.Union[File, typing.List[File]]]],
typing.List[typing.Tuple[str, File]],
]
] = None,
headers: typing.Optional[typing.Dict[str, typing.Any]] = None,
request_options: typing.Optional[RequestOptions] = None,
retries: int = 2,
omit: typing.Optional[typing.Any] = None,
force_multipart: typing.Optional[bool] = None,
) -> httpx.Response:
base_url = self.get_base_url(base_url)
timeout = (
request_options.get("timeout_in_seconds")
if request_options is not None and request_options.get("timeout_in_seconds") is not None
else self.base_timeout()
)
json_body, data_body = get_request_body(json=json, data=data, request_options=request_options, omit=omit)
request_files: typing.Optional[RequestFiles] = (
convert_file_dict_to_httpx_tuples(remove_omit_from_dict(remove_none_from_dict(files), omit))
if (files is not None and files is not omit and isinstance(files, dict))
else None
)
if (request_files is None or len(request_files) == 0) and force_multipart:
request_files = FORCE_MULTIPART
data_body = _maybe_filter_none_from_multipart_data(data_body, request_files, force_multipart)
response = self.httpx_client.request(
method=method,
url=urllib.parse.urljoin(f"{base_url}/", path),
headers=jsonable_encoder(
remove_none_from_dict(
{
**self.base_headers(),
**(headers if headers is not None else {}),
**(request_options.get("additional_headers", {}) or {} if request_options is not None else {}),
}
)
),
params=encode_query(
jsonable_encoder(
remove_none_from_dict(
remove_omit_from_dict(
{
**(params if params is not None else {}),
**(
request_options.get("additional_query_parameters", {}) or {}
if request_options is not None
else {}
),
},
omit,
)
)
)
),
json=json_body,
data=data_body,
content=content,
files=request_files,
timeout=timeout,
)
max_retries: int = request_options.get("max_retries", 0) if request_options is not None else 0
if _should_retry(response=response):
if max_retries > retries:
time.sleep(_retry_timeout(response=response, retries=retries))
return self.request(
path=path,
method=method,
base_url=base_url,
params=params,
json=json,
content=content,
files=files,
headers=headers,
request_options=request_options,
retries=retries + 1,
omit=omit,
)
return response
@contextmanager
def stream(
self,
path: typing.Optional[str] = None,
*,
method: str,
base_url: typing.Optional[str] = None,
params: typing.Optional[typing.Dict[str, typing.Any]] = None,
json: typing.Optional[typing.Any] = None,
data: typing.Optional[typing.Any] = None,
content: typing.Optional[typing.Union[bytes, typing.Iterator[bytes], typing.AsyncIterator[bytes]]] = None,
files: typing.Optional[
typing.Union[
typing.Dict[str, typing.Optional[typing.Union[File, typing.List[File]]]],
typing.List[typing.Tuple[str, File]],
]
] = None,
headers: typing.Optional[typing.Dict[str, typing.Any]] = None,
request_options: typing.Optional[RequestOptions] = None,
retries: int = 2,
omit: typing.Optional[typing.Any] = None,
force_multipart: typing.Optional[bool] = None,
) -> typing.Iterator[httpx.Response]:
base_url = self.get_base_url(base_url)
timeout = (
request_options.get("timeout_in_seconds")
if request_options is not None and request_options.get("timeout_in_seconds") is not None
else self.base_timeout()
)
request_files: typing.Optional[RequestFiles] = (
convert_file_dict_to_httpx_tuples(remove_omit_from_dict(remove_none_from_dict(files), omit))
if (files is not None and files is not omit and isinstance(files, dict))
else None
)
if (request_files is None or len(request_files) == 0) and force_multipart:
request_files = FORCE_MULTIPART
json_body, data_body = get_request_body(json=json, data=data, request_options=request_options, omit=omit)
data_body = _maybe_filter_none_from_multipart_data(data_body, request_files, force_multipart)
with self.httpx_client.stream(
method=method,
url=urllib.parse.urljoin(f"{base_url}/", path),
headers=jsonable_encoder(
remove_none_from_dict(
{
**self.base_headers(),
**(headers if headers is not None else {}),
**(request_options.get("additional_headers", {}) if request_options is not None else {}),
}
)
),
params=encode_query(
jsonable_encoder(
remove_none_from_dict(
remove_omit_from_dict(
{
**(params if params is not None else {}),
**(
request_options.get("additional_query_parameters", {})
if request_options is not None
else {}
),
},
omit,
)
)
)
),
json=json_body,
data=data_body,
content=content,
files=request_files,
timeout=timeout,
) as stream:
yield stream
class AsyncHttpClient:
def __init__(
self,
*,
httpx_client: httpx.AsyncClient,
base_timeout: typing.Callable[[], typing.Optional[float]],
base_headers: typing.Callable[[], typing.Dict[str, str]],
base_url: typing.Optional[typing.Callable[[], str]] = None,
):
self.base_url = base_url
self.base_timeout = base_timeout
self.base_headers = base_headers
self.httpx_client = httpx_client
def get_base_url(self, maybe_base_url: typing.Optional[str]) -> str:
base_url = maybe_base_url
if self.base_url is not None and base_url is None:
base_url = self.base_url()
if base_url is None:
raise ValueError("A base_url is required to make this request, please provide one and try again.")
return base_url
async def request(
self,
path: typing.Optional[str] = None,
*,
method: str,
base_url: typing.Optional[str] = None,
params: typing.Optional[typing.Dict[str, typing.Any]] = None,
json: typing.Optional[typing.Any] = None,
data: typing.Optional[typing.Any] = None,
content: typing.Optional[typing.Union[bytes, typing.Iterator[bytes], typing.AsyncIterator[bytes]]] = None,
files: typing.Optional[
typing.Union[
typing.Dict[str, typing.Optional[typing.Union[File, typing.List[File]]]],
typing.List[typing.Tuple[str, File]],
]
] = None,
headers: typing.Optional[typing.Dict[str, typing.Any]] = None,
request_options: typing.Optional[RequestOptions] = None,
retries: int = 2,
omit: typing.Optional[typing.Any] = None,
force_multipart: typing.Optional[bool] = None,
) -> httpx.Response:
base_url = self.get_base_url(base_url)
timeout = (
request_options.get("timeout_in_seconds")
if request_options is not None and request_options.get("timeout_in_seconds") is not None
else self.base_timeout()
)
request_files: typing.Optional[RequestFiles] = (
convert_file_dict_to_httpx_tuples(remove_omit_from_dict(remove_none_from_dict(files), omit))
if (files is not None and files is not omit and isinstance(files, dict))
else None
)
if (request_files is None or len(request_files) == 0) and force_multipart:
request_files = FORCE_MULTIPART
json_body, data_body = get_request_body(json=json, data=data, request_options=request_options, omit=omit)
data_body = _maybe_filter_none_from_multipart_data(data_body, request_files, force_multipart)
# Add the input to each of these and do None-safety checks
response = await self.httpx_client.request(
method=method,
url=urllib.parse.urljoin(f"{base_url}/", path),
headers=jsonable_encoder(
remove_none_from_dict(
{
**self.base_headers(),
**(headers if headers is not None else {}),
**(request_options.get("additional_headers", {}) or {} if request_options is not None else {}),
}
)
),
params=encode_query(
jsonable_encoder(
remove_none_from_dict(
remove_omit_from_dict(
{
**(params if params is not None else {}),
**(
request_options.get("additional_query_parameters", {}) or {}
if request_options is not None
else {}
),
},
omit,
)
)
)
),
json=json_body,
data=data_body,
content=content,
files=request_files,
timeout=timeout,
)
max_retries: int = request_options.get("max_retries", 0) if request_options is not None else 0
if _should_retry(response=response):
if max_retries > retries:
await asyncio.sleep(_retry_timeout(response=response, retries=retries))
return await self.request(
path=path,
method=method,
base_url=base_url,
params=params,
json=json,
content=content,
files=files,
headers=headers,
request_options=request_options,
retries=retries + 1,
omit=omit,
)
return response
@asynccontextmanager
async def stream(
self,
path: typing.Optional[str] = None,
*,
method: str,
base_url: typing.Optional[str] = None,
params: typing.Optional[typing.Dict[str, typing.Any]] = None,
json: typing.Optional[typing.Any] = None,
data: typing.Optional[typing.Any] = None,
content: typing.Optional[typing.Union[bytes, typing.Iterator[bytes], typing.AsyncIterator[bytes]]] = None,
files: typing.Optional[
typing.Union[
typing.Dict[str, typing.Optional[typing.Union[File, typing.List[File]]]],
typing.List[typing.Tuple[str, File]],
]
] = None,
headers: typing.Optional[typing.Dict[str, typing.Any]] = None,
request_options: typing.Optional[RequestOptions] = None,
retries: int = 2,
omit: typing.Optional[typing.Any] = None,
force_multipart: typing.Optional[bool] = None,
) -> typing.AsyncIterator[httpx.Response]:
base_url = self.get_base_url(base_url)
timeout = (
request_options.get("timeout_in_seconds")
if request_options is not None and request_options.get("timeout_in_seconds") is not None
else self.base_timeout()
)
request_files: typing.Optional[RequestFiles] = (
convert_file_dict_to_httpx_tuples(remove_omit_from_dict(remove_none_from_dict(files), omit))
if (files is not None and files is not omit and isinstance(files, dict))
else None
)
if (request_files is None or len(request_files) == 0) and force_multipart:
request_files = FORCE_MULTIPART
json_body, data_body = get_request_body(json=json, data=data, request_options=request_options, omit=omit)
data_body = _maybe_filter_none_from_multipart_data(data_body, request_files, force_multipart)
async with self.httpx_client.stream(
method=method,
url=urllib.parse.urljoin(f"{base_url}/", path),
headers=jsonable_encoder(
remove_none_from_dict(
{
**self.base_headers(),
**(headers if headers is not None else {}),
**(request_options.get("additional_headers", {}) if request_options is not None else {}),
}
)
),
params=encode_query(
jsonable_encoder(
remove_none_from_dict(
remove_omit_from_dict(
{
**(params if params is not None else {}),
**(
request_options.get("additional_query_parameters", {})
if request_options is not None
else {}
),
},
omit=omit,
)
)
)
),
json=json_body,
data=data_body,
content=content,
files=request_files,
timeout=timeout,
) as stream:
yield stream