~certify-web-dev/twisted/certify-trunk

<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="twisted.spread.jelly.html" target="_top">no frames</a>]</font></td></tr>

</table></td>

</tr></table>

<h2 class="module">Module twisted.spread.jelly</h2>

<p>S-expression-based persistence of python objects.</p>

<p>Stability: semi-stable</p>

<p>Future Plans: Optimization. Lots of optimization. No semantic

breakages should be necessary, but if small tweaks are required to gain

acceptable large-scale performance then they will be made. Although Glyph

is the maintainer, Bruce Mitchener will be supervising most of the

optimization work here.</p>

<p>I do something very much like <code>Pickle</code>; however, pickle's

main goal seems to be efficiency (both in space and time); jelly's main

goals are security, human readability, and portability to other

environments.</p>

<p>This is how Jelly converts various objects to s-expressions:</p>

<p>Boolean: True --> ['boolean', 'true']</p>

<p>Integer: 1 --> 1</p>

<p>String: "hello" --> "hello"</p>

<p>Float: 2.3 --> 2.3</p>

<p>Dictionary: {'a' : 1, 'b' : 'c'} --> ['dictionary', ['b', 'c'],

['a', 1]]</p>

<p>Module: UserString --> ['module', 'UserString']</p>

<p>Class: UserString.UserString --> ['class', ['module',

'UserString'], 'UserString']</p>

<p>Function: string.join --> ['function', 'join', ['module',

'string']]</p>

<p>Instance: s is an instance of UserString.UserString, with a __dict__

{'data': 'hello'}: ["UserString.UserString", ['dictionary',

['data', 'hello']]]</p>

<p># ['instance', ['class', ['module', 'UserString'], 'UserString'],

['dictionary', ['data', 'hello']]]</p>

<p>Class Method: UserString.UserString.center: ['method', 'center',

['None'], ['class', ['module', 'UserString'], 'UserString']]</p>

Instance Method: s.center, where s is an instance of

UserString.UserString: ['method', 'center', ['instance', ['reference', 1,

['class', ['module', 'UserString'], 'UserString']], ['dictionary',

['data', 'd']]], ['dereference', 1]]

<hr/>

<p><b>Author:</b> <a href="mailto:glyph@twistedmatrix.com">Glyph Lefkowitz</a>

</p>

<th colspan="2">Classes</th></tr>

<b><a href="twisted.spread.jelly._Dummy.html"><code>_Dummy</code></a></b></td>

<td>(Internal) Dummy class, used for unserializing instances.</td></tr>

<b><a href="twisted.spread.jelly._Jellier.html"><code>_Jellier</code></a></b></td>

<td>(Internal) This class manages state for a call to jelly()</td></tr>

<b><a href="twisted.spread.jelly._Unjellier.html"><code>_Unjellier</code></a></b></td>

<b><a href="twisted.spread.jelly.DummySecurityOptions.html"><code>DummySecurityOptions</code></a></b></td>

100

<td>DummySecurityOptions() -> insecure security options Dummy security

101

options -- this class will allow anything.</td></tr>

102

103

<b><a href="twisted.spread.jelly.Jellyable.html"><code>Jellyable</code></a></b></td>

104

<td>Inherit from me to Jelly yourself directly with the `getStateFor'

105

convenience method.</td></tr>

106

107

<b><a href="twisted.spread.jelly.SecurityOptions.html"><code>SecurityOptions</code></a></b></td>

108

<td>This will by default disallow everything, except for 'none'.</td></tr>

109

110

<b><a href="twisted.spread.jelly.Unjellyable.html"><code>Unjellyable</code></a></b></td>

111

<td>Inherit from me to Unjelly yourself directly with the `setStateFor'

112

convenience method.</td></tr>

113

114

<b><a href="twisted.spread.jelly.Unpersistable.html"><code>Unpersistable</code></a></b></td>

115

<td>This is an instance of a class that comes back when something couldn't

116

be persisted.</td></tr>

117

</table><br />

118

119

120

121

122

123

<th colspan="2">Exceptions</th></tr>

124

125

<b><a href="twisted.spread.jelly.InsecureJelly.html"><code>InsecureJelly</code></a></b></td>

126

<td>This exception will be raised when a jelly is deemed `insecure';

127

e.g.</td></tr>

128

</table><br />

129

130

131

132

133

134

<th colspan="2">Function Summary</th></tr>

135

136

<td><code><a name="_maybeClass"></a><span class="summary-sig"><span class="summary-sig-name">_maybeClass</span>(<span class=summary-sig-arg>classnamep</span>)</span></code>

137

</td></tr>

138

139

<td><code><span class="summary-sig"><a href="twisted.spread.jelly.html#getInstanceState" class="summary-sig-name"><code>getInstanceState</code></a>(<span class=summary-sig-arg>inst</span>,

140

<span class=summary-sig-arg>jellier</span>)</span></code>

141

<br />

142

Utility method to default to 'normal' state rules in

143

serialization.</td></tr>

144

145

<td><code><span class="summary-sig"><a href="twisted.spread.jelly.html#jelly" class="summary-sig-name"><code>jelly</code></a>(<span class=summary-sig-arg>object</span>,

146

<span class=summary-sig-arg>taster</span>,

147

<span class=summary-sig-arg>persistentStore</span>,

148

<span class=summary-sig-arg>invoker</span>)</span></code>

149

<br />

150

Serialize to s-expression.</td></tr>

151

152

<td><code><span class="summary-sig"><a href="twisted.spread.jelly.html#setInstanceState" class="summary-sig-name"><code>setInstanceState</code></a>(<span class=summary-sig-arg>inst</span>,

153

<span class=summary-sig-arg>unjellier</span>,

154

<span class=summary-sig-arg>jellyList</span>)</span></code>

155

<br />

156

Utility method to default to 'normal' state rules in

157

unserialization.</td></tr>

158

159

<td><code><span class="summary-sig"><a href="twisted.spread.jelly.html#setUnjellyableFactoryForClass" class="summary-sig-name"><code>setUnjellyableFactoryForClass</code></a>(<span class=summary-sig-arg>classname</span>,

160

<span class=summary-sig-arg>copyFactory</span>)</span></code>

161

<br />

162

Set the factory to construct a remote instance of a type:</td></tr>

163

164

<td><code><span class="summary-sig"><a href="twisted.spread.jelly.html#setUnjellyableForClass" class="summary-sig-name"><code>setUnjellyableForClass</code></a>(<span class=summary-sig-arg>classname</span>,

165

<span class=summary-sig-arg>unjellyable</span>)</span></code>

166

<br />

167

Set which local class will represent a remote type.</td></tr>

168

169

<td><code><span class="summary-sig"><a href="twisted.spread.jelly.html#setUnjellyableForClassTree" class="summary-sig-name"><code>setUnjellyableForClassTree</code></a>(<span class=summary-sig-arg>module</span>,

170

<span class=summary-sig-arg>baseClass</span>,

171

<span class=summary-sig-arg>prefix</span>)</span></code>

172

<br />

173

Set all classes in a module derived from <code>baseClass</code> as

174

copiers for a corresponding remote class.</td></tr>

175

176

<td><code><span class="summary-sig"><a href="twisted.spread.jelly.html#unjelly" class="summary-sig-name"><code>unjelly</code></a>(<span class=summary-sig-arg>sexp</span>,

177

<span class=summary-sig-arg>taster</span>,

178

<span class=summary-sig-arg>persistentLoad</span>,

179

<span class=summary-sig-arg>invoker</span>)</span></code>

180

<br />

181

Unserialize from s-expression.</td></tr>

182

</table><br />

183

184

185

186

187

188

<th colspan="2">Variable Summary</th></tr>

189

190

<td><b><a href="twisted.spread.jelly.html#__version__"><code>__version__</code></a></b> = <span title="'1.48'"><code><span class="variable-quote">'</span>1.48<span class="variable-quote">'</span> </code>

191

</span></td></tr>

192

<tr><td align="right" valign="top" width="15%"><font size="-1"><a href="twisted.spread.jelly.SecurityOptions.html"

193

class="link"><code>SecurityOptions</code></a></font></td>

194

<td><b><a href="twisted.spread.jelly.html#globalSecurity"><code>globalSecurity</code></a></b> = <span title="<twisted.spread.jelly.SecurityOptions instance at 0x83e95d4>"><code><twisted.spread.jelly.SecurityOptions i<span class="variable-ellipsis">...</span></code>

195

</span></td></tr>

196

197

<td><b><a href="twisted.spread.jelly.html#unjellyableFactoryRegistry"><code>unjellyableFactoryRegistry</code></a></b> = <span title="{}"><code>{} </code>

198

</span></td></tr>

199

200

<td><b><a href="twisted.spread.jelly.html#unjellyableRegistry"><code>unjellyableRegistry</code></a></b> = <span title="{'twisted.web.server.Request': <class twisted.web.distrib.Request at 0x86f6b34>, 'remote': <class twisted.spread.pb.RemoteReference at 0x8535084>, 'cached': <function unjellyCached at 0x84628e4>, 'lcache': <function unjellyLCache at 0x846291c>, 'twisted.spread.pb.CopyableFailure': <class twisted.spread.pb.CopiedFailure at 0x8479924>, 'local': <function unjellyLocal at 0x85a807c>}"><code>{'twisted.web.server.Request': <cl<span class="variable-ellipsis">...</span></code>

201

</span></td></tr>

202

</table><br />

203

204

205

206

207

208

<th colspan="2">Function Details</th></tr>

209

</table>

210

211

212

213

<h3><span class="sig"><span class="sig-name">getInstanceState</span>(<span class=sig-arg>inst</span>,

214

<span class=sig-arg>jellier</span>)</span>

215

</h3>

216

Utility method to default to 'normal' state rules in

217

serialization.

218

219

</dd></dl>

220

</td></tr></table>

221

222

223

224

<h3><span class="sig"><span class="sig-name">jelly</span>(<span class=sig-arg>object</span>,

225

<span class=sig-arg>taster</span>=<span class=sig-default><twisted.spread.jelly.DummySecurityOptions instance at 0x...</span>,

226

<span class=sig-arg>persistentStore</span>=<span class=sig-default>None</span>,

227

<span class=sig-arg>invoker</span>=<span class=sig-default>None</span>)</span>

228

</h3>

229

<p>Serialize to s-expression.</p>

230

Returns a list which is the serialized representation of an object.

231

An optional 'taster' argument takes a SecurityOptions and will mark any

232

insecure objects as unpersistable rather than serializing them.

233

234

</dd></dl>

235

</td></tr></table>

236

237

238

239

<h3><span class="sig"><span class="sig-name">setInstanceState</span>(<span class=sig-arg>inst</span>,

240

<span class=sig-arg>unjellier</span>,

241

<span class=sig-arg>jellyList</span>)</span>

242

</h3>

243

Utility method to default to 'normal' state rules in

244

unserialization.

245

246

</dd></dl>

247

</td></tr></table>

248

249

250

251

<h3><span class="sig"><span class="sig-name">setUnjellyableFactoryForClass</span>(<span class=sig-arg>classname</span>,

252

<span class=sig-arg>copyFactory</span>)</span>

253

</h3>

254

Set the factory to construct a remote instance of a type:

255

256

jellier.setFactoryForClass('module.package.Class', MyFactory)

257

</pre>

258

<p>Call this at the module level immediately after its class

259

definition. <code>copyFactory</code> should return an instance or

260

subclass of <a href="twisted.spread.flavors.RemoteCopy.html"

261

class="link"><code>RemoteCopy</code></a>.</p>

262

Similar to <a

263

href="twisted.spread.jelly.html#setUnjellyableForClass"

264

class="link"><code>setUnjellyableForClass</code></a> except it uses a

265

factory instead of creating an instance.

266

267

</dd></dl>

268

</td></tr></table>

269

270

271

272

<h3><span class="sig"><span class="sig-name">setUnjellyableForClass</span>(<span class=sig-arg>classname</span>,

273

<span class=sig-arg>unjellyable</span>)</span>

274

</h3>

275

<p>Set which local class will represent a remote type.</p>

276

If you have written a Copyable class that you expect your client to

277

be receiving, write a local "copy" class to represent it,

278

then call:

279

280

jellier.setUnjellyableForClass('module.package.Class', MyJellier).

281

</pre>

282

<p>Call this at the module level immediately after its class

283

definition. MyCopier should be a subclass of RemoteCopy.</p>

284

<p>The classname may be a special tag returned by

285

'Copyable.getTypeToCopyFor' rather than an actual classname.</p>

286

This call is also for cached classes, since there will be no

287

overlap. The rules are the same.

288

289

</dd></dl>

290

</td></tr></table>

291

292

293

294

<h3><span class="sig"><span class="sig-name">setUnjellyableForClassTree</span>(<span class=sig-arg>module</span>,

295

<span class=sig-arg>baseClass</span>,

296

<span class=sig-arg>prefix</span>=<span class=sig-default>None</span>)</span>

297

</h3>

298

<p>Set all classes in a module derived from <code>baseClass</code> as

299

copiers for a corresponding remote class.</p>

300

<p>When you have a heirarchy of Copyable (or Cacheable) classes on one

301

side, and a mirror structure of Copied (or RemoteCache) classes on the

302

other, use this to setCopierForClass all your Copieds for the

303

Copyables.</p>

304

Each copyTag (the "classname" argument to

305

getTypeToCopyFor, and what the Copyable's getTypeToCopyFor returns) is

306

formed from adding a prefix to the Copied's class name. The prefix

307

defaults to module.__name__. If you wish the copy tag to consist of

308

solely the classname, pass the empty string ''.

309

310

<dl><dt><b>Parameters:</b></dt>

311

<dd><code><b>module</b></code> -

312

a module object from which to pull the Copied classes.

313

(passing sys.modules[__name__] might be useful)

314

<dd><code><b>baseClass</b></code> -

315

the base class from which all your Copied classes derive.

316

<dd><code><b>prefix</b></code> -

317

the string prefixed to classnames to form the

318

unjellyableRegistry.

319

</dd>

320

</dl>

321

</dd></dl>

322

</td></tr></table>

323

324

325

326

<h3><span class="sig"><span class="sig-name">unjelly</span>(<span class=sig-arg>sexp</span>,

327

<span class=sig-arg>taster</span>=<span class=sig-default><twisted.spread.jelly.DummySecurityOptions instance at 0x...</span>,

328

<span class=sig-arg>persistentLoad</span>=<span class=sig-default>None</span>,

329

<span class=sig-arg>invoker</span>=<span class=sig-default>None</span>)</span>

330

</h3>

331

<p>Unserialize from s-expression.</p>

332

Takes an list that was the result from a call to jelly() and

333

unserializes an arbitrary object from it. The optional 'taster'

334

argument, an instance of SecurityOptions, will cause an InsecureJelly

335

exception to be raised if a disallowed type, module, or class attempted

336

to unserialize.

337

338

</dd></dl>

339

</td></tr></table>

340

<br />

341

342

343

344

345

346

<th colspan="2">Variable Details</th></tr>

347

</table>

348

349

350

<h3>__version__</h3>

351

<dl>

352

353

<dd>

354

<dl>

355

356

<dd>

357

358

359

</dd>

360

<span title="'1.48'"> <dt><b>Value:</b></dt>

361

362

363

364

</td></tr></table></dd>

365

</span> </dl>

366

</dd>

367

</dl></td></tr></table>

368

369

370

<h3>globalSecurity</h3>

371

<dl>

372

373

<dd>

374

<dl>

375

376

<dd>

377

<a href="twisted.spread.jelly.SecurityOptions.html"

378

class="link"><code>SecurityOptions</code></a>

379

380

</dd>

381

<span title="<twisted.spread.jelly.SecurityOptions instance at 0x83e95d4>"> <dt><b>Value:</b></dt>

382

383

384

<twisted.spread.jelly.SecurityOptions instance at 0x83e95d4> </pre>

385

</td></tr></table></dd>

386

</span> </dl>

387

</dd>

388

</dl></td></tr></table>

389

390

391

<h3>unjellyableFactoryRegistry</h3>

392

<dl>

393

394

<dd>

395

<dl>

396

397

<dd>

398

399

400

</dd>

401

<span title="{}"> <dt><b>Value:</b></dt>

402

403

404

{} </pre>

405

</td></tr></table></dd>

406

</span> </dl>

407

</dd>

408

</dl></td></tr></table>

409

410

411

<h3>unjellyableRegistry</h3>

412

<dl>

413

414

<dd>

415

<dl>

416

417

<dd>

418

419

420

</dd>

421

<span title="{'twisted.web.server.Request': <class twisted.web.distrib.Request at 0x86f6b34>, 'remote': <class twisted.spread.pb.RemoteReference at 0x8535084>, 'cached': <function unjellyCached at 0x84628e4>, 'lcache': <function unjellyLCache at 0x846291c>, 'twisted.spread.pb.CopyableFailure': <class twisted.spread.pb.CopiedFailure at 0x8479924>, 'local': <function unjellyLocal at 0x85a807c>}"> <dt><b>Value:</b></dt>

422

423

424

{'cached': <function unjellyCached at 0x84628e4>,

425

'lcache': <function unjellyLCache at 0x846291c>,

426

'local': <function unjellyLocal at 0x85a807c>,

427

'remote': <class twisted.spread.pb.RemoteReference at 0x8535084>,

428

'twisted.spread.pb.CopyableFailure': <class twisted.spread.pb.CopiedF<span class="variable-linewrap">\</span>

429

ailure at 0x8479924>,

430

'twisted.web.server.Request': <class twisted.web.distrib.Request at 0<span class="variable-linewrap">\</span>

431

x86f6b34>} </pre>

432

</td></tr></table></dd>

433

</span> </dl>

434

</dd>

435

</dl></td></tr></table>

436

<br />

437

438

439

440

441

442

443

<th class="navbar">   <a class="navbar" href="trees.html">Trees</a>   </th>

444

<th class="navbar">   <a class="navbar" href="indices.html">Index</a>   </th>

445

446

447

448

449

450

<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>

451

</p></th></tr></table>

452

</th>

453

</tr>

454

</table>

455

456

457

<tr>

458

<td align="left"><font size="-2">Generated by Epydoc 2.0 on Sat May 15 20:08:15 2004</font></td>

459

<td align="right"><a href="http://epydoc.sourceforge.net"

460

><font size="-2">http://epydoc.sf.net</font></a></td>

461

</tr>

462

</table>

463

</body>

464

</html>

Older »