-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathmanager.py
More file actions
1247 lines (947 loc) · 39.3 KB
/
manager.py
File metadata and controls
1247 lines (947 loc) · 39.3 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 json
from copy import deepcopy
import six
from syncano.connection import ConnectionMixin
from syncano.exceptions import SyncanoRequestError, SyncanoValidationError, SyncanoValueError
from syncano.models.bulk import ModelBulkCreate, ObjectBulkCreate
from syncano.models.manager_mixins import ArrayOperationsMixin, IncrementMixin, clone
from .registry import registry
# The maximum number of items to display in a Manager.__repr__
REPR_OUTPUT_SIZE = 20
class ManagerDescriptor(object):
def __init__(self, manager):
self.manager = manager
def __get__(self, instance, owner=None):
if instance is not None:
raise AttributeError("Manager isn't accessible via {0} instances.".format(owner.__name__))
return self.manager.all()
class Manager(ConnectionMixin):
"""Base class responsible for all ORM (``please``) actions."""
BATCH_URI = '/v1.1/instances/{name}/batch/'
def __init__(self):
self.name = None
self.model = None
self.endpoint = None
self.properties = {}
self.method = None
self.query = {}
self.data = {}
self.is_lazy = False
self._filter_kwargs = {}
self._limit = None
self._serialize = True
self._connection = None
self._template = None
def __repr__(self): # pragma: no cover
data = list(self[:REPR_OUTPUT_SIZE + 1])
if len(data) > REPR_OUTPUT_SIZE:
data[-1] = '...(remaining elements truncated)...'
return repr(data)
def __str__(self): # pragma: no cover
return '<Manager: {0}>'.format(self.model.__name__)
def __unicode__(self): # pragma: no cover
return six.u(str(self))
def __len__(self): # pragma: no cover
return self.iterator()
def __iter__(self): # pragma: no cover
return iter(self.iterator())
def __nonzero__(self):
try:
self[0]
return True
except IndexError:
return False
def __bool__(self): # pragma: no cover
try:
self[0]
return True
except IndexError:
return False
def __getitem__(self, k):
"""
Retrieves an item or slice from the set of results.
"""
if not isinstance(k, (slice,) + six.integer_types):
raise TypeError
assert ((not isinstance(k, slice) and (k >= 0)) or
(isinstance(k, slice) and (k.start is None or k.start >= 0) and
(k.stop is None or k.stop >= 0))), \
"Negative indexing is not supported."
manager = self._clone()
if isinstance(k, slice):
if k.stop is not None:
manager.limit(int(k.stop) + 1)
return list(manager)[k.start:k.stop:k.step]
manager.limit(k + 1)
return list(manager)[k]
def _set_default_properties(self, endpoint_properties):
for field in self.model._meta.fields:
is_demanded = field.name in endpoint_properties
has_default = field.default is not None
if is_demanded and has_default:
self.properties[field.name] = field.default
def as_batch(self):
self.is_lazy = True
return self
def batch(self, *args):
"""
A convenience method for making a batch request. Only create, update and delete manager method are supported.
Batch request are limited to 50. So the args length should be equal or less than 50.
Usage::
klass = instance.classes.get(name='some_class')
Object.please.batch(
klass.objects.as_batch().delete(id=652),
klass.objects.as_batch().delete(id=653),
...
)
and::
Object.please.batch(
klass.objects.as_batch().update(id=652, arg='some_b'),
klass.objects.as_batch().update(id=653, arg='some_b'),
...
)
and::
Object.please.batch(
klass.objects.as_batch().create(arg='some_c'),
klass.objects.as_batch().create(arg='some_c'),
...
)
and::
Object.please.batch(
klass.objects.as_batch().delete(id=653),
klass.objects.as_batch().update(id=652, arg='some_a'),
klass.objects.as_batch().create(arg='some_c'),
...
)
are posible.
But::
Object.please.batch(
klass.objects.as_batch().get_or_create(id=653, arg='some_a')
)
will not work as expected.
Some snippet for working with instance users::
instance = Instance.please.get(name='Nabuchodonozor')
model_users = instance.users.batch(
instance.users.as_batch().delete(id=7),
instance.users.as_batch().update(id=9, username='username_a'),
instance.users.as_batch().create(username='username_b', password='5432'),
...
)
And sample response will be::
[{u'code': 204}, <User: 9>, <User: 11>, ...]
:param args: a arg is on of the: klass.objects.as_batch().create(...), klass.objects.as_batch().update(...),
klass.objects.as_batch().delete(...)
:return: a list with objects corresponding to batch arguments; update and create will return a populated Object,
when delete return a raw response from server (usually a dict: {'code': 204}, sometimes information about not
found resource to delete);
"""
# firstly turn off lazy mode:
self.is_lazy = False
meta = []
requests = []
for arg in args:
if isinstance(arg, list): # update now can return a list;
for nested_arg in arg:
meta.append(nested_arg['meta'])
requests.append(nested_arg['body'])
else:
meta.append(arg['meta'])
requests.append(arg['body'])
response = self.connection.request(
'POST',
self.BATCH_URI.format(name=registry.instance_name),
**{'data': {'requests': requests}}
)
populated_response = []
for meta, res in zip(meta, response):
if res['code'] in [200, 201]: # success response: update or create;
content = res['content']
model = meta['model']
properties = meta['properties']
content.update(properties)
populated_response.append(model(**content))
else:
populated_response.append(res)
return populated_response
# Object actions
def create(self, **kwargs):
"""
A convenience method for creating an object and saving it all in one step. Thus::
instance = Instance.please.create(name='test-one', description='description')
and::
instance = Instance(name='test-one', description='description')
instance.save()
are equivalent.
"""
data = self.properties.copy()
attrs = kwargs.copy()
data.update(attrs)
data.update({'is_lazy': self.is_lazy})
instance = self._get_instance(data)
if instance.__class__.__name__ == 'Instance':
registry.set_used_instance(instance.name)
saved_instance = instance.save()
if not self.is_lazy:
return instance
return saved_instance
def bulk_create(self, *objects):
"""
Creates many new instances based on provided list of objects.
Usage::
instance = Instance.please.get(name='instance_a')
instances = instance.users.bulk_create(
User(username='user_a', password='1234'),
User(username='user_b', password='4321')
)
Warning::
This method is restricted to handle 50 objects at once.
"""
return ModelBulkCreate(objects, self).process()
@clone
def get(self, *args, **kwargs):
"""
Returns the object matching the given lookup parameters.
Usage::
instance = Instance.please.get('test-one')
instance = Instance.please.get(name='test-one')
"""
self.method = 'GET'
self.endpoint = 'detail'
self._filter(*args, **kwargs)
return self.request()
@clone
def in_bulk(self, object_ids_list, **kwargs):
"""
A method which allows to bulk get objects;
Use::
response = Classes.please.in_bulk(['test_class', ...])
response is:
> {'test_class': <Class: test_class>}
For objects:
res = Object.please.in_bulk([1, 2], class_name='test_class')
or
res = klass.objects.in_bulk([1, 2])
response is:
{1: <SyncanoTestClassObject: 1>, 2: {u'content': {u'detail': u'Not found.'}, u'code': 404}}
:param object_ids_list: This list expects the primary keys - id in api, a names, ids can be used here;
:return: a dict in which keys are the object_ids_list elements, and values are a populated objects;
"""
self.properties.update(kwargs)
path, defaults = self._get_endpoint_properties()
requests = [
{'method': 'GET', 'path': '{path}{id}/'.format(path=path, id=object_id)} for object_id in object_ids_list
]
response = self.connection.request(
'POST',
self.BATCH_URI.format(name=registry.instance_name),
**{'data': {'requests': requests}}
)
bulk_response = {}
for object_id, object in zip(object_ids_list, response):
if object['code'] == 200:
data = object['content'].copy()
data.update(self.properties)
bulk_response[object_id] = self.model(**data)
else:
bulk_response[object_id] = object
return bulk_response
def detail(self, *args, **kwargs):
"""
Wrapper around ``get`` method.
Usage::
instance = Instance.please.detail('test-one')
instance = Instance.please.detail(name='test-one')
"""
return self.get(*args, **kwargs)
def get_or_create(self, **kwargs):
"""
A convenience method for looking up an object with the given
lookup parameters, creating one if necessary.
Returns a tuple of **(object, created)**, where **object** is the retrieved or
**created** object and created is a boolean specifying whether a new object was created.
This is meant as a shortcut to boilerplatish code. For example::
try:
instance = Instance.please.get(name='test-one')
except Instance.DoesNotExist:
instance = Instance(name='test-one', description='test')
instance.save()
The above example can be rewritten using **get_or_create()** like so::
instance, created = Instance.please.get_or_create(name='test-one', defaults={'description': 'test'})
"""
defaults = deepcopy(kwargs.pop('defaults', {}))
try:
instance = self.get(**kwargs)
except self.model.DoesNotExist:
defaults.update(kwargs)
instance = self.create(**defaults)
created = True
else:
created = False
return instance, created
@clone
def delete(self, *args, **kwargs):
"""
Removes single instance based on provided arguments.
Returns None if deletion went fine.
Usage::
Instance.please.delete('test-one')
Instance.please.delete(name='test-one')
"""
self.method = 'DELETE'
self.endpoint = 'detail'
self._filter(*args, **kwargs)
if not self.is_lazy:
return self.request()
path, defaults = self._get_endpoint_properties()
return self.model.batch_object(method=self.method, path=path, body=self.data, properties=defaults)
@clone
def filter(self, **kwargs):
endpoint_fields = [field.name for field in self.model._meta.fields if field.has_endpoint_data]
for kwarg_name in kwargs:
if kwarg_name not in endpoint_fields:
raise SyncanoValueError('Only endpoint properties can be used in filter: {}'.format(endpoint_fields))
self._filter_kwargs = kwargs
return self
@clone
def update(self, *args, **kwargs):
if self._filter_kwargs or self.query: # means that .filter() was run;
return self.new_update(**kwargs)
return self.old_update(*args, **kwargs)
@clone
def new_update(self, **kwargs):
"""
Updates multiple instances based on provided arguments. There to ways to do so:
1. Django-style update.
2. By specifying arguments.
Usage::
objects = Object.please.list(instance_name=INSTANCE_NAME,
class_name='someclass').filter(id=1).update(arg='103')
objects = Object.please.list(instance_name=INSTANCE_NAME,
class_name='someclass').filter(id=1).update(arg='103')
The return value is a list of objects;
"""
model_fields = [field.name for field in self.model._meta.fields if not field.has_endpoint_data]
for field_name in kwargs:
if field_name not in model_fields:
raise SyncanoValueError('This model has not field {}'.format(field_name))
self.endpoint = 'detail'
self.method = self.get_allowed_method('PATCH', 'PUT', 'POST')
self.data = kwargs.copy()
if self._filter_kwargs: # Manager context;
# do a single object update: Class, Instance for example;
self.data.update(self._filter_kwargs)
serialized = self._get_serialized_data()
self._filter(*(), **self.data) # sets the proper self.properties here
if not self.is_lazy:
return [self.serialize(self.request(), self.model)]
path, defaults = self._get_endpoint_properties()
return [self.model.batch_object(method=self.method, path=path, body=serialized, properties=defaults)]
instances = [] # ObjectManager context;
for obj in self:
self._filter(*(), **kwargs)
serialized = self._get_serialized_data()
self.properties.update({'id': obj.id})
path, defaults = self._get_endpoint_properties()
updated_instance = self.model.batch_object(method=self.method, path=path, body=serialized,
properties=defaults)
instances.append(updated_instance) # always a batch structure here;
if not self.is_lazy:
instances = self.batch(instances)
return instances
@clone
def old_update(self, *args, **kwargs):
"""
Updates single instance based on provided arguments. There to ways to do so:
1. Django-style update.
2. By specifying **data** argument.
The **data** is a dictionary of (field, value) pairs used to update the object.
Usage::
instance = Instance.please.update('test-one', description='new one')
instance = Instance.please.update(name='test-one', description='new one')
instance = Instance.please.update('test-one', data={'description': 'new one'})
instance = Instance.please.update(name='test-one', data={'description': 'new one'})
"""
self.endpoint = 'detail'
self.method = self.get_allowed_method('PATCH', 'PUT', 'POST')
data = kwargs.pop('data', {})
self.data = kwargs.copy()
self.data.update(data)
model = self.serialize(self.data, self.model)
serialized = model.to_native()
serialized = {k: v for k, v in six.iteritems(serialized)
if k in self.data}
self.data.update(serialized)
self._filter(*args, **kwargs)
if not self.is_lazy:
return self.request()
path, defaults = self._get_endpoint_properties()
return self.model.batch_object(method=self.method, path=path, body=self.data, properties=defaults)
def update_or_create(self, defaults=None, **kwargs):
"""
A convenience method for updating an object with the given parameters, creating a new one if necessary.
The ``defaults`` is a dictionary of (field, value) pairs used to update the object.
Returns a tuple of **(object, created)**, where object is the created or updated object and created
is a boolean specifying whether a new object was created.
The **update_or_create** method tries to fetch an object from Syncano API based on the given kwargs.
If a match is found, it updates the fields passed in the defaults dictionary.
This is meant as a shortcut to boilerplatish code. For example::
try:
instance = Instance.please.update(name='test-one', data=updated_values)
except Instance.DoesNotExist:
updated_values.update({'name': 'test-one'})
instance = Instance(**updated_values)
instance.save()
This pattern gets quite unwieldy as the number of fields in a model goes up.
The above example can be rewritten using **update_or_create()** like so::
instance, created = Instance.please.update_or_create(name='test-one',
defaults=updated_values)
"""
defaults = deepcopy(defaults or {})
try:
instance = self.update(**kwargs)
except self.model.DoesNotExist:
defaults.update(kwargs)
instance = self.create(**defaults)
created = True
else:
created = False
return instance, created
# List actions
@clone
def all(self, *args, **kwargs):
"""
Returns a copy of the current ``Manager`` with limit removed.
Usage::
instances = Instance.please.all()
"""
self._limit = None
return self.list(*args, **kwargs)
@clone
def list(self, *args, **kwargs):
"""
Returns a copy of the current ``Manager`` containing objects that match the given lookup parameters.
Usage::
instance = Instance.please.list()
classes = Class.please.list(instance_name='test-one')
"""
self.method = 'GET'
self.endpoint = 'list'
self._filter(*args, **kwargs)
return self
@clone
def first(self, *args, **kwargs):
"""
Returns the first object matched by the lookup parameters or None, if there is no matching object.
Usage::
instance = Instance.please.first()
classes = Class.please.first(instance_name='test-one')
"""
try:
self._limit = 1
return self.list(*args, **kwargs)[0]
except KeyError:
return None
@clone
def page_size(self, value):
"""
Sets page size.
Usage::
instances = Instance.please.page_size(20).all()
"""
if not value or not isinstance(value, six.integer_types):
raise SyncanoValueError('page_size value needs to be an int.')
self.query['page_size'] = value
return self
@clone
def limit(self, value):
"""
Sets limit of returned objects.
Usage::
instances = Instance.please.list().limit(10)
classes = Class.please.list(instance_name='test-one').limit(10)
"""
if not value or not isinstance(value, six.integer_types):
raise SyncanoValueError('Limit value needs to be an int.')
self._limit = value
return self
@clone
def ordering(self, order='asc'):
"""
Sets order of returned objects.
Usage::
instances = Instance.please.ordering()
"""
if order not in ('asc', 'desc'):
raise SyncanoValueError('Invalid order value.')
self.query['ordering'] = order
return self
@clone
def raw(self):
"""
Disables serialization. ``request`` method will return raw Python types.
Usage::
>>> instances = Instance.please.list().raw()
>>> instances
[{'description': 'new one', 'name': 'test-one'...}...]
"""
self._serialize = False
return self
@clone
def template(self, name):
"""
Disables serialization. ``request`` method will return raw text.
Usage::
>>> instances = Instance.please.list().template('test')
>>> instances
u'text'
"""
self._serialize = False
self._template = name
return self
@clone
def using(self, connection):
"""
Connection juggling.
"""
# ConnectionMixin will validate this
self.connection = connection
return self
# Other stuff
def contribute_to_class(self, model, name): # pragma: no cover
setattr(model, name, ManagerDescriptor(self))
self.model = model
if not self.name:
self.name = name
def _get_serialized_data(self):
model = self.serialize(self.data, self.model)
serialized = model.to_native()
serialized = {k: v for k, v in six.iteritems(serialized)
if k in self.data}
self.data.update(serialized)
return serialized
def _filter(self, *args, **kwargs):
properties = self.model._meta.get_endpoint_properties(self.endpoint)
self._set_default_properties(properties)
if args and self.endpoint:
# let user get object by 'id'
too_much_properties = len(args) < len(properties)
id_specified = 'id' in properties
if too_much_properties and id_specified:
properties = ['id']
mapped_args = {k: v for k, v in zip(properties, args)}
self.properties.update(mapped_args)
self.properties.update(kwargs)
def _clone(self):
# Maybe deepcopy ?
manager = self.__class__()
manager.name = self.name
manager.model = self.model
manager._connection = self._connection
manager._template = self._template
manager.endpoint = self.endpoint
manager.properties = deepcopy(self.properties)
manager._limit = self._limit
manager.method = self.method
manager.query = deepcopy(self.query)
manager._filter_kwargs = deepcopy(self._filter_kwargs)
manager.data = deepcopy(self.data)
manager._serialize = self._serialize
manager.is_lazy = self.is_lazy
return manager
def serialize(self, data, model=None):
"""Serializes passed data to related :class:`~syncano.models.base.Model` class."""
model = model or self.model
if data == '':
return
if isinstance(data, model):
return data
if not isinstance(data, dict):
raise SyncanoValueError('Unsupported data type.')
properties = deepcopy(self.properties)
properties.update(data)
return model(**properties) if self._serialize else data
def build_request(self, request):
if 'params' not in request and self.query:
request['params'] = self.query
if 'data' not in request and self.data:
request['data'] = self.data
if 'headers' not in request:
request['headers'] = {}
if self._template is not None and 'X-TEMPLATE-RESPONSE' not in request['headers']:
request['headers']['X-TEMPLATE-RESPONSE'] = self._template
def request(self, method=None, path=None, **request):
"""Internal method, which calls Syncano API and returns serialized data."""
meta = self.model._meta
method = method or self.method
allowed_methods = meta.get_endpoint_methods(self.endpoint)
if not path:
path, defaults = self._get_endpoint_properties()
if method.lower() not in allowed_methods:
methods = ', '.join(allowed_methods)
raise SyncanoValueError('Unsupported request method "{0}" allowed are {1}.'.format(method, methods))
self.build_request(request)
try:
response = self.connection.request(method, path, **request)
except SyncanoRequestError as e:
if e.status_code == 404:
obj_id = path.rsplit('/')[-2]
raise self.model.DoesNotExist("{} not found.".format(obj_id))
raise
if 'next' not in response and not self._template:
return self.serialize(response)
return response
def get_allowed_method(self, *methods):
meta = self.model._meta
allowed_methods = meta.get_endpoint_methods(self.endpoint)
for method in methods:
if method.lower() in allowed_methods:
return method
methods = ', '.join(methods)
raise SyncanoValueError('Unsupported request methods {0}.'.format(methods))
def iterator(self):
"""Pagination handler"""
response = self._get_response()
results = 0
while True:
if self._template:
yield response
break
objects = response.get('objects')
next_url = response.get('next')
for o in objects:
if self._limit and results >= self._limit:
break
results += 1
yield self.serialize(o)
if not objects or not next_url or (self._limit and results >= self._limit):
break
response = self.request(path=next_url)
def _get_response(self):
return self.request()
def _get_instance(self, attrs):
return self.model(**attrs)
def _get_endpoint_properties(self):
defaults = {f.name: f.default for f in self.model._meta.fields if f.default is not None}
defaults.update(self.properties)
return self.model._meta.resolve_endpoint(self.endpoint, defaults), defaults
class ScriptManager(Manager):
"""
Custom :class:`~syncano.models.manager.Manager`
class for :class:`~syncano.models.base.Script` model.
"""
@clone
def run(self, *args, **kwargs):
payload = kwargs.pop('payload', {})
if not isinstance(payload, six.string_types):
payload = json.dumps(payload)
self.method = 'POST'
self.endpoint = 'run'
self.data['payload'] = payload
self._filter(*args, **kwargs)
self._serialize = False
response = self.request()
return registry.ScriptTrace(**response)
class ScriptEndpointManager(Manager):
"""
Custom :class:`~syncano.models.manager.Manager`
class for :class:`~syncano.models.base.ScriptEndpoint` model.
"""
@clone
def run(self, *args, **kwargs):
payload = kwargs.pop('payload', {})
if not isinstance(payload, six.string_types):
payload = json.dumps(payload)
self.method = 'POST'
self.endpoint = 'run'
self.data['payload'] = payload
self._filter(*args, **kwargs)
self._serialize = False
response = self.request()
# Workaround for circular import
return registry.ScriptEndpointTrace(**response)
class ObjectManager(IncrementMixin, ArrayOperationsMixin, Manager):
"""
Custom :class:`~syncano.models.manager.Manager`
class for :class:`~syncano.models.base.Object` model.
"""
LOOKUP_SEPARATOR = '__'
ALLOWED_LOOKUPS = [
'gt', 'gte', 'lt', 'lte',
'eq', 'neq', 'exists', 'in', 'nin',
'near', 'is', 'contains',
'startswith', 'endswith',
'contains', 'istartswith',
'iendswith', 'icontains',
'ieq', 'near',
]
def __init__(self):
super(ObjectManager, self).__init__()
self._initial_response = None
def serialize(self, data, model=None):
model = model or self.model.get_subclass_model(**self.properties)
return super(ObjectManager, self).serialize(data, model)
@clone
def count(self):
"""
Return the queryset count;
Usage::
Object.please.list(instance_name='raptor', class_name='some_class').filter(id__gt=600).count()
Object.please.list(instance_name='raptor', class_name='some_class').count()
Object.please.all(instance_name='raptor', class_name='some_class').count()
:return: The count of the returned objects: count = DataObjects.please.list(...).count();
"""
self.method = 'GET'
self.query.update({
'include_count': True,
'page_size': 0,
})
response = self.request()
return response['objects_count']
@clone
def with_count(self, page_size=20):
"""
Return the queryset with count;
Usage::
Object.please.list(instance_name='raptor', class_name='some_class').filter(id__gt=600).with_count()
Object.please.list(instance_name='raptor', class_name='some_class').with_count(page_size=30)
Object.please.all(instance_name='raptor', class_name='some_class').with_count()
:param page_size: The size of the pagination; Default to 20;
:return: The tuple with objects and the count: objects, count = DataObjects.please.list(...).with_count();
"""
query_data = {
'include_count': True,
'page_size': page_size,
}
self.method = 'GET'
self.query.update(query_data)
response = self.request()
self._initial_response = response
return self, self._initial_response['objects_count']
@clone
def filter(self, **kwargs):
"""
Special method just for data object :class:`~syncano.models.base.Object` model.
Usage::
objects = Object.please.list('instance-name', 'class-name').filter(henryk__gte='hello')
"""
query = self._build_query(query_data=kwargs)
self.query['query'] = json.dumps(query)
self.method = 'GET'
self.endpoint = 'list'
return self
def _build_query(self, query_data, **kwargs):
query = {}
self.properties.update(**kwargs)
model = self.model.get_subclass_model(**self.properties)
for field_name, value in six.iteritems(query_data):
lookup = 'eq'
model_name = None
if self.LOOKUP_SEPARATOR in field_name:
model_name, field_name, lookup = self._get_lookup_attributes(field_name)
# if filter is made on relation field: relation__name__eq='test';
if model_name:
for field in model._meta.fields:
if field.name == model_name:
break
# if filter is made on normal field: name__eq='test';
else:
for field in model._meta.fields:
if field.name == field_name:
break
self._validate_lookup(model, model_name, field_name, lookup, field)
query_main_lookup, query_main_field = self._get_main_lookup(model_name, field_name, lookup)
query.setdefault(query_main_field, {})
query[query_main_field]['_{0}'.format(query_main_lookup)] = field.to_query(
value,
query_main_lookup,
related_field_name=field_name,
related_field_lookup=lookup,
)
return query
def _get_lookup_attributes(self, field_name):
try: