third_party/simplejson/docs/index.html - Issue 159607: Extension docs build script, gyp target and PRESUBMIT.PY check

Unified Diff: third_party/simplejson/docs/index.html

Issue 159607: Extension docs build script, gyp target and PRESUBMIT.PY check (Closed)

Patch Set: remove build step on mac Created 11 years, 5 months ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View side-by-side diff with in-line comments

Index: third_party/simplejson/docs/index.html

diff --git a/third_party/simplejson/docs/index.html b/third_party/simplejson/docs/index.html

new file mode 100755

index 0000000000000000000000000000000000000000..5d2e8e80f0f61f6daa642fe773ed74bbd194625c

--- /dev/null

+++ b/third_party/simplejson/docs/index.html

@@ -0,0 +1,503 @@

+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml">

+ <head>

+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

+ <title>simplejson — JSON encoder and decoder — simplejson v2.0.0 documentation</title>

+ <link rel="stylesheet" href="_static/default.css" type="text/css" />

+ <link rel="stylesheet" href="_static/pygments.css" type="text/css" />

+ <script type="text/javascript">

+ var DOCUMENTATION_OPTIONS = {

+ URL_ROOT: '',

+ VERSION: '2.0.0',

+ COLLAPSE_MODINDEX: false,

+ FILE_SUFFIX: '.html'

+ };

+ </script>

+ <script type="text/javascript" src="_static/jquery.js"></script>

+ <script type="text/javascript" src="_static/interface.js"></script>

+ <script type="text/javascript" src="_static/doctools.js"></script>

+ <link rel="contents" title="Global table of contents" href="contents.html" />

+ <link rel="index" title="Global index" href="genindex.html" />

+ <link rel="search" title="Search" href="search.html" />

+ <link rel="top" title="simplejson v2.0.0 documentation" href="" />

+ </head>

+ <body>

+ <div class="related">

+ <h3>Navigation</h3>

+ <ul>

+ <li class="right" style="margin-right: 10px">

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

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

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

+ </ul>

+ </div>

+ <div class="document">

+ <div class="documentwrapper">

+ <div class="bodywrapper">

+ <div class="body">

+ <div class="section" id="module-simplejson">

+<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.4 and 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>

+Specializing JSON object decoding:

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

+>>> def as_complex(dct):

+... if '__complex__' in dct:

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

+... return dct

+...

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

+... object_hook=as_complex)

+(1+2j)

+>>> import decimal

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

+True

+</pre></div>

+Specializing JSON object encoding:

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

+>>> def encode_complex(obj):

+... if isinstance(obj, complex):

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

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

+...

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

+'[2.0, 1.0]'

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

+'[2.0, 1.0]'

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

+'[2.0, 1.0]'

+</pre></div>

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

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

+ "json": "obj"

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

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

+</pre></div>

+<div class="admonition note">

+Note

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

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

+</div>

+<div class="section" id="basic-usage">

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

+<dl class="function">

+<dt id="simplejson.dump">

+<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[, **kw]]]]]]]]]]<big>)</big><a class="headerlink" href="#simplejson.dump" title="Permalink to this definition">¶</a></dt>

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

+file-like object).

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

+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>,

+<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

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

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

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

+<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>

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

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

+they are safe and it is highly optimized.

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

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

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

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

+<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>,

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

+If allow_nan is true, their JavaScript equivalents will be used

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

+If indent is a non-negative integer, then JSON array elements and object

+members will be pretty-printed with that indent level. An indent level of 0

+will only insert newlines. <tt class="xref docutils literal">None</tt> (the default) selects the most compact

+representation.

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

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

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

+encoding is the character encoding for str instances, default is

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

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

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

+version of the object or raise a <tt class="xref docutils literal">TypeError</tt>. If not specified,

+<tt class="xref docutils literal">TypeError</tt> is always raised in those cases.

+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

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

+cls kwarg.

+<blockquote>

+<div class="admonition note">

+Note

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

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

+container protocol to delimit them.

+</div>

+</blockquote>

+</dd></dl>

+<dl class="function">

+<dt id="simplejson.dumps">

+<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[, **kw]]]]]]]]]]<big>)</big><a class="headerlink" href="#simplejson.dumps" title="Permalink to this definition">¶</a></dt>

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

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

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

+<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

+better performance.

+</dd></dl>

+<dl class="function">

+<dt id="simplejson.load">

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

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

+document) to a Python object.

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

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

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

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

+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

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

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

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

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

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

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

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

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

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

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

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

+be used to use another datatype or parser for JSON integers

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

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

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

+raise an exception if invalid JSON numbers are encountered.

+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>

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

+class.

+<blockquote>

+<div class="admonition note">

+Note

+<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

+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

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

+other than whitespace after the document. Except for files containing

+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>.

+</div>

+</blockquote>

+</dd></dl>

+<dl class="function">

+<dt id="simplejson.loads">

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

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

+document) to a Python object.

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

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

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

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

+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>.

+</dd></dl>

+</div>

+<div class="section" id="encoders-and-decoders">

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

+<dl class="class">

+<dt id="simplejson.JSONDecoder">

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

+<dd>Simple JSON decoder.

+Performs the following translations in decoding by default:

+<table border="1" class="docutils">

+<colgroup>

+<col width="44%" />

+<col width="56%" />

+</colgroup>

+<thead valign="bottom">

+<tr><th class="head">JSON</th>

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

+</tr>

+</thead>

+<tbody valign="top">

+<tr><td>object</td>

+<td>dict</td>

+</tr>

+<tr><td>array</td>

+<td>list</td>

+</tr>

+<tr><td>string</td>

+<td>unicode</td>

+</tr>

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

+<td>int, long</td>

+</tr>

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

+<td>float</td>

+</tr>

+<tr><td>true</td>

+<td>True</td>

+</tr>

+<tr><td>false</td>

+<td>False</td>

+</tr>

+<tr><td>null</td>

+<td>None</td>

+</tr>

+</tbody>

+</table>

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

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

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

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

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

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

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

+object_hook, if specified, will be called with the result of every JSON

+object decoded and its return value will be used in place of the given

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

+support JSON-RPC class hinting).

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

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

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

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

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

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

+be used to use another datatype or parser for JSON integers

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

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

+raise an exception if invalid JSON numbers are encountered.

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

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

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

+characters will be allowed in strings.

+<dl class="method">

+<dt id="simplejson.JSONDecoder.decode">

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

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

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

+<dl class="method">

+<dt id="simplejson.JSONDecoder.raw_decode">

+<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>

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

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

+representation and the index in s where the document ended.

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

+extraneous data at the end.

+</dd></dl>

+<dl class="class">

+<dt id="simplejson.JSONEncoder">

+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>

+<dd>Extensible JSON encoder for Python data structures.

+Supports the following objects and types by default:

+<table border="1" class="docutils">

+<colgroup>

+<col width="56%" />

+<col width="44%" />

+</colgroup>

+<thead valign="bottom">

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

+<th class="head">JSON</th>

+</tr>

+</thead>

+<tbody valign="top">

+<tr><td>dict</td>

+<td>object</td>

+</tr>

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

+<td>array</td>

+</tr>

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

+<td>string</td>

+</tr>

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

+<td>number</td>

+</tr>

+<tr><td>True</td>

+<td>true</td>

+</tr>

+<tr><td>False</td>

+<td>false</td>

+</tr>

+<tr><td>None</td>

+<td>null</td>

+</tr>

+</tbody>

+</table>

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

+<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

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

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

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

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

+skipkeys is true, such items are simply skipped.

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

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

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

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

+encoded objects will be checked for circular references during encoding to

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

+Otherwise, no such check takes place.

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

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

+specification compliant, but is consistent with most JavaScript based

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

+such floats.

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

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

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

+If indent is a non-negative integer (it is <tt class="xref docutils literal">None</tt> by default), then JSON

+array elements and object members will be pretty-printed with that indent

+level. An indent level of 0 will only insert newlines. <tt class="xref docutils literal">None</tt> is the most

+compact representation.

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

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

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

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

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

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

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

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

+<dl class="method">

+<dt id="simplejson.JSONEncoder.default">

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

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

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

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

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

+like this:

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

+ try:

+ iterable = iter(o)

+ except TypeError:

+ pass

+ else:

+ return list(iterable)

+ return JSONEncoder.default(self, o)

+</pre></div>

+</dd></dl>

+<dl class="method">

+<dt id="simplejson.JSONEncoder.encode">

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

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

+example:

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

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

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

+</pre></div>

+</dd></dl>

+<dl class="method">

+<dt id="simplejson.JSONEncoder.iterencode">

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

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

+available. For example:

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

+ mysocket.write(chunk)

+</pre></div>

+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

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

+</dd></dl>

+</div>

+ </div>

+ <div class="sphinxsidebar">

+ <div class="sphinxsidebarwrapper">

+ <h3>Table Of Contents</h3>

+ <ul>

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

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

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

+</ul>

+</li>

+</ul>

+ <h3>This Page</h3>

+ <ul class="this-page-menu">

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

+ </ul>

+ <h3>Quick search</h3>

+ <form class="search" action="search.html" method="get">

+ <input type="text" name="q" size="18" /> <input type="submit" value="Go" />

+ <input type="hidden" name="check_keywords" value="yes" />

+ <input type="hidden" name="area" value="default" />

+ </form>

+ </div>

+ <div class="clearer"></div>

+ </div>

+ <div class="related">

+ <h3>Navigation</h3>

+ <ul>

+ <li class="right" style="margin-right: 10px">

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

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

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

+ </ul>

+ </div>

+ <div class="footer">

+ Last updated on Feb 18, 2009.

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

+ </div>

+ </body>

+</html>

« no previous file with comments | « third_party/simplejson/docs/genindex.html ('k') | third_party/simplejson/docs/search.html » ('j') | no next file with comments »