-
Notifications
You must be signed in to change notification settings - Fork 37
Expand file tree
/
Copy pathrelation.html
More file actions
191 lines (160 loc) · 16.1 KB
/
relation.html
File metadata and controls
191 lines (160 loc) · 16.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
<!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.relation — LeanCloud-Python-SDK 2.6.1 文档</title>
<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 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 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="Navigation menu">
<!-- 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="Mobile navigation menu" >
<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="Page 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.relation</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.relation 源代码</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="kn">import</span> <span class="n">absolute_import</span>
<span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">division</span>
<span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">print_function</span>
<span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">unicode_literals</span>
<span class="kn">import</span> <span class="nn">leancloud</span>
<span class="kn">from</span> <span class="nn">leancloud</span> <span class="kn">import</span> <span class="n">operation</span>
<span class="n">__author__</span> <span class="o">=</span> <span class="s2">"asaka <[email protected]>"</span>
<div class="viewcode-block" id="Relation"><a class="viewcode-back" href="../../index.html#leancloud.Relation">[文档]</a><span class="k">class</span> <span class="nc">Relation</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">parent</span><span class="p">,</span> <span class="n">key</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">parent</span> <span class="o">=</span> <span class="n">parent</span>
<span class="bp">self</span><span class="o">.</span><span class="n">key</span> <span class="o">=</span> <span class="n">key</span>
<span class="bp">self</span><span class="o">.</span><span class="n">target_class_name</span> <span class="o">=</span> <span class="kc">None</span>
<div class="viewcode-block" id="Relation.reverse_query"><a class="viewcode-back" href="../../index.html#leancloud.Relation.reverse_query">[文档]</a> <span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">reverse_query</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">parent_class</span><span class="p">,</span> <span class="n">relation_key</span><span class="p">,</span> <span class="n">child</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> 创建一个新的 Query 对象,反向查询所有指向此 Relation 的父对象。</span>
<span class="sd"> :param parent_class: 父类名称</span>
<span class="sd"> :param relation_key: 父类中 Relation 的字段名</span>
<span class="sd"> :param child: 子类对象</span>
<span class="sd"> :return: leancloud.Query</span>
<span class="sd"> """</span>
<span class="n">q</span> <span class="o">=</span> <span class="n">leancloud</span><span class="o">.</span><span class="n">Query</span><span class="p">(</span><span class="n">parent_class</span><span class="p">)</span>
<span class="n">q</span><span class="o">.</span><span class="n">equal_to</span><span class="p">(</span><span class="n">relation_key</span><span class="p">,</span> <span class="n">child</span><span class="o">.</span><span class="n">_to_pointer</span><span class="p">())</span>
<span class="k">return</span> <span class="n">q</span></div>
<span class="k">def</span> <span class="nf">_ensure_parent_and_key</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">parent</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">key</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">parent</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">parent</span> <span class="o">=</span> <span class="n">parent</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">key</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">key</span> <span class="o">=</span> <span class="n">key</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">parent</span> <span class="o">!=</span> <span class="n">parent</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">"relation retrieved from two different object"</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">key</span> <span class="o">!=</span> <span class="n">key</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">"relation retrieved from two different object"</span><span class="p">)</span>
<div class="viewcode-block" id="Relation.add"><a class="viewcode-back" href="../../index.html#leancloud.Relation.add">[文档]</a> <span class="k">def</span> <span class="nf">add</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">obj_or_objs</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> 添加一个新的 leancloud.Object 至 Relation。</span>
<span class="sd"> :param obj_or_objs: 需要添加的对象或对象列表</span>
<span class="sd"> """</span>
<span class="n">objs</span> <span class="o">=</span> <span class="n">obj_or_objs</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">obj_or_objs</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">objs</span> <span class="o">=</span> <span class="p">(</span><span class="n">obj_or_objs</span><span class="p">,)</span>
<span class="n">change</span> <span class="o">=</span> <span class="n">operation</span><span class="o">.</span><span class="n">Relation</span><span class="p">(</span><span class="n">objs</span><span class="p">,</span> <span class="p">())</span>
<span class="bp">self</span><span class="o">.</span><span class="n">parent</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">key</span><span class="p">,</span> <span class="n">change</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">target_class_name</span> <span class="o">=</span> <span class="n">change</span><span class="o">.</span><span class="n">_target_class_name</span></div>
<div class="viewcode-block" id="Relation.remove"><a class="viewcode-back" href="../../index.html#leancloud.Relation.remove">[文档]</a> <span class="k">def</span> <span class="nf">remove</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">obj_or_objs</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> 从一个 Relation 中删除一个 leancloud.Object 。</span>
<span class="sd"> :param obj_or_objs: 需要删除的对象或对象列表</span>
<span class="sd"> :return:</span>
<span class="sd"> """</span>
<span class="n">objs</span> <span class="o">=</span> <span class="n">obj_or_objs</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">obj_or_objs</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">objs</span> <span class="o">=</span> <span class="p">(</span><span class="n">obj_or_objs</span><span class="p">,)</span>
<span class="n">change</span> <span class="o">=</span> <span class="n">operation</span><span class="o">.</span><span class="n">Relation</span><span class="p">((),</span> <span class="n">objs</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">parent</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">key</span><span class="p">,</span> <span class="n">change</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">target_class_name</span> <span class="o">=</span> <span class="n">change</span><span class="o">.</span><span class="n">_target_class_name</span></div>
<div class="viewcode-block" id="Relation.dump"><a class="viewcode-back" href="../../index.html#leancloud.Relation.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="k">return</span> <span class="p">{</span><span class="s2">"__type"</span><span class="p">:</span> <span class="s2">"Relation"</span><span class="p">,</span> <span class="s2">"className"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">target_class_name</span><span class="p">}</span></div>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">query</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> 获取指向 Relation 内容的 Query 对象。</span>
<span class="sd"> :rtype: leancloud.Query</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">target_class_name</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">target_class</span> <span class="o">=</span> <span class="n">leancloud</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="bp">self</span><span class="o">.</span><span class="n">parent</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">leancloud</span><span class="o">.</span><span class="n">Query</span><span class="p">(</span><span class="n">target_class</span><span class="p">)</span>
<span class="n">query</span><span class="o">.</span><span class="n">_extra</span><span class="p">[</span><span class="s2">"redirectClassNameForKey"</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">key</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">target_class</span> <span class="o">=</span> <span class="n">leancloud</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="bp">self</span><span class="o">.</span><span class="n">target_class_name</span><span class="p">)</span>
<span class="n">query</span> <span class="o">=</span> <span class="n">leancloud</span><span class="o">.</span><span class="n">Query</span><span class="p">(</span><span class="n">target_class</span><span class="p">)</span>
<span class="n">query</span><span class="o">.</span><span class="n">_add_condition</span><span class="p">(</span><span class="s2">"$relatedTo"</span><span class="p">,</span> <span class="s2">"object"</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">parent</span><span class="o">.</span><span class="n">_to_pointer</span><span class="p">())</span>
<span class="n">query</span><span class="o">.</span><span class="n">_add_condition</span><span class="p">(</span><span class="s2">"$relatedTo"</span><span class="p">,</span> <span class="s2">"key"</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">key</span><span class="p">)</span>
<span class="k">return</span> <span class="n">query</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>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>