diff --git a/docs/class-simplejson.JSONDecoder.html b/docs/class-simplejson.JSONDecoder.html new file mode 100644 index 0000000000000000000000000000000000000000..8b45c785af13ce27ef32feeb750c6de8650b274d_ZG9jcy9jbGFzcy1zaW1wbGVqc29uLkpTT05EZWNvZGVyLmh0bWw= --- /dev/null +++ b/docs/class-simplejson.JSONDecoder.html @@ -0,0 +1,205 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<HTML> + + <HEAD><META CONTENT="text/html; charset=utf-8" HTTP-EQUIV="Content-Type"> + <TITLE>simplejson.JSONDecoder -- Simple JSON &lt;<a class="reference" href="http://json.org">http://json.org</a>&gt; decoder</TITLE> + <LINK HREF="layout.css" TYPE="text/css" REL="stylesheet"> + + </HEAD> + <BODY> + <DIV ID="page"> + + <DIV ID="top-nav"> + <H1 ID="doc-title"> + <A HREF="index.html" REL="index">simplejson 1.1</A></H1> + <DIV CLASS="online-navigation"> + <A HREF="index.html" REL="index">index</A> + <SPAN ID="nav-docs"> + + </SPAN> + + + <BR> + + + + <A HREF="module-simplejson.html" TITLE="simplejson reference"> + simplejson + </A> + + + <A HREF="class-simplejson.JSONDecoder.html">details</A> + + <A HREF="class-simplejson.JSONDecoder-index.html"> + tree + </A> + + + </DIV> + </DIV> + + <DIV ID="main-content"> + + <H1 CLASS="pudge-member-page-heading"> + <TT>JSONDecoder</TT> + </H1> + <H4 CLASS="pudge-member-page-subheading"> + Simple JSON <<A HREF="http://json.org" CLASS="reference">http://json.org</A>> decoder + </H4> + <P CLASS="pudge-member-parent-link"> + <SMALL> + The JSONDecoder class is accessible via the + <A HREF="module-simplejson.html"> + <TT>simplejson</TT> + </A> module. + </SMALL> + </P> + <DIV ID="pudge-section-nav"> + <UL> + <LI> + <A HREF="#attributes" CLASS="pudge-section-link"> + Attributes (1) + </A> + + </LI> + + <LI> + <A HREF="#methods" CLASS="pudge-section-link"> + Methods (1) + </A> + + </LI> + + <LI> + <A HREF="simplejson/decoder.py.html?f=196&l=257#196" CLASS="pudge-section-link"> + Source + </A> + </LI> + </UL> + </DIV> + <DIV STYLE="clear: left"> + </DIV> + <DIV CLASS="rst pudge-module-doc"> + <P>Performs the following translations in decoding:</P> +<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> +<P>It also understands <TT CLASS="docutils literal"><SPAN CLASS="pre">NaN</SPAN></TT>, <TT CLASS="docutils literal"><SPAN CLASS="pre">Infinity</SPAN></TT>, and <TT CLASS="docutils literal"><SPAN CLASS="pre">-Infinity</SPAN></TT> as +their corresponding <TT CLASS="docutils literal"><SPAN CLASS="pre">float</SPAN></TT> values, which is outside the JSON spec.</P> + </DIV> + + <HR> + + + + + <A NAME="attributes"> + + + </A> + <H2>Attributes</H2> + <DIV CLASS="pudge-member name"> + <A NAME="scanner"> + </A> + <H4 CLASS="pudge-member-name"> + <SPAN CLASS="prefix">a</SPAN> + <TT> + <A HREF="class-simplejson.JSONDecoder.html#scanner" CLASS="pudge-obj-link">scanner</A></TT></H4> + <DIV CLASS="pudge-section rst"> + <PRE><simplejson.scanner.Scanner object at 0x67ec70></PRE> + </DIV> + </DIV> + + + <A NAME="methods"> + + + </A> + <H2>Methods</H2> + <DIV CLASS="pudge-member routine alias"> + <A NAME="__init__"> + </A> + <H4 CLASS="pudge-member-name"> + <SPAN CLASS="prefix">f</SPAN> + <TT> + <A HREF="class-simplejson.JSONDecoder.html#__init__" CLASS="pudge-obj-link">__init__</A>(self, encoding=None)</TT> + <A HREF="simplejson/decoder.py.html?f=228&l=230#228" TITLE="View Source">...</A> + </H4> + <DIV CLASS="pudge-section rst"> + + + + + </DIV> + </DIV> + + + + <P> + <SMALL> + + + See + <A HREF="simplejson/decoder.py.html?f=196&l=257#196" TITLE="simplejson/decoder.py:196">the source</A> + for more information. + </SMALL> + </P> +</DIV> + + <DIV ID="footer"> + + <P ID="pudge"> + Built with + <A HREF="http://lesscode.org/projects/pudge/"> + Pudge/0.1</A> + </P> + + </DIV> + </DIV> + </BODY> +</HTML> \ No newline at end of file diff --git a/docs/class-simplejson.JSONEncoder.html b/docs/class-simplejson.JSONEncoder.html new file mode 100644 index 0000000000000000000000000000000000000000..8b45c785af13ce27ef32feeb750c6de8650b274d_ZG9jcy9jbGFzcy1zaW1wbGVqc29uLkpTT05FbmNvZGVyLmh0bWw= --- /dev/null +++ b/docs/class-simplejson.JSONEncoder.html @@ -0,0 +1,199 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<HTML> + + <HEAD><META CONTENT="text/html; charset=utf-8" HTTP-EQUIV="Content-Type"> + <TITLE>simplejson.JSONEncoder -- Extensible JSON &lt;<a class="reference" href="http://json.org">http://json.org</a>&gt; encoder for Python data structures.</TITLE> + <LINK HREF="layout.css" TYPE="text/css" REL="stylesheet"> + + </HEAD> + <BODY> + <DIV ID="page"> + + <DIV ID="top-nav"> + <H1 ID="doc-title"> + <A HREF="index.html" REL="index">simplejson 1.1</A></H1> + <DIV CLASS="online-navigation"> + <A HREF="index.html" REL="index">index</A> + <SPAN ID="nav-docs"> + + </SPAN> + + + <BR> + + + + <A HREF="module-simplejson.html" TITLE="simplejson reference"> + simplejson + </A> + + + <A HREF="class-simplejson.JSONEncoder.html">details</A> + + <A HREF="class-simplejson.JSONEncoder-index.html"> + tree + </A> + + + </DIV> + </DIV> + + <DIV ID="main-content"> + + <H1 CLASS="pudge-member-page-heading"> + <TT>JSONEncoder</TT> + </H1> + <H4 CLASS="pudge-member-page-subheading"> + Extensible JSON <<A HREF="http://json.org" CLASS="reference">http://json.org</A>> encoder for Python data structures. + </H4> + <P CLASS="pudge-member-parent-link"> + <SMALL> + The JSONEncoder class is accessible via the + <A HREF="module-simplejson.html"> + <TT>simplejson</TT> + </A> module. + </SMALL> + </P> + <DIV ID="pudge-section-nav"> + <UL> + <LI> + + <SPAN CLASS="pudge-missing-section-link"> + Attributes + </SPAN> + </LI> + <LI> + <A HREF="#methods" CLASS="pudge-section-link"> + Methods (1) + </A> + + </LI> + + <LI> + <A HREF="simplejson/encoder.py.html?f=63&l=273#63" CLASS="pudge-section-link"> + Source + </A> + </LI> + </UL> + </DIV> + <DIV STYLE="clear: left"> + </DIV> + <DIV CLASS="rst pudge-module-doc"> + <P>Supports the following objects and types by default:</P> +<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> +<P>To extend this to recognize other objects, subclass and implement a +<TT CLASS="docutils literal"><SPAN CLASS="pre">.default(o)</SPAN></TT> method with another method that returns a serializable +object for <TT CLASS="docutils literal"><SPAN CLASS="pre">o</SPAN></TT> if possible, otherwise it should call the superclass +implementation (to raise <TT CLASS="docutils literal"><SPAN CLASS="pre">TypeError</SPAN></TT>).</P> + </DIV> + + <HR> + + + + + <A NAME="methods"> + + + </A> + <H2>Methods</H2> + <DIV CLASS="pudge-member routine alias"> + <A NAME="__init__"> + </A> + <H4 CLASS="pudge-member-name"> + <SPAN CLASS="prefix">f</SPAN> + <TT> + <A HREF="class-simplejson.JSONEncoder.html#__init__" CLASS="pudge-obj-link">__init__</A>(self, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True)</TT> + <A HREF="simplejson/encoder.py.html?f=92&l=120#92" TITLE="View Source">...</A> + </H4> + <DIV CLASS="pudge-section rst"> + + <P CLASS="pudge-member-blurb"> + Constructor for JSONEncoder, with sensible defaults. + </P> + <P>If skipkeys is False, then it is a TypeError to attempt +encoding of keys that are not str, int, long, float or None. If +skipkeys is True, such items are simply skipped.</P> +<P>If ensure_ascii is True, the output is guaranteed to be str +objects with all incoming unicode characters escaped. If ensure_ascii +is false, the output will be unicode object.</P> +<P>If check_circular is True, then lists, dicts, and custom encoded +objects will be checked for circular references during encoding to +prevent an infinite recursion (which would cause an OverflowError). +Otherwise, no such check takes place.</P> +<P>If allow_nan is True, then NaN, Infinity, and -Infinity 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 ValueError to encode such floats.</P> + + </DIV> + </DIV> + + + + <P> + <SMALL> + + + See + <A HREF="simplejson/encoder.py.html?f=63&l=273#63" TITLE="simplejson/encoder.py:63">the source</A> + for more information. + </SMALL> + </P> +</DIV> + + <DIV ID="footer"> + + <P ID="pudge"> + Built with + <A HREF="http://lesscode.org/projects/pudge/"> + Pudge/0.1</A> + </P> + + </DIV> + </DIV> + </BODY> +</HTML> \ No newline at end of file diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000000000000000000000000000000000000..8b45c785af13ce27ef32feeb750c6de8650b274d_ZG9jcy9pbmRleC5odG1s --- /dev/null +++ b/docs/index.html @@ -0,0 +1,448 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<HTML> + + <HEAD><META CONTENT="text/html; charset=utf-8" HTTP-EQUIV="Content-Type"> + <TITLE>simplejson -- A simple, fast, extensible JSON encoder and decoder</TITLE> + <LINK HREF="layout.css" TYPE="text/css" REL="stylesheet"> + + </HEAD> + <BODY> + <DIV ID="page"> + + <DIV ID="top-nav"> + <H1 ID="doc-title"> + <A HREF="index.html" REL="index">simplejson 1.1</A></H1> + <DIV CLASS="online-navigation"> + <A HREF="index.html" REL="index">index</A> + <SPAN ID="nav-docs"> + + </SPAN> + + + <BR> + + + + <A HREF="module-simplejson.html" TITLE="simplejson reference"> + simplejson + </A> + + + <A HREF="module-simplejson.html">details</A> + + <A HREF="module-simplejson-index.html"> + tree + </A> + + + </DIV> + </DIV> + + <DIV ID="main-content"> + + <H1 CLASS="pudge-member-page-heading"> + <TT>simplejson</TT> + </H1> + <H4 CLASS="pudge-member-page-subheading"> + A simple, fast, extensible JSON encoder and decoder + </H4> + + <DIV ID="pudge-section-nav"> + <UL> + <LI> + + <SPAN CLASS="pudge-missing-section-link"> + Attributes + </SPAN> + </LI> + <LI> + <A HREF="#functions" CLASS="pudge-section-link"> + Functions (4) + </A> + + </LI> + + <LI> + <A HREF="#classes" CLASS="pudge-section-link"> + Classes (2) + </A> + + </LI> + + <LI> + + <SPAN CLASS="pudge-missing-section-link"> + Modules + </SPAN> + </LI> + <LI> + <A HREF="module-simplejson-index.html" CLASS="pudge-section-link"> + Index + </A> + </LI> + <LI> + <A HREF="simplejson/__init__.py.html" CLASS="pudge-section-link"> + Source + </A> + </LI> + </UL> + </DIV> + <DIV STYLE="clear: left"> + </DIV> + <DIV CLASS="rst pudge-module-doc"> + <P>JSON (JavaScript Object Notation) <<A HREF="http://json.org" CLASS="reference">http://json.org</A>> is a subset of +JavaScript syntax (ECMA-262 3rd edition) used as a lightweight data +interchange format.</P> +<P>simplejson exposes an API familiar to uses of the standard library +marshal and pickle modules.</P> +<P>Encoding basic Python object hierarchies:</P> +<PRE CLASS="literal-block"> +>>> import simplejson +>>> simplejson.dumps(['foo', {'bar': ('baz', None, 1.0, 2)}]) +'["foo", {"bar":["baz", null, 1.0, 2]}]' +>>> print simplejson.dumps("\"foo\bar") +"\"foo\bar" +>>> print simplejson.dumps(u'\u1234') +"\u1234" +>>> print simplejson.dumps('\\') +"\\" +>>> from StringIO import StringIO +>>> io = StringIO() +>>> simplejson.dump(['streaming API'], io) +>>> io.getvalue() +'["streaming API"]' +</PRE> +<P>Decoding JSON:</P> +<PRE CLASS="literal-block"> +>>> import simplejson +>>> simplejson.loads('["foo", {"bar":["baz", null, 1.0, 2]}]') +[u'foo', {u'bar': [u'baz', None, 1.0, 2]}] +>>> simplejson.loads('"\\"foo\\bar"') +u'"foo\x08ar' +>>> from StringIO import StringIO +>>> io = StringIO('["streaming API"]') +>>> simplejson.load(io) +[u'streaming API'] +</PRE> +<P>Extending JSONEncoder:</P> +<PRE CLASS="literal-block"> +>>> import simplejson +>>> class ComplexEncoder(simplejson.JSONEncoder): +... def default(self, obj): +... if isinstance(obj, complex): +... return [obj.real, obj.imag] +... return simplejson.JSONEncoder.default(self, obj) +... +>>> dumps(2 + 1j, cls=ComplexEncoder) +'[2.0, 1.0]' +>>> ComplexEncoder().encode(2 + 1j) +'[2.0, 1.0]' +>>> list(ComplexEncoder().iterencode(2 + 1j)) +['[', '2.0', ', ', '1.0', ']'] +</PRE> +<P>Note that the JSON produced by this module is a subset of YAML, +so it may be used as a serializer for that as well.</P> + </DIV> + + <HR> + + + + + <A NAME="functions"> + + + </A> + <H2>Functions</H2> + <DIV CLASS="pudge-member routine "> + <A NAME="dump"> + </A> + <H4 CLASS="pudge-member-name"> + <SPAN CLASS="prefix">f</SPAN> + <TT> + <A HREF="module-simplejson.html#dump" CLASS="pudge-obj-link">dump</A>(obj, fp, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, cls=None)</TT> + <A HREF="simplejson/__init__.py.html?f=69&l=107#69" TITLE="View Source">...</A> + </H4> + <DIV CLASS="pudge-section rst"> + + <P CLASS="pudge-member-blurb"> + Serialize <TT CLASS="docutils literal"><SPAN CLASS="pre">obj</SPAN></TT> as a JSON formatted stream to <TT CLASS="docutils literal"><SPAN CLASS="pre">fp</SPAN></TT> (a +<TT CLASS="docutils literal"><SPAN CLASS="pre">.write()</SPAN></TT>-supporting file-like object). + </P> + <P>If <TT CLASS="docutils literal"><SPAN CLASS="pre">skipkeys</SPAN></TT> is <TT CLASS="docutils literal"><SPAN CLASS="pre">True</SPAN></TT> then <TT CLASS="docutils literal"><SPAN CLASS="pre">dict</SPAN></TT> keys that are not basic types +(<TT CLASS="docutils literal"><SPAN CLASS="pre">str</SPAN></TT>, <TT CLASS="docutils literal"><SPAN CLASS="pre">unicode</SPAN></TT>, <TT CLASS="docutils literal"><SPAN CLASS="pre">int</SPAN></TT>, <TT CLASS="docutils literal"><SPAN CLASS="pre">long</SPAN></TT>, <TT CLASS="docutils literal"><SPAN CLASS="pre">float</SPAN></TT>, <TT CLASS="docutils literal"><SPAN CLASS="pre">bool</SPAN></TT>, <TT CLASS="docutils literal"><SPAN CLASS="pre">None</SPAN></TT>) +will be skipped instead of raising a <TT CLASS="docutils literal"><SPAN CLASS="pre">TypeError</SPAN></TT>.</P> +<P>If <TT CLASS="docutils literal"><SPAN CLASS="pre">ensure_ascii</SPAN></TT> is <TT CLASS="docutils literal"><SPAN CLASS="pre">False</SPAN></TT>, then the some chunks written to <TT CLASS="docutils literal"><SPAN CLASS="pre">fp</SPAN></TT> +may be <TT CLASS="docutils literal"><SPAN CLASS="pre">unicode</SPAN></TT> instances, subject to normal Python <TT CLASS="docutils literal"><SPAN CLASS="pre">str</SPAN></TT> to +<TT CLASS="docutils literal"><SPAN CLASS="pre">unicode</SPAN></TT> coercion rules. Unless <TT CLASS="docutils literal"><SPAN CLASS="pre">fp.write()</SPAN></TT> explicitly +understands <TT CLASS="docutils literal"><SPAN CLASS="pre">unicode</SPAN></TT> (as in <TT CLASS="docutils literal"><SPAN CLASS="pre">codecs.getwriter()</SPAN></TT>) this is likely +to cause an error.</P> +<P>If <TT CLASS="docutils literal"><SPAN CLASS="pre">check_circular</SPAN></TT> is <TT CLASS="docutils literal"><SPAN CLASS="pre">False</SPAN></TT>, then the circular reference check +for container types will be skipped and a circular reference will +result in an <TT CLASS="docutils literal"><SPAN CLASS="pre">OverflowError</SPAN></TT> (or worse).</P> +<P>If <TT CLASS="docutils literal"><SPAN CLASS="pre">allow_nan</SPAN></TT> is <TT CLASS="docutils literal"><SPAN CLASS="pre">False</SPAN></TT>, then it will be a <TT CLASS="docutils literal"><SPAN CLASS="pre">ValueError</SPAN></TT> to +serialize out of range <TT CLASS="docutils literal"><SPAN CLASS="pre">float</SPAN></TT> values (<TT CLASS="docutils literal"><SPAN CLASS="pre">nan</SPAN></TT>, <TT CLASS="docutils literal"><SPAN CLASS="pre">inf</SPAN></TT>, <TT CLASS="docutils literal"><SPAN CLASS="pre">-inf</SPAN></TT>) +in strict compliance of the JSON specification, instead of using the +JavaScript equivalents (<TT CLASS="docutils literal"><SPAN CLASS="pre">NaN</SPAN></TT>, <TT CLASS="docutils literal"><SPAN CLASS="pre">Infinity</SPAN></TT>, <TT CLASS="docutils literal"><SPAN CLASS="pre">-Infinity</SPAN></TT>).</P> +<P>To use a custom <TT CLASS="docutils literal"><SPAN CLASS="pre">JSONEncoder</SPAN></TT> subclass (e.g. one that overrides the +<TT CLASS="docutils literal"><SPAN CLASS="pre">.default()</SPAN></TT> method to serialize additional types), specify it with +the <TT CLASS="docutils literal"><SPAN CLASS="pre">cls</SPAN></TT> kwarg.</P> + + </DIV> + </DIV> + <DIV CLASS="pudge-member routine "> + <A NAME="dumps"> + </A> + <H4 CLASS="pudge-member-name"> + <SPAN CLASS="prefix">f</SPAN> + <TT> + <A HREF="module-simplejson.html#dumps" CLASS="pudge-obj-link">dumps</A>(obj, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, cls=None)</TT> + <A HREF="simplejson/__init__.py.html?f=108&l=138#108" TITLE="View Source">...</A> + </H4> + <DIV CLASS="pudge-section rst"> + + <P CLASS="pudge-member-blurb"> + Serialize <TT CLASS="docutils literal"><SPAN CLASS="pre">obj</SPAN></TT> to a JSON formatted <TT CLASS="docutils literal"><SPAN CLASS="pre">str</SPAN></TT>. + </P> + <P>If <TT CLASS="docutils literal"><SPAN CLASS="pre">skipkeys</SPAN></TT> is <TT CLASS="docutils literal"><SPAN CLASS="pre">True</SPAN></TT> then <TT CLASS="docutils literal"><SPAN CLASS="pre">dict</SPAN></TT> keys that are not basic types +(<TT CLASS="docutils literal"><SPAN CLASS="pre">str</SPAN></TT>, <TT CLASS="docutils literal"><SPAN CLASS="pre">unicode</SPAN></TT>, <TT CLASS="docutils literal"><SPAN CLASS="pre">int</SPAN></TT>, <TT CLASS="docutils literal"><SPAN CLASS="pre">long</SPAN></TT>, <TT CLASS="docutils literal"><SPAN CLASS="pre">float</SPAN></TT>, <TT CLASS="docutils literal"><SPAN CLASS="pre">bool</SPAN></TT>, <TT CLASS="docutils literal"><SPAN CLASS="pre">None</SPAN></TT>) +will be skipped instead of raising a <TT CLASS="docutils literal"><SPAN CLASS="pre">TypeError</SPAN></TT>.</P> +<P>If <TT CLASS="docutils literal"><SPAN CLASS="pre">ensure_ascii</SPAN></TT> is <TT CLASS="docutils literal"><SPAN CLASS="pre">False</SPAN></TT>, then the return value will be a +<TT CLASS="docutils literal"><SPAN CLASS="pre">unicode</SPAN></TT> instance subject to normal Python <TT CLASS="docutils literal"><SPAN CLASS="pre">str</SPAN></TT> to <TT CLASS="docutils literal"><SPAN CLASS="pre">unicode</SPAN></TT> +coercion rules instead of being escaped to an ASCII <TT CLASS="docutils literal"><SPAN CLASS="pre">str</SPAN></TT>.</P> +<P>If <TT CLASS="docutils literal"><SPAN CLASS="pre">check_circular</SPAN></TT> is <TT CLASS="docutils literal"><SPAN CLASS="pre">False</SPAN></TT>, then the circular reference check +for container types will be skipped and a circular reference will +result in an <TT CLASS="docutils literal"><SPAN CLASS="pre">OverflowError</SPAN></TT> (or worse).</P> +<P>If <TT CLASS="docutils literal"><SPAN CLASS="pre">allow_nan</SPAN></TT> is <TT CLASS="docutils literal"><SPAN CLASS="pre">False</SPAN></TT>, then it will be a <TT CLASS="docutils literal"><SPAN CLASS="pre">ValueError</SPAN></TT> to +serialize out of range <TT CLASS="docutils literal"><SPAN CLASS="pre">float</SPAN></TT> values (<TT CLASS="docutils literal"><SPAN CLASS="pre">nan</SPAN></TT>, <TT CLASS="docutils literal"><SPAN CLASS="pre">inf</SPAN></TT>, <TT CLASS="docutils literal"><SPAN CLASS="pre">-inf</SPAN></TT>) in +strict compliance of the JSON specification, instead of using the +JavaScript equivalents (<TT CLASS="docutils literal"><SPAN CLASS="pre">NaN</SPAN></TT>, <TT CLASS="docutils literal"><SPAN CLASS="pre">Infinity</SPAN></TT>, <TT CLASS="docutils literal"><SPAN CLASS="pre">-Infinity</SPAN></TT>).</P> +<P>To use a custom <TT CLASS="docutils literal"><SPAN CLASS="pre">JSONEncoder</SPAN></TT> subclass (e.g. one that overrides the +<TT CLASS="docutils literal"><SPAN CLASS="pre">.default()</SPAN></TT> method to serialize additional types), specify it with +the <TT CLASS="docutils literal"><SPAN CLASS="pre">cls</SPAN></TT> kwarg.</P> + + </DIV> + </DIV> + <DIV CLASS="pudge-member routine "> + <A NAME="load"> + </A> + <H4 CLASS="pudge-member-name"> + <SPAN CLASS="prefix">f</SPAN> + <TT> + <A HREF="module-simplejson.html#load" CLASS="pudge-obj-link">load</A>(fp, encoding=None, cls=None)</TT> + <A HREF="simplejson/__init__.py.html?f=139&l=157#139" TITLE="View Source">...</A> + </H4> + <DIV CLASS="pudge-section rst"> + + <P CLASS="pudge-member-blurb"> + Deserialize <TT CLASS="docutils literal"><SPAN CLASS="pre">fp</SPAN></TT> (a <TT CLASS="docutils literal"><SPAN CLASS="pre">.read()</SPAN></TT>-supporting file-like object containing +a JSON document) to a Python object. + </P> + <P>If the contents of <TT CLASS="docutils literal"><SPAN CLASS="pre">fp</SPAN></TT> is encoded with an ASCII based encoding other +than utf-8 (e.g. latin-1), then an appropriate <TT CLASS="docutils literal"><SPAN CLASS="pre">encoding</SPAN></TT> 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"><SPAN CLASS="pre">codecs.getreader(fp)(encoding)</SPAN></TT>, or simply decoded to a <TT CLASS="docutils literal"><SPAN CLASS="pre">unicode</SPAN></TT> +object and passed to <TT CLASS="docutils literal"><SPAN CLASS="pre">loads()</SPAN></TT></P> +<P>To use a custom <TT CLASS="docutils literal"><SPAN CLASS="pre">JSONDecoder</SPAN></TT> subclass, specify it with the <TT CLASS="docutils literal"><SPAN CLASS="pre">cls</SPAN></TT> +kwarg.</P> + + </DIV> + </DIV> + <DIV CLASS="pudge-member routine "> + <A NAME="loads"> + </A> + <H4 CLASS="pudge-member-name"> + <SPAN CLASS="prefix">f</SPAN> + <TT> + <A HREF="module-simplejson.html#loads" CLASS="pudge-obj-link">loads</A>(s, encoding=None, cls=None)</TT> + <A HREF="simplejson/__init__.py.html?f=158&l=174#158" TITLE="View Source">...</A> + </H4> + <DIV CLASS="pudge-section rst"> + + <P CLASS="pudge-member-blurb"> + Deserialize <TT CLASS="docutils literal"><SPAN CLASS="pre">s</SPAN></TT> (a <TT CLASS="docutils literal"><SPAN CLASS="pre">str</SPAN></TT> or <TT CLASS="docutils literal"><SPAN CLASS="pre">unicode</SPAN></TT> instance containing a JSON +document) to a Python object. + </P> + <P>If <TT CLASS="docutils literal"><SPAN CLASS="pre">s</SPAN></TT> is a <TT CLASS="docutils literal"><SPAN CLASS="pre">str</SPAN></TT> instance and is encoded with an ASCII based encoding +other than utf-8 (e.g. latin-1) then an appropriate <TT CLASS="docutils literal"><SPAN CLASS="pre">encoding</SPAN></TT> name +must be specified. Encodings that are not ASCII based (such as UCS-2) +are not allowed and should be decoded to <TT CLASS="docutils literal"><SPAN CLASS="pre">unicode</SPAN></TT> first.</P> +<P>To use a custom <TT CLASS="docutils literal"><SPAN CLASS="pre">JSONDecoder</SPAN></TT> subclass, specify it with the <TT CLASS="docutils literal"><SPAN CLASS="pre">cls</SPAN></TT> +kwarg.</P> + + </DIV> + </DIV> + + + <A NAME="classes"> + + + </A> + <H2>Classes</H2> + <DIV CLASS="pudge-member class alias"> + <H4 CLASS="pudge-member-name"> + <SPAN CLASS="prefix">C</SPAN> + <TT> + <A HREF="class-simplejson.JSONEncoder.html" CLASS="pudge-obj-link">JSONEncoder</A>(...)</TT> + <A HREF="simplejson/encoder.py.html?f=63&l=273#63" CLASS="pudge-member-view-source" TITLE="View Source">...</A> + </H4> + <DIV CLASS="pudge-section rst"> + + <P CLASS="pudge-member-blurb"> + Extensible JSON <<A HREF="http://json.org" CLASS="reference">http://json.org</A>> encoder for Python data structures. + </P> + <P>Supports the following objects and types by default:</P> +<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> +<P>To extend this to recognize other objects, subclass and implement a +<TT CLASS="docutils literal"><SPAN CLASS="pre">.default(o)</SPAN></TT> method with another method that returns a serializable +object for <TT CLASS="docutils literal"><SPAN CLASS="pre">o</SPAN></TT> if possible, otherwise it should call the superclass +implementation (to raise <TT CLASS="docutils literal"><SPAN CLASS="pre">TypeError</SPAN></TT>).</P> + + + <P CLASS="note"> + This class contains <A HREF="class-simplejson.JSONEncoder.html#members"> + 1 member</A>. + </P> + </DIV> + </DIV> + <DIV CLASS="pudge-member class alias"> + <H4 CLASS="pudge-member-name"> + <SPAN CLASS="prefix">C</SPAN> + <TT> + <A HREF="class-simplejson.JSONDecoder.html" CLASS="pudge-obj-link">JSONDecoder</A>(...)</TT> + <A HREF="simplejson/decoder.py.html?f=196&l=257#196" CLASS="pudge-member-view-source" TITLE="View Source">...</A> + </H4> + <DIV CLASS="pudge-section rst"> + + <P CLASS="pudge-member-blurb"> + Simple JSON <<A HREF="http://json.org" CLASS="reference">http://json.org</A>> decoder + </P> + <P>Performs the following translations in decoding:</P> +<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> +<P>It also understands <TT CLASS="docutils literal"><SPAN CLASS="pre">NaN</SPAN></TT>, <TT CLASS="docutils literal"><SPAN CLASS="pre">Infinity</SPAN></TT>, and <TT CLASS="docutils literal"><SPAN CLASS="pre">-Infinity</SPAN></TT> as +their corresponding <TT CLASS="docutils literal"><SPAN CLASS="pre">float</SPAN></TT> values, which is outside the JSON spec.</P> + + + <P CLASS="note"> + This class contains <A HREF="class-simplejson.JSONDecoder.html#members"> + 2 members</A>. + </P> + </DIV> + </DIV> + + + + <P> + <SMALL> + + + See + <A HREF="simplejson/__init__.py.html" TITLE="simplejson/__init__.py:0">the source</A> + for more information. + </SMALL> + </P> +</DIV> + + <DIV ID="footer"> + + <P ID="pudge"> + Built with + <A HREF="http://lesscode.org/projects/pudge/"> + Pudge/0.1</A> + </P> + + </DIV> + </DIV> + </BODY> +</HTML> \ No newline at end of file diff --git a/docs/layout.css b/docs/layout.css new file mode 100644 index 0000000000000000000000000000000000000000..8b45c785af13ce27ef32feeb750c6de8650b274d_ZG9jcy9sYXlvdXQuY3Nz --- /dev/null +++ b/docs/layout.css @@ -0,0 +1,208 @@ +@import url("pudge.css"); + +/* Basic Layout +---------------------------------- */ + +body { + margin-left: 1em; + margin-right: 1em; + max-width: 50em; +} +body { + font-size: .80em; + color: #111; +} +div#main-content { + margin-left: 1em; + margin-right: 1em; + max-width: 47em; +} + +/* Top Navigation +----------------------------------- */ + +div#top-nav { + background: #373; + padding: .3em .3em; + margin: 0; + margin-bottom: 1.5em; + font-size: 90%; +} +div#top-nav #doc-title { + font-size: 140%; + font-weight: bold; + margin: 0; + padding-top: .32em; + padding-right: 1em; + padding-left: .3em; + color: #9c9; + float: left; +} +div#top-nav a { + color: #6a6; + text-decoration: none; +} +div#top-nav .online-navigation a:hover, +div#top-nav h1 a +{ + color: #9c9; +} + +/* Footer +----------------------------------- */ + +div#footer { + text-align: right; + margin-top: 1.5em; + border-top: 1px solid #373; + padding-top: .5em; + font-size: 80%; + color: #666; +} +div#footer a { + color: #373; + text-decoration: none; +} +div#footer p { + margin: .2em 1em; +} + +/* Basic Style +----------------------------------- */ +h1, h2, h3, h4 { + margin: 1em auto; + font-family: 'Trebuchet MS', 'Verdana', Sans-serif; + color: #555; + font-weight: normal; +} +h1 { font-size: 200% } +h2 { font-size: 170% } +h3 { font-size: 150% } +h4 { font-size: 120% } +a:link { color: #060; font-weight: bold } +a:visited { color: #060; text-decoration: none } +hr { margin: auto 12px } +pre { color: #036 } + +dl dt { + font-style: italic; + margin-top: .5em; + font-weight: bold; + color: #555; +} +hr { + color: #373; + background-color: #373; + height: 1px; + border: 0; + width: 100%; + margin: 2em 0; +} + +/* Pudge Elements +--------------------------------- */ + +h1.pudge-member-page-heading { + font-size: 300%; + margin-top: .4em; + margin-bottom: .4em; +} +h4.pudge-member-page-subheading { + font-size: 150%; + font-style: italic; + margin-top: -1.3em; + margin-left: 2em; + color: #999; +} +p.pudge-member-blurb { + font-style: italic; + font-weight: bold; + font-size: 120%; + margin-top: 0.2em; + color: #6a6; +} +div.pudge-module-doc { + max-width: 45em; +} +div.pudge-section { + margin-left: 2em; + max-width: 45em; +} +p.pudge-member-blurb { + font-style: italic; + font-weight: bold; + font-size: 120%; +} + +/* Section Navigation +----------------------------------- */ + +div#pudge-section-nav +{ + margin: 1em 0 1.5em 0; + padding: 0; + height: 20px; +} + +div#pudge-section-nav ul { + border: 0; + margin: 0; + padding: 0; + list-style-type: none; + text-align: center; + border-right: 1px solid #aaa; +} +div#pudge-section-nav ul li +{ + display: block; + float: left; + text-align: center; + padding: 0; + margin: 0; +} + +div#pudge-section-nav ul li .pudge-section-link, +div#pudge-section-nav ul li .pudge-missing-section-link +{ + background: #aaa; + width: 11em; + height: 1.8em; + border: 0; + border-right: 3px solid #fff; + padding: 0; + margin: 0 0 10px 0; + color: #ddd; + text-decoration: none; + display: block; + text-align: center; + font: normal 10px/18px "Lucida Grande", "Lucida Sans Unicode", verdana, lucida, sans-serif; + font-weight: bold; + cursor: hand; +} + +div#pudge-section-nav ul li a:hover +{ + color: #fff; + background: #393; +} + +div#pudge-section-nav ul li .pudge-section-link +{ + background: #373; + color: #9c9; +} + +/* Module Lists +----------------------------------- */ +dl.pudge-module-list dt { + font-style: normal; + font-size: 110%; +} +dl.pudge-module-list dd { + color: #555; +} + +/* misc */ +pre, tt { + font-size: 120%; +} diff --git a/docs/module-index.html b/docs/module-index.html new file mode 100644 index 0000000000000000000000000000000000000000..8b45c785af13ce27ef32feeb750c6de8650b274d_ZG9jcy9tb2R1bGUtaW5kZXguaHRtbA== --- /dev/null +++ b/docs/module-index.html @@ -0,0 +1,73 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<HTML> + + <HEAD><META CONTENT="text/html; charset=utf-8" HTTP-EQUIV="Content-Type"> + <TITLE>simplejson 1.1 -- Module Reference</TITLE> + <LINK HREF="layout.css" TYPE="text/css" REL="stylesheet"> + + </HEAD> + <BODY> + <DIV ID="page"> + + <DIV ID="top-nav"> + <H1 ID="doc-title"> + <A HREF="index.html" REL="index">simplejson 1.1</A></H1> + <DIV CLASS="online-navigation"> + <A HREF="index.html" REL="index">index</A> + <SPAN ID="nav-docs"> + + </SPAN> + + + <BR> + + + + <A HREF="module-simplejson.html" TITLE="simplejson reference"> + simplejson + </A> + + </DIV> + </DIV> + + <DIV ID="main-content"> + + <H1 CLASS="pudge-member-page-heading"> + simplejson 1.1 + </H1> + <H4 CLASS="pudge-member-page-subheading"> + Module Reference + </H4> + + <H2>Packages and Modules</H2> + + <DL CLASS="pudge-module-list"> + + <DT> + + <TT> + + <A HREF="module-simplejson.html" CLASS="pudge-obj-link"> + simplejson + </A></TT> + </DT> + <DD> + A simple, fast, extensible JSON encoder and decoder + </DD> + + </DL> + +</DIV> + + <DIV ID="footer"> + + <P ID="pudge"> + Built with + <A HREF="http://lesscode.org/projects/pudge/"> + Pudge/0.1</A> + </P> + + </DIV> + </DIV> + </BODY> +</HTML> \ No newline at end of file diff --git a/docs/module-simplejson-index.html b/docs/module-simplejson-index.html new file mode 100644 index 0000000000000000000000000000000000000000..8b45c785af13ce27ef32feeb750c6de8650b274d_ZG9jcy9tb2R1bGUtc2ltcGxlanNvbi1pbmRleC5odG1s --- /dev/null +++ b/docs/module-simplejson-index.html @@ -0,0 +1,133 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<HTML> + + <HEAD><META CONTENT="text/html; charset=utf-8" HTTP-EQUIV="Content-Type"> + <TITLE>Index of simplejson module</TITLE> + <LINK HREF="layout.css" TYPE="text/css" REL="stylesheet"> + + </HEAD> + <BODY> + <DIV ID="page"> + + <DIV ID="top-nav"> + <H1 ID="doc-title"> + <A HREF="index.html" REL="index">simplejson 1.1</A></H1> + <DIV CLASS="online-navigation"> + <A HREF="index.html" REL="index">index</A> + <SPAN ID="nav-docs"> + + </SPAN> + + + <BR> + + + + <A HREF="module-simplejson.html" TITLE="simplejson reference"> + simplejson + </A> + + + <A HREF="module-simplejson.html">details</A> + + <A HREF="module-simplejson-index.html"> + tree + </A> + + + </DIV> + </DIV> + + <DIV ID="main-content"> + + <H1>Index of the <TT>simplejson</TT> module</H1> + + <UL CLASS="pudge-module-index"> + <LI CLASS="module"> + <SPAN CLASS="prefix">m</SPAN> + <A HREF="module-simplejson.html"> + <TT>simplejson</TT> + </A> + <A HREF="simplejson/__init__.py.html">...</A> + <SMALL> + - <SPAN CLASS="rst">A simple, fast, extensible JSON encoder and decoder</SPAN> + </SMALL> + <UL> + + + + + + <LI CLASS="routine"> + <SPAN CLASS="prefix">f</SPAN> + <A HREF="module-simplejson.html#load"> + <TT>load</TT> + </A> + <A HREF="simplejson/__init__.py.html?f=139&l=157#139">...</A> + <SMALL> + - <SPAN CLASS="rst">Deserialize <TT CLASS="docutils literal"><SPAN CLASS="pre">fp</SPAN></TT> (a <TT CLASS="docutils literal"><SPAN CLASS="pre">.read()</SPAN></TT>-supporting file-like object containing +a JSON document) to a Python object.</SPAN> + </SMALL> + + </LI> + + <LI CLASS="routine"> + <SPAN CLASS="prefix">f</SPAN> + <A HREF="module-simplejson.html#dump"> + <TT>dump</TT> + </A> + <A HREF="simplejson/__init__.py.html?f=69&l=107#69">...</A> + <SMALL> + - <SPAN CLASS="rst">Serialize <TT CLASS="docutils literal"><SPAN CLASS="pre">obj</SPAN></TT> as a JSON formatted stream to <TT CLASS="docutils literal"><SPAN CLASS="pre">fp</SPAN></TT> (a +<TT CLASS="docutils literal"><SPAN CLASS="pre">.write()</SPAN></TT>-supporting file-like object).</SPAN> + </SMALL> + + </LI> + + <LI CLASS="routine"> + <SPAN CLASS="prefix">f</SPAN> + <A HREF="module-simplejson.html#dumps"> + <TT>dumps</TT> + </A> + <A HREF="simplejson/__init__.py.html?f=108&l=138#108">...</A> + <SMALL> + - <SPAN CLASS="rst">Serialize <TT CLASS="docutils literal"><SPAN CLASS="pre">obj</SPAN></TT> to a JSON formatted <TT CLASS="docutils literal"><SPAN CLASS="pre">str</SPAN></TT>.</SPAN> + </SMALL> + + </LI> + + <LI CLASS="routine"> + <SPAN CLASS="prefix">f</SPAN> + <A HREF="module-simplejson.html#loads"> + <TT>loads</TT> + </A> + <A HREF="simplejson/__init__.py.html?f=158&l=174#158">...</A> + <SMALL> + - <SPAN CLASS="rst">Deserialize <TT CLASS="docutils literal"><SPAN CLASS="pre">s</SPAN></TT> (a <TT CLASS="docutils literal"><SPAN CLASS="pre">str</SPAN></TT> or <TT CLASS="docutils literal"><SPAN CLASS="pre">unicode</SPAN></TT> instance containing a JSON +document) to a Python object.</SPAN> + </SMALL> + + </LI> + + + + </UL> + </LI> + </UL> + + + +</DIV> + + <DIV ID="footer"> + + <P ID="pudge"> + Built with + <A HREF="http://lesscode.org/projects/pudge/"> + Pudge/0.1</A> + </P> + + </DIV> + </DIV> + </BODY> +</HTML> \ No newline at end of file diff --git a/docs/module-simplejson.html b/docs/module-simplejson.html new file mode 100644 index 0000000000000000000000000000000000000000..8b45c785af13ce27ef32feeb750c6de8650b274d_ZG9jcy9tb2R1bGUtc2ltcGxlanNvbi5odG1s --- /dev/null +++ b/docs/module-simplejson.html @@ -0,0 +1,448 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<HTML> + + <HEAD><META CONTENT="text/html; charset=utf-8" HTTP-EQUIV="Content-Type"> + <TITLE>simplejson -- A simple, fast, extensible JSON encoder and decoder</TITLE> + <LINK HREF="layout.css" TYPE="text/css" REL="stylesheet"> + + </HEAD> + <BODY> + <DIV ID="page"> + + <DIV ID="top-nav"> + <H1 ID="doc-title"> + <A HREF="index.html" REL="index">simplejson 1.1</A></H1> + <DIV CLASS="online-navigation"> + <A HREF="index.html" REL="index">index</A> + <SPAN ID="nav-docs"> + + </SPAN> + + + <BR> + + + + <A HREF="module-simplejson.html" TITLE="simplejson reference"> + simplejson + </A> + + + <A HREF="module-simplejson.html">details</A> + + <A HREF="module-simplejson-index.html"> + tree + </A> + + + </DIV> + </DIV> + + <DIV ID="main-content"> + + <H1 CLASS="pudge-member-page-heading"> + <TT>simplejson</TT> + </H1> + <H4 CLASS="pudge-member-page-subheading"> + A simple, fast, extensible JSON encoder and decoder + </H4> + + <DIV ID="pudge-section-nav"> + <UL> + <LI> + + <SPAN CLASS="pudge-missing-section-link"> + Attributes + </SPAN> + </LI> + <LI> + <A HREF="#functions" CLASS="pudge-section-link"> + Functions (4) + </A> + + </LI> + + <LI> + <A HREF="#classes" CLASS="pudge-section-link"> + Classes (2) + </A> + + </LI> + + <LI> + + <SPAN CLASS="pudge-missing-section-link"> + Modules + </SPAN> + </LI> + <LI> + <A HREF="module-simplejson-index.html" CLASS="pudge-section-link"> + Index + </A> + </LI> + <LI> + <A HREF="simplejson/__init__.py.html" CLASS="pudge-section-link"> + Source + </A> + </LI> + </UL> + </DIV> + <DIV STYLE="clear: left"> + </DIV> + <DIV CLASS="rst pudge-module-doc"> + <P>JSON (JavaScript Object Notation) <<A HREF="http://json.org" CLASS="reference">http://json.org</A>> is a subset of +JavaScript syntax (ECMA-262 3rd edition) used as a lightweight data +interchange format.</P> +<P>simplejson exposes an API familiar to uses of the standard library +marshal and pickle modules.</P> +<P>Encoding basic Python object hierarchies:</P> +<PRE CLASS="literal-block"> +>>> import simplejson +>>> simplejson.dumps(['foo', {'bar': ('baz', None, 1.0, 2)}]) +'["foo", {"bar":["baz", null, 1.0, 2]}]' +>>> print simplejson.dumps("\"foo\bar") +"\"foo\bar" +>>> print simplejson.dumps(u'\u1234') +"\u1234" +>>> print simplejson.dumps('\\') +"\\" +>>> from StringIO import StringIO +>>> io = StringIO() +>>> simplejson.dump(['streaming API'], io) +>>> io.getvalue() +'["streaming API"]' +</PRE> +<P>Decoding JSON:</P> +<PRE CLASS="literal-block"> +>>> import simplejson +>>> simplejson.loads('["foo", {"bar":["baz", null, 1.0, 2]}]') +[u'foo', {u'bar': [u'baz', None, 1.0, 2]}] +>>> simplejson.loads('"\\"foo\\bar"') +u'"foo\x08ar' +>>> from StringIO import StringIO +>>> io = StringIO('["streaming API"]') +>>> simplejson.load(io) +[u'streaming API'] +</PRE> +<P>Extending JSONEncoder:</P> +<PRE CLASS="literal-block"> +>>> import simplejson +>>> class ComplexEncoder(simplejson.JSONEncoder): +... def default(self, obj): +... if isinstance(obj, complex): +... return [obj.real, obj.imag] +... return simplejson.JSONEncoder.default(self, obj) +... +>>> dumps(2 + 1j, cls=ComplexEncoder) +'[2.0, 1.0]' +>>> ComplexEncoder().encode(2 + 1j) +'[2.0, 1.0]' +>>> list(ComplexEncoder().iterencode(2 + 1j)) +['[', '2.0', ', ', '1.0', ']'] +</PRE> +<P>Note that the JSON produced by this module is a subset of YAML, +so it may be used as a serializer for that as well.</P> + </DIV> + + <HR> + + + + + <A NAME="functions"> + + + </A> + <H2>Functions</H2> + <DIV CLASS="pudge-member routine "> + <A NAME="dump"> + </A> + <H4 CLASS="pudge-member-name"> + <SPAN CLASS="prefix">f</SPAN> + <TT> + <A HREF="module-simplejson.html#dump" CLASS="pudge-obj-link">dump</A>(obj, fp, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, cls=None)</TT> + <A HREF="simplejson/__init__.py.html?f=69&l=107#69" TITLE="View Source">...</A> + </H4> + <DIV CLASS="pudge-section rst"> + + <P CLASS="pudge-member-blurb"> + Serialize <TT CLASS="docutils literal"><SPAN CLASS="pre">obj</SPAN></TT> as a JSON formatted stream to <TT CLASS="docutils literal"><SPAN CLASS="pre">fp</SPAN></TT> (a +<TT CLASS="docutils literal"><SPAN CLASS="pre">.write()</SPAN></TT>-supporting file-like object). + </P> + <P>If <TT CLASS="docutils literal"><SPAN CLASS="pre">skipkeys</SPAN></TT> is <TT CLASS="docutils literal"><SPAN CLASS="pre">True</SPAN></TT> then <TT CLASS="docutils literal"><SPAN CLASS="pre">dict</SPAN></TT> keys that are not basic types +(<TT CLASS="docutils literal"><SPAN CLASS="pre">str</SPAN></TT>, <TT CLASS="docutils literal"><SPAN CLASS="pre">unicode</SPAN></TT>, <TT CLASS="docutils literal"><SPAN CLASS="pre">int</SPAN></TT>, <TT CLASS="docutils literal"><SPAN CLASS="pre">long</SPAN></TT>, <TT CLASS="docutils literal"><SPAN CLASS="pre">float</SPAN></TT>, <TT CLASS="docutils literal"><SPAN CLASS="pre">bool</SPAN></TT>, <TT CLASS="docutils literal"><SPAN CLASS="pre">None</SPAN></TT>) +will be skipped instead of raising a <TT CLASS="docutils literal"><SPAN CLASS="pre">TypeError</SPAN></TT>.</P> +<P>If <TT CLASS="docutils literal"><SPAN CLASS="pre">ensure_ascii</SPAN></TT> is <TT CLASS="docutils literal"><SPAN CLASS="pre">False</SPAN></TT>, then the some chunks written to <TT CLASS="docutils literal"><SPAN CLASS="pre">fp</SPAN></TT> +may be <TT CLASS="docutils literal"><SPAN CLASS="pre">unicode</SPAN></TT> instances, subject to normal Python <TT CLASS="docutils literal"><SPAN CLASS="pre">str</SPAN></TT> to +<TT CLASS="docutils literal"><SPAN CLASS="pre">unicode</SPAN></TT> coercion rules. Unless <TT CLASS="docutils literal"><SPAN CLASS="pre">fp.write()</SPAN></TT> explicitly +understands <TT CLASS="docutils literal"><SPAN CLASS="pre">unicode</SPAN></TT> (as in <TT CLASS="docutils literal"><SPAN CLASS="pre">codecs.getwriter()</SPAN></TT>) this is likely +to cause an error.</P> +<P>If <TT CLASS="docutils literal"><SPAN CLASS="pre">check_circular</SPAN></TT> is <TT CLASS="docutils literal"><SPAN CLASS="pre">False</SPAN></TT>, then the circular reference check +for container types will be skipped and a circular reference will +result in an <TT CLASS="docutils literal"><SPAN CLASS="pre">OverflowError</SPAN></TT> (or worse).</P> +<P>If <TT CLASS="docutils literal"><SPAN CLASS="pre">allow_nan</SPAN></TT> is <TT CLASS="docutils literal"><SPAN CLASS="pre">False</SPAN></TT>, then it will be a <TT CLASS="docutils literal"><SPAN CLASS="pre">ValueError</SPAN></TT> to +serialize out of range <TT CLASS="docutils literal"><SPAN CLASS="pre">float</SPAN></TT> values (<TT CLASS="docutils literal"><SPAN CLASS="pre">nan</SPAN></TT>, <TT CLASS="docutils literal"><SPAN CLASS="pre">inf</SPAN></TT>, <TT CLASS="docutils literal"><SPAN CLASS="pre">-inf</SPAN></TT>) +in strict compliance of the JSON specification, instead of using the +JavaScript equivalents (<TT CLASS="docutils literal"><SPAN CLASS="pre">NaN</SPAN></TT>, <TT CLASS="docutils literal"><SPAN CLASS="pre">Infinity</SPAN></TT>, <TT CLASS="docutils literal"><SPAN CLASS="pre">-Infinity</SPAN></TT>).</P> +<P>To use a custom <TT CLASS="docutils literal"><SPAN CLASS="pre">JSONEncoder</SPAN></TT> subclass (e.g. one that overrides the +<TT CLASS="docutils literal"><SPAN CLASS="pre">.default()</SPAN></TT> method to serialize additional types), specify it with +the <TT CLASS="docutils literal"><SPAN CLASS="pre">cls</SPAN></TT> kwarg.</P> + + </DIV> + </DIV> + <DIV CLASS="pudge-member routine "> + <A NAME="dumps"> + </A> + <H4 CLASS="pudge-member-name"> + <SPAN CLASS="prefix">f</SPAN> + <TT> + <A HREF="module-simplejson.html#dumps" CLASS="pudge-obj-link">dumps</A>(obj, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, cls=None)</TT> + <A HREF="simplejson/__init__.py.html?f=108&l=138#108" TITLE="View Source">...</A> + </H4> + <DIV CLASS="pudge-section rst"> + + <P CLASS="pudge-member-blurb"> + Serialize <TT CLASS="docutils literal"><SPAN CLASS="pre">obj</SPAN></TT> to a JSON formatted <TT CLASS="docutils literal"><SPAN CLASS="pre">str</SPAN></TT>. + </P> + <P>If <TT CLASS="docutils literal"><SPAN CLASS="pre">skipkeys</SPAN></TT> is <TT CLASS="docutils literal"><SPAN CLASS="pre">True</SPAN></TT> then <TT CLASS="docutils literal"><SPAN CLASS="pre">dict</SPAN></TT> keys that are not basic types +(<TT CLASS="docutils literal"><SPAN CLASS="pre">str</SPAN></TT>, <TT CLASS="docutils literal"><SPAN CLASS="pre">unicode</SPAN></TT>, <TT CLASS="docutils literal"><SPAN CLASS="pre">int</SPAN></TT>, <TT CLASS="docutils literal"><SPAN CLASS="pre">long</SPAN></TT>, <TT CLASS="docutils literal"><SPAN CLASS="pre">float</SPAN></TT>, <TT CLASS="docutils literal"><SPAN CLASS="pre">bool</SPAN></TT>, <TT CLASS="docutils literal"><SPAN CLASS="pre">None</SPAN></TT>) +will be skipped instead of raising a <TT CLASS="docutils literal"><SPAN CLASS="pre">TypeError</SPAN></TT>.</P> +<P>If <TT CLASS="docutils literal"><SPAN CLASS="pre">ensure_ascii</SPAN></TT> is <TT CLASS="docutils literal"><SPAN CLASS="pre">False</SPAN></TT>, then the return value will be a +<TT CLASS="docutils literal"><SPAN CLASS="pre">unicode</SPAN></TT> instance subject to normal Python <TT CLASS="docutils literal"><SPAN CLASS="pre">str</SPAN></TT> to <TT CLASS="docutils literal"><SPAN CLASS="pre">unicode</SPAN></TT> +coercion rules instead of being escaped to an ASCII <TT CLASS="docutils literal"><SPAN CLASS="pre">str</SPAN></TT>.</P> +<P>If <TT CLASS="docutils literal"><SPAN CLASS="pre">check_circular</SPAN></TT> is <TT CLASS="docutils literal"><SPAN CLASS="pre">False</SPAN></TT>, then the circular reference check +for container types will be skipped and a circular reference will +result in an <TT CLASS="docutils literal"><SPAN CLASS="pre">OverflowError</SPAN></TT> (or worse).</P> +<P>If <TT CLASS="docutils literal"><SPAN CLASS="pre">allow_nan</SPAN></TT> is <TT CLASS="docutils literal"><SPAN CLASS="pre">False</SPAN></TT>, then it will be a <TT CLASS="docutils literal"><SPAN CLASS="pre">ValueError</SPAN></TT> to +serialize out of range <TT CLASS="docutils literal"><SPAN CLASS="pre">float</SPAN></TT> values (<TT CLASS="docutils literal"><SPAN CLASS="pre">nan</SPAN></TT>, <TT CLASS="docutils literal"><SPAN CLASS="pre">inf</SPAN></TT>, <TT CLASS="docutils literal"><SPAN CLASS="pre">-inf</SPAN></TT>) in +strict compliance of the JSON specification, instead of using the +JavaScript equivalents (<TT CLASS="docutils literal"><SPAN CLASS="pre">NaN</SPAN></TT>, <TT CLASS="docutils literal"><SPAN CLASS="pre">Infinity</SPAN></TT>, <TT CLASS="docutils literal"><SPAN CLASS="pre">-Infinity</SPAN></TT>).</P> +<P>To use a custom <TT CLASS="docutils literal"><SPAN CLASS="pre">JSONEncoder</SPAN></TT> subclass (e.g. one that overrides the +<TT CLASS="docutils literal"><SPAN CLASS="pre">.default()</SPAN></TT> method to serialize additional types), specify it with +the <TT CLASS="docutils literal"><SPAN CLASS="pre">cls</SPAN></TT> kwarg.</P> + + </DIV> + </DIV> + <DIV CLASS="pudge-member routine "> + <A NAME="load"> + </A> + <H4 CLASS="pudge-member-name"> + <SPAN CLASS="prefix">f</SPAN> + <TT> + <A HREF="module-simplejson.html#load" CLASS="pudge-obj-link">load</A>(fp, encoding=None, cls=None)</TT> + <A HREF="simplejson/__init__.py.html?f=139&l=157#139" TITLE="View Source">...</A> + </H4> + <DIV CLASS="pudge-section rst"> + + <P CLASS="pudge-member-blurb"> + Deserialize <TT CLASS="docutils literal"><SPAN CLASS="pre">fp</SPAN></TT> (a <TT CLASS="docutils literal"><SPAN CLASS="pre">.read()</SPAN></TT>-supporting file-like object containing +a JSON document) to a Python object. + </P> + <P>If the contents of <TT CLASS="docutils literal"><SPAN CLASS="pre">fp</SPAN></TT> is encoded with an ASCII based encoding other +than utf-8 (e.g. latin-1), then an appropriate <TT CLASS="docutils literal"><SPAN CLASS="pre">encoding</SPAN></TT> 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"><SPAN CLASS="pre">codecs.getreader(fp)(encoding)</SPAN></TT>, or simply decoded to a <TT CLASS="docutils literal"><SPAN CLASS="pre">unicode</SPAN></TT> +object and passed to <TT CLASS="docutils literal"><SPAN CLASS="pre">loads()</SPAN></TT></P> +<P>To use a custom <TT CLASS="docutils literal"><SPAN CLASS="pre">JSONDecoder</SPAN></TT> subclass, specify it with the <TT CLASS="docutils literal"><SPAN CLASS="pre">cls</SPAN></TT> +kwarg.</P> + + </DIV> + </DIV> + <DIV CLASS="pudge-member routine "> + <A NAME="loads"> + </A> + <H4 CLASS="pudge-member-name"> + <SPAN CLASS="prefix">f</SPAN> + <TT> + <A HREF="module-simplejson.html#loads" CLASS="pudge-obj-link">loads</A>(s, encoding=None, cls=None)</TT> + <A HREF="simplejson/__init__.py.html?f=158&l=174#158" TITLE="View Source">...</A> + </H4> + <DIV CLASS="pudge-section rst"> + + <P CLASS="pudge-member-blurb"> + Deserialize <TT CLASS="docutils literal"><SPAN CLASS="pre">s</SPAN></TT> (a <TT CLASS="docutils literal"><SPAN CLASS="pre">str</SPAN></TT> or <TT CLASS="docutils literal"><SPAN CLASS="pre">unicode</SPAN></TT> instance containing a JSON +document) to a Python object. + </P> + <P>If <TT CLASS="docutils literal"><SPAN CLASS="pre">s</SPAN></TT> is a <TT CLASS="docutils literal"><SPAN CLASS="pre">str</SPAN></TT> instance and is encoded with an ASCII based encoding +other than utf-8 (e.g. latin-1) then an appropriate <TT CLASS="docutils literal"><SPAN CLASS="pre">encoding</SPAN></TT> name +must be specified. Encodings that are not ASCII based (such as UCS-2) +are not allowed and should be decoded to <TT CLASS="docutils literal"><SPAN CLASS="pre">unicode</SPAN></TT> first.</P> +<P>To use a custom <TT CLASS="docutils literal"><SPAN CLASS="pre">JSONDecoder</SPAN></TT> subclass, specify it with the <TT CLASS="docutils literal"><SPAN CLASS="pre">cls</SPAN></TT> +kwarg.</P> + + </DIV> + </DIV> + + + <A NAME="classes"> + + + </A> + <H2>Classes</H2> + <DIV CLASS="pudge-member class alias"> + <H4 CLASS="pudge-member-name"> + <SPAN CLASS="prefix">C</SPAN> + <TT> + <A HREF="class-simplejson.JSONEncoder.html" CLASS="pudge-obj-link">JSONEncoder</A>(...)</TT> + <A HREF="simplejson/encoder.py.html?f=63&l=273#63" CLASS="pudge-member-view-source" TITLE="View Source">...</A> + </H4> + <DIV CLASS="pudge-section rst"> + + <P CLASS="pudge-member-blurb"> + Extensible JSON <<A HREF="http://json.org" CLASS="reference">http://json.org</A>> encoder for Python data structures. + </P> + <P>Supports the following objects and types by default:</P> +<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> +<P>To extend this to recognize other objects, subclass and implement a +<TT CLASS="docutils literal"><SPAN CLASS="pre">.default(o)</SPAN></TT> method with another method that returns a serializable +object for <TT CLASS="docutils literal"><SPAN CLASS="pre">o</SPAN></TT> if possible, otherwise it should call the superclass +implementation (to raise <TT CLASS="docutils literal"><SPAN CLASS="pre">TypeError</SPAN></TT>).</P> + + + <P CLASS="note"> + This class contains <A HREF="class-simplejson.JSONEncoder.html#members"> + 1 member</A>. + </P> + </DIV> + </DIV> + <DIV CLASS="pudge-member class alias"> + <H4 CLASS="pudge-member-name"> + <SPAN CLASS="prefix">C</SPAN> + <TT> + <A HREF="class-simplejson.JSONDecoder.html" CLASS="pudge-obj-link">JSONDecoder</A>(...)</TT> + <A HREF="simplejson/decoder.py.html?f=196&l=257#196" CLASS="pudge-member-view-source" TITLE="View Source">...</A> + </H4> + <DIV CLASS="pudge-section rst"> + + <P CLASS="pudge-member-blurb"> + Simple JSON <<A HREF="http://json.org" CLASS="reference">http://json.org</A>> decoder + </P> + <P>Performs the following translations in decoding:</P> +<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> +<P>It also understands <TT CLASS="docutils literal"><SPAN CLASS="pre">NaN</SPAN></TT>, <TT CLASS="docutils literal"><SPAN CLASS="pre">Infinity</SPAN></TT>, and <TT CLASS="docutils literal"><SPAN CLASS="pre">-Infinity</SPAN></TT> as +their corresponding <TT CLASS="docutils literal"><SPAN CLASS="pre">float</SPAN></TT> values, which is outside the JSON spec.</P> + + + <P CLASS="note"> + This class contains <A HREF="class-simplejson.JSONDecoder.html#members"> + 2 members</A>. + </P> + </DIV> + </DIV> + + + + <P> + <SMALL> + + + See + <A HREF="simplejson/__init__.py.html" TITLE="simplejson/__init__.py:0">the source</A> + for more information. + </SMALL> + </P> +</DIV> + + <DIV ID="footer"> + + <P ID="pudge"> + Built with + <A HREF="http://lesscode.org/projects/pudge/"> + Pudge/0.1</A> + </P> + + </DIV> + </DIV> + </BODY> +</HTML> \ No newline at end of file diff --git a/docs/pudge.css b/docs/pudge.css new file mode 100644 index 0000000000000000000000000000000000000000..8b45c785af13ce27ef32feeb750c6de8650b274d_ZG9jcy9wdWRnZS5jc3M= --- /dev/null +++ b/docs/pudge.css @@ -0,0 +1,60 @@ +/* Layout +----------------------------------- */ + +@import url("rst.css"); + +/* Pudge Elements +----------------------------------- */ +.note { font-size: 90% } +h4.pudge-member-name { + font-size: 110%; + margin-bottom: 0; +} +h4.pudge-member-name a.obj-link { + font-weight: bold; + text-decoration: none; +} +h4.pudge-member-name .prefix { + font-style: oblique; + padding-right: 6px; + font-weight: bold; + color: #c9c; +} +h1.pudge-member-page-heading { + font-size: 250%; +} +h4.pudge-member-page-subheading { + font-size: 150%; + font-style: italic; +} +h4.pudge-member-page-subheading p { + display: inline; +} +div.pudge-member { + margin-top: 1.5em; + margin-bottom: 1.5em; +} +ul.pudge-module-index { + margin-left: 0; + padding-left: 0; +} +ul.pudge-module-index ul { + padding-left: 1.5em; + margin-left: 0; +} +ul.pudge-module-index li { + list-style-type: none; +} +ul.pudge-module-index .prefix { + font-style: oblique; + padding-right: 6px; + font-size: 90%; + font-weight: bold; + color: purple; +} +ul.pudge-module-index a { + text-decoration: none; +} +div.pudge-section { + margin-left: 2em; +} \ No newline at end of file diff --git a/docs/rst.css b/docs/rst.css new file mode 100644 index 0000000000000000000000000000000000000000..8b45c785af13ce27ef32feeb750c6de8650b274d_ZG9jcy9yc3QuY3Nz --- /dev/null +++ b/docs/rst.css @@ -0,0 +1,142 @@ +/* Headings + ------------------------------- */ + +.rst h1 { font-size: 110% } +.rst h2 { font-size: 100% } + +/*.rst-doc h1 { font-size: 200% } +.rst-doc h2 { font-size: 140% } +.rst-doc h3 { font-size: 110% }*/ +.rst-doc h1.title { font-size: 220% } +.rst-doc h1 a, .rst-doc h2 a, .rst-doc h3 a { + color: inherit ; + font-weight: inherit; + text-decoration: inherit; +} + +/* Blockquotes + ------------------------------- */ + +.rst blockquote, +.rst-doc blockquote { + font-style: italic; + font-family: Georgia, serif; + max-width: 30em; +} + +/* Document Info + ------------------------------- */ +.rst-doc table.docinfo { + margin: 2em 0 + width: 100%; +} +.rst-doc table.docinfo th { + text-align: left ; + padding-right: 2em; + color: #555; +} +.rst-doc table.docinfo td { + text-align: left +} + +/* Field Lists + ------------------------------- */ + +.rst table.field-list, +.rst-doc table.field-list { + border: 0; + margin-left: 0; +} +.rst table.field-list ul, +.rst-doc table.field-list ul { + margin-left: 0; +} +.rst-doc table.field-list ul { + border: 0; + margin-left: 2em; + background: #fff; + color: #119; +} + +/* Tables + ------------------------------- */ + +.rst table.docutils, +.rst-doc table.docutils { + border: 0; +} +.rst table.docutils th, +.rst-doc table.docutils th { + border: 0; + background: #777; + color: #fff; + padding: 3px; +} +.rst table.docutils td, +.rst-doc table.docutils td { + border: 0; + border-bottom: 1px solid #ccc; + padding-bottom: 2px; +} + +/* Contents and Back References + ------------------------------- */ + +.rst-doc div.contents { + margin: 2em inherit; +} +.rst-doc div.contents ul { + margin-left: 0; + padding-left: 2em; + line-height: 150%; +} +.rst-doc div.contents ul li { + font-weight: bold; + list-style-type: none; +} +.rst-doc div.contents p.topic-title { + font-size: 160%; + font-weight: normal; + color: #555; + margin-top: .5em; +} +.rst-doc .contents .reference, +.rst-doc .toc-backref { + text-decoration: none; +} + +/* Admonitions + ------------------------------- */ + +.rst-doc div.admonition, +.rst-doc div.warning, +.rst-doc div.note { + margin: 2.5em 6em; + padding: .6em 2.5em; + background: #ddf; + border: 2px solid #ccc; + font-family: Georgia, serif; + color: #333; +} +.rst-doc div.warning { + background: #ff8; + border-color: #fe2; +} +.rst-doc div .admonition-title { + font-weight: bold; + font-style: italic; + color: #223; + font-size: 110%; + font-family: sans-serif; +} + +/* Misc + ------------------------------- */ + +tt.literal { + color: #333; +} +.footnote-reference { + vertical-align: super; + font-size: 20%; +} \ No newline at end of file diff --git a/docs/simplejson/__init__.py.html b/docs/simplejson/__init__.py.html new file mode 100644 index 0000000000000000000000000000000000000000..8b45c785af13ce27ef32feeb750c6de8650b274d_ZG9jcy9zaW1wbGVqc29uL19faW5pdF9fLnB5Lmh0bWw= --- /dev/null +++ b/docs/simplejson/__init__.py.html @@ -0,0 +1,263 @@ +<html><head><title>/src/simplejson/simplejson/__init__.py</title> + <script type="text/javascript"> + +function show_line_range() { + var href = document.location.href; + if (href.indexOf('?') == -1) { + return; + } + var qs = href.substring(href.indexOf('?')+1); + if (qs.indexOf('#') >= 0) { + qs = qs.substring(0, qs.indexOf('#')); + } + var first = qs.match(/f=(\d+)/)[1]; + var last = qs.match(/l=(\d+)/)[1]; + if (! first || ! last) { + return; + } + var anchors = document.getElementsByTagName('A'); + var container = document.createElement('DIV'); + container.className = 'highlighted'; + var children = []; + var start = null; + var parent = null; + var highlight = false; + for (var i = 0; i < anchors.length; i++) { + var el = anchors[i]; + if (el.getAttribute('name') == first) { + start = el.previousSibling; + parent = el.parentNode; + highlight = true; + } + if (el.getAttribute('name') == last) { + break; + } + if (highlight) { + children[children.length] = el; + el = el.nextSibling; + while (el && el.tagName != 'A') { + children[children.length] = el; + el = el.nextSibling; + } + } + } + for (i=0; i<children.length; i++) { + container.appendChild(children[i]); + } + if (start) { + start.parentNode.insertBefore(container, start.nextSibling); + } else { + parent.insertBefore(container, parent.childNodes[0]); + } +} + + </script> + <style> + div.python { + color: #333 + } + div.python a.lnum { + color: #555; + background-color: #eee; + border-right: 1px solid #999; + padding-right: 2px; + margin-right: 4px; + } + div.python span.comment { color: #933 } + div.python span.keyword { color: #a3e; font-weight: bold } + div.python span.op { color: #c96 } + div.python span.string { color: #6a6 } + div.python span.name { } + div.python span.text { color: #333 } + div.highlighted { background-color: #ff9; border: 1px solid #009 } + </style></head><body onload="show_line_range()"><div class="python"><code><a class="lnum" href="#1" name="1">0001</a><span class="string">r"""</span><br /> +<a class="lnum" href="#2" name="2">0002</a><span class="string">A simple, fast, extensible JSON encoder and decoder</span><br /> +<a class="lnum" href="#3" name="3">0003</a><span class="string"></span><br /> +<a class="lnum" href="#4" name="4">0004</a><span class="string">JSON (JavaScript Object Notation) <http://json.org> is a subset of</span><br /> +<a class="lnum" href="#5" name="5">0005</a><span class="string">JavaScript syntax (ECMA-262 3rd edition) used as a lightweight data</span><br /> +<a class="lnum" href="#6" name="6">0006</a><span class="string">interchange format.</span><br /> +<a class="lnum" href="#7" name="7">0007</a><span class="string"></span><br /> +<a class="lnum" href="#8" name="8">0008</a><span class="string">simplejson exposes an API familiar to uses of the standard library</span><br /> +<a class="lnum" href="#9" name="9">0009</a><span class="string">marshal and pickle modules.</span><br /> +<a class="lnum" href="#10" name="10">0010</a><span class="string"></span><br /> +<a class="lnum" href="#11" name="11">0011</a><span class="string">Encoding basic Python object hierarchies::</span><br /> +<a class="lnum" href="#12" name="12">0012</a><span class="string">    </span><br /> +<a class="lnum" href="#13" name="13">0013</a><span class="string">    >>> import simplejson</span><br /> +<a class="lnum" href="#14" name="14">0014</a><span class="string">    >>> simplejson.dumps(['foo', {'bar': ('baz', None, 1.0, 2)}])</span><br /> +<a class="lnum" href="#15" name="15">0015</a><span class="string">    '["foo", {"bar":["baz", null, 1.0, 2]}]'</span><br /> +<a class="lnum" href="#16" name="16">0016</a><span class="string">    >>> print simplejson.dumps("\"foo\bar")</span><br /> +<a class="lnum" href="#17" name="17">0017</a><span class="string">    "\"foo\bar"</span><br /> +<a class="lnum" href="#18" name="18">0018</a><span class="string">    >>> print simplejson.dumps(u'\u1234')</span><br /> +<a class="lnum" href="#19" name="19">0019</a><span class="string">    "\u1234"</span><br /> +<a class="lnum" href="#20" name="20">0020</a><span class="string">    >>> print simplejson.dumps('\\')</span><br /> +<a class="lnum" href="#21" name="21">0021</a><span class="string">    "\\"</span><br /> +<a class="lnum" href="#22" name="22">0022</a><span class="string">    >>> from StringIO import StringIO</span><br /> +<a class="lnum" href="#23" name="23">0023</a><span class="string">    >>> io = StringIO()</span><br /> +<a class="lnum" href="#24" name="24">0024</a><span class="string">    >>> simplejson.dump(['streaming API'], io)</span><br /> +<a class="lnum" href="#25" name="25">0025</a><span class="string">    >>> io.getvalue()</span><br /> +<a class="lnum" href="#26" name="26">0026</a><span class="string">    '["streaming API"]'</span><br /> +<a class="lnum" href="#27" name="27">0027</a><span class="string"></span><br /> +<a class="lnum" href="#28" name="28">0028</a><span class="string">Decoding JSON::</span><br /> +<a class="lnum" href="#29" name="29">0029</a><span class="string">    </span><br /> +<a class="lnum" href="#30" name="30">0030</a><span class="string">    >>> import simplejson</span><br /> +<a class="lnum" href="#31" name="31">0031</a><span class="string">    >>> simplejson.loads('["foo", {"bar":["baz", null, 1.0, 2]}]')</span><br /> +<a class="lnum" href="#32" name="32">0032</a><span class="string">    [u'foo', {u'bar': [u'baz', None, 1.0, 2]}]</span><br /> +<a class="lnum" href="#33" name="33">0033</a><span class="string">    >>> simplejson.loads('"\\"foo\\bar"')</span><br /> +<a class="lnum" href="#34" name="34">0034</a><span class="string">    u'"foo\x08ar'</span><br /> +<a class="lnum" href="#35" name="35">0035</a><span class="string">    >>> from StringIO import StringIO</span><br /> +<a class="lnum" href="#36" name="36">0036</a><span class="string">    >>> io = StringIO('["streaming API"]')</span><br /> +<a class="lnum" href="#37" name="37">0037</a><span class="string">    >>> simplejson.load(io)</span><br /> +<a class="lnum" href="#38" name="38">0038</a><span class="string">    [u'streaming API']</span><br /> +<a class="lnum" href="#39" name="39">0039</a><span class="string"></span><br /> +<a class="lnum" href="#40" name="40">0040</a><span class="string">Extending JSONEncoder::</span><br /> +<a class="lnum" href="#41" name="41">0041</a><span class="string">    </span><br /> +<a class="lnum" href="#42" name="42">0042</a><span class="string">    >>> import simplejson</span><br /> +<a class="lnum" href="#43" name="43">0043</a><span class="string">    >>> class ComplexEncoder(simplejson.JSONEncoder):</span><br /> +<a class="lnum" href="#44" name="44">0044</a><span class="string">    ...     def default(self, obj):</span><br /> +<a class="lnum" href="#45" name="45">0045</a><span class="string">    ...         if isinstance(obj, complex):</span><br /> +<a class="lnum" href="#46" name="46">0046</a><span class="string">    ...             return [obj.real, obj.imag]</span><br /> +<a class="lnum" href="#47" name="47">0047</a><span class="string">    ...         return simplejson.JSONEncoder.default(self, obj)</span><br /> +<a class="lnum" href="#48" name="48">0048</a><span class="string">    ... </span><br /> +<a class="lnum" href="#49" name="49">0049</a><span class="string">    >>> dumps(2 + 1j, cls=ComplexEncoder)</span><br /> +<a class="lnum" href="#50" name="50">0050</a><span class="string">    '[2.0, 1.0]'</span><br /> +<a class="lnum" href="#51" name="51">0051</a><span class="string">    >>> ComplexEncoder().encode(2 + 1j)</span><br /> +<a class="lnum" href="#52" name="52">0052</a><span class="string">    '[2.0, 1.0]'</span><br /> +<a class="lnum" href="#53" name="53">0053</a><span class="string">    >>> list(ComplexEncoder().iterencode(2 + 1j))</span><br /> +<a class="lnum" href="#54" name="54">0054</a><span class="string">    ['[', '2.0', ', ', '1.0', ']']</span><br /> +<a class="lnum" href="#55" name="55">0055</a><span class="string">    </span><br /> +<a class="lnum" href="#56" name="56">0056</a><span class="string"></span><br /> +<a class="lnum" href="#57" name="57">0057</a><span class="string">Note that the JSON produced by this module is a subset of YAML,</span><br /> +<a class="lnum" href="#58" name="58">0058</a><span class="string">so it may be used as a serializer for that as well.</span><br /> +<a class="lnum" href="#59" name="59">0059</a><span class="string">"""</span><br /> +<a class="lnum" href="#60" name="60">0060</a><span class="name">__version__</span> <span class="op">=</span> <span class="string">'1.1'</span><br /> +<a class="lnum" href="#61" name="61">0061</a><span class="name">__all__</span> <span class="op">=</span> <span class="op">[</span><br /> +<a class="lnum" href="#62" name="62">0062</a>    <span class="string">'dump'</span><span class="op">,</span> <span class="string">'dumps'</span><span class="op">,</span> <span class="string">'load'</span><span class="op">,</span> <span class="string">'loads'</span><span class="op">,</span><br /> +<a class="lnum" href="#63" name="63">0063</a>    <span class="string">'JSONDecoder'</span><span class="op">,</span> <span class="string">'JSONEncoder'</span><span class="op">,</span><br /> +<a class="lnum" href="#64" name="64">0064</a><span class="op">]</span><br /> +<a class="lnum" href="#65" name="65">0065</a><br /> +<a class="lnum" href="#66" name="66">0066</a><span class="keyword">from</span> <span class="name">decoder</span> <span class="keyword">import</span> <span class="name">JSONDecoder</span><br /> +<a class="lnum" href="#67" name="67">0067</a><span class="keyword">from</span> <span class="name">encoder</span> <span class="keyword">import</span> <span class="name">JSONEncoder</span><br /> +<a class="lnum" href="#68" name="68">0068</a><br /> +<a class="lnum" href="#69" name="69">0069</a><span class="keyword">def</span> <span class="name">dump</span><span class="op">(</span><span class="name">obj</span><span class="op">,</span> <span class="name">fp</span><span class="op">,</span> <span class="name">skipkeys</span><span class="op">=</span><span class="name">False</span><span class="op">,</span> <span class="name">ensure_ascii</span><span class="op">=</span><span class="name">True</span><span class="op">,</span> <span class="name">check_circular</span><span class="op">=</span><span class="name">True</span><span class="op">,</span><br /> +<a class="lnum" href="#70" name="70">0070</a>        <span class="name">allow_nan</span><span class="op">=</span><span class="name">True</span><span class="op">,</span> <span class="name">cls</span><span class="op">=</span><span class="name">None</span><span class="op">,</span> <span class="op">**</span><span class="name">kw</span><span class="op">)</span><span class="op">:</span><br /> +<a class="lnum" href="#71" name="71">0071</a>    <span class="string">"""</span><br /> +<a class="lnum" href="#72" name="72">0072</a><span class="string">    Serialize ``obj`` as a JSON formatted stream to ``fp`` (a</span><br /> +<a class="lnum" href="#73" name="73">0073</a><span class="string">    ``.write()``-supporting file-like object).</span><br /> +<a class="lnum" href="#74" name="74">0074</a><span class="string"></span><br /> +<a class="lnum" href="#75" name="75">0075</a><span class="string">    If ``skipkeys`` is ``True`` then ``dict`` keys that are not basic types</span><br /> +<a class="lnum" href="#76" name="76">0076</a><span class="string">    (``str``, ``unicode``, ``int``, ``long``, ``float``, ``bool``, ``None``) </span><br /> +<a class="lnum" href="#77" name="77">0077</a><span class="string">    will be skipped instead of raising a ``TypeError``.</span><br /> +<a class="lnum" href="#78" name="78">0078</a><span class="string"></span><br /> +<a class="lnum" href="#79" name="79">0079</a><span class="string">    If ``ensure_ascii`` is ``False``, then the some chunks written to ``fp``</span><br /> +<a class="lnum" href="#80" name="80">0080</a><span class="string">    may be ``unicode`` instances, subject to normal Python ``str`` to</span><br /> +<a class="lnum" href="#81" name="81">0081</a><span class="string">    ``unicode`` coercion rules.  Unless ``fp.write()`` explicitly</span><br /> +<a class="lnum" href="#82" name="82">0082</a><span class="string">    understands ``unicode`` (as in ``codecs.getwriter()``) this is likely</span><br /> +<a class="lnum" href="#83" name="83">0083</a><span class="string">    to cause an error.</span><br /> +<a class="lnum" href="#84" name="84">0084</a><span class="string"></span><br /> +<a class="lnum" href="#85" name="85">0085</a><span class="string">    If ``check_circular`` is ``False``, then the circular reference check</span><br /> +<a class="lnum" href="#86" name="86">0086</a><span class="string">    for container types will be skipped and a circular reference will</span><br /> +<a class="lnum" href="#87" name="87">0087</a><span class="string">    result in an ``OverflowError`` (or worse).</span><br /> +<a class="lnum" href="#88" name="88">0088</a><span class="string"></span><br /> +<a class="lnum" href="#89" name="89">0089</a><span class="string">    If ``allow_nan`` is ``False``, then it will be a ``ValueError`` to</span><br /> +<a class="lnum" href="#90" name="90">0090</a><span class="string">    serialize out of range ``float`` values (``nan``, ``inf``, ``-inf``)</span><br /> +<a class="lnum" href="#91" name="91">0091</a><span class="string">    in strict compliance of the JSON specification, instead of using the</span><br /> +<a class="lnum" href="#92" name="92">0092</a><span class="string">    JavaScript equivalents (``NaN``, ``Infinity``, ``-Infinity``).</span><br /> +<a class="lnum" href="#93" name="93">0093</a><span class="string"></span><br /> +<a class="lnum" href="#94" name="94">0094</a><span class="string">    To use a custom ``JSONEncoder`` subclass (e.g. one that overrides the</span><br /> +<a class="lnum" href="#95" name="95">0095</a><span class="string">    ``.default()`` method to serialize additional types), specify it with</span><br /> +<a class="lnum" href="#96" name="96">0096</a><span class="string">    the ``cls`` kwarg.</span><br /> +<a class="lnum" href="#97" name="97">0097</a><span class="string">    """</span><br /> +<a class="lnum" href="#98" name="98">0098</a>    <span class="keyword">if</span> <span class="name">cls</span> <span class="keyword">is</span> <span class="name">None</span><span class="op">:</span><br /> +<a class="lnum" href="#99" name="99">0099</a>        <span class="name">cls</span> <span class="op">=</span> <span class="name">JSONEncoder</span><br /> +<a class="lnum" href="#100" name="100">0100</a>    <span class="name">iterable</span> <span class="op">=</span> <span class="name">cls</span><span class="op">(</span><span class="name">skipkeys</span><span class="op">=</span><span class="name">skipkeys</span><span class="op">,</span> <span class="name">ensure_ascii</span><span class="op">=</span><span class="name">ensure_ascii</span><span class="op">,</span><br /> +<a class="lnum" href="#101" name="101">0101</a>        <span class="name">check_circular</span><span class="op">=</span><span class="name">check_circular</span><span class="op">,</span> <span class="name">allow_nan</span><span class="op">=</span><span class="name">allow_nan</span><span class="op">,</span><br /> +<a class="lnum" href="#102" name="102">0102</a>        <span class="op">**</span><span class="name">kw</span><span class="op">)</span><span class="op">.</span><span class="name">iterencode</span><span class="op">(</span><span class="name">obj</span><span class="op">)</span><br /> +<a class="lnum" href="#103" name="103">0103</a>    <span class="comment"># could accelerate with writelines in some versions of Python, at</span><br /> +<a class="lnum" href="#104" name="104">0104</a><span class="comment"></span>    <span class="comment"># a debuggability cost</span><br /> +<a class="lnum" href="#105" name="105">0105</a><span class="comment"></span>    <span class="keyword">for</span> <span class="name">chunk</span> <span class="keyword">in</span> <span class="name">iterable</span><span class="op">:</span><br /> +<a class="lnum" href="#106" name="106">0106</a>        <span class="name">fp</span><span class="op">.</span><span class="name">write</span><span class="op">(</span><span class="name">chunk</span><span class="op">)</span><br /> +<a class="lnum" href="#107" name="107">0107</a><br /> +<a class="lnum" href="#108" name="108">0108</a><span class="keyword">def</span> <span class="name">dumps</span><span class="op">(</span><span class="name">obj</span><span class="op">,</span> <span class="name">skipkeys</span><span class="op">=</span><span class="name">False</span><span class="op">,</span> <span class="name">ensure_ascii</span><span class="op">=</span><span class="name">True</span><span class="op">,</span> <span class="name">check_circular</span><span class="op">=</span><span class="name">True</span><span class="op">,</span><br /> +<a class="lnum" href="#109" name="109">0109</a>        <span class="name">allow_nan</span><span class="op">=</span><span class="name">True</span><span class="op">,</span> <span class="name">cls</span><span class="op">=</span><span class="name">None</span><span class="op">,</span> <span class="op">**</span><span class="name">kw</span><span class="op">)</span><span class="op">:</span><br /> +<a class="lnum" href="#110" name="110">0110</a>    <span class="string">"""</span><br /> +<a class="lnum" href="#111" name="111">0111</a><span class="string">    Serialize ``obj`` to a JSON formatted ``str``.</span><br /> +<a class="lnum" href="#112" name="112">0112</a><span class="string"></span><br /> +<a class="lnum" href="#113" name="113">0113</a><span class="string">    If ``skipkeys`` is ``True`` then ``dict`` keys that are not basic types</span><br /> +<a class="lnum" href="#114" name="114">0114</a><span class="string">    (``str``, ``unicode``, ``int``, ``long``, ``float``, ``bool``, ``None``) </span><br /> +<a class="lnum" href="#115" name="115">0115</a><span class="string">    will be skipped instead of raising a ``TypeError``.</span><br /> +<a class="lnum" href="#116" name="116">0116</a><span class="string"></span><br /> +<a class="lnum" href="#117" name="117">0117</a><span class="string">    If ``ensure_ascii`` is ``False``, then the return value will be a</span><br /> +<a class="lnum" href="#118" name="118">0118</a><span class="string">    ``unicode`` instance subject to normal Python ``str`` to ``unicode``</span><br /> +<a class="lnum" href="#119" name="119">0119</a><span class="string">    coercion rules instead of being escaped to an ASCII ``str``.</span><br /> +<a class="lnum" href="#120" name="120">0120</a><span class="string"></span><br /> +<a class="lnum" href="#121" name="121">0121</a><span class="string">    If ``check_circular`` is ``False``, then the circular reference check</span><br /> +<a class="lnum" href="#122" name="122">0122</a><span class="string">    for container types will be skipped and a circular reference will</span><br /> +<a class="lnum" href="#123" name="123">0123</a><span class="string">    result in an ``OverflowError`` (or worse).</span><br /> +<a class="lnum" href="#124" name="124">0124</a><span class="string"></span><br /> +<a class="lnum" href="#125" name="125">0125</a><span class="string">    If ``allow_nan`` is ``False``, then it will be a ``ValueError`` to</span><br /> +<a class="lnum" href="#126" name="126">0126</a><span class="string">    serialize out of range ``float`` values (``nan``, ``inf``, ``-inf``) in</span><br /> +<a class="lnum" href="#127" name="127">0127</a><span class="string">    strict compliance of the JSON specification, instead of using the</span><br /> +<a class="lnum" href="#128" name="128">0128</a><span class="string">    JavaScript equivalents (``NaN``, ``Infinity``, ``-Infinity``).</span><br /> +<a class="lnum" href="#129" name="129">0129</a><span class="string"></span><br /> +<a class="lnum" href="#130" name="130">0130</a><span class="string">    To use a custom ``JSONEncoder`` subclass (e.g. one that overrides the</span><br /> +<a class="lnum" href="#131" name="131">0131</a><span class="string">    ``.default()`` method to serialize additional types), specify it with</span><br /> +<a class="lnum" href="#132" name="132">0132</a><span class="string">    the ``cls`` kwarg.</span><br /> +<a class="lnum" href="#133" name="133">0133</a><span class="string">    """</span><br /> +<a class="lnum" href="#134" name="134">0134</a>    <span class="keyword">if</span> <span class="name">cls</span> <span class="keyword">is</span> <span class="name">None</span><span class="op">:</span><br /> +<a class="lnum" href="#135" name="135">0135</a>        <span class="name">cls</span> <span class="op">=</span> <span class="name">JSONEncoder</span><br /> +<a class="lnum" href="#136" name="136">0136</a>    <span class="keyword">return</span> <span class="name">cls</span><span class="op">(</span><span class="name">skipkeys</span><span class="op">=</span><span class="name">skipkeys</span><span class="op">,</span> <span class="name">ensure_ascii</span><span class="op">=</span><span class="name">ensure_ascii</span><span class="op">,</span><br /> +<a class="lnum" href="#137" name="137">0137</a>        <span class="name">check_circular</span><span class="op">=</span><span class="name">check_circular</span><span class="op">,</span> <span class="name">allow_nan</span><span class="op">=</span><span class="name">allow_nan</span><span class="op">,</span> <span class="op">**</span><span class="name">kw</span><span class="op">)</span><span class="op">.</span><span class="name">encode</span><span class="op">(</span><span class="name">obj</span><span class="op">)</span><br /> +<a class="lnum" href="#138" name="138">0138</a><br /> +<a class="lnum" href="#139" name="139">0139</a><span class="keyword">def</span> <span class="name">load</span><span class="op">(</span><span class="name">fp</span><span class="op">,</span> <span class="name">encoding</span><span class="op">=</span><span class="name">None</span><span class="op">,</span> <span class="name">cls</span><span class="op">=</span><span class="name">None</span><span class="op">,</span> <span class="op">**</span><span class="name">kw</span><span class="op">)</span><span class="op">:</span><br /> +<a class="lnum" href="#140" name="140">0140</a>    <span class="string">"""</span><br /> +<a class="lnum" href="#141" name="141">0141</a><span class="string">    Deserialize ``fp`` (a ``.read()``-supporting file-like object containing</span><br /> +<a class="lnum" href="#142" name="142">0142</a><span class="string">    a JSON document) to a Python object.</span><br /> +<a class="lnum" href="#143" name="143">0143</a><span class="string"></span><br /> +<a class="lnum" href="#144" name="144">0144</a><span class="string">    If the contents of ``fp`` is encoded with an ASCII based encoding other</span><br /> +<a class="lnum" href="#145" name="145">0145</a><span class="string">    than utf-8 (e.g. latin-1), then an appropriate ``encoding`` name must</span><br /> +<a class="lnum" href="#146" name="146">0146</a><span class="string">    be specified.  Encodings that are not ASCII based (such as UCS-2) are</span><br /> +<a class="lnum" href="#147" name="147">0147</a><span class="string">    not allowed, and should be wrapped with</span><br /> +<a class="lnum" href="#148" name="148">0148</a><span class="string">    ``codecs.getreader(fp)(encoding)``, or simply decoded to a ``unicode``</span><br /> +<a class="lnum" href="#149" name="149">0149</a><span class="string">    object and passed to ``loads()``</span><br /> +<a class="lnum" href="#150" name="150">0150</a><span class="string">    </span><br /> +<a class="lnum" href="#151" name="151">0151</a><span class="string">    To use a custom ``JSONDecoder`` subclass, specify it with the ``cls``</span><br /> +<a class="lnum" href="#152" name="152">0152</a><span class="string">    kwarg.</span><br /> +<a class="lnum" href="#153" name="153">0153</a><span class="string">    """</span><br /> +<a class="lnum" href="#154" name="154">0154</a>    <span class="keyword">if</span> <span class="name">cls</span> <span class="keyword">is</span> <span class="name">None</span><span class="op">:</span><br /> +<a class="lnum" href="#155" name="155">0155</a>        <span class="name">cls</span> <span class="op">=</span> <span class="name">JSONDecoder</span><br /> +<a class="lnum" href="#156" name="156">0156</a>    <span class="keyword">return</span> <span class="name">cls</span><span class="op">(</span><span class="name">encoding</span><span class="op">=</span><span class="name">encoding</span><span class="op">,</span> <span class="op">**</span><span class="name">kw</span><span class="op">)</span><span class="op">.</span><span class="name">decode</span><span class="op">(</span><span class="name">fp</span><span class="op">.</span><span class="name">read</span><span class="op">(</span><span class="op">)</span><span class="op">)</span><br /> +<a class="lnum" href="#157" name="157">0157</a><br /> +<a class="lnum" href="#158" name="158">0158</a><span class="keyword">def</span> <span class="name">loads</span><span class="op">(</span><span class="name">s</span><span class="op">,</span> <span class="name">encoding</span><span class="op">=</span><span class="name">None</span><span class="op">,</span> <span class="name">cls</span><span class="op">=</span><span class="name">None</span><span class="op">,</span> <span class="op">**</span><span class="name">kw</span><span class="op">)</span><span class="op">:</span><br /> +<a class="lnum" href="#159" name="159">0159</a>    <span class="string">"""</span><br /> +<a class="lnum" href="#160" name="160">0160</a><span class="string">    Deserialize ``s`` (a ``str`` or ``unicode`` instance containing a JSON</span><br /> +<a class="lnum" href="#161" name="161">0161</a><span class="string">    document) to a Python object.</span><br /> +<a class="lnum" href="#162" name="162">0162</a><span class="string"></span><br /> +<a class="lnum" href="#163" name="163">0163</a><span class="string">    If ``s`` is a ``str`` instance and is encoded with an ASCII based encoding</span><br /> +<a class="lnum" href="#164" name="164">0164</a><span class="string">    other than utf-8 (e.g. latin-1) then an appropriate ``encoding`` name</span><br /> +<a class="lnum" href="#165" name="165">0165</a><span class="string">    must be specified.  Encodings that are not ASCII based (such as UCS-2)</span><br /> +<a class="lnum" href="#166" name="166">0166</a><span class="string">    are not allowed and should be decoded to ``unicode`` first.</span><br /> +<a class="lnum" href="#167" name="167">0167</a><span class="string"></span><br /> +<a class="lnum" href="#168" name="168">0168</a><span class="string">    To use a custom ``JSONDecoder`` subclass, specify it with the ``cls``</span><br /> +<a class="lnum" href="#169" name="169">0169</a><span class="string">    kwarg.</span><br /> +<a class="lnum" href="#170" name="170">0170</a><span class="string">    """</span><br /> +<a class="lnum" href="#171" name="171">0171</a>    <span class="keyword">if</span> <span class="name">cls</span> <span class="keyword">is</span> <span class="name">None</span><span class="op">:</span><br /> +<a class="lnum" href="#172" name="172">0172</a>        <span class="name">cls</span> <span class="op">=</span> <span class="name">JSONDecoder</span><br /> +<a class="lnum" href="#173" name="173">0173</a>    <span class="keyword">return</span> <span class="name">cls</span><span class="op">(</span><span class="name">encoding</span><span class="op">=</span><span class="name">encoding</span><span class="op">,</span> <span class="op">**</span><span class="name">kw</span><span class="op">)</span><span class="op">.</span><span class="name">decode</span><span class="op">(</span><span class="name">s</span><span class="op">)</span><br /> +<a class="lnum" href="#174" name="174">0174</a><br /> +<a class="lnum" href="#175" name="175">0175</a><span class="keyword">def</span> <span class="name">read</span><span class="op">(</span><span class="name">s</span><span class="op">)</span><span class="op">:</span><br /> +<a class="lnum" href="#176" name="176">0176</a>    <span class="string">"""</span><br /> +<a class="lnum" href="#177" name="177">0177</a><span class="string">    json-py API compatibility hook.  Use loads(s) instead.</span><br /> +<a class="lnum" href="#178" name="178">0178</a><span class="string">    """</span><br /> +<a class="lnum" href="#179" name="179">0179</a>    <span class="keyword">import</span> <span class="name">warnings</span><br /> +<a class="lnum" href="#180" name="180">0180</a>    <span class="name">warnings</span><span class="op">.</span><span class="name">warn</span><span class="op">(</span><span class="string">"simplejson.loads(s) should be used instead of read(s)"</span><span class="op">,</span><br /> +<a class="lnum" href="#181" name="181">0181</a>        <span class="name">DeprecationWarning</span><span class="op">)</span><br /> +<a class="lnum" href="#182" name="182">0182</a>    <span class="keyword">return</span> <span class="name">loads</span><span class="op">(</span><span class="name">s</span><span class="op">)</span><br /> +<a class="lnum" href="#183" name="183">0183</a><br /> +<a class="lnum" href="#184" name="184">0184</a><span class="keyword">def</span> <span class="name">write</span><span class="op">(</span><span class="name">obj</span><span class="op">)</span><span class="op">:</span><br /> +<a class="lnum" href="#185" name="185">0185</a>    <span class="string">"""</span><br /> +<a class="lnum" href="#186" name="186">0186</a><span class="string">    json-py API compatibility hook.  Use dumps(s) instead.</span><br /> +<a class="lnum" href="#187" name="187">0187</a><span class="string">    """</span><br /> +<a class="lnum" href="#188" name="188">0188</a>    <span class="keyword">import</span> <span class="name">warnings</span><br /> +<a class="lnum" href="#189" name="189">0189</a>    <span class="name">warnings</span><span class="op">.</span><span class="name">warn</span><span class="op">(</span><span class="string">"simplejson.dumps(s) should be used instead of write(s)"</span><span class="op">,</span><br /> +<a class="lnum" href="#190" name="190">0190</a>        <span class="name">DeprecationWarning</span><span class="op">)</span><br /> +<a class="lnum" href="#191" name="191">0191</a>    <span class="keyword">return</span> <span class="name">dumps</span><span class="op">(</span><span class="name">obj</span><span class="op">)</span></code></div></body></html> \ No newline at end of file