forked from leancloud/python-sdk
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathquery.html
More file actions
925 lines (686 loc) · 93.3 KB
/
Copy pathquery.html
File metadata and controls
925 lines (686 loc) · 93.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
<!DOCTYPE html>
<html class="writer-html5" lang="zh-CN" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>leancloud.query — LeanCloud-Python-SDK 2.6.1 文档</title>
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
<script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
<script src="../../_static/jquery.js"></script>
<script src="../../_static/underscore.js"></script>
<script src="../../_static/doctools.js"></script>
<script src="../../_static/translations.js"></script>
<script type="text/javascript" src="../../_static/js/theme.js"></script>
<link rel="index" title="索引" href="../../genindex.html" />
<link rel="search" title="搜索" href="../../search.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../../index.html" class="icon icon-home"> LeanCloud-Python-SDK
</a>
<div class="version">
2.6
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
<input type="text" name="q" placeholder="在文档中搜索" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<!-- Local TOC -->
<div class="local-toc"></div>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../index.html">LeanCloud-Python-SDK</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../index.html" class="icon icon-home"></a> »</li>
<li><a href="../index.html">模块代码</a> »</li>
<li>leancloud.query</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<h1>leancloud.query 源代码</h1><div class="highlight"><pre>
<span></span><span class="c1"># coding: utf-8</span>
<span class="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">absolute_import</span>
<span class="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">division</span>
<span class="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">print_function</span>
<span class="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">unicode_literals</span>
<span class="kn">import</span> <span class="nn">json</span>
<span class="kn">import</span> <span class="nn">six</span>
<span class="kn">import</span> <span class="nn">leancloud</span>
<span class="kn">from</span> <span class="nn">leancloud</span> <span class="k">import</span> <span class="n">client</span>
<span class="kn">from</span> <span class="nn">leancloud</span> <span class="k">import</span> <span class="n">utils</span>
<span class="kn">from</span> <span class="nn">leancloud.file_</span> <span class="k">import</span> <span class="n">File</span>
<span class="kn">from</span> <span class="nn">leancloud.object_</span> <span class="k">import</span> <span class="n">Object</span>
<span class="kn">from</span> <span class="nn">leancloud.errors</span> <span class="k">import</span> <span class="n">LeanCloudError</span>
<span class="n">__author__</span> <span class="o">=</span> <span class="s2">"asaka <lan@leancloud.rocks>"</span>
<span class="k">class</span> <span class="nc">CQLResult</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> CQL 查询结果对象。</span>
<span class="sd"> Attributes:</span>
<span class="sd"> results: 返回的查询结果</span>
<span class="sd"> count: 如果查询语句包含 count，将保存在此字段</span>
<span class="sd"> class_name: 查询的 class 名称</span>
<span class="sd"> """</span>
<span class="vm">__slots__</span> <span class="o">=</span> <span class="p">[</span><span class="s2">"results"</span><span class="p">,</span> <span class="s2">"count"</span><span class="p">,</span> <span class="s2">"class_name"</span><span class="p">]</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">results</span><span class="p">,</span> <span class="n">count</span><span class="p">,</span> <span class="n">class_name</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">results</span> <span class="o">=</span> <span class="n">results</span>
<span class="bp">self</span><span class="o">.</span><span class="n">count</span> <span class="o">=</span> <span class="n">count</span>
<span class="bp">self</span><span class="o">.</span><span class="n">class_name</span> <span class="o">=</span> <span class="n">class_name</span>
<span class="k">class</span> <span class="nc">Cursor</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Query.scan 返回结果对象。</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">query_class</span><span class="p">,</span> <span class="n">batch_size</span><span class="p">,</span> <span class="n">scan_key</span><span class="p">,</span> <span class="n">params</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_params</span> <span class="o">=</span> <span class="n">params</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_query_class</span> <span class="o">=</span> <span class="n">query_class</span>
<span class="k">if</span> <span class="n">batch_size</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_params</span><span class="p">[</span><span class="s2">"limit"</span><span class="p">]</span> <span class="o">=</span> <span class="n">batch_size</span>
<span class="k">if</span> <span class="n">scan_key</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_params</span><span class="p">[</span><span class="s2">"scan_key"</span><span class="p">]</span> <span class="o">=</span> <span class="n">scan_key</span>
<span class="k">def</span> <span class="nf">__iter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">while</span> <span class="kc">True</span><span class="p">:</span>
<span class="n">content</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span>
<span class="s2">"/scan/classes/</span><span class="si">{}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_query_class</span><span class="o">.</span><span class="n">_class_name</span><span class="p">),</span> <span class="bp">self</span><span class="o">.</span><span class="n">_params</span>
<span class="p">)</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>
<span class="k">for</span> <span class="n">result</span> <span class="ow">in</span> <span class="n">content</span><span class="p">[</span><span class="s2">"results"</span><span class="p">]:</span>
<span class="n">obj</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_query_class</span><span class="p">()</span>
<span class="n">obj</span><span class="o">.</span><span class="n">_update_data</span><span class="p">(</span><span class="n">result</span><span class="p">)</span>
<span class="k">yield</span> <span class="n">obj</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">content</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"cursor"</span><span class="p">):</span>
<span class="k">break</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_params</span><span class="p">[</span><span class="s2">"cursor"</span><span class="p">]</span> <span class="o">=</span> <span class="n">content</span><span class="p">[</span><span class="s2">"cursor"</span><span class="p">]</span>
<div class="viewcode-block" id="Query"><a class="viewcode-back" href="../../index.html#leancloud.Query">[文档]</a><span class="k">class</span> <span class="nc">Query</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">query_class</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> :param query_class: 要查询的 class 名称或者对象</span>
<span class="sd"> :type query_class: string_types or leancloud.ObjectMeta</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">query_class</span><span class="p">,</span> <span class="n">six</span><span class="o">.</span><span class="n">string_types</span><span class="p">):</span>
<span class="k">if</span> <span class="n">query_class</span> <span class="ow">in</span> <span class="p">(</span><span class="s2">"File"</span><span class="p">,</span> <span class="s2">"_File"</span><span class="p">):</span>
<span class="n">query_class</span> <span class="o">=</span> <span class="n">File</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">query_class</span> <span class="o">=</span> <span class="n">Object</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">query_class</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">query_class</span><span class="p">,</span> <span class="p">(</span><span class="nb">type</span><span class="p">,</span> <span class="n">six</span><span class="o">.</span><span class="n">class_types</span><span class="p">))</span> <span class="ow">or</span> <span class="ow">not</span> <span class="nb">issubclass</span><span class="p">(</span>
<span class="n">query_class</span><span class="p">,</span> <span class="p">(</span><span class="n">File</span><span class="p">,</span> <span class="n">Object</span><span class="p">)</span>
<span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"Query takes string or LeanCloud Object"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_query_class</span> <span class="o">=</span> <span class="n">query_class</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_where</span> <span class="o">=</span> <span class="p">{}</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_include</span> <span class="o">=</span> <span class="p">[]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_include_acl</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_limit</span> <span class="o">=</span> <span class="o">-</span><span class="mi">1</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_skip</span> <span class="o">=</span> <span class="mi">0</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_extra</span> <span class="o">=</span> <span class="p">{}</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_order</span> <span class="o">=</span> <span class="p">[]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_select</span> <span class="o">=</span> <span class="p">[]</span>
<div class="viewcode-block" id="Query.or_"><a class="viewcode-back" href="../../index.html#leancloud.Query.or_">[文档]</a> <span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">or_</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="o">*</span><span class="n">queries</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> 根据传入的 Query 对象，构造一个新的 OR 查询。</span>
<span class="sd"> :param queries: 需要构造的子查询列表</span>
<span class="sd"> :rtype: Query</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">queries</span><span class="p">)</span> <span class="o"><</span> <span class="mi">2</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"or_ need two queries at least"</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">all</span><span class="p">(</span>
<span class="n">x</span><span class="o">.</span><span class="n">_query_class</span><span class="o">.</span><span class="n">_class_name</span> <span class="o">==</span> <span class="n">queries</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">_query_class</span><span class="o">.</span><span class="n">_class_name</span>
<span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">queries</span>
<span class="p">):</span>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">"All queries must be for the same class"</span><span class="p">)</span>
<span class="n">query</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="n">queries</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">_query_class</span><span class="o">.</span><span class="n">_class_name</span><span class="p">)</span>
<span class="n">query</span><span class="o">.</span><span class="n">_or_query</span><span class="p">(</span><span class="n">queries</span><span class="p">)</span>
<span class="k">return</span> <span class="n">query</span></div>
<div class="viewcode-block" id="Query.and_"><a class="viewcode-back" href="../../index.html#leancloud.Query.and_">[文档]</a> <span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">and_</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="o">*</span><span class="n">queries</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> 根据传入的 Query 对象，构造一个新的 AND 查询。</span>
<span class="sd"> :param queries: 需要构造的子查询列表</span>
<span class="sd"> :rtype: Query</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">queries</span><span class="p">)</span> <span class="o"><</span> <span class="mi">2</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"and_ need two queries at least"</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">all</span><span class="p">(</span>
<span class="n">x</span><span class="o">.</span><span class="n">_query_class</span><span class="o">.</span><span class="n">_class_name</span> <span class="o">==</span> <span class="n">queries</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">_query_class</span><span class="o">.</span><span class="n">_class_name</span>
<span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">queries</span>
<span class="p">):</span>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">"All queries must be for the same class"</span><span class="p">)</span>
<span class="n">query</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="n">queries</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">_query_class</span><span class="o">.</span><span class="n">_class_name</span><span class="p">)</span>
<span class="n">query</span><span class="o">.</span><span class="n">_and_query</span><span class="p">(</span><span class="n">queries</span><span class="p">)</span>
<span class="k">return</span> <span class="n">query</span></div>
<div class="viewcode-block" id="Query.do_cloud_query"><a class="viewcode-back" href="../../index.html#leancloud.Query.do_cloud_query">[文档]</a> <span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">do_cloud_query</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">cql</span><span class="p">,</span> <span class="o">*</span><span class="n">pvalues</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> 使用 CQL 来构造查询。CQL 语法参考 `这里 <https://cn.avoscloud.com/docs/cql_guide.html>`_。</span>
<span class="sd"> :param cql: CQL 语句</span>
<span class="sd"> :param pvalues: 查询参数</span>
<span class="sd"> :rtype: CQLResult</span>
<span class="sd"> """</span>
<span class="n">params</span> <span class="o">=</span> <span class="p">{</span><span class="s2">"cql"</span><span class="p">:</span> <span class="n">cql</span><span class="p">}</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">pvalues</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span> <span class="ow">and</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">pvalues</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="p">(</span><span class="nb">tuple</span><span class="p">,</span> <span class="nb">list</span><span class="p">)):</span>
<span class="n">pvalues</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">pvalues</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">pvalues</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
<span class="n">params</span><span class="p">[</span><span class="s2">"pvalues"</span><span class="p">]</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">pvalues</span><span class="p">)</span>
<span class="n">content</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"/cloudQuery"</span><span class="p">,</span> <span class="n">params</span><span class="p">)</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>
<span class="n">objs</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">query</span> <span class="o">=</span> <span class="bp">cls</span><span class="p">(</span><span class="n">content</span><span class="p">[</span><span class="s2">"className"</span><span class="p">])</span>
<span class="k">for</span> <span class="n">result</span> <span class="ow">in</span> <span class="n">content</span><span class="p">[</span><span class="s2">"results"</span><span class="p">]:</span>
<span class="n">obj</span> <span class="o">=</span> <span class="n">query</span><span class="o">.</span><span class="n">_new_object</span><span class="p">()</span>
<span class="n">obj</span><span class="o">.</span><span class="n">_update_data</span><span class="p">(</span><span class="n">query</span><span class="o">.</span><span class="n">_process_result</span><span class="p">(</span><span class="n">result</span><span class="p">))</span>
<span class="n">objs</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">obj</span><span class="p">)</span>
<span class="k">return</span> <span class="n">CQLResult</span><span class="p">(</span><span class="n">objs</span><span class="p">,</span> <span class="n">content</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"count"</span><span class="p">),</span> <span class="n">content</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"className"</span><span class="p">))</span></div>
<div class="viewcode-block" id="Query.dump"><a class="viewcode-back" href="../../index.html#leancloud.Query.dump">[文档]</a> <span class="k">def</span> <span class="nf">dump</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> :return: 当前对象的序列化结果</span>
<span class="sd"> :rtype: dict</span>
<span class="sd"> """</span>
<span class="n">params</span> <span class="o">=</span> <span class="p">{</span>
<span class="s2">"where"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">_where</span><span class="p">,</span>
<span class="p">}</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_include</span><span class="p">:</span>
<span class="n">params</span><span class="p">[</span><span class="s2">"include"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">","</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_include</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_select</span><span class="p">:</span>
<span class="n">params</span><span class="p">[</span><span class="s2">"keys"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">","</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_select</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_include_acl</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">params</span><span class="p">[</span><span class="s2">"returnACL"</span><span class="p">]</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_include_acl</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_limit</span> <span class="o">>=</span> <span class="mi">0</span><span class="p">:</span>
<span class="n">params</span><span class="p">[</span><span class="s2">"limit"</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_limit</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_skip</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
<span class="n">params</span><span class="p">[</span><span class="s2">"skip"</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_skip</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_order</span><span class="p">:</span>
<span class="n">params</span><span class="p">[</span><span class="s2">"order"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">","</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_order</span><span class="p">)</span>
<span class="n">params</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_extra</span><span class="p">)</span>
<span class="k">return</span> <span class="n">params</span></div>
<span class="k">def</span> <span class="nf">_new_object</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_query_class</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">_process_result</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">obj</span><span class="p">):</span>
<span class="k">return</span> <span class="n">obj</span>
<span class="k">def</span> <span class="nf">_do_request</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">params</span><span class="p">):</span>
<span class="k">return</span> <span class="n">client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span>
<span class="s2">"/classes/</span><span class="si">{0}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_query_class</span><span class="o">.</span><span class="n">_class_name</span><span class="p">),</span> <span class="n">params</span>
<span class="p">)</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>
<div class="viewcode-block" id="Query.first"><a class="viewcode-back" href="../../index.html#leancloud.Query.first">[文档]</a> <span class="k">def</span> <span class="nf">first</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> 根据查询获取最多一个对象。</span>
<span class="sd"> :return: 查询结果</span>
<span class="sd"> :rtype: Object</span>
<span class="sd"> :raise: LeanCloudError</span>
<span class="sd"> """</span>
<span class="n">params</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">dump</span><span class="p">()</span>
<span class="n">params</span><span class="p">[</span><span class="s2">"limit"</span><span class="p">]</span> <span class="o">=</span> <span class="mi">1</span>
<span class="n">content</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_do_request</span><span class="p">(</span><span class="n">params</span><span class="p">)</span>
<span class="n">results</span> <span class="o">=</span> <span class="n">content</span><span class="p">[</span><span class="s2">"results"</span><span class="p">]</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">results</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">LeanCloudError</span><span class="p">(</span><span class="mi">101</span><span class="p">,</span> <span class="s2">"Object not found"</span><span class="p">)</span>
<span class="n">obj</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_new_object</span><span class="p">()</span>
<span class="n">obj</span><span class="o">.</span><span class="n">_update_data</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_process_result</span><span class="p">(</span><span class="n">results</span><span class="p">[</span><span class="mi">0</span><span class="p">]))</span>
<span class="k">return</span> <span class="n">obj</span></div>
<div class="viewcode-block" id="Query.get"><a class="viewcode-back" href="../../index.html#leancloud.Query.get">[文档]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">object_id</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> 根据 objectId 查询。</span>
<span class="sd"> :param object_id: 要查询对象的 objectId</span>
<span class="sd"> :return: 查询结果</span>
<span class="sd"> :rtype: Object</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">object_id</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">LeanCloudError</span><span class="p">(</span><span class="n">code</span><span class="o">=</span><span class="mi">101</span><span class="p">,</span> <span class="n">error</span><span class="o">=</span><span class="s2">"Object not found."</span><span class="p">)</span>
<span class="n">obj</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_query_class</span><span class="o">.</span><span class="n">create_without_data</span><span class="p">(</span><span class="n">object_id</span><span class="p">)</span>
<span class="n">obj</span><span class="o">.</span><span class="n">fetch</span><span class="p">(</span><span class="n">select</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_select</span><span class="p">,</span> <span class="n">include</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_include</span><span class="p">)</span>
<span class="k">return</span> <span class="n">obj</span></div>
<div class="viewcode-block" id="Query.find"><a class="viewcode-back" href="../../index.html#leancloud.Query.find">[文档]</a> <span class="k">def</span> <span class="nf">find</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> 根据查询条件，获取包含所有满足条件的对象。</span>
<span class="sd"> :rtype: list</span>
<span class="sd"> """</span>
<span class="n">content</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_do_request</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">dump</span><span class="p">())</span>
<span class="n">objs</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">result</span> <span class="ow">in</span> <span class="n">content</span><span class="p">[</span><span class="s2">"results"</span><span class="p">]:</span>
<span class="n">obj</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_new_object</span><span class="p">()</span>
<span class="n">obj</span><span class="o">.</span><span class="n">_update_data</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_process_result</span><span class="p">(</span><span class="n">result</span><span class="p">))</span>
<span class="n">objs</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">obj</span><span class="p">)</span>
<span class="k">return</span> <span class="n">objs</span></div>
<div class="viewcode-block" id="Query.scan"><a class="viewcode-back" href="../../index.html#leancloud.Query.scan">[文档]</a> <span class="k">def</span> <span class="nf">scan</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">batch_size</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">scan_key</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="n">params</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">dump</span><span class="p">()</span>
<span class="k">if</span> <span class="s2">"skip"</span> <span class="ow">in</span> <span class="n">params</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">LeanCloudError</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="s2">"Query.scan dose not support skip option"</span><span class="p">)</span>
<span class="k">if</span> <span class="s2">"limit"</span> <span class="ow">in</span> <span class="n">params</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">LeanCloudError</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="s2">"Query.scan dose not support limit option"</span><span class="p">)</span>
<span class="k">return</span> <span class="n">Cursor</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_query_class</span><span class="p">,</span> <span class="n">batch_size</span><span class="p">,</span> <span class="n">scan_key</span><span class="p">,</span> <span class="n">params</span><span class="p">)</span></div>
<div class="viewcode-block" id="Query.count"><a class="viewcode-back" href="../../index.html#leancloud.Query.count">[文档]</a> <span class="k">def</span> <span class="nf">count</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> 返回满足查询条件的对象的数量。</span>
<span class="sd"> :rtype: int</span>
<span class="sd"> """</span>
<span class="n">params</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">dump</span><span class="p">()</span>
<span class="n">params</span><span class="p">[</span><span class="s2">"limit"</span><span class="p">]</span> <span class="o">=</span> <span class="mi">0</span>
<span class="n">params</span><span class="p">[</span><span class="s2">"count"</span><span class="p">]</span> <span class="o">=</span> <span class="mi">1</span>
<span class="n">content</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_do_request</span><span class="p">(</span><span class="n">params</span><span class="p">)</span>
<span class="k">return</span> <span class="n">content</span><span class="p">[</span><span class="s2">"count"</span><span class="p">]</span></div>
<div class="viewcode-block" id="Query.skip"><a class="viewcode-back" href="../../index.html#leancloud.Query.skip">[文档]</a> <span class="k">def</span> <span class="nf">skip</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">n</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> 查询条件中跳过指定个数的对象，在做分页时很有帮助。</span>
<span class="sd"> :param n: 需要跳过对象的个数</span>
<span class="sd"> :rtype: Query</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_skip</span> <span class="o">=</span> <span class="n">n</span>
<span class="k">return</span> <span class="bp">self</span></div>
<div class="viewcode-block" id="Query.limit"><a class="viewcode-back" href="../../index.html#leancloud.Query.limit">[文档]</a> <span class="k">def</span> <span class="nf">limit</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">n</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> 设置查询返回结果的数量。如果不设置，默认为 100。最大返回数量为 1000，如果超过这个数量，需要使用多次查询来获取结果。</span>
<span class="sd"> :param n: 限制结果的数量</span>
<span class="sd"> :rtype: Query</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">n</span> <span class="o">></span> <span class="mi">1000</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"limit only accept number less than or equal to 1000"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_limit</span> <span class="o">=</span> <span class="n">n</span>
<span class="k">return</span> <span class="bp">self</span></div>
<div class="viewcode-block" id="Query.include_acl"><a class="viewcode-back" href="../../index.html#leancloud.Query.include_acl">[文档]</a> <span class="k">def</span> <span class="nf">include_acl</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> 设置查询结果的对象，是否包含 ACL 字段。需要在控制台选项中开启对应选项才能生效。</span>
<span class="sd"> :param value: 是否包含 ACL，默认为 True</span>
<span class="sd"> :type value: bool</span>
<span class="sd"> :rtype: Query</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_include_acl</span> <span class="o">=</span> <span class="n">value</span>
<span class="k">return</span> <span class="bp">self</span></div>
<div class="viewcode-block" id="Query.equal_to"><a class="viewcode-back" href="../../index.html#leancloud.Query.equal_to">[文档]</a> <span class="k">def</span> <span class="nf">equal_to</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> 增加查询条件，查询字段的值必须为指定值。</span>
<span class="sd"> :param key: 查询条件的字段名</span>
<span class="sd"> :param value: 查询条件的值</span>
<span class="sd"> :rtype: Query</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_where</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">utils</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span></div>
<div class="viewcode-block" id="Query.size_equal_to"><a class="viewcode-back" href="../../index.html#leancloud.Query.size_equal_to">[文档]</a> <span class="k">def</span> <span class="nf">size_equal_to</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">size</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> 增加查询条件，限制查询结果指定数组字段长度与查询值相同</span>
<span class="sd"> :param key: 查询条件数组字段名</span>
<span class="sd"> :param size: 查询条件值</span>
<span class="sd"> :rtype: Query</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_add_condition</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="s2">"$size"</span><span class="p">,</span> <span class="n">size</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span></div>
<span class="k">def</span> <span class="nf">_add_condition</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">condition</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_where</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">key</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_where</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="p">{}</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_where</span><span class="p">[</span><span class="n">key</span><span class="p">][</span><span class="n">condition</span><span class="p">]</span> <span class="o">=</span> <span class="n">utils</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span>
<div class="viewcode-block" id="Query.not_equal_to"><a class="viewcode-back" href="../../index.html#leancloud.Query.not_equal_to">[文档]</a> <span class="k">def</span> <span class="nf">not_equal_to</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> 增加查询条件，限制查询结果指定字段的值与查询值不同</span>
<span class="sd"> :param key: 查询条件字段名</span>
<span class="sd"> :param value: 查询条件值</span>
<span class="sd"> :rtype: Query</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_add_condition</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="s2">"$ne"</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span></div>
<div class="viewcode-block" id="Query.less_than"><a class="viewcode-back" href="../../index.html#leancloud.Query.less_than">[文档]</a> <span class="k">def</span> <span class="nf">less_than</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> 增加查询条件，限制查询结果指定字段的值小于查询值</span>
<span class="sd"> :param key: 查询条件字段名</span>
<span class="sd"> :param value: 查询条件值</span>
<span class="sd"> :rtype: Query</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_add_condition</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="s2">"$lt"</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span></div>
<div class="viewcode-block" id="Query.greater_than"><a class="viewcode-back" href="../../index.html#leancloud.Query.greater_than">[文档]</a> <span class="k">def</span> <span class="nf">greater_than</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> 增加查询条件，限制查询结果指定字段的值大于查询值</span>
<span class="sd"> :param key: 查询条件字段名</span>
<span class="sd"> :param value: 查询条件值</span>
<span class="sd"> :rtype: Query</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_add_condition</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="s2">"$gt"</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span></div>
<div class="viewcode-block" id="Query.less_than_or_equal_to"><a class="viewcode-back" href="../../index.html#leancloud.Query.less_than_or_equal_to">[文档]</a> <span class="k">def</span> <span class="nf">less_than_or_equal_to</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> 增加查询条件，限制查询结果指定字段的值小于等于查询值</span>
<span class="sd"> :param key: 查询条件字段名</span>
<span class="sd"> :param value: 查询条件值</span>
<span class="sd"> :rtype: Query</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_add_condition</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="s2">"$lte"</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span></div>
<div class="viewcode-block" id="Query.greater_than_or_equal_to"><a class="viewcode-back" href="../../index.html#leancloud.Query.greater_than_or_equal_to">[文档]</a> <span class="k">def</span> <span class="nf">greater_than_or_equal_to</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> 增加查询条件，限制查询结果指定字段的值大于等于查询值</span>
<span class="sd"> :param key: 查询条件字段名</span>
<span class="sd"> :param value: 查询条件值名</span>
<span class="sd"> :rtype: Query</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_add_condition</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="s2">"$gte"</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span></div>
<div class="viewcode-block" id="Query.contained_in"><a class="viewcode-back" href="../../index.html#leancloud.Query.contained_in">[文档]</a> <span class="k">def</span> <span class="nf">contained_in</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">values</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> 增加查询条件，限制查询结果指定字段的值在查询值列表中</span>
<span class="sd"> :param key: 查询条件字段名</span>
<span class="sd"> :param values: 查询条件值</span>
<span class="sd"> :type values: list or tuple</span>
<span class="sd"> :rtype: Query</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_add_condition</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="s2">"$in"</span><span class="p">,</span> <span class="n">values</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span></div>
<div class="viewcode-block" id="Query.not_contained_in"><a class="viewcode-back" href="../../index.html#leancloud.Query.not_contained_in">[文档]</a> <span class="k">def</span> <span class="nf">not_contained_in</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">values</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> 增加查询条件，限制查询结果指定字段的值不在查询值列表中</span>
<span class="sd"> :param key: 查询条件字段名</span>
<span class="sd"> :param values: 查询条件值</span>
<span class="sd"> :type values: list or tuple</span>
<span class="sd"> :rtype: Query</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_add_condition</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="s2">"$nin"</span><span class="p">,</span> <span class="n">values</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span></div>
<div class="viewcode-block" id="Query.contains_all"><a class="viewcode-back" href="../../index.html#leancloud.Query.contains_all">[文档]</a> <span class="k">def</span> <span class="nf">contains_all</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">values</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> 增加查询条件，限制查询结果指定字段的值全部包含与查询值列表中</span>
<span class="sd"> :param key: 查询条件字段名</span>
<span class="sd"> :param values: 查询条件值</span>
<span class="sd"> :type values: list or tuple</span>
<span class="sd"> :rtype: Query</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_add_condition</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="s2">"$all"</span><span class="p">,</span> <span class="n">values</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span></div>
<div class="viewcode-block" id="Query.exists"><a class="viewcode-back" href="../../index.html#leancloud.Query.exists">[文档]</a> <span class="k">def</span> <span class="nf">exists</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> 增加查询条件，限制查询结果对象包含指定字段</span>
<span class="sd"> :param key: 查询条件字段名</span>
<span class="sd"> :rtype: Query</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_add_condition</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="s2">"$exists"</span><span class="p">,</span> <span class="kc">True</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span></div>
<div class="viewcode-block" id="Query.does_not_exist"><a class="viewcode-back" href="../../index.html#leancloud.Query.does_not_exist">[文档]</a> <span class="k">def</span> <span class="nf">does_not_exist</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> 增加查询条件，限制查询结果对象不包含指定字段</span>
<span class="sd"> :param key: 查询条件字段名</span>
<span class="sd"> :rtype: Query</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_add_condition</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="s2">"$exists"</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span></div>
<div class="viewcode-block" id="Query.matched"><a class="viewcode-back" href="../../index.html#leancloud.Query.matched">[文档]</a> <span class="k">def</span> <span class="nf">matched</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">regex</span><span class="p">,</span> <span class="n">ignore_case</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">multi_line</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> 增加查询条件，限制查询结果对象指定字段满足指定的正则表达式。</span>
<span class="sd"> :param key: 查询条件字段名</span>
<span class="sd"> :param regex: 查询正则表达式</span>
<span class="sd"> :param ignore_case: 查询是否忽略大小写，默认不忽略</span>
<span class="sd"> :param multi_line: 查询是否匹配多行，默认不匹配</span>
<span class="sd"> :rtype: Query</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">regex</span><span class="p">,</span> <span class="n">six</span><span class="o">.</span><span class="n">string_types</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">"matched only accept str or unicode"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_add_condition</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="s2">"$regex"</span><span class="p">,</span> <span class="n">regex</span><span class="p">)</span>
<span class="n">modifiers</span> <span class="o">=</span> <span class="s2">""</span>
<span class="k">if</span> <span class="n">ignore_case</span><span class="p">:</span>
<span class="n">modifiers</span> <span class="o">+=</span> <span class="s2">"i"</span>
<span class="k">if</span> <span class="n">multi_line</span><span class="p">:</span>
<span class="n">modifiers</span> <span class="o">+=</span> <span class="s2">"m"</span>
<span class="k">if</span> <span class="n">modifiers</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_add_condition</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="s2">"$options"</span><span class="p">,</span> <span class="n">modifiers</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span></div>
<div class="viewcode-block" id="Query.matches_query"><a class="viewcode-back" href="../../index.html#leancloud.Query.matches_query">[文档]</a> <span class="k">def</span> <span class="nf">matches_query</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">query</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> 增加查询条件，限制查询结果对象指定字段的值，与另外一个查询对象的返回结果相同。</span>
<span class="sd"> :param key: 查询条件字段名</span>
<span class="sd"> :param query: 查询对象</span>
<span class="sd"> :type query: Query</span>
<span class="sd"> :rtype: Query</span>
<span class="sd"> """</span>
<span class="n">dumped</span> <span class="o">=</span> <span class="n">query</span><span class="o">.</span><span class="n">dump</span><span class="p">()</span>
<span class="n">dumped</span><span class="p">[</span><span class="s2">"className"</span><span class="p">]</span> <span class="o">=</span> <span class="n">query</span><span class="o">.</span><span class="n">_query_class</span><span class="o">.</span><span class="n">_class_name</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_add_condition</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="s2">"$inQuery"</span><span class="p">,</span> <span class="n">dumped</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span></div>
<div class="viewcode-block" id="Query.does_not_match_query"><a class="viewcode-back" href="../../index.html#leancloud.Query.does_not_match_query">[文档]</a> <span class="k">def</span> <span class="nf">does_not_match_query</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">query</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> 增加查询条件，限制查询结果对象指定字段的值，与另外一个查询对象的返回结果不相同。</span>
<span class="sd"> :param key: 查询条件字段名</span>
<span class="sd"> :param query: 查询对象</span>
<span class="sd"> :type query: Query</span>
<span class="sd"> :rtype: Query</span>
<span class="sd"> """</span>
<span class="n">dumped</span> <span class="o">=</span> <span class="n">query</span><span class="o">.</span><span class="n">dump</span><span class="p">()</span>
<span class="n">dumped</span><span class="p">[</span><span class="s2">"className"</span><span class="p">]</span> <span class="o">=</span> <span class="n">query</span><span class="o">.</span><span class="n">_query_class</span><span class="o">.</span><span class="n">_class_name</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_add_condition</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="s2">"$notInQuery"</span><span class="p">,</span> <span class="n">dumped</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span></div>
<div class="viewcode-block" id="Query.matches_key_in_query"><a class="viewcode-back" href="../../index.html#leancloud.Query.matches_key_in_query">[文档]</a> <span class="k">def</span> <span class="nf">matches_key_in_query</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">query_key</span><span class="p">,</span> <span class="n">query</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> 增加查询条件，限制查询结果对象指定字段的值，与另外一个查询对象的返回结果指定的值相同。</span>
<span class="sd"> :param key: 查询条件字段名</span>
<span class="sd"> :param query_key: 查询对象返回结果的字段名</span>
<span class="sd"> :param query: 查询对象</span>
<span class="sd"> :type query: Query</span>
<span class="sd"> :rtype: Query</span>
<span class="sd"> """</span>
<span class="n">dumped</span> <span class="o">=</span> <span class="n">query</span><span class="o">.</span><span class="n">dump</span><span class="p">()</span>
<span class="n">dumped</span><span class="p">[</span><span class="s2">"className"</span><span class="p">]</span> <span class="o">=</span> <span class="n">query</span><span class="o">.</span><span class="n">_query_class</span><span class="o">.</span><span class="n">_class_name</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_add_condition</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="s2">"$select"</span><span class="p">,</span> <span class="p">{</span><span class="s2">"key"</span><span class="p">:</span> <span class="n">query_key</span><span class="p">,</span> <span class="s2">"query"</span><span class="p">:</span> <span class="n">dumped</span><span class="p">})</span>
<span class="k">return</span> <span class="bp">self</span></div>
<div class="viewcode-block" id="Query.does_not_match_key_in_query"><a class="viewcode-back" href="../../index.html#leancloud.Query.does_not_match_key_in_query">[文档]</a> <span class="k">def</span> <span class="nf">does_not_match_key_in_query</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">query_key</span><span class="p">,</span> <span class="n">query</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> 增加查询条件，限制查询结果对象指定字段的值，与另外一个查询对象的返回结果指定的值不相同。</span>
<span class="sd"> :param key: 查询条件字段名</span>
<span class="sd"> :param query_key: 查询对象返回结果的字段名</span>
<span class="sd"> :param query: 查询对象</span>
<span class="sd"> :type query: Query</span>
<span class="sd"> :rtype: Query</span>
<span class="sd"> """</span>
<span class="n">dumped</span> <span class="o">=</span> <span class="n">query</span><span class="o">.</span><span class="n">dump</span><span class="p">()</span>
<span class="n">dumped</span><span class="p">[</span><span class="s2">"className"</span><span class="p">]</span> <span class="o">=</span> <span class="n">query</span><span class="o">.</span><span class="n">_query_class</span><span class="o">.</span><span class="n">_class_name</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_add_condition</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="s2">"$dontSelect"</span><span class="p">,</span> <span class="p">{</span><span class="s2">"key"</span><span class="p">:</span> <span class="n">query_key</span><span class="p">,</span> <span class="s2">"query"</span><span class="p">:</span> <span class="n">dumped</span><span class="p">})</span>
<span class="k">return</span> <span class="bp">self</span></div>
<span class="k">def</span> <span class="nf">_or_query</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">queries</span><span class="p">):</span>
<span class="n">dumped</span> <span class="o">=</span> <span class="p">[</span><span class="n">q</span><span class="o">.</span><span class="n">dump</span><span class="p">()[</span><span class="s2">"where"</span><span class="p">]</span> <span class="k">for</span> <span class="n">q</span> <span class="ow">in</span> <span class="n">queries</span><span class="p">]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_where</span><span class="p">[</span><span class="s2">"$or"</span><span class="p">]</span> <span class="o">=</span> <span class="n">dumped</span>
<span class="k">return</span> <span class="bp">self</span>
<span class="k">def</span> <span class="nf">_and_query</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">queries</span><span class="p">):</span>
<span class="n">dumped</span> <span class="o">=</span> <span class="p">[</span><span class="n">q</span><span class="o">.</span><span class="n">dump</span><span class="p">()[</span><span class="s2">"where"</span><span class="p">]</span> <span class="k">for</span> <span class="n">q</span> <span class="ow">in</span> <span class="n">queries</span><span class="p">]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_where</span><span class="p">[</span><span class="s2">"$and"</span><span class="p">]</span> <span class="o">=</span> <span class="n">dumped</span>
<span class="k">def</span> <span class="nf">_quote</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">s</span><span class="p">):</span>
<span class="c1"># return "\\Q" + s.replace("\\E", "\\E\\\\E\\Q") + "\\E"</span>
<span class="k">return</span> <span class="n">s</span>
<div class="viewcode-block" id="Query.contains"><a class="viewcode-back" href="../../index.html#leancloud.Query.contains">[文档]</a> <span class="k">def</span> <span class="nf">contains</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> 增加查询条件，限制查询结果对象指定最短的值，包含指定字符串。在数据量比较大的情况下会比较慢。</span>
<span class="sd"> :param key: 查询条件字段名</span>
<span class="sd"> :param value: 需要包含的字符串</span>
<span class="sd"> :rtype: Query</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_add_condition</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="s2">"$regex"</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_quote</span><span class="p">(</span><span class="n">value</span><span class="p">))</span>
<span class="k">return</span> <span class="bp">self</span></div>
<div class="viewcode-block" id="Query.startswith"><a class="viewcode-back" href="../../index.html#leancloud.Query.startswith">[文档]</a> <span class="k">def</span> <span class="nf">startswith</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> 增加查询条件，限制查询结果对象指定最短的值，以指定字符串开头。在数据量比较大的情况下会比较慢。</span>
<span class="sd"> :param key: 查询条件字段名</span>
<span class="sd"> :param value: 需要查询的字符串</span>
<span class="sd"> :rtype: Query</span>
<span class="sd"> """</span>
<span class="n">value</span> <span class="o">=</span> <span class="n">value</span> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">six</span><span class="o">.</span><span class="n">text_type</span><span class="p">)</span> <span class="k">else</span> <span class="n">value</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s2">"utf-8"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_add_condition</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="s2">"$regex"</span><span class="p">,</span> <span class="s2">"^"</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">_quote</span><span class="p">(</span><span class="n">value</span><span class="p">))</span>
<span class="k">return</span> <span class="bp">self</span></div>
<div class="viewcode-block" id="Query.endswith"><a class="viewcode-back" href="../../index.html#leancloud.Query.endswith">[文档]</a> <span class="k">def</span> <span class="nf">endswith</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> 增加查询条件，限制查询结果对象指定最短的值，以指定字符串结尾。在数据量比较大的情况下会比较慢。</span>
<span class="sd"> :param key: 查询条件字段名</span>
<span class="sd"> :param value: 需要查询的字符串</span>
<span class="sd"> :rtype: Query</span>
<span class="sd"> """</span>
<span class="n">value</span> <span class="o">=</span> <span class="n">value</span> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">six</span><span class="o">.</span><span class="n">text_type</span><span class="p">)</span> <span class="k">else</span> <span class="n">value</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s2">"utf-8"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_add_condition</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="s2">"$regex"</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_quote</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> <span class="o">+</span> <span class="s2">"$"</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span></div>
<div class="viewcode-block" id="Query.ascending"><a class="viewcode-back" href="../../index.html#leancloud.Query.ascending">[文档]</a> <span class="k">def</span> <span class="nf">ascending</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> 限制查询返回结果以指定字段升序排序。</span>
<span class="sd"> :param key: 排序字段名</span>
<span class="sd"> :rtype: Query</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_order</span> <span class="o">=</span> <span class="p">[</span><span class="n">key</span><span class="p">]</span>
<span class="k">return</span> <span class="bp">self</span></div>
<div class="viewcode-block" id="Query.add_ascending"><a class="viewcode-back" href="../../index.html#leancloud.Query.add_ascending">[文档]</a> <span class="k">def</span> <span class="nf">add_ascending</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> 增加查询排序条件。之前指定的排序条件优先级更高。</span>
<span class="sd"> :param key: 排序字段名</span>
<span class="sd"> :rtype: Query</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_order</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">key</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span></div>
<div class="viewcode-block" id="Query.descending"><a class="viewcode-back" href="../../index.html#leancloud.Query.descending">[文档]</a> <span class="k">def</span> <span class="nf">descending</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> 限制查询返回结果以指定字段降序排序。</span>
<span class="sd"> :param key: 排序字段名</span>
<span class="sd"> :rtype: Query</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_order</span> <span class="o">=</span> <span class="p">[</span><span class="s2">"-</span><span class="si">{0}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">key</span><span class="p">)]</span>
<span class="k">return</span> <span class="bp">self</span></div>
<div class="viewcode-block" id="Query.add_descending"><a class="viewcode-back" href="../../index.html#leancloud.Query.add_descending">[文档]</a> <span class="k">def</span> <span class="nf">add_descending</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> 增加查询排序条件。之前指定的排序条件优先级更高。</span>
<span class="sd"> :param key: 排序字段名</span>
<span class="sd"> :rtype: Query</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_order</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">"-</span><span class="si">{0}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">key</span><span class="p">))</span>
<span class="k">return</span> <span class="bp">self</span></div>
<div class="viewcode-block" id="Query.near"><a class="viewcode-back" href="../../index.html#leancloud.Query.near">[文档]</a> <span class="k">def</span> <span class="nf">near</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">point</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> 增加查询条件，限制返回结果指定字段值的位置与给定地理位置临近。</span>
<span class="sd"> :param key: 查询条件字段名</span>
<span class="sd"> :param point: 需要查询的地理位置</span>
<span class="sd"> :rtype: Query</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">point</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"near query does not accept None"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_add_condition</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="s2">"$nearSphere"</span><span class="p">,</span> <span class="n">point</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span></div>
<div class="viewcode-block" id="Query.within_radians"><a class="viewcode-back" href="../../index.html#leancloud.Query.within_radians">[文档]</a> <span class="k">def</span> <span class="nf">within_radians</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">point</span><span class="p">,</span> <span class="n">max_distance</span><span class="p">,</span> <span class="n">min_distance</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> 增加查询条件，限制返回结果指定字段值的位置在某点的一段距离之内。</span>
<span class="sd"> :param key: 查询条件字段名</span>
<span class="sd"> :param point: 查询地理位置</span>
<span class="sd"> :param max_distance: 最大距离限定（弧度）</span>
<span class="sd"> :param min_distance: 最小距离限定（弧度）</span>
<span class="sd"> :rtype: Query</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">near</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">point</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_add_condition</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="s2">"$maxDistance"</span><span class="p">,</span> <span class="n">max_distance</span><span class="p">)</span>
<span class="k">if</span> <span class="n">min_distance</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_add_condition</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="s2">"$minDistance"</span><span class="p">,</span> <span class="n">min_distance</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span></div>
<div class="viewcode-block" id="Query.within_miles"><a class="viewcode-back" href="../../index.html#leancloud.Query.within_miles">[文档]</a> <span class="k">def</span> <span class="nf">within_miles</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">point</span><span class="p">,</span> <span class="n">max_distance</span><span class="p">,</span> <span class="n">min_distance</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> 增加查询条件，限制返回结果指定字段值的位置在某点的一段距离之内。</span>
<span class="sd"> :param key: 查询条件字段名</span>
<span class="sd"> :param point: 查询地理位置</span>
<span class="sd"> :param max_distance: 最大距离限定（英里）</span>
<span class="sd"> :param min_distance: 最小距离限定（英里）</span>
<span class="sd"> :rtype: Query</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">min_distance</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">min_distance</span> <span class="o">=</span> <span class="n">min_distance</span> <span class="o">/</span> <span class="mf">3958.8</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">within_radians</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">point</span><span class="p">,</span> <span class="n">max_distance</span> <span class="o">/</span> <span class="mf">3958.8</span><span class="p">,</span> <span class="n">min_distance</span><span class="p">)</span></div>
<div class="viewcode-block" id="Query.within_kilometers"><a class="viewcode-back" href="../../index.html#leancloud.Query.within_kilometers">[文档]</a> <span class="k">def</span> <span class="nf">within_kilometers</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">point</span><span class="p">,</span> <span class="n">max_distance</span><span class="p">,</span> <span class="n">min_distance</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> 增加查询条件，限制返回结果指定字段值的位置在某点的一段距离之内。</span>
<span class="sd"> :param key: 查询条件字段名</span>
<span class="sd"> :param point: 查询地理位置</span>
<span class="sd"> :param max_distance: 最大距离限定（千米）</span>
<span class="sd"> :param min_distance: 最小距离限定（千米）</span>
<span class="sd"> :rtype: Query</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">min_distance</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">min_distance</span> <span class="o">=</span> <span class="n">min_distance</span> <span class="o">/</span> <span class="mf">6371.0</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">within_radians</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">point</span><span class="p">,</span> <span class="n">max_distance</span> <span class="o">/</span> <span class="mf">6371.0</span><span class="p">,</span> <span class="n">min_distance</span><span class="p">)</span></div>
<div class="viewcode-block" id="Query.within_geo_box"><a class="viewcode-back" href="../../index.html#leancloud.Query.within_geo_box">[文档]</a> <span class="k">def</span> <span class="nf">within_geo_box</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">southwest</span><span class="p">,</span> <span class="n">northeast</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> 增加查询条件，限制返回结果指定字段值的位置在指定坐标范围之内。</span>
<span class="sd"> :param key: 查询条件字段名</span>
<span class="sd"> :param southwest: 限制范围西南角坐标</span>
<span class="sd"> :param northeast: 限制范围东北角坐标</span>
<span class="sd"> :rtype: Query</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_add_condition</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="s2">"$within"</span><span class="p">,</span> <span class="p">{</span><span class="s2">"$box"</span><span class="p">:</span> <span class="p">[</span><span class="n">southwest</span><span class="p">,</span> <span class="n">northeast</span><span class="p">]})</span>
<span class="k">return</span> <span class="bp">self</span></div>
<div class="viewcode-block" id="Query.include"><a class="viewcode-back" href="../../index.html#leancloud.Query.include">[文档]</a> <span class="k">def</span> <span class="nf">include</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">keys</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> 指定查询返回结果中包含关联表字段。</span>
<span class="sd"> :param keys: 关联子表字段名</span>
<span class="sd"> :rtype: Query</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">keys</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span> <span class="ow">and</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">keys</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="p">(</span><span class="nb">list</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">)):</span>
<span class="n">keys</span> <span class="o">=</span> <span class="n">keys</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_include</span> <span class="o">+=</span> <span class="n">keys</span>
<span class="k">return</span> <span class="bp">self</span></div>
<div class="viewcode-block" id="Query.select"><a class="viewcode-back" href="../../index.html#leancloud.Query.select">[文档]</a> <span class="k">def</span> <span class="nf">select</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">keys</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> 指定查询返回结果中只包含某些字段。可以重复调用，每次调用的包含内容都将会被返回。</span>
<span class="sd"> :param keys: 包含字段名</span>
<span class="sd"> :rtype: Query</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">keys</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span> <span class="ow">and</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">keys</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="p">(</span><span class="nb">list</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">)):</span>
<span class="n">keys</span> <span class="o">=</span> <span class="n">keys</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_select</span> <span class="o">+=</span> <span class="n">keys</span>
<span class="k">return</span> <span class="bp">self</span></div></div>
<div class="viewcode-block" id="FriendshipQuery"><a class="viewcode-back" href="../../index.html#leancloud.FriendshipQuery">[文档]</a><span class="k">class</span> <span class="nc">FriendshipQuery</span><span class="p">(</span><span class="n">Query</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">query_class</span><span class="p">):</span>
<span class="nb">super</span><span class="p">(</span><span class="n">FriendshipQuery</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">query_class</span><span class="p">)</span>
<span class="k">if</span> <span class="n">query_class</span> <span class="ow">in</span> <span class="p">(</span><span class="s2">"_Follower"</span><span class="p">,</span> <span class="s2">"Follower"</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_friendship_tag</span> <span class="o">=</span> <span class="s2">"follower"</span>
<span class="k">elif</span> <span class="n">query_class</span> <span class="ow">in</span> <span class="p">(</span><span class="s2">"_Followee"</span><span class="p">,</span> <span class="s2">"Followee"</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_friendship_tag</span> <span class="o">=</span> <span class="s2">"followee"</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">"FriendshipQuery takes only follower or followee"</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_new_object</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="n">leancloud</span><span class="o">.</span><span class="n">User</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">_process_result</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">obj</span><span class="p">):</span>
<span class="n">content</span> <span class="o">=</span> <span class="n">obj</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">_friendship_tag</span><span class="p">]</span>
<span class="k">if</span> <span class="n">content</span><span class="p">[</span><span class="s2">"__type"</span><span class="p">]</span> <span class="o">==</span> <span class="s2">"Pointer"</span> <span class="ow">and</span> <span class="n">content</span><span class="p">[</span><span class="s2">"className"</span><span class="p">]</span> <span class="o">==</span> <span class="s2">"_User"</span><span class="p">:</span>
<span class="k">del</span> <span class="n">content</span><span class="p">[</span><span class="s2">"__type"</span><span class="p">]</span>
<span class="k">del</span> <span class="n">content</span><span class="p">[</span><span class="s2">"className"</span><span class="p">]</span>
<span class="k">return</span> <span class="n">content</span></div>
</pre></div>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>
© 版权所有 2015, asaka.
</p>
</div>
利用 <a href="https://www.sphinx-doc.org/">Sphinx</a> 构建，使用了
<a href="https://github.com/readthedocs/sphinx_rtd_theme">主题</a>
由 <a href="https://readthedocs.org">Read the Docs</a>开发.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>