~ubuntu-branches/ubuntu/oneiric/lightning-extension/oneiric-updates

<h1 id="module-simplejson"><tt class="xref docutils literal">simplejson</tt> — JSON encoder and decoder<a class="headerlink" href="#module-simplejson" title="Permalink to this headline">¶</a></h1>

JSON (JavaScript Object Notation) <<a class="reference external" href="http://json.org">http://json.org</a>> is a subset of JavaScript

syntax (ECMA-262 3rd edition) used as a lightweight data interchange format.

<tt class="xref docutils literal">simplejson</tt> exposes an API familiar to users of the standard library

<tt class="xref docutils literal">marshal</tt> and <tt class="xref docutils literal">pickle</tt> modules. It is the externally maintained

version of the <tt class="xref docutils literal">json</tt> library contained in Python 2.6, but maintains

compatibility with Python 2.5 and (currently) has

significant performance advantages, even without using the optional C

extension for speedups.

Encoding basic Python object hierarchies:

<div class="highlight"><pre>>>> import simplejson as json

>>> json.dumps(['foo', {'bar': ('baz', None, 1.0, 2)}])

'["foo", {"bar": ["baz", null, 1.0, 2]}]'

>>> print json.dumps("\"foo\bar")

"\"foo\bar"

>>> print json.dumps(u'\u1234')

"\u1234"

>>> print json.dumps('\\')

"\\"

>>> print json.dumps({"c": 0, "b": 0, "a": 0}, sort_keys=True)

{"a": 0, "b": 0, "c": 0}

>>> from StringIO import StringIO

>>> io = StringIO()

>>> json.dump(['streaming API'], io)

>>> io.getvalue()

'["streaming API"]'

</pre></div>

Compact encoding:

<div class="highlight"><pre>>>> import simplejson as json

>>> json.dumps([1,2,3,{'4': 5, '6': 7}], separators=(',',':'))

'[1,2,3,{"4":5,"6":7}]'

</pre></div>

Pretty printing:

<div class="highlight"><pre>>>> import simplejson as json

>>> s = json.dumps({'4': 5, '6': 7}, sort_keys=True, indent=4 * ' ')

>>> print '\n'.join([l.rstrip() for l in s.splitlines()])

{

"4": 5,

"6": 7

}

</pre></div>

Decoding JSON:

<div class="highlight"><pre>>>> import simplejson as json

>>> obj = [u'foo', {u'bar': [u'baz', None, 1.0, 2]}]

>>> json.loads('["foo", {"bar":["baz", null, 1.0, 2]}]') == obj

True

>>> json.loads('"\\"foo\\bar"') == u'"foo\x08ar'

True

>>> from StringIO import StringIO

>>> io = StringIO('["streaming API"]')

>>> json.load(io)[0] == 'streaming API'

True

</pre></div>

Using Decimal instead of float:

<div class="highlight"><pre>>>> import simplejson as json

>>> from decimal import Decimal

>>> json.loads('1.1', use_decimal=True) == Decimal('1.1')

True

>>> json.dumps(Decimal('1.1'), use_decimal=True) == '1.1'

100

True

101

</pre></div>

102

Specializing JSON object decoding:

103

<div class="highlight"><pre>>>> import simplejson as json

104

>>> def as_complex(dct):

105

... if '__complex__' in dct:

106

... return complex(dct['real'], dct['imag'])

107

... return dct

108

...

109

>>> json.loads('{"__complex__": true, "real": 1, "imag": 2}',

110

... object_hook=as_complex)

111

(1+2j)

112

>>> import decimal

113

>>> json.loads('1.1', parse_float=decimal.Decimal) == decimal.Decimal('1.1')

114

True

115

</pre></div>

116

Specializing JSON object encoding:

117

<div class="highlight"><pre>>>> import simplejson as json

118

>>> def encode_complex(obj):

119

... if isinstance(obj, complex):

120

... return [obj.real, obj.imag]

121

... raise TypeError(repr(o) + " is not JSON serializable")

122

...

123

>>> json.dumps(2 + 1j, default=encode_complex)

124

'[2.0, 1.0]'

125

>>> json.JSONEncoder(default=encode_complex).encode(2 + 1j)

126

'[2.0, 1.0]'

127

>>> ''.join(json.JSONEncoder(default=encode_complex).iterencode(2 + 1j))

128

'[2.0, 1.0]'

129

</pre></div>

130

Using <tt class="xref docutils literal">simplejson.tool</tt> from the shell to validate and pretty-print:

131

<div class="highlight"><pre>$ echo '{"json":"obj"}' | python -m simplejson.tool

132

{

133

"json": "obj"

134

}

135

$ echo '{ 1.2:3.4}' | python -m simplejson.tool

136

Expecting property name: line 1 column 2 (char 2)

137

</pre></div>

138

139

Note

140

The JSON produced by this module’s default settings is a subset of

141

YAML, so it may be used as a serializer for that as well.

142

</div>

143

144

<h2 id="basic-usage">Basic Usage<a class="headerlink" href="#basic-usage" title="Permalink to this headline">¶</a></h2>

145

146

147

<tt class="descclassname">simplejson.</tt><tt class="descname">dump</tt><big>(</big>obj, fp[, skipkeys[, ensure_ascii[, check_circular[, allow_nan[, cls[, indent[, separators[, encoding[, default[, use_decimal[, **kw]]]]]]]]]]]<big>)</big><a class="headerlink" href="#simplejson.dump" title="Permalink to this definition">¶</a></dt>

148

<dd>Serialize obj as a JSON formatted stream to fp (a <tt class="docutils literal">.write()</tt>-supporting

149

file-like object).

150

If skipkeys is true (default: <tt class="xref docutils literal">False</tt>), then dict keys that are not

151

of a basic type (<tt class="xref docutils literal">str</tt>, <tt class="xref docutils literal">unicode</tt>, <tt class="xref docutils literal">int</tt>, <tt class="xref docutils literal">long</tt>,

152

<tt class="xref docutils literal">float</tt>, <tt class="xref docutils literal">bool</tt>, <tt class="xref docutils literal">None</tt>) will be skipped instead of raising a

153

<tt class="xref docutils literal">TypeError</tt>.

154

If ensure_ascii is false (default: <tt class="xref docutils literal">True</tt>), then some chunks written

155

to fp may be <tt class="xref docutils literal">unicode</tt> instances, subject to normal Python

156

<tt class="xref docutils literal">str</tt> to <tt class="xref docutils literal">unicode</tt> coercion rules. Unless <tt class="docutils literal">fp.write()</tt>

157

explicitly understands <tt class="xref docutils literal">unicode</tt> (as in <tt class="xref docutils literal">codecs.getwriter()</tt>) this

158

is likely to cause an error. It’s best to leave the default settings, because

159

they are safe and it is highly optimized.

160

If check_circular is false (default: <tt class="xref docutils literal">True</tt>), then the circular

161

reference check for container types will be skipped and a circular reference

162

will result in an <tt class="xref docutils literal">OverflowError</tt> (or worse).

163

If allow_nan is false (default: <tt class="xref docutils literal">True</tt>), then it will be a

164

<tt class="xref docutils literal">ValueError</tt> to serialize out of range <tt class="xref docutils literal">float</tt> values (<tt class="docutils literal">nan</tt>,

165

<tt class="docutils literal">inf</tt>, <tt class="docutils literal">-inf</tt>) in strict compliance of the JSON specification.

166

If allow_nan is true, their JavaScript equivalents will be used

167

(<tt class="docutils literal">NaN</tt>, <tt class="docutils literal">Infinity</tt>, <tt class="docutils literal">-Infinity</tt>).

168

If indent is a string, then JSON array elements and object members

169

will be pretty-printed with a newline followed by that string repeated

170

for each level of nesting. <tt class="xref docutils literal">None</tt> (the default) selects the most compact

171

representation without any newlines. For backwards compatibility with

172

versions of simplejson earlier than 2.1.0, an integer is also accepted

173

and is converted to a string with that many spaces.

174

175

Changed in version 2.1.0: Changed indent from an integer number of spaces to a string.

176

If specified, separators should be an <tt class="docutils literal">(item_separator, dict_separator)</tt>

177

tuple. By default, <tt class="docutils literal">(', ', ': ')</tt> are used. To get the most compact JSON

178

representation, you should specify <tt class="docutils literal">(',', ':')</tt> to eliminate whitespace.

179

encoding is the character encoding for str instances, default is

180

<tt class="docutils literal">'utf-8'</tt>.

181

default(obj) is a function that should return a serializable version of

182

obj or raise <tt class="xref docutils literal">TypeError</tt>. The default simply raises <tt class="xref docutils literal">TypeError</tt>.

183

To use a custom <a title="simplejson.JSONEncoder" class="reference internal" href="#simplejson.JSONEncoder"><tt class="xref docutils literal">JSONEncoder</tt></a> subclass (e.g. one that overrides the

184

<tt class="xref docutils literal">default()</tt> method to serialize additional types), specify it with the

185

cls kwarg.

186

If use_decimal is true (default: <tt class="xref docutils literal">False</tt>) then <tt class="xref docutils literal">decimal.Decimal</tt>

187

will be natively serialized to JSON with full precision.

188

189

Changed in version 2.1.0: use_decimal is new in 2.1.0.<div class="admonition note">

190

Note

191

JSON is not a framed protocol so unlike <tt class="xref docutils literal">pickle</tt> or <tt class="xref docutils literal">marshal</tt> it

192

does not make sense to serialize more than one JSON document without some

193

container protocol to delimit them.

194

</div>

195

196

</dd></dl>

197

198

199

200

<tt class="descclassname">simplejson.</tt><tt class="descname">dumps</tt><big>(</big>obj[, skipkeys[, ensure_ascii[, check_circular[, allow_nan[, cls[, indent[, separators[, encoding[, default[, use_decimal[, **kw]]]]]]]]]]]<big>)</big><a class="headerlink" href="#simplejson.dumps" title="Permalink to this definition">¶</a></dt>

201

<dd>Serialize obj to a JSON formatted <tt class="xref docutils literal">str</tt>.

202

If ensure_ascii is false, then the return value will be a

203

<tt class="xref docutils literal">unicode</tt> instance. The other arguments have the same meaning as in

204

<a title="simplejson.dump" class="reference internal" href="#simplejson.dump"><tt class="xref docutils literal">dump()</tt></a>. Note that the default ensure_ascii setting has much

205

better performance.

206

</dd></dl>

207

208

209

210

<tt class="descclassname">simplejson.</tt><tt class="descname">load</tt><big>(</big>fp[, encoding[, cls[, object_hook[, parse_float[, parse_int[, parse_constant[, object_pairs_hook[, use_decimal[, **kw]]]]]]]]]<big>)</big><a class="headerlink" href="#simplejson.load" title="Permalink to this definition">¶</a></dt>

211

<dd>Deserialize fp (a <tt class="docutils literal">.read()</tt>-supporting file-like object containing a JSON

212

document) to a Python object.

213

If the contents of fp are encoded with an ASCII based encoding other than

214

UTF-8 (e.g. latin-1), then an appropriate encoding name must be specified.

215

Encodings that are not ASCII based (such as UCS-2) are not allowed, and

216

should be wrapped with <tt class="docutils literal">codecs.getreader(fp)(encoding)</tt>, or simply decoded

217

to a <tt class="xref docutils literal">unicode</tt> object and passed to <a title="simplejson.loads" class="reference internal" href="#simplejson.loads"><tt class="xref docutils literal">loads()</tt></a>. The default

218

setting of <tt class="docutils literal">'utf-8'</tt> is fastest and should be using whenever possible.

219

If fp.read() returns <tt class="xref docutils literal">str</tt> then decoded JSON strings that contain

220

only ASCII characters may be parsed as <tt class="xref docutils literal">str</tt> for performance and

221

memory reasons. If your code expects only <tt class="xref docutils literal">unicode</tt> the appropriate

222

solution is to wrap fp with a reader as demonstrated above.

223

object_hook is an optional function that will be called with the result of

224

any object literal decode (a <tt class="xref docutils literal">dict</tt>). The return value of

225

object_hook will be used instead of the <tt class="xref docutils literal">dict</tt>. This feature can be used

226

to implement custom decoders (e.g. JSON-RPC class hinting).

227

object_pairs_hook is an optional function that will be called with the

228

result of any object literal decode with an ordered list of pairs. The

229

return value of object_pairs_hook will be used instead of the

230

<tt class="xref docutils literal">dict</tt>. This feature can be used to implement custom decoders that

231

rely on the order that the key and value pairs are decoded (for example,

232

<tt class="xref docutils literal">collections.OrderedDict</tt> will remember the order of insertion). If

233

object_hook is also defined, the object_pairs_hook takes priority.

234

235

Changed in version 2.1.0: Added support for object_pairs_hook.

236

parse_float, if specified, will be called with the string of every JSON

237

float to be decoded. By default, this is equivalent to <tt class="docutils literal">float(num_str)</tt>.

238

This can be used to use another datatype or parser for JSON floats

239

(e.g. <tt class="xref docutils literal">decimal.Decimal</tt>).

240

parse_int, if specified, will be called with the string of every JSON int

241

to be decoded. By default, this is equivalent to <tt class="docutils literal">int(num_str)</tt>. This can

242

be used to use another datatype or parser for JSON integers

243

(e.g. <tt class="xref docutils literal">float</tt>).

244

parse_constant, if specified, will be called with one of the following

245

strings: <tt class="docutils literal">'-Infinity'</tt>, <tt class="docutils literal">'Infinity'</tt>, <tt class="docutils literal">'NaN'</tt>. This can be used to

246

raise an exception if invalid JSON numbers are encountered.

247

If use_decimal is true (default: <tt class="xref docutils literal">False</tt>) then parse_float is set to

248

<tt class="xref docutils literal">decimal.Decimal</tt>. This is a convenience for parity with the

249

<a title="simplejson.dump" class="reference internal" href="#simplejson.dump"><tt class="xref docutils literal">dump()</tt></a> parameter.

250

251

Changed in version 2.1.0: use_decimal is new in 2.1.0.

252

To use a custom <a title="simplejson.JSONDecoder" class="reference internal" href="#simplejson.JSONDecoder"><tt class="xref docutils literal">JSONDecoder</tt></a> subclass, specify it with the <tt class="docutils literal">cls</tt>

253

kwarg. Additional keyword arguments will be passed to the constructor of the

254

class.

255

256

257

Note

258

<a title="simplejson.load" class="reference internal" href="#simplejson.load"><tt class="xref docutils literal">load()</tt></a> will read the rest of the file-like object as a string and

259

then call <a title="simplejson.loads" class="reference internal" href="#simplejson.loads"><tt class="xref docutils literal">loads()</tt></a>. It does not stop at the end of the first valid

260

JSON document it finds and it will raise an error if there is anything

261

other than whitespace after the document. Except for files containing

262

only one JSON document, it is recommended to use <a title="simplejson.loads" class="reference internal" href="#simplejson.loads"><tt class="xref docutils literal">loads()</tt></a>.

263

</div>

264

</blockquote>

265

</dd></dl>

266

267

268

269

<tt class="descclassname">simplejson.</tt><tt class="descname">loads</tt><big>(</big>s[, encoding[, cls[, object_hook[, parse_float[, parse_int[, parse_constant[, object_pairs_hook[, use_decimal[, **kw]]]]]]]]]<big>)</big><a class="headerlink" href="#simplejson.loads" title="Permalink to this definition">¶</a></dt>

270

<dd>Deserialize s (a <tt class="xref docutils literal">str</tt> or <tt class="xref docutils literal">unicode</tt> instance containing a JSON

271

document) to a Python object.

272

If s is a <tt class="xref docutils literal">str</tt> instance and is encoded with an ASCII based encoding

273

other than UTF-8 (e.g. latin-1), then an appropriate encoding name must be

274

specified. Encodings that are not ASCII based (such as UCS-2) are not

275

allowed and should be decoded to <tt class="xref docutils literal">unicode</tt> first.

276

If s is a <tt class="xref docutils literal">str</tt> then decoded JSON strings that contain

277

only ASCII characters may be parsed as <tt class="xref docutils literal">str</tt> for performance and

278

memory reasons. If your code expects only <tt class="xref docutils literal">unicode</tt> the appropriate

279

solution is decode s to <tt class="xref docutils literal">unicode</tt> prior to calling loads.

280

The other arguments have the same meaning as in <a title="simplejson.load" class="reference internal" href="#simplejson.load"><tt class="xref docutils literal">load()</tt></a>.

281

</dd></dl>

282

283

</div>

284

285

<h2 id="encoders-and-decoders">Encoders and decoders<a class="headerlink" href="#encoders-and-decoders" title="Permalink to this headline">¶</a></h2>

286

287

288

class <tt class="descclassname">simplejson.</tt><tt class="descname">JSONDecoder</tt><big>(</big>[encoding[, object_hook[, parse_float[, parse_int[, parse_constant[, object_pairs_hook[, strict]]]]]]]<big>)</big><a class="headerlink" href="#simplejson.JSONDecoder" title="Permalink to this definition">¶</a></dt>

289

<dd>Simple JSON decoder.

290

Performs the following translations in decoding by default:

291

292

293

294

295

</colgroup>

296

297

298

<th class="head">Python</th>

299

</tr>

300

</thead>

301

302

<tr><td>object</td>

303

304

</tr>

305

<tr><td>array</td>

306

307

</tr>

308

<tr><td>string</td>

309

<td>unicode</td>

310

</tr>

311

<tr><td>number (int)</td>

312

313

</tr>

314

<tr><td>number (real)</td>

315

<td>float</td>

316

</tr>

317

318

319

</tr>

320

<tr><td>false</td>

321

<td>False</td>

322

</tr>

323

324

325

</tr>

326

</tbody>

327

</table>

328

It also understands <tt class="docutils literal">NaN</tt>, <tt class="docutils literal">Infinity</tt>, and <tt class="docutils literal">-Infinity</tt> as their

329

corresponding <tt class="docutils literal">float</tt> values, which is outside the JSON spec.

330

encoding determines the encoding used to interpret any <tt class="xref docutils literal">str</tt> objects

331

decoded by this instance (<tt class="docutils literal">'utf-8'</tt> by default). It has no effect when decoding

332

<tt class="xref docutils literal">unicode</tt> objects.

333

Note that currently only encodings that are a superset of ASCII work, strings

334

of other encodings should be passed in as <tt class="xref docutils literal">unicode</tt>.

335

object_hook is an optional function that will be called with the result of

336

every JSON object decoded and its return value will be used in place of the

337

given <tt class="xref docutils literal">dict</tt>. This can be used to provide custom deserializations

338

(e.g. to support JSON-RPC class hinting).

339

object_pairs_hook is an optional function that will be called with the

340

result of any object literal decode with an ordered list of pairs. The

341

return value of object_pairs_hook will be used instead of the

342

<tt class="xref docutils literal">dict</tt>. This feature can be used to implement custom decoders that

343

rely on the order that the key and value pairs are decoded (for example,

344

<tt class="xref docutils literal">collections.OrderedDict</tt> will remember the order of insertion). If

345

object_hook is also defined, the object_pairs_hook takes priority.

346

347

Changed in version 2.1.0: Added support for object_pairs_hook.

348

parse_float, if specified, will be called with the string of every JSON

349

float to be decoded. By default, this is equivalent to <tt class="docutils literal">float(num_str)</tt>.

350

This can be used to use another datatype or parser for JSON floats

351

(e.g. <tt class="xref docutils literal">decimal.Decimal</tt>).

352

parse_int, if specified, will be called with the string of every JSON int

353

to be decoded. By default, this is equivalent to <tt class="docutils literal">int(num_str)</tt>. This can

354

be used to use another datatype or parser for JSON integers

355

(e.g. <tt class="xref docutils literal">float</tt>).

356

parse_constant, if specified, will be called with one of the following

357

358

raise an exception if invalid JSON numbers are encountered.

359

strict controls the parser’s behavior when it encounters an invalid

360

control character in a string. The default setting of <tt class="xref docutils literal">True</tt> means that

361

unescaped control characters are parse errors, if <tt class="xref docutils literal">False</tt> then control

362

characters will be allowed in strings.

363

364

365

<tt class="descname">decode</tt><big>(</big>s<big>)</big><a class="headerlink" href="#simplejson.JSONDecoder.decode" title="Permalink to this definition">¶</a></dt>

366

<dd>Return the Python representation of s (a <tt class="xref docutils literal">str</tt> or

367

<tt class="xref docutils literal">unicode</tt> instance containing a JSON document)

368

If s is a <tt class="xref docutils literal">str</tt> then decoded JSON strings that contain

369

only ASCII characters may be parsed as <tt class="xref docutils literal">str</tt> for performance and

370

memory reasons. If your code expects only <tt class="xref docutils literal">unicode</tt> the

371

appropriate solution is decode s to <tt class="xref docutils literal">unicode</tt> prior to calling

372

decode.

373

</dd></dl>

374

375

376

377

<tt class="descname">raw_decode</tt><big>(</big>s<big>)</big><a class="headerlink" href="#simplejson.JSONDecoder.raw_decode" title="Permalink to this definition">¶</a></dt>

378

<dd>Decode a JSON document from s (a <tt class="xref docutils literal">str</tt> or <tt class="xref docutils literal">unicode</tt>

379

beginning with a JSON document) and return a 2-tuple of the Python

380

representation and the index in s where the document ended.

381

This can be used to decode a JSON document from a string that may have

382

extraneous data at the end.

383

</dd></dl>

384

385

</dd></dl>

386

387

388

389

class <tt class="descclassname">simplejson.</tt><tt class="descname">JSONEncoder</tt><big>(</big>[skipkeys[, ensure_ascii[, check_circular[, allow_nan[, sort_keys[, indent[, separators[, encoding[, default]]]]]]]]]<big>)</big><a class="headerlink" href="#simplejson.JSONEncoder" title="Permalink to this definition">¶</a></dt>

390

<dd>Extensible JSON encoder for Python data structures.

391

Supports the following objects and types by default:

392

393

394

395

396

</colgroup>

397

398

<tr><th class="head">Python</th>

399

400

</tr>

401

</thead>

402

403

404

<td>object</td>

405

</tr>

406

<tr><td>list, tuple</td>

407

<td>array</td>

408

</tr>

409

<tr><td>str, unicode</td>

410

<td>string</td>

411

</tr>

412

<tr><td>int, long, float</td>

413

<td>number</td>

414

</tr>

415

416

417

</tr>

418

<tr><td>False</td>

419

<td>false</td>

420

</tr>

421

422

423

</tr>

424

</tbody>

425

</table>

426

To extend this to recognize other objects, subclass and implement a

427

<a title="simplejson.JSONEncoder.default" class="reference internal" href="#simplejson.JSONEncoder.default"><tt class="xref docutils literal">default()</tt></a> method with another method that returns a serializable object

428

for <tt class="docutils literal">o</tt> if possible, otherwise it should call the superclass implementation

429

(to raise <tt class="xref docutils literal">TypeError</tt>).

430

If skipkeys is false (the default), then it is a <tt class="xref docutils literal">TypeError</tt> to

431

attempt encoding of keys that are not str, int, long, float or None. If

432

skipkeys is true, such items are simply skipped.

433

If ensure_ascii is true (the default), the output is guaranteed to be

434

<tt class="xref docutils literal">str</tt> objects with all incoming unicode characters escaped. If

435

ensure_ascii is false, the output will be a unicode object.

436

If check_circular is false (the default), then lists, dicts, and custom

437

encoded objects will be checked for circular references during encoding to

438

prevent an infinite recursion (which would cause an <tt class="xref docutils literal">OverflowError</tt>).

439

Otherwise, no such check takes place.

440

If allow_nan is true (the default), then <tt class="docutils literal">NaN</tt>, <tt class="docutils literal">Infinity</tt>, and

441

<tt class="docutils literal">-Infinity</tt> will be encoded as such. This behavior is not JSON

442

specification compliant, but is consistent with most JavaScript based

443

encoders and decoders. Otherwise, it will be a <tt class="xref docutils literal">ValueError</tt> to encode

444

such floats.

445

If sort_keys is true (not the default), then the output of dictionaries

446

will be sorted by key; this is useful for regression tests to ensure that

447

JSON serializations can be compared on a day-to-day basis.

448

If indent is a string, then JSON array elements and object members

449

will be pretty-printed with a newline followed by that string repeated

450

for each level of nesting. <tt class="xref docutils literal">None</tt> (the default) selects the most compact

451

representation without any newlines. For backwards compatibility with

452

versions of simplejson earlier than 2.1.0, an integer is also accepted

453

and is converted to a string with that many spaces.

454

455

Changed in version 2.1.0: Changed indent from an integer number of spaces to a string.

456

If specified, separators should be an <tt class="docutils literal">(item_separator, key_separator)</tt>

457

458

representation, you should specify <tt class="docutils literal">(',', ':')</tt> to eliminate whitespace.

459

If specified, default should be a function that gets called for objects

460

that can’t otherwise be serialized. It should return a JSON encodable

461

version of the object or raise a <tt class="xref docutils literal">TypeError</tt>.

462

If encoding is not <tt class="xref docutils literal">None</tt>, then all input strings will be transformed

463

into unicode using that encoding prior to JSON-encoding. The default is

464

<tt class="docutils literal">'utf-8'</tt>.

465

466

467

<tt class="descname">default</tt><big>(</big>o<big>)</big><a class="headerlink" href="#simplejson.JSONEncoder.default" title="Permalink to this definition">¶</a></dt>

468

<dd>Implement this method in a subclass such that it returns a serializable

469

object for o, or calls the base implementation (to raise a

470

<tt class="xref docutils literal">TypeError</tt>).

471

For example, to support arbitrary iterators, you could implement default

472

like this:

473

<div class="highlight"><pre>def default(self, o):

474

try:

475

iterable = iter(o)

476

except TypeError:

477

pass

478

else:

479

return list(iterable)

480

return JSONEncoder.default(self, o)

481

</pre></div>

482

</dd></dl>

483

484

485

486

<tt class="descname">encode</tt><big>(</big>o<big>)</big><a class="headerlink" href="#simplejson.JSONEncoder.encode" title="Permalink to this definition">¶</a></dt>

487

<dd>Return a JSON string representation of a Python data structure, o. For

488

example:

489

<div class="highlight"><pre>>>> import simplejson as json

490

>>> json.JSONEncoder().encode({"foo": ["bar", "baz"]})

491

'{"foo": ["bar", "baz"]}'

492

</pre></div>

493

</dd></dl>

494

495

496

497

<tt class="descname">iterencode</tt><big>(</big>o<big>)</big><a class="headerlink" href="#simplejson.JSONEncoder.iterencode" title="Permalink to this definition">¶</a></dt>

498

<dd>Encode the given object, o, and yield each string representation as

499

available. For example:

500

<div class="highlight"><pre>for chunk in JSONEncoder().iterencode(bigobject):

501

mysocket.write(chunk)

502

</pre></div>

503

Note that <a title="simplejson.JSONEncoder.encode" class="reference internal" href="#simplejson.JSONEncoder.encode"><tt class="xref docutils literal">encode()</tt></a> has much better performance than

504

<a title="simplejson.JSONEncoder.iterencode" class="reference internal" href="#simplejson.JSONEncoder.iterencode"><tt class="xref docutils literal">iterencode()</tt></a>.

505

</dd></dl>

506

507

</dd></dl>

508

509

510

511

class <tt class="descclassname">simplejson.</tt><tt class="descname">JSONEncoderForHTML</tt><big>(</big>[skipkeys[, ensure_ascii[, check_circular[, allow_nan[, sort_keys[, indent[, separators[, encoding[, default]]]]]]]]]<big>)</big><a class="headerlink" href="#simplejson.JSONEncoderForHTML" title="Permalink to this definition">¶</a></dt>

512

<dd>Subclass of <a title="simplejson.JSONEncoder" class="reference internal" href="#simplejson.JSONEncoder"><tt class="xref docutils literal">JSONEncoder</tt></a> that escapes &, <, and > for embedding in HTML.

513

514

Changed in version 2.1.0: New in 2.1.0

515

</dd></dl>

516

517

</div>

518

</div>

519

520

521

</div>

522

</div>

523

</div>

524

525

526

<h3>Table Of Contents</h3>

527

<ul>

528

<li><a class="reference external" href=""><tt class="docutils literal">simplejson</tt> — JSON encoder and decoder</a><ul>

529

<li><a class="reference external" href="#basic-usage">Basic Usage</a></li>

530

<li><a class="reference external" href="#encoders-and-decoders">Encoders and decoders</a></li>

531

</ul>

532

</li>

533

</ul>

534

535

536

537

<li><a href="_sources/index.txt">Show Source</a></li>

538

</ul>

539

<h3>Quick search</h3>

540

541

542

543

544

</form>

545

</div>

546

</div>

547

548

</div>

549

550

<h3>Navigation</h3>

551

<ul>

552

553

<a href="genindex.html" title="General Index"

554

accesskey="I">index</a></li>

555

<li><a href="">simplejson v2.1.1 documentation</a> »</li>

556

</ul>

557

</div>

558

559

560

Last updated on Mar 31, 2010.

561

Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.

562

</div>

563

</body>

564

</html>

b'\\ No newline at end of file'

Older »