python-sdk/docs/_modules/leancloud/cloud.html at python-310 · leancloud/python-sdk

History

286 lines (236 loc) · 25.2 KB

Raw

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

<!DOCTYPE html>

<head>

<title>leancloud.cloud — LeanCloud-Python-SDK 2.6.1 文档</title>

<!--[if lt IE 9]>

<![endif]-->

</head>

<a href="../../index.html" class="icon icon-home"> LeanCloud-Python-SDK

</a>

2.6

</div>

</form>

</div>

</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">

</div>

</nav>

<a href="../../index.html">LeanCloud-Python-SDK</a>

</nav>

<li>leancloud.cloud</li>

</li>

</ul>

<hr/>

</div>

<h1>leancloud.cloud 源代码</h1><div class="highlight"><pre>

# coding: utf-8

from __future__ import absolute_import

from __future__ import division

from __future__ import print_function

from __future__ import unicode_literals

import six

import leancloud

from leancloud import utils

from leancloud.engine import leanengine

__author__ = "asaka <[email protected]>"

<div class="viewcode-block" id="run"><a class="viewcode-back" href="../../index.html#leancloud.cloud.run">[文档]</a>def run(_cloud_func_name, **params):

"""

调用 LeanEngine 上的远程代码

:param name: 需要调用的远程 Cloud Code 的名称

:type name: string_types

:param params: 调用参数

:return: 调用结果

"""

"/functions/{0}".format(_cloud_func_name), params=params

)

content = response.json()

return utils.decode(None, content)["result"]</div>

def _run_in_local(_cloud_func_name, **params):

if not leanengine.root_engine:

return

result = leanengine.dispatch_cloud_func(

leanengine.root_engine.app.cloud_codes, {}, _cloud_func_name, False, params

)

run.remote = run

run.local = _run_in_local

<div class="viewcode-block" id="rpc"><a class="viewcode-back" href="../../index.html#leancloud.cloud.rpc">[文档]</a>def rpc(_cloud_rpc_name, **params):

"""

调用 LeanEngine 上的远程代码

与 cloud.run 类似，但是允许传入 leancloud.Object 作为参数，也允许传入 leancloud.Object 作为结果

:param name: 需要调用的远程 Cloud Code 的名称

:type name: basestring

:param params: 调用参数

:return: 调用结果

"""

encoded_params = {}

for key, value in params.items():

if isinstance(params, leancloud.Object):

encoded_params[key] = utils.encode(value._dump())

else:

"/call/{}".format(_cloud_rpc_name), params=encoded_params

)

content = response.json()

return utils.decode(None, content["result"])</div>

def _rpc_in_local(_cloud_rpc_name, **params):

if not leanengine.root_engine:

return

result = leanengine.dispatch_cloud_func(

leanengine.root_engine.app.cloud_codes, {}, _cloud_rpc_name, True, params

)

rpc.remote = rpc

rpc.local = _rpc_in_local

<div class="viewcode-block" id="request_sms_code"><a class="viewcode-back" href="../../index.html#leancloud.cloud.request_sms_code">[文档]</a>def request_sms_code(

phone_number,

idd="+86",

sms_type="sms",

validate_token=None,

template=None,

sign=None,

params=None,

):

"""

请求发送手机验证码

:param phone_number: 需要验证的手机号码

:param idd: 号码的所在地国家代码，默认为中国（+86）

:param sms_type: 验证码发送方式，'voice' 为语音，'sms' 为短信

:param template: 模版名称

:param sign: 短信签名名称

:return: None

"""

if not isinstance(phone_number, six.string_types):

raise TypeError("phone_number must be a string")

data = {

"mobilePhoneNumber": phone_number

if phone_number.startswith("+")

else idd + phone_number,

"smsType": sms_type,

}

if template is not None:

data["template"] = template

if sign is not None:

data["sign"] = sign

if validate_token is not None:

data["validate_token"] = validate_token

if params is not None:

data.update(params)

<div class="viewcode-block" id="verify_sms_code"><a class="viewcode-back" href="../../index.html#leancloud.cloud.verify_sms_code">[文档]</a>def verify_sms_code(phone_number, code):

"""

获取到手机验证码之后，验证验证码是否正确。如果验证失败，抛出异常。

:param phone_number: 需要验证的手机号码

:param code: 接受到的验证码

:return: None

"""

params = {

"mobilePhoneNumber": phone_number,

}

leancloud.client.post("/verifySmsCode/{0}".format(code), params=params)

return True</div>

<div class="viewcode-block" id="Captcha"><a class="viewcode-back" href="../../index.html#leancloud.cloud.Captcha">[文档]</a>class Captcha(object):

"""

表示图形验证码

"""

def __init__(self, token, url):

self.token = token

self.url = url

<div class="viewcode-block" id="Captcha.verify"><a class="viewcode-back" href="../../index.html#leancloud.cloud.Captcha.verify">[文档]</a> def verify(self, code):

"""

验证用户输入与图形验证码是否匹配

:params code: 用户填写的验证码

"""

return verify_captcha(code, self.token)</div></div>

<div class="viewcode-block" id="request_captcha"><a class="viewcode-back" href="../../index.html#leancloud.cloud.request_captcha">[文档]</a>def request_captcha(size=None, width=None, height=None, ttl=None):

"""

请求生成新的图形验证码

:return: Captcha

"""

params = {

"size": size,

"width": width,

"height": height,

"ttl": ttl,

}

params = {k: v for k, v in params.items() if v is not None}

response = leancloud.client.get("/requestCaptcha", params)

content = response.json()

return Captcha(content["captcha_token"], content["captcha_url"])</div>

<div class="viewcode-block" id="verify_captcha"><a class="viewcode-back" href="../../index.html#leancloud.cloud.verify_captcha">[文档]</a>def verify_captcha(code, token):

"""

验证用户输入与图形验证码是否匹配

:params code: 用户填写的验证码

:params token: 图形验证码对应的 token

:return: validate token

"""

params = {

"captcha_token": token,

"captcha_code": code,

}

response = leancloud.client.post("/verifyCaptcha", params)

return response.json()["validate_token"]</div>

<div class="viewcode-block" id="get_server_time"><a class="viewcode-back" href="../../index.html#leancloud.cloud.get_server_time">[文档]</a>def get_server_time():

return leancloud.client.get_server_time()</div>

</pre></div>

</div>

<hr/>

</div>

利用 <a href="https://www.sphinx-doc.org/">Sphinx</a> 构建，使用了

由 <a href="https://readthedocs.org">Read the Docs</a>开发.

</footer>

</div>

</section>

</div>

jQuery(function () {

SphinxRtdTheme.Navigation.enable(true);

});

</script>

</body>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

cloud.html

Latest commit

History

cloud.html

File metadata and controls