forked from seatable/seatable-api-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmain.py
More file actions
1089 lines (978 loc) · 38.1 KB
/
main.py
File metadata and controls
1089 lines (978 loc) · 38.1 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
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import io
import json
import re
from datetime import datetime, timedelta
from urllib import parse
from uuid import UUID
# https://requests.readthedocs.io
import requests
from seatable_api.exception import AuthExpiredError
from seatable_api.message import get_sender_by_account
from .constants import ROW_FILTER_KEYS, ColumnTypes
from .constants import RENAME_COLUMN, RESIZE_COLUMN, FREEZE_COLUMN, MOVE_COLUMN, MODIFY_COLUMN_TYPE, DELETE_COLUMN
from .socket_io import SocketIO
from .query import QuerySet
from .utils import convert_db_rows
def parse_server_url(server_url):
return server_url.rstrip('/')
def parse_response(response):
if response.status_code >= 400:
try:
err_data = json.loads(response.text)
except:
err_data = {}
if err_data.get("error_msg") == "Token expired." and \
response.status_code == 403:
raise AuthExpiredError
raise ConnectionError(response.status_code, response.text)
else:
try:
data = json.loads(response.text)
return data
except:
pass
def like_table_id(value):
return re.match(r'^[-0-9a-zA-Z]{4}$', value)
class ApiBase(object):
def __init__(self, session, timeout, ssl_verify):
#: Create a session object for requests
self.session = session or requests.Session()
self.timeout = timeout
self.ssl_verify = ssl_verify
self.headers = {}
self.jwt_token = None
self.jwt_exp = None
def _get_session_opts(self):
return {
"headers": self.headers.copy(),
"timeout": self.timeout,
"verify": self.ssl_verify,
}
def token_headers(self, token=None):
if not token:
token = self.token
return {
'Authorization': 'Token %s' % (token,)
}
def json_headers(self, token=None):
return {
**self.token_headers(token), **{
'Content-Type': 'application/json',
}
}
def http_request(self, verb, url, headers={}, timeout=None, params={}, json={}, data={}):
"""Make an HTTP request to the Seatable server"""
opts = self._get_session_opts()
verify = opts.pop("verify")
if timeout is None:
timeout = opts.pop("timeout")
headers = {**opts.pop("headers"), **headers}
result = self.session.request(
method=verb,
url=url,
json=json,
params=params,
data=data,
timeout=timeout,
verify=verify,
headers=headers,
**opts,
)
return result
class SeaTableAPI(ApiBase):
"""SeaTable API
"""
def __init__(self, token, server_url, session=None, ssl_verify=True, timeout=30):
"""
:param token: str
:param server_url: str
:param session: requests.Session()
:param ssl_verify: bool
:param timeout: int
"""
self.token = token
self.server_url = parse_server_url(server_url)
self.dtable_server_url = None
self.dtable_db_url = None
self.workspace_id = None
self.dtable_uuid = None
self.dtable_name = None
self.socketIO = None
super().__init__(session, timeout, ssl_verify)
def __str__(self):
return '<SeaTable Base [ %s ]>' % self.dtable_name
def _clone(self):
clone = self.__class__(self.token, self.server_url)
clone.dtable_server_url = self.dtable_server_url
clone.dtable_db_url = self.dtable_db_url
clone.jwt_token = self.jwt_token
clone.jwt_exp = self.jwt_exp
clone.headers = self.headers
clone.ssl_verify = self.ssl_verify
clone.workspace_id = self.workspace_id
clone.dtable_uuid = self.dtable_uuid
clone.dtable_name = self.dtable_name
clone.timeout = self.timeout
return clone
def _get_msg_sender_by_account(self, account_name):
try:
account = self._get_account_detail(account_name)
msg_sender = get_sender_by_account(account)
except:
msg_sender = None
return msg_sender
def auth(self, with_socket_io=False):
"""Auth to SeaTable
"""
self.jwt_exp = datetime.now() + timedelta(days=3)
url = self.server_url + '/api/v2.1/dtable/app-access-token/'
response = self.http_request('get', url, headers=self.json_headers())
data = parse_response(response)
self.dtable_server_url = parse_server_url(data.get('dtable_server'))
self.dtable_db_url = parse_server_url(data.get('dtable_db', ''))
self.jwt_token = data.get('access_token')
self.headers = self.json_headers(self.jwt_token)
self.workspace_id = data.get('workspace_id')
self.dtable_uuid = data.get('dtable_uuid')
self.dtable_name = data.get('dtable_name')
if with_socket_io is True:
base = self._clone()
self.socketIO = SocketIO(base)
self.socketIO._connect()
def _metadata_server_url(self):
return self.dtable_server_url + '/api/v1/dtables/' + self.dtable_uuid + '/metadata/'
def _table_server_url(self):
return self.dtable_server_url + '/api/v1/dtables/' + self.dtable_uuid + '/tables/'
def _row_server_url(self):
return self.dtable_server_url + '/api/v1/dtables/' + self.dtable_uuid + '/rows/'
def _batch_row_server_url(self):
return self.dtable_server_url + '/api/v1/dtables/' + self.dtable_uuid + '/batch-append-rows/'
def _batch_update_row_server_url(self):
return self.dtable_server_url + '/api/v1/dtables/' + self.dtable_uuid + '/batch-update-rows/'
def _batch_delete_row_server_url(self):
return self.dtable_server_url + '/api/v1/dtables/' + self.dtable_uuid + '/batch-delete-rows/'
def _filtered_rows_server_url(self):
return self.dtable_server_url + '/api/v1/dtables/' + self.dtable_uuid + '/filtered-rows/'
def _row_link_server_url(self):
return self.dtable_server_url + '/api/v1/dtables/' + self.dtable_uuid + '/links/'
def _batch_update_row_link_server_url(self):
return self.dtable_server_url + '/api/v1/dtables/' + self.dtable_uuid + '/batch-update-links/'
def _app_download_link_url(self):
return self.server_url + '/api/v2.1/dtable/app-download-link/'
def _app_upload_link_url(self):
return self.server_url + '/api/v2.1/dtable/app-upload-link/'
def _column_server_url(self):
return self.dtable_server_url + '/api/v1/dtables/' + self.dtable_uuid + '/columns/'
def _column_options_server_url(self):
return self.dtable_server_url + '/api/v1/dtables/' + self.dtable_uuid + '/column-options/'
def _column_cascade_setting_server_url(self):
return self.dtable_server_url + '/api/v1/dtables/' + self.dtable_uuid + '/column-cascade-settings/'
def _third_party_accounts_url(self):
return self.server_url + '/api/v2.1/dtable/third-party-account/'
def _dtable_db_query_url(self):
return self.dtable_db_url + '/api/v1/query/' + self.dtable_uuid + '/'
def _dtable_db_linked_records_url(self):
return self.dtable_db_url + '/api/v1/linked-records/' + self.dtable_uuid + '/'
def _dtable_db_insert_rows_url(self):
return self.dtable_db_url + '/api/v1/insert-rows/' + self.dtable_uuid + '/'
def _get_related_users_url(self):
return '%(server_url)s/api/v2.1/dtables/%(dtable_uuid)s/related-users/' % {
'server_url': self.server_url,
'dtable_uuid': self.dtable_uuid
}
def _send_toast_notification_url(self):
return '%(dtable_server_url)s/api/v1/dtables/%(dtable_uuid)s/ui-toasts/' % {
'dtable_server_url': self.dtable_server_url,
'dtable_uuid': self.dtable_uuid
}
def _add_workflow_task_url(self, token):
return '%(server_url)s/api/v2.1/workflows/%(token)s/external-task-submit/' % {
'server_url': self.server_url,
'token': token
}
def _get_account_detail(self, account_name):
url = self._third_party_accounts_url()
params = {
'account_name': account_name
}
response = self.http_request('get', url, params=params, headers=self.json_headers())
data = parse_response(response)
return data.get('account')
def send_email(self, account_name, msg, **kwargs):
msg_sender = self._get_msg_sender_by_account(account_name)
if not msg_sender or msg_sender.msg_type != 'email':
raise ValueError('Email message sender does not configered.')
msg_sender.send_msg(msg, **kwargs)
def send_wechat_msg(self, account_name, msg):
msg_sender = self._get_msg_sender_by_account(account_name)
if not msg_sender or msg_sender.msg_type != 'wechat':
raise ValueError('Wechat message sender does not configered.')
msg_sender.send_msg(msg)
def get_metadata(self):
"""
:return: dict
"""
url = self._metadata_server_url()
response = self.http_request('get', url)
data = parse_response(response)
return data.get('metadata')
def add_table(self, table_name, lang='en', columns=[]):
"""
:param table_name: str
:param lang: str, currently 'en' for English, and 'zh-cn' for Chinese
:param columns: list
"""
url = self._table_server_url()
json_data = {
'table_name': table_name,
'lang': lang,
}
if columns:
json_data['columns'] = columns
response = self.http_request('post', url, json=json_data)
return parse_response(response)
def list_rows(self, table_name, view_name=None, order_by=None, desc=False, start=None, limit=None):
"""
:param table_name: str
:param view_name: str
:param order_by: str
:param desc: boolean
:param start: int
:param limit: int
:return: list
"""
url = self._row_server_url()
params = {
'table_name': table_name
}
if like_table_id(table_name):
params['table_id'] = table_name
if view_name:
params['view_name'] = view_name
if order_by:
params['order_by'] = order_by
params['direction'] = 'desc' if desc else 'asc'
if start:
params['start'] = start
if limit:
params['limit'] = limit
response = self.http_request('get', url, params=params)
data = parse_response(response)
return data.get('rows')
def get_row(self, table_name, row_id):
"""
:param table_name: str
:param row_id: str
:return: dict
"""
url = self._row_server_url() + row_id + '/'
params = {
'table_name': table_name
}
if like_table_id(table_name):
params['table_id'] = table_name
response = self.http_request('get', url, params=params)
data = parse_response(response)
return data
def append_row(self, table_name, row_data):
"""
:param table_name: str
:param row_data: dict
"""
url = self._row_server_url()
json_data = {
'table_name': table_name,
'row': row_data,
}
if like_table_id(table_name):
json_data['table_id'] = table_name
response = self.http_request('post', url, json=json_data)
return parse_response(response)
def batch_append_rows(self, table_name, rows_data):
"""
:param table_name: str
:param rows_data: dict
"""
url = self._batch_row_server_url()
json_data = {
'table_name': table_name,
'rows': rows_data,
}
if like_table_id(table_name):
json_data['table_id'] = table_name
response = self.http_request('post', url, json=json_data)
return parse_response(response)
def insert_row(self, table_name, row_data, anchor_row_id):
"""
:param table_name: str
:param row_data: dict
:param anchor_row_id: str
"""
url = self._row_server_url()
json_data = {
'table_name': table_name,
'row': row_data,
'anchor_row_id': anchor_row_id,
}
if like_table_id(table_name):
json_data['table_id'] = table_name
response = self.http_request('post', url, json=json_data)
return parse_response(response)
def update_row(self, table_name, row_id, row_data):
"""
:param table_name: str
:param row_id: str
:param row_data: dict
"""
url = self._row_server_url()
json_data = {
'table_name': table_name,
'row_id': row_id,
'row': row_data,
}
if like_table_id(table_name):
json_data['table_id'] = table_name
response = self.http_request('put', url, json=json_data )
return parse_response(response)
def batch_update_rows(self, table_name, rows_data):
"""
:param table_name: str
:param rows_data: list
:return:
"""
url = self._batch_update_row_server_url()
json_data = {
'table_name': table_name,
'updates': rows_data,
}
if like_table_id(table_name):
json_data['table_id'] = table_name
response = self.http_request('put', url, json=json_data)
return parse_response(response)
def delete_row(self, table_name, row_id):
"""
:param table_name: str
:param row_id: str
"""
url = self._row_server_url()
json_data = {
'table_name': table_name,
'row_id': row_id,
}
if like_table_id(table_name):
json_data['table_id'] = table_name
response = self.http_request('delete', url, json=json_data)
return parse_response(response)
def batch_delete_rows(self, table_name, row_ids):
"""
:param table_name: str
:param row_ids: list
"""
url = self._batch_delete_row_server_url()
json_data = {
'table_name': table_name,
'row_ids': row_ids,
}
if like_table_id(table_name):
json_data['table_id'] = table_name
response = self.http_request('delete', url, json=json_data)
return parse_response(response)
def filter_rows(self, table_name, filters, view_name=None, filter_conjunction='And'):
"""
:param table_name: str
:param view_name: str
:param filters: list
:param filter_conjunction: str, 'And' or 'Or'
:return: list
"""
# params check
if not filters:
raise ValueError('filters can not be empty.')
if not isinstance(filters, list):
raise ValueError('filters invalid.')
if len(filters) != len([f for f in filters if isinstance(f, dict)]):
raise ValueError('filters invalid.')
for f in filters:
for key in f.keys():
if key not in ROW_FILTER_KEYS:
raise ValueError('filters invalid.')
if filter_conjunction not in ['And', 'Or']:
raise ValueError('filter_conjunction invalid, filter_conjunction must be '
'"And" or "Or"')
params = {
'table_name': table_name,
}
if view_name:
params['view_name'] = view_name
json_data = {
'filters': filters,
'filter_conjunction': filter_conjunction,
}
url = self._filtered_rows_server_url()
response = self.http_request('get', url, json=json_data, params=params)
data = parse_response(response)
return data.get('rows')
def get_file_download_link(self, path):
"""
:param path: str
:return: str
"""
url = self._app_download_link_url()
params = {'path': path}
response = self.http_request('get', url, params=params, headers=self.json_headers())
data = parse_response(response)
return data.get('download_link')
def get_file_upload_link(self):
"""
:return: dict
"""
url = self._app_upload_link_url()
response = self.http_request('get', url, headers=self.json_headers())
data = parse_response(response)
return data
def add_link(self, link_id, table_name, other_table_name, row_id, other_row_id):
"""
:param link_id: str
:param table_name: str
:param other_table_name: str
:param row_id: str
:param other_row_id: str
"""
url = self._row_link_server_url()
json_data = {
'link_id': link_id,
'table_name': table_name,
'other_table_name': other_table_name,
'table_row_id': row_id,
'other_table_row_id': other_row_id,
}
if like_table_id(table_name):
json_data['table_id'] = table_name
if like_table_id(other_table_name):
json_data['other_table_id'] = other_table_name
response = self.http_request('post', url, json=json_data)
return parse_response(response)
def remove_link(self, link_id, table_name, other_table_name, row_id, other_row_id):
"""
:param link_id: str
:param table_name: str
:param other_table_name: str
:param row_id: str
:param other_row_id: str
"""
url = self._row_link_server_url()
json_data = {
'link_id': link_id,
'table_name': table_name,
'other_table_name': other_table_name,
'table_row_id': row_id,
'other_table_row_id': other_row_id,
}
if like_table_id(table_name):
json_data['table_id'] = table_name
if like_table_id(other_table_name):
json_data['other_table_id'] = other_table_name
response = self.http_request('delete', url, json=json_data )
return parse_response(response)
def update_link(self, link_id, table_name, other_table_name, row_id, other_rows_ids):
"""
:param link_id: str
:param table_id: str
:param other_table_id: str
:param row_id: str
:param other_rows_ids: list
"""
if not isinstance(other_rows_ids, list):
raise ValueError('params other_rows_ids requires type list')
url = self._row_link_server_url()
json_data = {
'link_id': link_id,
'table_name': table_name,
'other_table_name': other_table_name,
'row_id': row_id,
'other_rows_ids': other_rows_ids,
}
if like_table_id(table_name):
json_data['table_id'] = table_name
if like_table_id(other_table_name):
json_data['other_table_id'] = other_table_name
response = self.http_request('put', url, json=json_data)
return parse_response(response)
def batch_update_links(self, link_id, table_name, other_table_name, row_id_list, other_rows_ids_map):
"""
:param link_id: str
:param table_id: str
:param other_table_id: str
:param row_id_list: []
:param other_rows_ids_map: dict
"""
url = self._batch_update_row_link_server_url()
json_data = {
'link_id': link_id,
'table_name': table_name,
'other_table_name': other_table_name,
'row_id_list': row_id_list,
'other_rows_ids_map': other_rows_ids_map,
}
if like_table_id(table_name):
json_data['table_id'] = table_name
if like_table_id(other_table_name):
json_data['other_table_id'] = other_table_name
response = self.http_request('put', url, json=json_data)
return parse_response(response)
def get_linked_records(self, table_id, link_column_key, rows):
"""
:param table_id: str
:param link_column_key: str
:param rows: list
"""
url = self._dtable_db_linked_records_url()
json_data = {
'table_id': table_id,
'link_column': link_column_key,
'rows': rows,
}
response = self.http_request('post', url, json=json_data)
return parse_response(response)
def list_columns(self, table_name, view_name=None):
"""
:param table_name: str
:param view_name: str
:return: list
"""
url = self._column_server_url()
params = {
'table_name': table_name,
}
if like_table_id(table_name):
params['table_id'] = table_name
if view_name:
params['view_name'] = view_name
response = self.http_request('get', url, params=params)
data = parse_response(response)
return data.get('columns')
def get_column_link_id(self, table_name, column_name, view_name=None):
columns = self.list_columns(table_name, view_name)
for column in columns:
if column.get('name') == column_name and column.get('type') == 'link':
return column.get('data', {}).get('link_id')
raise ValueError('link type column "%s" does not exist in current view' % column_name)
def insert_column(self, table_name, column_name, column_type, column_key=None, column_data=None):
"""
:param table_name: str
:param column_name: str
:param column_type: ColumnType enum
:param column_key: str, which you want to insert after
:param column_data: dict, config information of column
:return: dict
"""
if column_type not in ColumnTypes:
raise ValueError("type %s invalid!" % (column_type,))
url = self._column_server_url()
json_data = {
'table_name': table_name,
'column_name': column_name,
'column_type': column_type.value
}
if like_table_id(table_name):
json_data['table_id'] = table_name
if column_key:
json_data['anchor_column'] = column_key
if column_data:
json_data['column_data'] = column_data
response = self.http_request('post', url, json=json_data)
data = parse_response(response)
return data
def rename_column(self, table_name, column_key, new_column_name):
"""
:param table_name: str
:param column_key: str
:param new_column_name: str
:return: dict
"""
url = self._column_server_url()
json_data = {
'op_type': RENAME_COLUMN,
'table_name': table_name,
'column': column_key,
'new_column_name': new_column_name
}
if like_table_id(table_name):
json_data['table_id'] = table_name
response = self.http_request('put', url, json=json_data)
data = parse_response(response)
return data
def resize_column(self, table_name, column_key, new_column_width):
"""
:param table_name: str
:param column_key: str
:param old_column_width: int
:param new_column_width: int
:return: dict
"""
url = self._column_server_url()
json_data = {
'op_type': RESIZE_COLUMN,
'table_name': table_name,
'column': column_key,
'new_column_width': new_column_width
}
if like_table_id(table_name):
json_data['table_id'] = table_name
response = self.http_request('put', url, json=json_data)
data = parse_response(response)
return data
def freeze_column(self, table_name, column_key, frozen):
"""
:param table_name: str
:param column_key: str
:param frozen: bool
:return: dict
"""
url = self._column_server_url()
json_data = {
'op_type': FREEZE_COLUMN,
'table_name': table_name,
'column': column_key,
'frozen': frozen
}
if like_table_id(table_name):
json_data['table_id'] = table_name
response = self.http_request('put', url, json=json_data)
data = parse_response(response)
return data
def move_column(self, table_name, column_key, target_column_key):
"""
:param table_name: str
:param column_key: str
:param target_column_key: bool
:return: dict
"""
url = self._column_server_url()
json_data = {
'op_type': MOVE_COLUMN,
'table_name': table_name,
'column': column_key,
'target_column': target_column_key
}
if like_table_id(table_name):
json_data['table_id'] = table_name
response = self.http_request('put', url, json=json_data)
data = parse_response(response)
return data
def modify_column_type(self, table_name, column_key, new_column_type):
"""
:param table_name: str
:param column_key: str
:param new_column_type: str
:return: dict
"""
if new_column_type not in ColumnTypes:
raise ValueError("type %s invalid!" % (new_column_type,))
url = self._column_server_url()
json_data = {
'op_type': MODIFY_COLUMN_TYPE,
'table_name': table_name,
'column': column_key,
'new_column_type': new_column_type.value
}
if like_table_id(table_name):
json_data['table_id'] = table_name
response = self.http_request('put', url, json=json_data)
data = parse_response(response)
return data
def add_column_options(self, table_name, column, options):
"""
:param table_name: str
:param column: str
:param options: list
"""
url = self._column_options_server_url()
json_data = {
"table_name": table_name,
"column": column,
"options": options
}
if like_table_id(table_name):
json_data['table_id'] = table_name
response = self.http_request('post', url, json=json_data)
data = parse_response(response)
return data
def add_column_cascade_settings(self, table_name, child_column, parent_column, cascade_settings):
"""
:param table_name: str
:param child_column: str
:param parent_column: str
:param cascade_settings: dict
:return:
"""
url = self._column_cascade_setting_server_url()
json_data = {
"table_name": table_name,
"child_column": child_column,
"parent_column": parent_column,
"cascade_settings": cascade_settings
}
if like_table_id(table_name):
json_data['table_id'] = table_name
response = self.http_request('post', url, json=json_data)
data = parse_response(response)
return data
def delete_column(self, table_name, column_key):
"""
:param table_name: str
:param column_key: str
:return: None
"""
url = self._column_server_url()
json_data = {
'table_name': table_name,
'column': column_key
}
if like_table_id(table_name):
json_data['table_id'] = table_name
response = self.http_request('delete', url, json=json_data)
data = parse_response(response)
return data
def download_file(self, url, save_path):
if not str(UUID(self.dtable_uuid)) in url:
raise Exception('url invalid.')
path = url.split(str(UUID(self.dtable_uuid)))[-1].strip('/')
download_link = self.get_file_download_link(parse.unquote(path))
response = self.http_request('get', download_link)
if response.status_code != 200:
raise Exception('download file error')
with open(save_path, 'wb') as f:
f.write(response.content)
def upload_bytes_file(self, name, content: bytes, relative_path=None, file_type=None, replace=False):
"""
relative_path: relative path for upload, if None, default {file_type}s/{date of this month} eg: files/2020-09
file_type: if relative is None, file type must in ['image', 'file'], default 'file'
return: info dict of uploaded file
"""
upload_link_dict = self.get_file_upload_link()
parent_dir = upload_link_dict['parent_path']
upload_link = upload_link_dict['upload_link'] + '?ret-json=1'
if not relative_path:
if file_type and file_type not in ['image', 'file']:
raise Exception('relative or file_type invalid.')
if not file_type:
file_type = 'file'
relative_path = '%ss/%s' % (file_type, str(datetime.today())[:7])
else:
relative_path = relative_path.strip('/')
response = self.http_request('post', upload_link, data={
'parent_dir': parent_dir,
'relative_path': relative_path,
'replace': 1 if replace else 0
}, files={
'file': (name, io.BytesIO(content))
})
d = response.json()[0]
url = '%(server)s/workspace/%(workspace_id)s/asset/%(dtable_uuid)s/%(relative_path)s/%(filename)s' % {
'server': self.server_url.strip('/'),
'workspace_id': self.workspace_id,
'dtable_uuid': str(UUID(self.dtable_uuid)),
'file_type': file_type,
'relative_path': parse.quote(relative_path.strip('/')),
'filename': parse.quote(d.get('name', name))
}
return {
'type': file_type,
'size': d.get('size'),
'name': d.get('name'),
'url': url
}
def upload_local_file(self, file_path, name=None, relative_path=None, file_type=None, replace=False):
"""
relative_path: relative path for upload, if None, default {file_type}s/{date of today}, eg: files/2020-09
file_type: if relative is None, file type must in ['image', 'file'], default 'file'
return: info dict of uploaded file
"""
if file_type not in ['image', 'file']:
raise Exception('file_type invalid.')
if not name:
name = file_path.strip('/').split('/')[-1]
if not relative_path:
if file_type and file_type not in ['image', 'file']:
raise Exception('relative or file_type invalid.')
if not file_type:
file_type = 'file'
relative_path = '%ss/%s' % (file_type, str(datetime.today())[:7])
else:
relative_path = relative_path.strip('/')
upload_link_dict = self.get_file_upload_link()
parent_dir = upload_link_dict['parent_path']
upload_link = upload_link_dict['upload_link'] + '?ret-json=1'
response = self.http_request('post', upload_link, data={
'parent_dir': parent_dir,
'relative_path': relative_path,
'replace': 1 if replace else 0
}, files={
'file': (name, open(file_path, 'rb'))
})
d = response.json()[0]
url = '%(server)s/workspace/%(workspace_id)s/asset/%(dtable_uuid)s/%(relative_path)s/%(filename)s' % {
'server': self.server_url.strip('/'),
'workspace_id': self.workspace_id,
'dtable_uuid': str(UUID(self.dtable_uuid)),
'file_type': file_type,
'relative_path': parse.quote(relative_path.strip('/')),
'filename': parse.quote(d.get('name', name))
}
return {
'type': file_type,
'size': d.get('size'),
'name': d.get('name'),
'url': url
}
def filter(self, table_name, conditions='', view_name=None):
"""
:param table_name: str
:param conditions: str
:return: queryset
"""
base = self._clone()
queryset = QuerySet(base, table_name)
queryset.raw_rows = self.list_rows(table_name, view_name)
queryset.raw_columns = self.list_columns(table_name, view_name)
queryset.conditions = conditions
queryset._execute_conditions()
return queryset
def query(self, sql, convert=True):
"""
:param sql: str
:param convert: bool
:return: list
"""
if not sql:
raise ValueError('sql can not be empty.')
url = self._dtable_db_query_url()
json_data = {'sql': sql}
response = self.http_request('post', url, json=json_data)
data = parse_response(response)
if not data.get('success'):
raise Exception(data.get('error_message'))
metadata = data.get('metadata')
results = data.get('results')
if convert:
converted_results = convert_db_rows(metadata, results)
return converted_results
else:
return results
def get_related_users(self):
response = self.http_request('get', self._get_related_users_url())
return parse_response(response)['user_list']
def send_toast_notification(self, user_id, msg, toast_type='success'):
url = self._send_toast_notification_url()
self.http_request('post', url, json={
'to_user': user_id,
'toast_type': toast_type,
'detail': {
'msg': str(msg)
}
})
def add_workflow_task(self, workflow_token, row_data, initiator=None, link_rows=None, new_linked_rows=None):
url = self._add_workflow_task_url(workflow_token)
response = self.http_request('post', url, data={
'row_data': json.dumps(row_data),
'initiator': initiator,
'link_rows': json.dumps(link_rows or []),
'new_linked_rows': json.dumps(new_linked_rows or [])
})
return parse_response(response)['task']
def add_workflow_task_with_existed_row(self, workflow_token, row_id, initiator=None):
url = self._add_workflow_task_url(workflow_token)
response = self.http_request('post', url, data={'row_id': row_id, 'initiator': initiator})
return parse_response(response)['task']
def big_data_insert_rows(self, table_name, rows_data):
url = self._dtable_db_insert_rows_url()
json_data = {
'table_name': table_name,
'rows': rows_data,
}
response = self.http_request('post', url, json=json_data)
return parse_response(response)
class Account(ApiBase):
def __init__(self, login_name, password, server_url, session=None, ssl_verify=True, timeout=30):
self.login_name = login_name
self.username = None
self.password = password
self.server_url = server_url.strip().strip('/')
self.token = None
super().__init__(session, timeout, ssl_verify)