/
usr
/
share
/
doc
/
python2-docs
/
html
/
_sources
/
library
/
/usr/share/doc/python2-docs/html/_sources/library
mkdir
upload
Name
Size
Mode
Actions
2to3.rst.txt
14647
0644
edit
dl
rm
abc.rst.txt
7219
0644
edit
dl
rm
aepack.rst.txt
4257
0644
edit
dl
rm
aetools.rst.txt
3532
0644
edit
dl
rm
aetypes.rst.txt
4257
0644
edit
dl
rm
aifc.rst.txt
7086
0644
edit
dl
rm
al.rst.txt
5309
0644
edit
dl
rm
allos.rst.txt
695
0644
edit
dl
rm
anydbm.rst.txt
4111
0644
edit
dl
rm
archiving.rst.txt
424
0644
edit
dl
rm
argparse.rst.txt
74685
0644
edit
dl
rm
array.rst.txt
10524
0644
edit
dl
rm
ast.rst.txt
10111
0644
edit
dl
rm
asynchat.rst.txt
9206
0644
edit
dl
rm
asyncore.rst.txt
12937
0644
edit
dl
rm
atexit.rst.txt
3910
0644
edit
dl
rm
audioop.rst.txt
10395
0644
edit
dl
rm
autogil.rst.txt
1015
0644
edit
dl
rm
base64.rst.txt
6252
0644
edit
dl
rm
basehttpserver.rst.txt
10404
0644
edit
dl
rm
bastion.rst.txt
2611
0644
edit
dl
rm
bdb.rst.txt
12456
0644
edit
dl
rm
binascii.rst.txt
6508
0644
edit
dl
rm
binhex.rst.txt
1910
0644
edit
dl
rm
bisect.rst.txt
5415
0644
edit
dl
rm
bsddb.rst.txt
7575
0644
edit
dl
rm
bz2.rst.txt
8064
0644
edit
dl
rm
calendar.rst.txt
11282
0644
edit
dl
rm
carbon.rst.txt
15956
0644
edit
dl
rm
cd.rst.txt
11974
0644
edit
dl
rm
cgi.rst.txt
22853
0644
edit
dl
rm
cgihttpserver.rst.txt
2788
0644
edit
dl
rm
cgitb.rst.txt
2874
0644
edit
dl
rm
chunk.rst.txt
4955
0644
edit
dl
rm
cmath.rst.txt
7647
0644
edit
dl
rm
cmd.rst.txt
8565
0644
edit
dl
rm
code.rst.txt
7115
0644
edit
dl
rm
codecs.rst.txt
66966
0644
edit
dl
rm
codeop.rst.txt
3774
0644
edit
dl
rm
collections.rst.txt
41448
0644
edit
dl
rm
colorpicker.rst.txt
913
0644
edit
dl
rm
colorsys.rst.txt
1819
0644
edit
dl
rm
commands.rst.txt
2595
0644
edit
dl
rm
compileall.rst.txt
4678
0644
edit
dl
rm
compiler.rst.txt
37464
0644
edit
dl
rm
configparser.rst.txt
19607
0644
edit
dl
rm
constants.rst.txt
2328
0644
edit
dl
rm
contextlib.rst.txt
6012
0644
edit
dl
rm
cookie.rst.txt
9543
0644
edit
dl
rm
cookielib.rst.txt
27875
0644
edit
dl
rm
copy.rst.txt
3351
0644
edit
dl
rm
copy_reg.rst.txt
2329
0644
edit
dl
rm
crypt.rst.txt
2292
0644
edit
dl
rm
crypto.rst.txt
355
0644
edit
dl
rm
csv.rst.txt
22757
0644
edit
dl
rm
ctypes.rst.txt
90513
0644
edit
dl
rm
curses.ascii.rst.txt
9046
0644
edit
dl
rm
curses.panel.rst.txt
2740
0644
edit
dl
rm
curses.rst.txt
74877
0644
edit
dl
rm
custominterp.rst.txt
570
0644
edit
dl
rm
datatypes.rst.txt
864
0644
edit
dl
rm
datetime.rst.txt
74679
0644
edit
dl
rm
dbhash.rst.txt
3865
0644
edit
dl
rm
dbm.rst.txt
3117
0644
edit
dl
rm
debug.rst.txt
446
0644
edit
dl
rm
decimal.rst.txt
70926
0644
edit
dl
rm
development.rst.txt
640
0644
edit
dl
rm
difflib.rst.txt
30716
0644
edit
dl
rm
dircache.rst.txt
1813
0644
edit
dl
rm
dis.rst.txt
23248
0644
edit
dl
rm
distribution.rst.txt
426
0644
edit
dl
rm
distutils.rst.txt
1958
0644
edit
dl
rm
dl.rst.txt
3392
0644
edit
dl
rm
doctest.rst.txt
73985
0644
edit
dl
rm
docxmlrpcserver.rst.txt
3802
0644
edit
dl
rm
dumbdbm.rst.txt
2841
0644
edit
dl
rm
dummy_thread.rst.txt
1058
0644
edit
dl
rm
dummy_threading.rst.txt
799
0644
edit
dl
rm
easydialogs.rst.txt
10346
0644
edit
dl
rm
email-examples.rst.txt
1271
0644
edit
dl
rm
email.charset.rst.txt
9654
0644
edit
dl
rm
email.encoders.rst.txt
2376
0644
edit
dl
rm
email.errors.rst.txt
4006
0644
edit
dl
rm
email.generator.rst.txt
6132
0644
edit
dl
rm
email.header.rst.txt
7531
0644
edit
dl
rm
email.iterators.rst.txt
2421
0644
edit
dl
rm
email.message.rst.txt
25217
0644
edit
dl
rm
email.mime.rst.txt
9917
0644
edit
dl
rm
email.parser.rst.txt
10327
0644
edit
dl
rm
email.rst.txt
16111
0644
edit
dl
rm
email.utils.rst.txt
6475
0644
edit
dl
rm
ensurepip.rst.txt
5022
0644
edit
dl
rm
errno.rst.txt
6708
0644
edit
dl
rm
exceptions.rst.txt
18343
0644
edit
dl
rm
fcntl.rst.txt
7361
0644
edit
dl
rm
filecmp.rst.txt
5348
0644
edit
dl
rm
fileformats.rst.txt
302
0644
edit
dl
rm
fileinput.rst.txt
7417
0644
edit
dl
rm
filesys.rst.txt
806
0644
edit
dl
rm
fl.rst.txt
17646
0644
edit
dl
rm
fm.rst.txt
2699
0644
edit
dl
rm
fnmatch.rst.txt
3104
0644
edit
dl
rm
formatter.rst.txt
13245
0644
edit
dl
rm
fpectl.rst.txt
4171
0644
edit
dl
rm
fpformat.rst.txt
1747
0644
edit
dl
rm
fractions.rst.txt
5297
0644
edit
dl
rm
framework.rst.txt
11444
0644
edit
dl
rm
frameworks.rst.txt
378
0644
edit
dl
rm
ftplib.rst.txt
15720
0644
edit
dl
rm
functions.rst.txt
75554
0644
edit
dl
rm
functools.rst.txt
7448
0644
edit
dl
rm
future_builtins.rst.txt
2010
0644
edit
dl
rm
gc.rst.txt
9014
0644
edit
dl
rm
gdbm.rst.txt
4882
0644
edit
dl
rm
gensuitemodule.rst.txt
3113
0644
edit
dl
rm
getopt.rst.txt
6670
0644
edit
dl
rm
getpass.rst.txt
1876
0644
edit
dl
rm
gettext.rst.txt
29040
0644
edit
dl
rm
gl.rst.txt
6009
0644
edit
dl
rm
glob.rst.txt
2414
0644
edit
dl
rm
grp.rst.txt
2256
0644
edit
dl
rm
gzip.rst.txt
4828
0644
edit
dl
rm
hashlib.rst.txt
7379
0644
edit
dl
rm
heapq.rst.txt
13185
0644
edit
dl
rm
hmac.rst.txt
3073
0644
edit
dl
rm
hotshot.rst.txt
4289
0644
edit
dl
rm
htmllib.rst.txt
7379
0644
edit
dl
rm
htmlparser.rst.txt
11640
0644
edit
dl
rm
httplib.rst.txt
37454
0644
edit
dl
rm
i18n.rst.txt
409
0644
edit
dl
rm
ic.rst.txt
5005
0644
edit
dl
rm
idle.rst.txt
22182
0644
edit
dl
rm
imageop.rst.txt
4001
0644
edit
dl
rm
imaplib.rst.txt
17221
0644
edit
dl
rm
imgfile.rst.txt
2765
0644
edit
dl
rm
imghdr.rst.txt
2635
0644
edit
dl
rm
imp.rst.txt
12593
0644
edit
dl
rm
importlib.rst.txt
1126
0644
edit
dl
rm
imputil.rst.txt
7023
0644
edit
dl
rm
index.rst.txt
2287
0644
edit
dl
rm
inspect.rst.txt
28151
0644
edit
dl
rm
internet.rst.txt
950
0644
edit
dl
rm
intro.rst.txt
2803
0644
edit
dl
rm
io.rst.txt
39015
0644
edit
dl
rm
ipc.rst.txt
630
0644
edit
dl
rm
itertools.rst.txt
36324
0644
edit
dl
rm
jpeg.rst.txt
3858
0644
edit
dl
rm
json.rst.txt
25545
0644
edit
dl
rm
keyword.rst.txt
617
0644
edit
dl
rm
language.rst.txt
523
0644
edit
dl
rm
linecache.rst.txt
1887
0644
edit
dl
rm
locale.rst.txt
24975
0644
edit
dl
rm
logging.config.rst.txt
31560
0644
edit
dl
rm
logging.handlers.rst.txt
28153
0644
edit
dl
rm
logging.rst.txt
46882
0644
edit
dl
rm
mac.rst.txt
791
0644
edit
dl
rm
macos.rst.txt
3824
0644
edit
dl
rm
macosa.rst.txt
3964
0644
edit
dl
rm
macostools.rst.txt
4017
0644
edit
dl
rm
macpath.rst.txt
650
0644
edit
dl
rm
mailbox.rst.txt
68129
0644
edit
dl
rm
mailcap.rst.txt
3675
0644
edit
dl
rm
markup.rst.txt
1249
0644
edit
dl
rm
marshal.rst.txt
5689
0644
edit
dl
rm
math.rst.txt
10920
0644
edit
dl
rm
md5.rst.txt
2815
0644
edit
dl
rm
mhlib.rst.txt
3966
0644
edit
dl
rm
mimetools.rst.txt
4504
0644
edit
dl
rm
mimetypes.rst.txt
9839
0644
edit
dl
rm
mimewriter.rst.txt
3360
0644
edit
dl
rm
mimify.rst.txt
3519
0644
edit
dl
rm
miniaeframe.rst.txt
2564
0644
edit
dl
rm
misc.rst.txt
248
0644
edit
dl
rm
mm.rst.txt
447
0644
edit
dl
rm
mmap.rst.txt
10481
0644
edit
dl
rm
modulefinder.rst.txt
3380
0644
edit
dl
rm
modules.rst.txt
382
0644
edit
dl
rm
msilib.rst.txt
19062
0644
edit
dl
rm
msvcrt.rst.txt
4346
0644
edit
dl
rm
multifile.rst.txt
6613
0644
edit
dl
rm
multiprocessing.rst.txt
92621
0644
edit
dl
rm
mutex.rst.txt
1939
0644
edit
dl
rm
netdata.rst.txt
432
0644
edit
dl
rm
netrc.rst.txt
3119
0644
edit
dl
rm
new.rst.txt
2653
0644
edit
dl
rm
nis.rst.txt
2108
0644
edit
dl
rm
nntplib.rst.txt
14531
0644
edit
dl
rm
numbers.rst.txt
8007
0644
edit
dl
rm
numeric.rst.txt
751
0644
edit
dl
rm
operator.rst.txt
22092
0644
edit
dl
rm
optparse.rst.txt
77101
0644
edit
dl
rm
os.path.rst.txt
13094
0644
edit
dl
rm
os.rst.txt
82580
0644
edit
dl
rm
ossaudiodev.rst.txt
17309
0644
edit
dl
rm
othergui.rst.txt
2721
0644
edit
dl
rm
parser.rst.txt
15385
0644
edit
dl
rm
pdb.rst.txt
16043
0644
edit
dl
rm
persistence.rst.txt
826
0644
edit
dl
rm
pickle.rst.txt
37262
0644
edit
dl
rm
pickletools.rst.txt
1997
0644
edit
dl
rm
pipes.rst.txt
3786
0644
edit
dl
rm
pkgutil.rst.txt
7714
0644
edit
dl
rm
platform.rst.txt
9554
0644
edit
dl
rm
plistlib.rst.txt
4134
0644
edit
dl
rm
popen2.rst.txt
7022
0644
edit
dl
rm
poplib.rst.txt
6220
0644
edit
dl
rm
posix.rst.txt
3630
0644
edit
dl
rm
posixfile.rst.txt
7200
0644
edit
dl
rm
pprint.rst.txt
9071
0644
edit
dl
rm
profile.rst.txt
28666
0644
edit
dl
rm
pty.rst.txt
1762
0644
edit
dl
rm
pwd.rst.txt
2725
0644
edit
dl
rm
pyclbr.rst.txt
3296
0644
edit
dl
rm
pydoc.rst.txt
4083
0644
edit
dl
rm
pyexpat.rst.txt
28891
0644
edit
dl
rm
python.rst.txt
514
0644
edit
dl
rm
py_compile.rst.txt
2479
0644
edit
dl
rm
queue.rst.txt
7034
0644
edit
dl
rm
quopri.rst.txt
2670
0644
edit
dl
rm
random.rst.txt
13319
0644
edit
dl
rm
re.rst.txt
55102
0644
edit
dl
rm
readline.rst.txt
10513
0644
edit
dl
rm
repr.rst.txt
4718
0644
edit
dl
rm
resource.rst.txt
9595
0644
edit
dl
rm
restricted.rst.txt
3327
0644
edit
dl
rm
rexec.rst.txt
11742
0644
edit
dl
rm
rfc822.rst.txt
14037
0644
edit
dl
rm
rlcompleter.rst.txt
2494
0644
edit
dl
rm
robotparser.rst.txt
2190
0644
edit
dl
rm
runpy.rst.txt
6938
0644
edit
dl
rm
sched.rst.txt
4644
0644
edit
dl
rm
scrolledtext.rst.txt
1379
0644
edit
dl
rm
select.rst.txt
20705
0644
edit
dl
rm
sets.rst.txt
14973
0644
edit
dl
rm
sgi.rst.txt
322
0644
edit
dl
rm
sgmllib.rst.txt
10664
0644
edit
dl
rm
sha.rst.txt
2807
0644
edit
dl
rm
shelve.rst.txt
8319
0644
edit
dl
rm
shlex.rst.txt
11313
0644
edit
dl
rm
shutil.rst.txt
13491
0644
edit
dl
rm
signal.rst.txt
10719
0644
edit
dl
rm
simplehttpserver.rst.txt
4559
0644
edit
dl
rm
simplexmlrpcserver.rst.txt
10881
0644
edit
dl
rm
site.rst.txt
7880
0644
edit
dl
rm
smtpd.rst.txt
2464
0644
edit
dl
rm
smtplib.rst.txt
14906
0644
edit
dl
rm
sndhdr.rst.txt
1759
0644
edit
dl
rm
socket.rst.txt
40765
0644
edit
dl
rm
socketserver.rst.txt
22512
0644
edit
dl
rm
someos.rst.txt
599
0644
edit
dl
rm
spwd.rst.txt
2825
0644
edit
dl
rm
sqlite3.rst.txt
35448
0644
edit
dl
rm
ssl.rst.txt
76554
0644
edit
dl
rm
stat.rst.txt
7778
0644
edit
dl
rm
statvfs.rst.txt
1300
0644
edit
dl
rm
stdtypes.rst.txt
122668
0644
edit
dl
rm
string.rst.txt
44085
0644
edit
dl
rm
stringio.rst.txt
4166
0644
edit
dl
rm
stringprep.rst.txt
4238
0644
edit
dl
rm
strings.rst.txt
746
0644
edit
dl
rm
struct.rst.txt
17100
0644
edit
dl
rm
subprocess.rst.txt
33648
0644
edit
dl
rm
sun.rst.txt
249
0644
edit
dl
rm
sunau.rst.txt
7124
0644
edit
dl
rm
sunaudio.rst.txt
5849
0644
edit
dl
rm
symbol.rst.txt
975
0644
edit
dl
rm
symtable.rst.txt
5064
0644
edit
dl
rm
sys.rst.txt
47520
0644
edit
dl
rm
sysconfig.rst.txt
7639
0644
edit
dl
rm
syslog.rst.txt
3931
0644
edit
dl
rm
tabnanny.rst.txt
1999
0644
edit
dl
rm
tarfile.rst.txt
28214
0644
edit
dl
rm
telnetlib.rst.txt
7482
0644
edit
dl
rm
tempfile.rst.txt
10504
0644
edit
dl
rm
termios.rst.txt
3733
0644
edit
dl
rm
test.rst.txt
17659
0644
edit
dl
rm
textwrap.rst.txt
8552
0644
edit
dl
rm
thread.rst.txt
6588
0644
edit
dl
rm
threading.rst.txt
32468
0644
edit
dl
rm
time.rst.txt
26020
0644
edit
dl
rm
timeit.rst.txt
11598
0644
edit
dl
rm
tix.rst.txt
22693
0644
edit
dl
rm
tk.rst.txt
1612
0644
edit
dl
rm
tkinter.rst.txt
33456
0644
edit
dl
rm
token.rst.txt
2451
0644
edit
dl
rm
tokenize.rst.txt
5570
0644
edit
dl
rm
trace.rst.txt
6724
0644
edit
dl
rm
traceback.rst.txt
10711
0644
edit
dl
rm
ttk.rst.txt
57411
0644
edit
dl
rm
tty.rst.txt
1011
0644
edit
dl
rm
turtle.rst.txt
64097
0644
edit
dl
rm
types.rst.txt
6200
0644
edit
dl
rm
undoc.rst.txt
6550
0644
edit
dl
rm
unicodedata.rst.txt
5736
0644
edit
dl
rm
unittest.rst.txt
82952
0644
edit
dl
rm
unix.rst.txt
490
0644
edit
dl
rm
urllib.rst.txt
24960
0644
edit
dl
rm
urllib2.rst.txt
35211
0644
edit
dl
rm
urlparse.rst.txt
16071
0644
edit
dl
rm
user.rst.txt
2748
0644
edit
dl
rm
userdict.rst.txt
9290
0644
edit
dl
rm
uu.rst.txt
2369
0644
edit
dl
rm
uuid.rst.txt
8378
0644
edit
dl
rm
warnings.rst.txt
19815
0644
edit
dl
rm
wave.rst.txt
5047
0644
edit
dl
rm
weakref.rst.txt
12926
0644
edit
dl
rm
webbrowser.rst.txt
9863
0644
edit
dl
rm
whichdb.rst.txt
931
0644
edit
dl
rm
windows.rst.txt
273
0644
edit
dl
rm
winsound.rst.txt
5066
0644
edit
dl
rm
wsgiref.rst.txt
30567
0644
edit
dl
rm
xdrlib.rst.txt
8077
0644
edit
dl
rm
xml.dom.minidom.rst.txt
11208
0644
edit
dl
rm
xml.dom.pulldom.rst.txt
1571
0644
edit
dl
rm
xml.dom.rst.txt
40182
0644
edit
dl
rm
xml.etree.elementtree.rst.txt
35707
0644
edit
dl
rm
xml.rst.txt
6090
0644
edit
dl
rm
xml.sax.handler.rst.txt
15371
0644
edit
dl
rm
xml.sax.reader.rst.txt
12257
0644
edit
dl
rm
xml.sax.rst.txt
6460
0644
edit
dl
rm
xml.sax.utils.rst.txt
3560
0644
edit
dl
rm
xmlrpclib.rst.txt
22559
0644
edit
dl
rm
zipfile.rst.txt
18871
0644
edit
dl
rm
zipimport.rst.txt
5957
0644
edit
dl
rm
zlib.rst.txt
12766
0644
edit
dl
rm
_winreg.rst.txt
23305
0644
edit
dl
rm
__builtin__.rst.txt
1494
0644
edit
dl
rm
__future__.rst.txt
4952
0644
edit
dl
rm
__main__.rst.txt
535
0644
edit
dl
rm
Edit:
/usr/share/doc/python2-docs/html/_sources/library/json.rst.txt
(25545B)
:mod:`json` --- JSON encoder and decoder ======================================== .. module:: json :synopsis: Encode and decode the JSON format. .. moduleauthor:: Bob Ippolito <bob@redivi.com> .. sectionauthor:: Bob Ippolito <bob@redivi.com> .. versionadded:: 2.6 `JSON (JavaScript Object Notation) <http://json.org>`_, specified by :rfc:`7159` (which obsoletes :rfc:`4627`) and by `ECMA-404 <http://www.ecma-international.org/publications/standards/Ecma-404.htm>`_, is a lightweight data interchange format inspired by `JavaScript <https://en.wikipedia.org/wiki/JavaScript>`_ object literal syntax (although it is not a strict subset of JavaScript [#rfc-errata]_ ). :mod:`json` exposes an API familiar to users of the standard library :mod:`marshal` and :mod:`pickle` modules. Encoding basic Python object hierarchies:: >>> import 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"]' Compact encoding:: >>> import json >>> json.dumps([1,2,3,{'4': 5, '6': 7}], separators=(',',':')) '[1,2,3,{"4":5,"6":7}]' Pretty printing:: >>> import json >>> print json.dumps({'4': 5, '6': 7}, sort_keys=True, ... indent=4, separators=(',', ': ')) { "4": 5, "6": 7 } Decoding JSON:: >>> import json >>> json.loads('["foo", {"bar":["baz", null, 1.0, 2]}]') [u'foo', {u'bar': [u'baz', None, 1.0, 2]}] >>> json.loads('"\\"foo\\bar"') u'"foo\x08ar' >>> from StringIO import StringIO >>> io = StringIO('["streaming API"]') >>> json.load(io) [u'streaming API'] Specializing JSON object decoding:: >>> import 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('1.1') Extending :class:`JSONEncoder`:: >>> import json >>> class ComplexEncoder(json.JSONEncoder): ... def default(self, obj): ... if isinstance(obj, complex): ... return [obj.real, obj.imag] ... # Let the base class default method raise the TypeError ... return json.JSONEncoder.default(self, obj) ... >>> json.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', ']'] .. highlight:: none Using :mod:`json.tool` from the shell to validate and pretty-print:: $ echo '{"json":"obj"}' | python -m json.tool { "json": "obj" } $ echo '{1.2:3.4}' | python -mjson.tool Expecting property name enclosed in double quotes: line 1 column 2 (char 1) .. highlight:: python .. note:: JSON is a subset of `YAML <http://yaml.org/>`_ 1.2. The JSON produced by this module's default settings (in particular, the default *separators* value) is also a subset of YAML 1.0 and 1.1. This module can thus also be used as a YAML serializer. Basic Usage ----------- .. function:: dump(obj, fp, skipkeys=False, ensure_ascii=True, \ check_circular=True, allow_nan=True, cls=None, \ indent=None, separators=None, encoding="utf-8", \ default=None, sort_keys=False, **kw) Serialize *obj* as a JSON formatted stream to *fp* (a ``.write()``-supporting :term:`file-like object`) using this :ref:`conversion table <py-to-json-table>`. If *skipkeys* is true (default: ``False``), then dict keys that are not of a basic type (:class:`str`, :class:`unicode`, :class:`int`, :class:`long`, :class:`float`, :class:`bool`, ``None``) will be skipped instead of raising a :exc:`TypeError`. If *ensure_ascii* is true (the default), all non-ASCII characters in the output are escaped with ``\uXXXX`` sequences, and the result is a :class:`str` instance consisting of ASCII characters only. If *ensure_ascii* is false, some chunks written to *fp* may be :class:`unicode` instances. This usually happens because the input contains unicode strings or the *encoding* parameter is used. Unless ``fp.write()`` explicitly understands :class:`unicode` (as in :func:`codecs.getwriter`) this is likely to cause an error. If *check_circular* is false (default: ``True``), then the circular reference check for container types will be skipped and a circular reference will result in an :exc:`OverflowError` (or worse). If *allow_nan* is false (default: ``True``), then it will be a :exc:`ValueError` to serialize out of range :class:`float` values (``nan``, ``inf``, ``-inf``) in strict compliance of the JSON specification. If *allow_nan* is true, their JavaScript equivalents (``NaN``, ``Infinity``, ``-Infinity``) will be used. 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, or negative, will only insert newlines. ``None`` (the default) selects the most compact representation. .. note:: Since the default item separator is ``', '``, the output might include trailing whitespace when *indent* is specified. You can use ``separators=(',', ': ')`` to avoid this. If specified, *separators* should be an ``(item_separator, key_separator)`` tuple. By default, ``(', ', ': ')`` are used. To get the most compact JSON representation, you should specify ``(',', ':')`` to eliminate whitespace. *encoding* is the character encoding for str instances, default is UTF-8. 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 :exc:`TypeError`. If not specified, :exc:`TypeError` is raised. If *sort_keys* is true (default: ``False``), then the output of dictionaries will be sorted by key. To use a custom :class:`JSONEncoder` subclass (e.g. one that overrides the :meth:`default` method to serialize additional types), specify it with the *cls* kwarg; otherwise :class:`JSONEncoder` is used. .. note:: Unlike :mod:`pickle` and :mod:`marshal`, JSON is not a framed protocol so trying to serialize more objects with repeated calls to :func:`dump` and the same *fp* will result in an invalid JSON file. .. function:: dumps(obj, skipkeys=False, ensure_ascii=True, \ check_circular=True, allow_nan=True, cls=None, \ indent=None, separators=None, encoding="utf-8", \ default=None, sort_keys=False, **kw) Serialize *obj* to a JSON formatted :class:`str` using this :ref:`conversion table <py-to-json-table>`. If *ensure_ascii* is false, the result may contain non-ASCII characters and the return value may be a :class:`unicode` instance. The arguments have the same meaning as in :func:`dump`. .. note:: Keys in key/value pairs of JSON are always of the type :class:`str`. When a dictionary is converted into JSON, all the keys of the dictionary are coerced to strings. As a result of this, if a dictionary is converted into JSON and then back into a dictionary, the dictionary may not equal the original one. That is, ``loads(dumps(x)) != x`` if x has non-string keys. .. function:: load(fp[, encoding[, cls[, object_hook[, parse_float[, parse_int[, parse_constant[, object_pairs_hook[, **kw]]]]]]]]) Deserialize *fp* (a ``.read()``-supporting :term:`file-like object` containing a JSON document) to a Python object using this :ref:`conversion table <json-to-py-table>`. 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 ``codecs.getreader(encoding)(fp)``, or simply decoded to a :class:`unicode` object and passed to :func:`loads`. *object_hook* is an optional function that will be called with the result of any object literal decoded (a :class:`dict`). The return value of *object_hook* will be used instead of the :class:`dict`. This feature can be used to implement custom decoders (e.g. `JSON-RPC <http://www.jsonrpc.org>`_ class hinting). *object_pairs_hook* is an optional function that will be called with the result of any object literal decoded with an ordered list of pairs. The return value of *object_pairs_hook* will be used instead of the :class:`dict`. This feature can be used to implement custom decoders that rely on the order that the key and value pairs are decoded (for example, :func:`collections.OrderedDict` will remember the order of insertion). If *object_hook* is also defined, the *object_pairs_hook* takes priority. .. versionchanged:: 2.7 Added support for *object_pairs_hook*. *parse_float*, if specified, will be called with the string of every JSON float to be decoded. By default, this is equivalent to ``float(num_str)``. This can be used to use another datatype or parser for JSON floats (e.g. :class:`decimal.Decimal`). *parse_int*, if specified, will be called with the string of every JSON int to be decoded. By default, this is equivalent to ``int(num_str)``. This can be used to use another datatype or parser for JSON integers (e.g. :class:`float`). *parse_constant*, if specified, will be called with one of the following strings: ``'-Infinity'``, ``'Infinity'``, ``'NaN'``. This can be used to raise an exception if invalid JSON numbers are encountered. .. versionchanged:: 2.7 *parse_constant* doesn't get called on 'null', 'true', 'false' anymore. To use a custom :class:`JSONDecoder` subclass, specify it with the ``cls`` kwarg; otherwise :class:`JSONDecoder` is used. Additional keyword arguments will be passed to the constructor of the class. .. function:: loads(s[, encoding[, cls[, object_hook[, parse_float[, parse_int[, parse_constant[, object_pairs_hook[, **kw]]]]]]]]) Deserialize *s* (a :class:`str` or :class:`unicode` instance containing a JSON document) to a Python object using this :ref:`conversion table <json-to-py-table>`. If *s* is a :class:`str` 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 :class:`unicode` first. The other arguments have the same meaning as in :func:`load`. Encoders and Decoders --------------------- .. class:: JSONDecoder([encoding[, object_hook[, parse_float[, parse_int[, parse_constant[, strict[, object_pairs_hook]]]]]]]) Simple JSON decoder. Performs the following translations in decoding by default: .. _json-to-py-table: +---------------+-------------------+ | JSON | Python | +===============+===================+ | object | dict | +---------------+-------------------+ | array | list | +---------------+-------------------+ | string | unicode | +---------------+-------------------+ | number (int) | int, long | +---------------+-------------------+ | number (real) | float | +---------------+-------------------+ | true | True | +---------------+-------------------+ | false | False | +---------------+-------------------+ | null | None | +---------------+-------------------+ It also understands ``NaN``, ``Infinity``, and ``-Infinity`` as their corresponding ``float`` values, which is outside the JSON spec. *encoding* determines the encoding used to interpret any :class:`str` objects decoded by this instance (UTF-8 by default). It has no effect when decoding :class:`unicode` objects. Note that currently only encodings that are a superset of ASCII work, strings of other encodings should be passed in as :class:`unicode`. *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 :class:`dict`. This can be used to provide custom deserializations (e.g. to support JSON-RPC class hinting). *object_pairs_hook*, if specified will be called with the result of every JSON object decoded with an ordered list of pairs. The return value of *object_pairs_hook* will be used instead of the :class:`dict`. This feature can be used to implement custom decoders that rely on the order that the key and value pairs are decoded (for example, :func:`collections.OrderedDict` will remember the order of insertion). If *object_hook* is also defined, the *object_pairs_hook* takes priority. .. versionchanged:: 2.7 Added support for *object_pairs_hook*. *parse_float*, if specified, will be called with the string of every JSON float to be decoded. By default, this is equivalent to ``float(num_str)``. This can be used to use another datatype or parser for JSON floats (e.g. :class:`decimal.Decimal`). *parse_int*, if specified, will be called with the string of every JSON int to be decoded. By default, this is equivalent to ``int(num_str)``. This can be used to use another datatype or parser for JSON integers (e.g. :class:`float`). *parse_constant*, if specified, will be called with one of the following strings: ``'-Infinity'``, ``'Infinity'``, ``'NaN'``. This can be used to raise an exception if invalid JSON numbers are encountered. If *strict* is false (``True`` is the default), then control characters will be allowed inside strings. Control characters in this context are those with character codes in the 0--31 range, including ``'\t'`` (tab), ``'\n'``, ``'\r'`` and ``'\0'``. If the data being deserialized is not a valid JSON document, a :exc:`ValueError` will be raised. .. method:: decode(s) Return the Python representation of *s* (a :class:`str` or :class:`unicode` instance containing a JSON document). .. method:: raw_decode(s) Decode a JSON document from *s* (a :class:`str` or :class:`unicode` 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. .. class:: JSONEncoder([skipkeys[, ensure_ascii[, check_circular[, allow_nan[, sort_keys[, indent[, separators[, encoding[, default]]]]]]]]]) Extensible JSON encoder for Python data structures. Supports the following objects and types by default: .. _py-to-json-table: +-------------------+---------------+ | Python | JSON | +===================+===============+ | dict | object | +-------------------+---------------+ | list, tuple | array | +-------------------+---------------+ | str, unicode | string | +-------------------+---------------+ | int, long, float | number | +-------------------+---------------+ | True | true | +-------------------+---------------+ | False | false | +-------------------+---------------+ | None | null | +-------------------+---------------+ To extend this to recognize other objects, subclass and implement a :meth:`default` method with another method that returns a serializable object for ``o`` if possible, otherwise it should call the superclass implementation (to raise :exc:`TypeError`). If *skipkeys* is false (the default), then it is a :exc:`TypeError` 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), all non-ASCII characters in the output are escaped with ``\uXXXX`` sequences, and the results are :class:`str` instances consisting of ASCII characters only. If *ensure_ascii* is false, a result may be a :class:`unicode` instance. This usually happens if the input contains unicode strings or the *encoding* parameter is used. If *check_circular* is true (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 :exc:`OverflowError`). Otherwise, no such check takes place. If *allow_nan* is true (the default), 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 :exc:`ValueError` to encode such floats. If *sort_keys* is true (default: ``False``), 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 ``None`` 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. ``None`` is the most compact representation. .. note:: Since the default item separator is ``', '``, the output might include trailing whitespace when *indent* is specified. You can use ``separators=(',', ': ')`` to avoid this. If specified, *separators* should be an ``(item_separator, key_separator)`` tuple. By default, ``(', ', ': ')`` are used. To get the most compact JSON representation, you should specify ``(',', ':')`` 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 :exc:`TypeError`. If not specified, :exc:`TypeError` is raised. If *encoding* is not ``None``, then all input strings will be transformed into unicode using that encoding prior to JSON-encoding. The default is UTF-8. .. method:: default(o) Implement this method in a subclass such that it returns a serializable object for *o*, or calls the base implementation (to raise a :exc:`TypeError`). For example, to support arbitrary iterators, you could implement default like this:: def default(self, o): try: iterable = iter(o) except TypeError: pass else: return list(iterable) # Let the base class default method raise the TypeError return JSONEncoder.default(self, o) .. method:: encode(o) Return a JSON string representation of a Python data structure, *o*. For example:: >>> JSONEncoder().encode({"foo": ["bar", "baz"]}) '{"foo": ["bar", "baz"]}' .. method:: iterencode(o) Encode the given object, *o*, and yield each string representation as available. For example:: for chunk in JSONEncoder().iterencode(bigobject): mysocket.write(chunk) Standard Compliance and Interoperability ---------------------------------------- The JSON format is specified by :rfc:`7159` and by `ECMA-404 <http://www.ecma-international.org/publications/standards/Ecma-404.htm>`_. This section details this module's level of compliance with the RFC. For simplicity, :class:`JSONEncoder` and :class:`JSONDecoder` subclasses, and parameters other than those explicitly mentioned, are not considered. This module does not comply with the RFC in a strict fashion, implementing some extensions that are valid JavaScript but not valid JSON. In particular: - Infinite and NaN number values are accepted and output; - Repeated names within an object are accepted, and only the value of the last name-value pair is used. Since the RFC permits RFC-compliant parsers to accept input texts that are not RFC-compliant, this module's deserializer is technically RFC-compliant under default settings. Character Encodings ^^^^^^^^^^^^^^^^^^^ The RFC requires that JSON be represented using either UTF-8, UTF-16, or UTF-32, with UTF-8 being the recommended default for maximum interoperability. Accordingly, this module uses UTF-8 as the default for its *encoding* parameter. This module's deserializer only directly works with ASCII-compatible encodings; UTF-16, UTF-32, and other ASCII-incompatible encodings require the use of workarounds described in the documentation for the deserializer's *encoding* parameter. As permitted, though not required, by the RFC, this module's serializer sets *ensure_ascii=True* by default, thus escaping the output so that the resulting strings only contain ASCII characters. The RFC prohibits adding a byte order mark (BOM) to the start of a JSON text, and this module's serializer does not add a BOM to its output. The RFC permits, but does not require, JSON deserializers to ignore an initial BOM in their input. This module's deserializer raises a :exc:`ValueError` when an initial BOM is present. The RFC does not explicitly forbid JSON strings which contain byte sequences that don't correspond to valid Unicode characters (e.g. unpaired UTF-16 surrogates), but it does note that they may cause interoperability problems. By default, this module accepts and outputs (when present in the original :class:`str`) code points for such sequences. Infinite and NaN Number Values ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The RFC does not permit the representation of infinite or NaN number values. Despite that, by default, this module accepts and outputs ``Infinity``, ``-Infinity``, and ``NaN`` as if they were valid JSON number literal values:: >>> # Neither of these calls raises an exception, but the results are not valid JSON >>> json.dumps(float('-inf')) '-Infinity' >>> json.dumps(float('nan')) 'NaN' >>> # Same when deserializing >>> json.loads('-Infinity') -inf >>> json.loads('NaN') nan In the serializer, the *allow_nan* parameter can be used to alter this behavior. In the deserializer, the *parse_constant* parameter can be used to alter this behavior. Repeated Names Within an Object ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The RFC specifies that the names within a JSON object should be unique, but does not mandate how repeated names in JSON objects should be handled. By default, this module does not raise an exception; instead, it ignores all but the last name-value pair for a given name:: >>> weird_json = '{"x": 1, "x": 2, "x": 3}' >>> json.loads(weird_json) {u'x': 3} The *object_pairs_hook* parameter can be used to alter this behavior. Top-level Non-Object, Non-Array Values ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The old version of JSON specified by the obsolete :rfc:`4627` required that the top-level value of a JSON text must be either a JSON object or array (Python :class:`dict` or :class:`list`), and could not be a JSON null, boolean, number, or string value. :rfc:`7159` removed that restriction, and this module does not and has never implemented that restriction in either its serializer or its deserializer. Regardless, for maximum interoperability, you may wish to voluntarily adhere to the restriction yourself. Implementation Limitations ^^^^^^^^^^^^^^^^^^^^^^^^^^ Some JSON deserializer implementations may set limits on: * the size of accepted JSON texts * the maximum level of nesting of JSON objects and arrays * the range and precision of JSON numbers * the content and maximum length of JSON strings This module does not impose any such limits beyond those of the relevant Python datatypes themselves or the Python interpreter itself. When serializing to JSON, beware any such limitations in applications that may consume your JSON. In particular, it is common for JSON numbers to be deserialized into IEEE 754 double precision numbers and thus subject to that representation's range and precision limitations. This is especially relevant when serializing Python :class:`int` values of extremely large magnitude, or when serializing instances of "exotic" numerical types such as :class:`decimal.Decimal`. .. rubric:: Footnotes .. [#rfc-errata] As noted in `the errata for RFC 7159 <https://www.rfc-editor.org/errata_search.php?rfc=7159>`_, JSON permits literal U+2028 (LINE SEPARATOR) and U+2029 (PARAGRAPH SEPARATOR) characters in strings, whereas JavaScript (as of ECMAScript Edition 5.1) does not.
Save
cmd:
run