forked from leancloud/python-sdk
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathobject_.py
More file actions
519 lines (406 loc) · 14.8 KB
/
Copy pathobject_.py
File metadata and controls
519 lines (406 loc) · 14.8 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
# coding: utf-8
import copy
from datetime import datetime
import iso8601
from werkzeug import LocalProxy
import leancloud
from leancloud import utils
from leancloud import client
from leancloud import operation
__author__ = 'asaka <lan@leancloud.rocks>'
object_class_map = {}
class ObjectMeta(type):
def __new__(cls, name, bases, attrs):
cached_class = object_class_map.get(name)
if cached_class:
return cached_class
super_new = super(ObjectMeta, cls).__new__
if name == 'User':
attrs['_class_name'] = '_User'
elif name == 'Installation':
attrs['_class_name'] = '_Installation'
elif name == 'Notification':
attrs['_class_name'] = '_Notification'
elif name == 'Role':
attrs['_class_name'] = '_Role'
else:
attrs['_class_name'] = name
object_class = super_new(cls, name, bases, attrs)
object_class_map[name] = object_class
return object_class
class Object(object):
__metaclass__ = ObjectMeta
def __init__(self, **attrs):
"""
创建一个新的 leancloud.Object
:param attrs: 对象属性
:return:
"""
self.id = None
self._class_name = self._class_name # for IDE
self._server_data = {}
self._op_set_queue = [{}]
self.attributes = {}
self._existed = False
self.created_at = None
self.updated_at = None
for k, v in attrs.iteritems():
self.set(k, v)
@classmethod
def extend(cls, name):
"""
派生一个新的 leancloud.Object 子类
:param name: 子类名称
:type name: basestring
:return: 派生的子类
:rtype: ObjectMeta
"""
if isinstance(name, unicode):
name = name.encode('utf-8')
return type(name, (cls,), {})
@classmethod
def create(cls, class_name, **attributes):
"""
根据参数创建一个 leancloud.Object 的子类的实例化对象
:param class_name: 子类名称
:type class_name: basestring
:param attributes: 对象属性
:return: 派生子类的实例
:rtype: Object
"""
object_class = cls.extend(class_name)
return object_class(**attributes)
@classmethod
def create_without_data(cls, id_):
"""
根据 objectId 创建一个 leancloud.Object，代表一个服务器上已经存在的对象。可以调用 fetch 方法来获取服务器上的数据
:param id_: 对象的 objectId
:type id_: basestring
:return: 没有数据的对象
:rtype: Object
"""
if cls is Object:
raise RuntimeError('can not call create_without_data on leancloud.Object')
obj = cls()
obj.id = id_
return obj
def dump(self):
obj = self._dump()
obj.pop('__type')
obj.pop('className')
return obj
def _dump(self, seen_objects=None):
seen_objects = seen_objects or []
obj = copy.deepcopy(self.attributes)
for k, v in obj.iteritems():
obj[k] = utils.encode(v, seen_objects)
if self.id is not None:
obj['objectId'] = self.id
obj['__type'] = 'Object'
obj['className'] = self._class_name
return obj
def destroy(self):
"""
从服务器上删除这个对象
:rtype: None
"""
if not self.id:
return False
client.delete('/classes/{0}/{1}'.format(self._class_name, self.id))
def save(self):
"""
将对象数据保存至服务器
:return: None
:rtype: None
"""
unsaved_children = []
unsaved_files = []
self._find_unsaved_children(self.attributes, unsaved_children, unsaved_files)
if len(unsaved_children) + len(unsaved_files) > 0:
self._deep_save(unsaved_children, unsaved_files, exclude=self.attributes)
self._start_save()
data = self._dump_save()
method = 'PUT' if self.id is not None else 'POST'
if method == 'PUT':
response = client.put('/classes/{0}/{1}'.format(self._class_name, self.id), data)
else:
response = client.post('/classes/{0}'.format(self._class_name), data)
self._finish_save(self.parse(utils.response_to_json(response), response.status_code))
def _deep_save(self, unsaved_children, unsaved_files, exclude=None):
if exclude:
unsaved_children = [x for x in unsaved_children if x != exclude]
for f in unsaved_files:
f.save()
dumped_objs = []
for obj in unsaved_children:
obj._start_save()
method = 'POST' if obj.id is None else 'PUT'
path = '/{0}/classes/{1}'.format(client.SERVER_VERSION, obj._class_name)
body = obj._dump_save()
dumped_obj = {
'method': method,
'path': path,
'body': body,
}
dumped_objs.append(dumped_obj)
response = utils.response_to_json(client.post('/batch', params={'requests': dumped_objs}))
errors = []
for idx, obj in enumerate(unsaved_children):
content = response[idx]
if not content.get('success'):
errors.append(leancloud.LeanCloudError(content.get('code'), content.get('error')))
obj._cancel_save()
else:
result = obj.parse(content['success'])
obj._finish_save(result)
if errors:
# TODO: how to raise list of errors?
# http://stackoverflow.com/questions/9875660/idiomatic-way-to-collect-report-multiple-exceptions-in-python
raise errors[0]
@classmethod
def _find_unsaved_children(cls, obj, children, files):
def callback(o):
if isinstance(o, Object):
if o.is_dirty():
children.append(o)
return
if isinstance(o, leancloud.File):
if o.url is None and o.id is None:
files.append(o)
return
utils.traverse_object(obj, callback)
def is_dirty(self, attr=None):
current_changes = self._op_set_queue[-1]
if attr is not None:
return True if attr in current_changes else False
if self.id is None:
return True
if current_changes:
return True
return False
def _to_pointer(self):
return {
'__type': 'Pointer',
'className': self._class_name,
'objectId': self.id,
}
def _merge_magic_field(self, attrs):
for key in ['id', 'objectId', 'createdAt', 'updatedAt']:
if attrs.get(key) is None:
continue
if key == 'objectId':
self.id = attrs[key]
elif key == 'createdAt' or key == 'updatedAt':
if isinstance(attrs[key], dict) and attrs[key].get('__type') == 'Date':
dt = iso8601.parse_date(attrs[key]['iso'])
elif not isinstance(attrs[key], datetime):
dt = iso8601.parse_date(attrs[key])
else:
dt = attrs[key]
if key == 'createdAt':
setattr(self, 'created_at', dt)
elif key == 'updatedAt':
setattr(self, 'updated_at', dt)
del attrs[key]
def _start_save(self):
self._op_set_queue.append({})
def _cancel_save(self):
failed_changes = self._op_set_queue.pop(0)
next_changes = self._op_set_queue[0]
for key, op in failed_changes.iteritems():
op1 = failed_changes[key]
op2 = next_changes[key]
if op1 and op2:
next_changes[key] = op2._merge(op1)
elif op1:
next_changes[key] = op1
def validate(self, attrs):
if 'ACL' in attrs and not isinstance(attrs['ACL'], leancloud.ACL):
raise TypeError('acl must be a ACL')
return True
def get(self, attr):
"""
获取对象字段的值
:param attr: 字段名
:type attr: basestring
:return: 字段值
"""
return self.attributes.get(attr)
def relation(self, attr):
"""
返回对象上相应字段的 Relation
:param attr: 字段名
:type attr: basestring
:return: Relation
:rtype: leancloud.Relation
"""
value = self.get(attr)
if value is not None:
if not isinstance(value, leancloud.Relation):
raise TypeError('field %s is not Relation'.format(attr))
value._ensure_parent_and_key(self, attr)
return value
return leancloud.Relation(self, attr)
def has(self, attr):
"""
判断此字段是否有值
:param attr: 字段名
:return: 当有值时返回 True， 否则返回 False
:rtype: bool
"""
return attr in self.attributes
def set(self, key_or_attrs, value=None, unset=False):
"""
在当前对象此字段上赋值
:param key_or_attrs: 字段名，或者一个包含 字段名 / 值的 dict
:type key_or_attrs: basestring or dict
:param value: 字段值
:param unset:
:return: 当前对象，供链式调用
"""
if isinstance(key_or_attrs, dict) and value is None:
attrs = key_or_attrs
keys = attrs.keys()
for k in keys:
if isinstance(attrs[k], LocalProxy):
attrs[k] = attrs[k]._get_current_object()
else:
key = key_or_attrs
if isinstance(value, LocalProxy):
value = value._get_current_object()
attrs = {key: utils.decode(key, value)}
if unset:
for k in attrs.keys():
attrs[k] = operation.Unset()
self.validate(attrs)
self._merge_magic_field(attrs)
keys = attrs.keys()
for k in keys:
v = attrs[k]
# TODO: Relation
if not isinstance(v, operation.BaseOp):
v = operation.Set(v)
current_changes = self._op_set_queue[-1]
current_changes[k] = v._merge(current_changes.get(k))
self._rebuild_estimated_data_for_key(k)
return self
def unset(self, attr):
"""
在对象上移除此字段。
:param attr: 字段名
:return: 当前对象
"""
return self.set(attr, None, unset=True)
def increment(self, attr, amount=1):
"""
在对象此字段上自增对应的数值，如果数值没有指定，默认为一。
:param attr: 字段名
:param amount: 自增量
:return: 当前对象
"""
return self.set(attr, operation.Increment(amount))
def add(self, attr, item):
"""
在对象此字段对应的数组末尾添加指定对象。
:param attr: 字段名
:param item: 要添加的对象
:return: 当前对象
"""
return self.set(attr, operation.Add([item]))
def add_unique(self, attr, item):
"""
在对象此字段对应的数组末尾添加指定对象，如果此对象并没有包含在字段中。
:param attr: 字段名
:param item: 要添加的对象
:return: 当前对象
"""
return self.set(attr, operation.AddUnique([item]))
def remove(self, attr, item):
"""
在对象此字段对应的数组中，将指定对象全部移除。
:param attr: 字段名
:param item: 要移除的对象
:return: 当前对象
"""
return self.set(attr, operation.Remove([item]))
def op(self, attr):
return self._op_set_queue[-1][attr]
def clear(self):
"""
将当前对象所有字段全部移除。
:return: 当前对象
"""
self.set(self.attributes, unset=True)
def _dump_save(self):
result = copy.deepcopy(self._op_set_queue[0])
for k, v in result.iteritems():
result[k] = v.dump()
return result
def fetch(self):
"""
从服务器获取当前对象所有的值，如果与本地值不同，将会覆盖本地的值。
:return: 当前对象
"""
response = client.get('/classes/{0}/{1}'.format(self._class_name, self.id), {})
result = self.parse(utils.response_to_json(response), response.status_code)
self._finish_fetch(result, True)
def parse(self, content, status_code=None):
self._existed = True
if status_code == 201:
self._existed = False
return content
def is_new(self):
"""
判断当前对象是否已经保存至服务器。
:rtype: bool
"""
return True if self.id else False
def is_existed(self):
return self._existed
def get_acl(self):
"""
返回当前对象的 ACL。
:return: 当前对象的 ACL
:rtype: leancloud.ACL
"""
return self.get('ACL')
def set_acl(self, acl):
"""
为当前对象设置 ACL
:type acl: leancloud.ACL
:return: 当前对象
"""
return self.set('ACL', acl)
def _finish_save(self, server_data):
saved_changes = self._op_set_queue[0]
self._op_set_queue = self._op_set_queue[1:]
self._apply_op_set(saved_changes, self._server_data)
self._merge_magic_field(server_data)
self._rebuild_all_estimated_data()
def _finish_fetch(self, server_data, has_data):
self._op_set_queue = [{}]
self._merge_magic_field(server_data)
for key, value in server_data.iteritems():
self._server_data[key] = utils.decode(key, value)
self._rebuild_all_estimated_data()
self._op_set_queue = [{}]
self._has_data = has_data
def _rebuild_estimated_data_for_key(self, key):
if self.attributes.get(key):
del self.attributes[key]
if key in self._server_data:
self.attributes[key] = self._server_data[key]
for op_set in self._op_set_queue:
o = op_set.get(key)
if o is None:
continue
self.attributes[key] = o._apply(self.attributes.get(key), self, key)
if self.attributes[key] is operation._UNSET:
del self.attributes[key]
def _rebuild_all_estimated_data(self):
self.attributes = copy.deepcopy(self._server_data)
def _apply_op_set(self, op_set, target):
for key, change in op_set.iteritems():
target[key] = change._apply(target.get(key), self, key)
if target[key] == operation._UNSET:
del target[key]