/
api.py
607 lines (542 loc) · 21.5 KB
/
api.py
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
601
602
603
604
605
606
607
#!/usr/bin/env python
import contextlib
import csv
import email.utils
import gzip
import io
import json
import logging
import os
import socket
import ssl
import tempfile
import time
import urllib.parse as urlparse
import warnings
from array import array
import msgpack
import urllib3
import urllib3.util
from tdclient import errors, version
from tdclient.bulk_import_api import BulkImportAPI
from tdclient.connector_api import ConnectorAPI
from tdclient.database_api import DatabaseAPI
from tdclient.export_api import ExportAPI
from tdclient.import_api import ImportAPI
from tdclient.job_api import JobAPI
from tdclient.partial_delete_api import PartialDeleteAPI
from tdclient.result_api import ResultAPI
from tdclient.schedule_api import ScheduleAPI
from tdclient.server_status_api import ServerStatusAPI
from tdclient.table_api import TableAPI
from tdclient.user_api import UserAPI
from tdclient.util import normalized_msgpack
from tdclient.util import csv_dict_record_reader
from tdclient.util import csv_text_record_reader
from tdclient.util import read_csv_records
from tdclient.util import validate_record
try:
import certifi
except ImportError:
certifi = None
log = logging.getLogger(__name__)
APIError = errors.APIError
AuthError = errors.AuthError
ForbiddenError = errors.ForbiddenError
AlreadyExistsError = errors.AlreadyExistsError
NotFoundError = errors.NotFoundError
class API(
BulkImportAPI,
ConnectorAPI,
DatabaseAPI,
ExportAPI,
ImportAPI,
JobAPI,
PartialDeleteAPI,
ResultAPI,
ScheduleAPI,
ServerStatusAPI,
TableAPI,
UserAPI,
):
"""Internal API class
Args:
apikey (str): the API key of Treasure Data Service. If `None` is given, `TD_API_KEY` will be used if available.
user_agent (str): custom User-Agent.
endpoint (str): custom endpoint URL. If `None` is given, `TD_API_SERVER` will be used if available.
headers (dict): custom HTTP headers.
retry_post_requests (bool): Specify whether allowing API client to retry POST requests. `False` by default.
max_cumul_retry_delay (int): maximum retry limit in seconds. 600 seconds by default.
http_proxy (str): HTTP proxy setting. if `None` is given, `HTTP_PROXY` will be used if available.
"""
DEFAULT_ENDPOINT = "https://api.treasuredata.com/"
DEFAULT_IMPORT_ENDPOINT = "https://api-import.treasuredata.com/"
def __init__(
self,
apikey=None,
user_agent=None,
endpoint=None,
headers=None,
retry_post_requests=False,
max_cumul_retry_delay=600,
http_proxy=None,
**kwargs
):
headers = {} if headers is None else headers
if apikey is not None:
self._apikey = apikey
elif "TD_API_KEY" in os.environ:
self._apikey = os.getenv("TD_API_KEY")
else:
raise ValueError("no API key given")
if user_agent is not None:
self._user_agent = user_agent
else:
self._user_agent = "TD-Client-Python/%s" % (version.__version__)
if endpoint is not None:
self._endpoint = endpoint
elif os.getenv("TD_API_SERVER"):
self._endpoint = os.getenv("TD_API_SERVER")
else:
self._endpoint = self.DEFAULT_ENDPOINT
pool_options = dict(kwargs)
if "ca_certs" not in pool_options and certifi:
pool_options["ca_certs"] = certifi.where()
if pool_options.get("ca_certs") is not None:
pool_options["cert_reqs"] = ssl.CERT_REQUIRED
if "timeout" not in pool_options:
pool_options["timeout"] = 60
self.http = self._init_http(
http_proxy if http_proxy else os.getenv("HTTP_PROXY"), **pool_options
)
self._retry_post_requests = retry_post_requests
self._max_cumul_retry_delay = max_cumul_retry_delay
self._headers = {key.lower(): value for (key, value) in headers.items()}
@property
def apikey(self):
return self._apikey
@property
def endpoint(self):
return self._endpoint
def _init_http(self, http_proxy=None, **kwargs):
if http_proxy is None:
return urllib3.PoolManager(**kwargs)
else:
if http_proxy.startswith("http://"):
return self._init_http_proxy(http_proxy, **kwargs)
else:
return self._init_http_proxy("http://%s" % (http_proxy,), **kwargs)
def _init_http_proxy(self, http_proxy, **kwargs):
pool_options = dict(kwargs)
p = urlparse.urlparse(http_proxy)
scheme = p.scheme
netloc = p.netloc
if "@" in netloc:
auth, netloc = netloc.split("@", 2)
pool_options["proxy_headers"] = urllib3.make_headers(proxy_basic_auth=auth)
return urllib3.ProxyManager("%s://%s" % (scheme, netloc), **pool_options)
def get(self, path, params=None, headers=None, **kwargs):
headers = {} if headers is None else dict(headers)
headers["accept-encoding"] = "deflate, gzip"
url, headers = self.build_request(path=path, headers=headers, **kwargs)
log.debug(
"REST GET call:\n headers: %s\n path: %s\n params: %s",
repr(headers),
repr(path),
repr(params),
)
# up to 7 retries with exponential (base 2) back-off starting at 'retry_delay'
retry_delay = 5
cumul_retry_delay = 0
# for both exceptions and 500+ errors retrying is enabled by default.
# The total number of retries cumulatively should not exceed 10 minutes / 600 seconds
response = None
while True:
try:
response = self.send_request(
"GET",
url,
fields=params,
headers=headers,
decode_content=True,
preload_content=False,
)
# retry if the HTTP error code is 500 or higher and we did not run out of retrying attempts
if response.status < 500:
break
else:
log.warning(
"Error %d: %s. Retrying after %d seconds... (cumulative: %d/%d)",
response.status,
response.data,
retry_delay,
cumul_retry_delay,
self._max_cumul_retry_delay,
)
except (
urllib3.exceptions.TimeoutStateError,
urllib3.exceptions.TimeoutError,
urllib3.exceptions.PoolError,
socket.error,
):
pass
if cumul_retry_delay <= self._max_cumul_retry_delay:
log.warning(
"Retrying after %d seconds... (cumulative: %d/%d)",
retry_delay,
cumul_retry_delay,
self._max_cumul_retry_delay,
)
time.sleep(retry_delay)
cumul_retry_delay += retry_delay
retry_delay *= 2
else:
raise APIError(
"Retrying stopped after %d seconds. (cumulative: %d/%d)"
% (
self._max_cumul_retry_delay,
cumul_retry_delay,
self._max_cumul_retry_delay,
)
)
log.debug(
"REST GET response:\n headers: %s\n status: %d\n body: <omitted>",
repr(dict(response.getheaders())),
response.status,
)
return contextlib.closing(response)
def post(self, path, params=None, headers=None, **kwargs):
headers = {} if headers is None else dict(headers)
url, headers = self.build_request(path=path, headers=headers, **kwargs)
log.debug(
"REST POST call:\n headers: %s\n path: %s\n params: %s",
repr(headers),
repr(path),
repr(params),
)
# up to 7 retries with exponential (base 2) back-off starting at 'retry_delay'
retry_delay = 5
cumul_retry_delay = 0
# for both exceptions and 500+ errors retrying can be enabled by initialization
# parameter 'retry_post_requests'. The total number of retries cumulatively
# should not exceed 10 minutes / 600 seconds
# use `params` as request parameter if it is a `dict`.
# otherwise, use it as byte string of request body.
body = fields = None
if isinstance(params, dict):
fields = params
else:
body = params
response = None
while True:
try:
response = self.send_request(
"POST",
url,
fields=fields,
body=body,
headers=headers,
decode_content=True,
preload_content=False,
)
# if the HTTP error code is 500 or higher and the user requested retrying
# on post request, attempt a retry
if response.status < 500:
break
else:
if not self._retry_post_requests:
raise APIError(
"Retrying stopped by retry_post_requests == False"
)
log.warning(
"Error %d: %s. Retrying after %d seconds... (cumulative: %d/%d)",
response.status,
response.data,
retry_delay,
cumul_retry_delay,
self._max_cumul_retry_delay,
)
except (
urllib3.exceptions.TimeoutStateError,
urllib3.exceptions.TimeoutError,
urllib3.exceptions.PoolError,
socket.error,
):
if not self._retry_post_requests:
raise APIError("Retrying stopped by retry_post_requests == False")
if cumul_retry_delay <= self._max_cumul_retry_delay:
log.warning(
"Retrying after %d seconds... (cumulative: %d/%d)",
retry_delay,
cumul_retry_delay,
self._max_cumul_retry_delay,
)
time.sleep(retry_delay)
cumul_retry_delay += retry_delay
retry_delay *= 2
else:
raise APIError(
"Retrying stopped after %d seconds. (cumulative: %d/%d)"
% (
self._max_cumul_retry_delay,
cumul_retry_delay,
self._max_cumul_retry_delay,
)
)
log.debug(
"REST POST response:\n headers: %s\n status: %d\n body: <omitted>",
repr(dict(response.getheaders())),
response.status,
)
return contextlib.closing(response)
def put(self, path, bytes_or_stream, size, headers=None, **kwargs):
headers = {} if headers is None else dict(headers)
headers["content-length"] = str(size)
if "content-type" not in headers:
headers["content-type"] = "application/octet-stream"
url, headers = self.build_request(path=path, headers=headers, **kwargs)
log.debug(
"REST PUT call:\n headers: %s\n path: %s\n body: <omitted>",
repr(headers),
repr(path),
)
if hasattr(bytes_or_stream, "read"):
# file-like must support `read` and `fileno` to work with `httplib`
fileno_supported = hasattr(bytes_or_stream, "fileno")
if fileno_supported:
try:
bytes_or_stream.fileno()
except io.UnsupportedOperation:
# `io.BytesIO` doesn't support `fileno`
fileno_supported = False
if fileno_supported:
stream = bytes_or_stream
else:
stream = array("b", bytes_or_stream.read())
else:
# send request body as an `array.array` since `httplib` requires the request body to be a unicode string
stream = array("b", bytes_or_stream)
response = None
try:
response = self.send_request(
"PUT",
url,
body=stream,
headers=headers,
decode_content=True,
preload_content=False,
)
if response.status < 500:
pass
else:
raise APIError("Error %d: %s", response.status, response.data)
except (
urllib3.exceptions.TimeoutStateError,
urllib3.exceptions.TimeoutError,
urllib3.exceptions.PoolError,
socket.error,
):
raise APIError("Error: %s" % (repr(response)))
log.debug(
"REST PUT response:\n headers: %s\n status: %d\n body: <omitted>",
repr(dict(response.getheaders())),
response.status,
)
return contextlib.closing(response)
def delete(self, path, params=None, headers=None, **kwargs):
headers = {} if headers is None else dict(headers)
url, headers = self.build_request(path=path, headers=headers, **kwargs)
log.debug(
"REST DELETE call:\n headers: %s\n path: %s\n params: %s",
repr(headers),
repr(path),
repr(params),
)
# up to 7 retries with exponential (base 2) back-off starting at 'retry_delay'
retry_delay = 5
cumul_retry_delay = 0
# for both exceptions and 500+ errors retrying is enabled by default.
# The total number of retries cumulatively should not exceed 10 minutes / 600 seconds
response = None
while True:
try:
response = self.send_request(
"DELETE",
url,
fields=params,
headers=headers,
decode_content=True,
preload_content=False,
)
# retry if the HTTP error code is 500 or higher and we did not run out of retrying attempts
if response.status < 500:
break
else:
log.warning(
"Error %d: %s. Retrying after %d seconds... (cumulative: %d/%d)",
response.status,
response.data,
retry_delay,
cumul_retry_delay,
self._max_cumul_retry_delay,
)
except (
urllib3.exceptions.TimeoutStateError,
urllib3.exceptions.TimeoutError,
urllib3.exceptions.PoolError,
socket.error,
):
pass
if cumul_retry_delay <= self._max_cumul_retry_delay:
log.warning(
"Retrying after %d seconds... (cumulative: %d/%d)",
retry_delay,
cumul_retry_delay,
self._max_cumul_retry_delay,
)
time.sleep(retry_delay)
cumul_retry_delay += retry_delay
retry_delay *= 2
else:
raise APIError(
"Retrying stopped after %d seconds. (cumulative: %d/%d)"
% (
self._max_cumul_retry_delay,
cumul_retry_delay,
self._max_cumul_retry_delay,
)
)
log.debug(
"REST DELETE response:\n headers: %s\n status: %d\n body: <omitted>",
repr(dict(response.getheaders())),
response.status,
)
return contextlib.closing(response)
def build_request(self, path=None, headers=None, endpoint=None):
headers = {} if headers is None else headers
if endpoint is None:
endpoint = self._endpoint
if path is None:
url = endpoint
else:
p = urlparse.urlparse(endpoint)
# should not use `os.path.join` since it returns path string like "/foo\\bar"
request_path = path if p.path == "/" else "/".join([p.path, path])
url = urlparse.urlunparse(
urlparse.ParseResult(
p.scheme, p.netloc, request_path, p.params, p.query, p.fragment
)
)
# use default headers first
_headers = dict(self._headers)
# add default headers
_headers["authorization"] = "TD1 %s" % (self._apikey,)
_headers["date"] = email.utils.formatdate(time.time())
_headers["user-agent"] = self._user_agent
# override given headers
_headers.update({key.lower(): value for (key, value) in headers.items()})
return (url, _headers)
def send_request(self, method, url, fields=None, body=None, headers=None, **kwargs):
if body is None:
return self.http.request(
method, url, fields=fields, headers=headers, **kwargs
)
if urllib3.util.IS_PYOPENSSL and isinstance(body, bytearray):
# workaround for https://github.com/pyca/pyopenssl/issues/621
body = memoryview(body)
if urllib3.util.IS_PYOPENSSL and isinstance(body, array):
# workaround for https://github.com/pyca/pyopenssl/issues/621
body = body.tostring()
return self.http.urlopen(method, url, body=body, headers=headers, **kwargs)
def raise_error(self, msg, res, body):
status_code = res.status
s = body if isinstance(body, str) else body.decode("utf-8")
if status_code == 404:
raise errors.NotFoundError("%s: %s" % (msg, s))
elif status_code == 409:
raise errors.AlreadyExistsError("%s: %s" % (msg, s))
elif status_code == 401:
raise errors.AuthError("%s: %s" % (msg, s))
elif status_code == 403:
raise errors.ForbiddenError("%s: %s" % (msg, s))
else:
raise errors.APIError("%d: %s: %s" % (status_code, msg, s))
def checked_json(self, body, required):
js = None
try:
js = json.loads(body.decode("utf-8"))
except ValueError as error:
raise APIError("Unexpected API response: %s: %s" % (error, repr(body)))
js = dict(js)
if 0 < [k in js for k in required].count(False):
missing = [k for k in required if k not in js]
raise APIError(
"Unexpected API response: %s: %s" % (repr(missing), repr(body))
)
return js
def close(self):
# urllib3 doesn't allow to close all connections immediately.
# all connections in pool will be closed eventually during gc.
self.http.clear()
def _prepare_file(self, file_like, fmt, **kwargs):
fp = tempfile.TemporaryFile()
with contextlib.closing(gzip.GzipFile(mode="wb", fileobj=fp)) as gz:
packer = msgpack.Packer()
with contextlib.closing(self._read_file(file_like, fmt, **kwargs)) as items:
for item in items:
try:
mp = packer.pack(item)
except (OverflowError, ValueError):
packer.reset()
mp = packer.pack(normalized_msgpack(item))
gz.write(mp)
fp.seek(0)
return fp
def _read_file(self, file_like, fmt, **kwargs):
compressed = fmt.endswith(".gz")
if compressed:
fmt = fmt[0 : len(fmt) - len(".gz")]
reader_name = "_read_%s_file" % (fmt,)
if hasattr(self, reader_name):
reader = getattr(self, reader_name)
else:
raise TypeError("unknown format: %s" % (fmt,))
if hasattr(file_like, "read"):
if compressed:
file_like = gzip.GzipFile(fileobj=file_like)
return reader(file_like, **kwargs)
else:
if compressed:
file_like = gzip.GzipFile(fileobj=open(file_like, "rb"))
else:
file_like = open(file_like, "rb")
return reader(file_like, **kwargs)
def _read_msgpack_file(self, file_like, **kwargs):
# current impl doesn't tolerate any unpack error
unpacker = msgpack.Unpacker(file_like, raw=False)
for record in unpacker:
validate_record(record)
yield record
def _read_json_file(self, file_like, **kwargs):
# current impl doesn't tolerate any JSON parse error
for s in file_like:
record = json.loads(s.decode("utf-8"))
validate_record(record)
yield record
def _read_csv_file(
self,
file_like,
dialect=csv.excel,
columns=None,
encoding="utf-8",
dtypes=None,
converters=None,
**kwargs
):
if columns is None:
reader = csv_dict_record_reader(file_like, encoding, dialect)
else:
reader = csv_text_record_reader(file_like, encoding, dialect, columns)
return read_csv_records(reader, dtypes, converters, **kwargs)
def _read_tsv_file(self, file_like, **kwargs):
return self._read_csv_file(file_like, dialect=csv.excel_tab, **kwargs)