Repository navigation
Expand file tree
/
Copy pathbitable.py
More file actions
578 lines (505 loc) · 21.5 KB
/
Copy pathbitable.py
File metadata and controls
578 lines (505 loc) · 21.5 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
"""
Feishu Bitable (多维表格) API wrapper — tables, records, fields CRUD.
All operations require user_access_token (UAT).
Usage:
bt = FeishuBitable(app_id, app_secret, lark_client)
records = bt.list_records(chat_id, user_open_id, app_token="appXXX", table_id="tblXXX")
bt.create_records(chat_id, user_open_id, app_token, table_id, records=[{"fields": {...}}])
"""
import logging
from typing import Optional
from feishu_bridge.api.client import FeishuAPI
log = logging.getLogger("feishu-bitable")
DEFAULT_PAGE_SIZE = 100
class FeishuBitable(FeishuAPI):
"""Feishu Bitable (多维表格) CRUD via OAPI v1."""
SCOPES = [
"bitable:app:readonly",
"bitable:app",
"base:app:read",
"base:app:create",
"base:table:read",
"base:table:create",
"base:table:update",
"base:table:delete",
"base:record:retrieve",
"base:record:create",
"base:record:update",
"base:record:delete",
"base:field:read",
"base:field:create",
"base:field:update",
"base:field:delete",
"base:view:read",
# Note: base:view:create/update/delete don't exist as Feishu scopes;
# view CUD is covered by base:table:update.
]
BASE_PATH = "/open-apis/bitable/v1"
# -------------------------------------------------------------------
# Dispatch (full read+write)
# -------------------------------------------------------------------
_READ_ACTIONS = {"list_records", "get_record", "list_fields",
"list_views", "list_tables", "get_view"}
_WRITE_ACTIONS = {"create_records", "update_records", "delete_records",
"create_table", "patch_table", "delete_table",
"create_field", "update_field", "delete_field",
"create_view", "patch_view", "delete_view",
"create_app", "copy_app"}
_ALL_ACTIONS = _READ_ACTIONS | _WRITE_ACTIONS
def dispatch(self, action: str, chat_id: str, sender_id: str,
**kwargs) -> dict:
"""统一入口,归一化返回 {ok, data/error}."""
try:
if action not in self._ALL_ACTIONS:
return {"ok": False, "error": "unsupported_action",
"message": f"支持的操作: "
f"{', '.join(sorted(self._ALL_ACTIONS))}"}
app_token = kwargs.get("app_token", "")
table_id = kwargs.get("table_id", "")
# Read
if action == "list_tables":
result = self.list_tables(chat_id, sender_id, app_token)
elif action == "list_records":
result = self.list_records(
chat_id, sender_id, app_token, table_id,
filter_=kwargs.get("filter"),
sort=kwargs.get("sort"),
field_names=kwargs.get("field_names"),
page_size=kwargs.get("page_size", DEFAULT_PAGE_SIZE),
page_token=kwargs.get("page_token"))
elif action == "get_record":
result = self.get_record(
chat_id, sender_id, app_token, table_id,
kwargs.get("record_id", ""))
elif action == "list_fields":
result = self.list_fields(
chat_id, sender_id, app_token, table_id)
elif action == "list_views":
result = self.list_views(
chat_id, sender_id, app_token, table_id)
elif action == "get_view":
result = self.get_view(
chat_id, sender_id, app_token, table_id,
kwargs.get("view_id", ""))
# Write — Records
elif action == "create_records":
result = self.create_records(
chat_id, sender_id, app_token, table_id,
records=kwargs.get("records", []))
elif action == "update_records":
result = self.update_records(
chat_id, sender_id, app_token, table_id,
records=kwargs.get("records", []))
elif action == "delete_records":
result = self.delete_records(
chat_id, sender_id, app_token, table_id,
record_ids=kwargs.get("record_ids", []))
# Write — Table
elif action == "create_table":
result = self.create_table(
chat_id, sender_id, app_token,
name=kwargs.get("name", ""),
fields=kwargs.get("fields"))
elif action == "patch_table":
result = self.patch_table(
chat_id, sender_id, app_token, table_id,
name=kwargs.get("name", ""))
elif action == "delete_table":
result = self.delete_table(
chat_id, sender_id, app_token, table_id)
# Write — Field
elif action == "create_field":
result = self.create_field(
chat_id, sender_id, app_token, table_id,
field_name=kwargs.get("field_name", ""),
field_type=kwargs.get("field_type", 1),
property_=kwargs.get("property_"))
elif action == "update_field":
result = self.update_field(
chat_id, sender_id, app_token, table_id,
field_id=kwargs.get("field_id", ""),
field_name=kwargs.get("field_name"),
field_type=kwargs.get("field_type"),
property_=kwargs.get("property_"))
elif action == "delete_field":
result = self.delete_field(
chat_id, sender_id, app_token, table_id,
field_id=kwargs.get("field_id", ""))
# Write — View
elif action == "create_view":
result = self.create_view(
chat_id, sender_id, app_token, table_id,
view_name=kwargs.get("view_name", ""),
view_type=kwargs.get("view_type", "grid"))
elif action == "patch_view":
result = self.patch_view(
chat_id, sender_id, app_token, table_id,
view_id=kwargs.get("view_id", ""),
view_name=kwargs.get("view_name", ""))
elif action == "delete_view":
result = self.delete_view(
chat_id, sender_id, app_token, table_id,
view_id=kwargs.get("view_id", ""))
# Write — App
elif action == "create_app":
result = self.create_app(
chat_id, sender_id,
name=kwargs.get("name", ""),
folder_token=kwargs.get("folder_token"))
elif action == "copy_app":
result = self.copy_app(
chat_id, sender_id,
app_token=app_token,
name=kwargs.get("name"),
folder_token=kwargs.get("folder_token"))
else:
return {"ok": False, "error": "unsupported_action",
"message": f"未知 action: {action}"}
if result is None:
return {"ok": False, "error": "auth_failed"}
return {"ok": True, "data": result}
except Exception as e:
log.exception("Bitable dispatch error: action=%s", action)
return {"ok": False, "error": "internal_error",
"message": str(e)}
# -------------------------------------------------------------------
# App (Bitable) operations
# -------------------------------------------------------------------
def get_app(self, chat_id: str, user_open_id: str,
app_token: str) -> Optional[dict]:
"""Get bitable app metadata."""
token = self.get_token(chat_id, user_open_id)
if not token:
return None
return self.request("GET", f"/apps/{app_token}", token)
def list_tables(self, chat_id: str, user_open_id: str,
app_token: str,
page_size: int = 50,
page_token: str = None) -> Optional[dict]:
"""List tables in a bitable app."""
token = self.get_token(chat_id, user_open_id)
if not token:
return None
params = {"page_size": page_size}
if page_token:
params["page_token"] = page_token
return self.request("GET", f"/apps/{app_token}/tables", token,
params=params)
def copy_app(self, chat_id: str, user_open_id: str,
app_token: str, name: str = None,
folder_token: str = None) -> Optional[dict]:
"""Copy a bitable app.
Args:
app_token: source app to copy
name: name for the copy (default: original name + " copy")
folder_token: target folder
"""
token = self.get_token(chat_id, user_open_id)
if not token:
return None
body = {}
if name:
body["name"] = name
if folder_token:
body["folder_token"] = folder_token
return self.request("POST", f"/apps/{app_token}/copy", token,
json_body=body or None)
def patch_table(self, chat_id: str, user_open_id: str,
app_token: str, table_id: str,
name: str) -> Optional[dict]:
"""Rename a table in a bitable app."""
token = self.get_token(chat_id, user_open_id)
if not token:
return None
return self.request("PATCH",
f"/apps/{app_token}/tables/{table_id}", token,
json_body={"table": {"name": name}})
# -------------------------------------------------------------------
# Record operations
# -------------------------------------------------------------------
def list_records(self, chat_id: str, user_open_id: str,
app_token: str, table_id: str,
filter_: str = None,
sort: list[dict] = None,
field_names: list[str] = None,
page_size: int = DEFAULT_PAGE_SIZE,
page_token: str = None) -> Optional[dict]:
"""Search/list records in a table.
Uses the search endpoint (recommended over deprecated list).
Args:
filter_: filter expression (e.g., 'CurrentValue.[Status]="Done"')
sort: sort specs (e.g., [{"field_name": "Created", "desc": True}])
field_names: only return these fields
page_size: records per page (max 500)
page_token: pagination cursor
Returns:
{"items": [...], "has_more": bool, "page_token": str, "total": int}
"""
token = self.get_token(chat_id, user_open_id)
if not token:
return None
body = {"page_size": page_size}
if filter_:
body["filter"] = filter_
if sort:
body["sort"] = sort
if field_names:
body["field_names"] = field_names
if page_token:
body["page_token"] = page_token
return self.request(
"POST",
f"/apps/{app_token}/tables/{table_id}/records/search",
token,
json_body=body,
)
def get_record(self, chat_id: str, user_open_id: str,
app_token: str, table_id: str,
record_id: str) -> Optional[dict]:
"""Get a single record."""
token = self.get_token(chat_id, user_open_id)
if not token:
return None
return self.request(
"GET",
f"/apps/{app_token}/tables/{table_id}/records/{record_id}",
token,
)
def create_records(self, chat_id: str, user_open_id: str,
app_token: str, table_id: str,
records: list[dict]) -> Optional[dict]:
"""Batch create records.
Args:
records: list of {"fields": {"FieldName": value, ...}}
"""
token = self.get_token(chat_id, user_open_id)
if not token:
return None
return self.request(
"POST",
f"/apps/{app_token}/tables/{table_id}/records/batch_create",
token,
json_body={"records": records},
)
def update_records(self, chat_id: str, user_open_id: str,
app_token: str, table_id: str,
records: list[dict]) -> Optional[dict]:
"""Batch update records.
Args:
records: list of {"record_id": "...", "fields": {"FieldName": value}}
"""
token = self.get_token(chat_id, user_open_id)
if not token:
return None
return self.request(
"POST",
f"/apps/{app_token}/tables/{table_id}/records/batch_update",
token,
json_body={"records": records},
)
def delete_records(self, chat_id: str, user_open_id: str,
app_token: str, table_id: str,
record_ids: list[str]) -> Optional[dict]:
"""Batch delete records."""
token = self.get_token(chat_id, user_open_id)
if not token:
return None
return self.request(
"POST",
f"/apps/{app_token}/tables/{table_id}/records/batch_delete",
token,
json_body={"records": record_ids},
)
def create_app(self, chat_id: str, user_open_id: str,
name: str, folder_token: str = None) -> Optional[dict]:
"""Create a new bitable app.
Args:
name: bitable app name
folder_token: optional target folder
"""
token = self.get_token(chat_id, user_open_id)
if not token:
return None
body = {"name": name}
if folder_token:
body["folder_token"] = folder_token
return self.request("POST", "/apps", token, json_body=body)
def create_table(self, chat_id: str, user_open_id: str,
app_token: str, name: str,
fields: list[dict] = None) -> Optional[dict]:
"""Create a new table in a bitable app.
Args:
name: table name
fields: optional initial field definitions
"""
token = self.get_token(chat_id, user_open_id)
if not token:
return None
table = {"name": name}
if fields:
table["fields"] = fields
return self.request("POST", f"/apps/{app_token}/tables", token,
json_body={"table": table})
def delete_table(self, chat_id: str, user_open_id: str,
app_token: str, table_id: str) -> Optional[dict]:
"""Delete a table from a bitable app."""
token = self.get_token(chat_id, user_open_id)
if not token:
return None
return self.request("DELETE", f"/apps/{app_token}/tables/{table_id}",
token)
# -------------------------------------------------------------------
# Field operations
# -------------------------------------------------------------------
def list_fields(self, chat_id: str, user_open_id: str,
app_token: str, table_id: str,
page_size: int = 100,
page_token: str = None) -> Optional[dict]:
"""List all fields (columns) in a table."""
token = self.get_token(chat_id, user_open_id)
if not token:
return None
params = {"page_size": page_size}
if page_token:
params["page_token"] = page_token
return self.request(
"GET",
f"/apps/{app_token}/tables/{table_id}/fields",
token,
params=params,
)
def create_field(self, chat_id: str, user_open_id: str,
app_token: str, table_id: str,
field_name: str, field_type: int,
property_: dict = None) -> Optional[dict]:
"""Create a field (column) in a table.
Args:
field_name: display name
field_type: type code (1=Text, 2=Number, 3=SingleSelect,
4=MultiSelect, 5=DateTime, 7=Checkbox, 11=User, 13=Phone,
15=URL, 17=Attachment, 18=Link, 20=Formula, 21=DuplexLink,
22=Location, 23=GroupChat, 1001=CreatedTime,
1002=LastModifiedTime, 1003=CreatedBy, 1004=LastModifiedBy,
1005=AutoNumber)
property_: type-specific config (e.g. options for select fields)
"""
token = self.get_token(chat_id, user_open_id)
if not token:
return None
body = {"field_name": field_name, "type": field_type}
if property_:
body["property"] = property_
return self.request(
"POST",
f"/apps/{app_token}/tables/{table_id}/fields",
token, json_body=body)
def update_field(self, chat_id: str, user_open_id: str,
app_token: str, table_id: str,
field_id: str,
field_name: str = None,
field_type: int = None,
property_: dict = None) -> Optional[dict]:
"""Update a field (rename, change type, or modify property).
Args:
field_id: field ID to update
field_name: new display name
field_type: new type code (see create_field for codes)
property_: new type-specific config
"""
token = self.get_token(chat_id, user_open_id)
if not token:
return None
body = {}
if field_name is not None:
body["field_name"] = field_name
if field_type is not None:
body["type"] = field_type
if property_ is not None:
body["property"] = property_
if not body:
raise ValueError("update_field requires at least one of: "
"field_name, field_type, property_")
return self.request(
"PUT",
f"/apps/{app_token}/tables/{table_id}/fields/{field_id}",
token, json_body=body)
def delete_field(self, chat_id: str, user_open_id: str,
app_token: str, table_id: str,
field_id: str) -> Optional[dict]:
"""Delete a field (column) from a table."""
token = self.get_token(chat_id, user_open_id)
if not token:
return None
return self.request(
"DELETE",
f"/apps/{app_token}/tables/{table_id}/fields/{field_id}",
token)
# -------------------------------------------------------------------
# View operations
# -------------------------------------------------------------------
def list_views(self, chat_id: str, user_open_id: str,
app_token: str, table_id: str,
page_size: int = 50,
page_token: str = None) -> Optional[dict]:
"""List views in a table."""
token = self.get_token(chat_id, user_open_id)
if not token:
return None
params = {"page_size": page_size}
if page_token:
params["page_token"] = page_token
return self.request(
"GET",
f"/apps/{app_token}/tables/{table_id}/views",
token, params=params)
def get_view(self, chat_id: str, user_open_id: str,
app_token: str, table_id: str,
view_id: str) -> Optional[dict]:
"""Get a view's details."""
token = self.get_token(chat_id, user_open_id)
if not token:
return None
return self.request(
"GET",
f"/apps/{app_token}/tables/{table_id}/views/{view_id}",
token)
def create_view(self, chat_id: str, user_open_id: str,
app_token: str, table_id: str,
view_name: str,
view_type: str = "grid") -> Optional[dict]:
"""Create a view in a table.
Args:
view_name: display name
view_type: "grid", "kanban", "gallery", "gantt", or "form"
"""
token = self.get_token(chat_id, user_open_id)
if not token:
return None
return self.request(
"POST",
f"/apps/{app_token}/tables/{table_id}/views",
token,
json_body={"view_name": view_name, "view_type": view_type})
def patch_view(self, chat_id: str, user_open_id: str,
app_token: str, table_id: str,
view_id: str, view_name: str) -> Optional[dict]:
"""Rename a view."""
token = self.get_token(chat_id, user_open_id)
if not token:
return None
return self.request(
"PATCH",
f"/apps/{app_token}/tables/{table_id}/views/{view_id}",
token,
json_body={"view_name": view_name})
def delete_view(self, chat_id: str, user_open_id: str,
app_token: str, table_id: str,
view_id: str) -> Optional[dict]:
"""Delete a view from a table."""
token = self.get_token(chat_id, user_open_id)
if not token:
return None
return self.request(
"DELETE",
f"/apps/{app_token}/tables/{table_id}/views/{view_id}",
token)