/usr/share/doc/python-simplejson-doc/index.html is in python-simplejson-doc 3.10.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>simplejson — JSON encoder and decoder — simplejson 3.10.0 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '3.10.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="top" title="simplejson 3.10.0 documentation" href="#" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head>
<body role="document">
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="module-simplejson">
<span id="simplejson-json-encoder-and-decoder"></span><h1><a class="reference internal" href="#module-simplejson" title="simplejson: Encode and decode the JSON format."><code class="xref py py-mod docutils literal"><span class="pre">simplejson</span></code></a> — JSON encoder and decoder<a class="headerlink" href="#module-simplejson" title="Permalink to this headline">¶</a></h1>
<p><a class="reference external" href="http://json.org">JSON (JavaScript Object Notation)</a>, specified by
<span class="target" id="index-0"></span><a class="rfc reference external" href="https://tools.ietf.org/html/rfc7159.html"><strong>RFC 7159</strong></a> (which obsoletes <span class="target" id="index-1"></span><a class="rfc reference external" href="https://tools.ietf.org/html/rfc4627.html"><strong>RFC 4627</strong></a>) and by
<a class="reference external" href="http://www.ecma-international.org/publications/standards/Ecma-404.htm">ECMA-404</a>,
is a lightweight data interchange format inspired by
<a class="reference external" href="http://en.wikipedia.org/wiki/JavaScript">JavaScript</a> object literal syntax
(although it is not a strict subset of JavaScript <a class="footnote-reference" href="#rfc-errata" id="id1">[1]</a> ).</p>
<p><a class="reference internal" href="#module-simplejson" title="simplejson: Encode and decode the JSON format."><code class="xref py py-mod docutils literal"><span class="pre">simplejson</span></code></a> exposes an API familiar to users of the standard library
<code class="xref py py-mod docutils literal"><span class="pre">marshal</span></code> and <code class="xref py py-mod docutils literal"><span class="pre">pickle</span></code> modules. It is the externally maintained
version of the <code class="xref py py-mod docutils literal"><span class="pre">json</span></code> library contained in Python 2.6, but maintains
compatibility with Python 2.5 and (currently) has
significant performance advantages, even without using the optional C
extension for speedups. <a class="reference internal" href="#module-simplejson" title="simplejson: Encode and decode the JSON format."><code class="xref py py-mod docutils literal"><span class="pre">simplejson</span></code></a> is also supported on Python 3.3+.</p>
<p>Development of simplejson happens on Github:
<a class="reference external" href="http://github.com/simplejson/simplejson">http://github.com/simplejson/simplejson</a></p>
<p>Encoding basic Python object hierarchies:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">simplejson</span> <span class="k">as</span> <span class="nn">json</span>
<span class="gp">>>> </span><span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">([</span><span class="s1">'foo'</span><span class="p">,</span> <span class="p">{</span><span class="s1">'bar'</span><span class="p">:</span> <span class="p">(</span><span class="s1">'baz'</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">,</span> <span class="mi">2</span><span class="p">)}])</span>
<span class="go">'["foo", {"bar": ["baz", null, 1.0, 2]}]'</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="s2">"</span><span class="se">\"</span><span class="s2">foo</span><span class="se">\b</span><span class="s2">ar"</span><span class="p">))</span>
<span class="go">"\"foo\bar"</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="s1">u'</span><span class="se">\u1234</span><span class="s1">'</span><span class="p">))</span>
<span class="go">"\u1234"</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="s1">'</span><span class="se">\\</span><span class="s1">'</span><span class="p">))</span>
<span class="go">"\\"</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">({</span><span class="s2">"c"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"b"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"a"</span><span class="p">:</span> <span class="mi">0</span><span class="p">},</span> <span class="n">sort_keys</span><span class="o">=</span><span class="kc">True</span><span class="p">))</span>
<span class="go">{"a": 0, "b": 0, "c": 0}</span>
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">simplejson.compat</span> <span class="k">import</span> <span class="n">StringIO</span>
<span class="gp">>>> </span><span class="n">io</span> <span class="o">=</span> <span class="n">StringIO</span><span class="p">()</span>
<span class="gp">>>> </span><span class="n">json</span><span class="o">.</span><span class="n">dump</span><span class="p">([</span><span class="s1">'streaming API'</span><span class="p">],</span> <span class="n">io</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">io</span><span class="o">.</span><span class="n">getvalue</span><span class="p">()</span>
<span class="go">'["streaming API"]'</span>
</pre></div>
</div>
<p>Compact encoding:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">simplejson</span> <span class="k">as</span> <span class="nn">json</span>
<span class="gp">>>> </span><span class="n">obj</span> <span class="o">=</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">,{</span><span class="s1">'4'</span><span class="p">:</span> <span class="mi">5</span><span class="p">,</span> <span class="s1">'6'</span><span class="p">:</span> <span class="mi">7</span><span class="p">}]</span>
<span class="gp">>>> </span><span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">separators</span><span class="o">=</span><span class="p">(</span><span class="s1">','</span><span class="p">,</span> <span class="s1">':'</span><span class="p">),</span> <span class="n">sort_keys</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="go">'[1,2,3,{"4":5,"6":7}]'</span>
</pre></div>
</div>
<p>Pretty printing:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">simplejson</span> <span class="k">as</span> <span class="nn">json</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">({</span><span class="s1">'4'</span><span class="p">:</span> <span class="mi">5</span><span class="p">,</span> <span class="s1">'6'</span><span class="p">:</span> <span class="mi">7</span><span class="p">},</span> <span class="n">sort_keys</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">indent</span><span class="o">=</span><span class="mi">4</span> <span class="o">*</span> <span class="s1">' '</span><span class="p">))</span>
<span class="go">{</span>
<span class="go"> "4": 5,</span>
<span class="go"> "6": 7</span>
<span class="go">}</span>
</pre></div>
</div>
<p>Decoding JSON:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">simplejson</span> <span class="k">as</span> <span class="nn">json</span>
<span class="gp">>>> </span><span class="n">obj</span> <span class="o">=</span> <span class="p">[</span><span class="s1">u'foo'</span><span class="p">,</span> <span class="p">{</span><span class="s1">u'bar'</span><span class="p">:</span> <span class="p">[</span><span class="s1">u'baz'</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">,</span> <span class="mi">2</span><span class="p">]}]</span>
<span class="gp">>>> </span><span class="n">json</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="s1">'["foo", {"bar":["baz", null, 1.0, 2]}]'</span><span class="p">)</span> <span class="o">==</span> <span class="n">obj</span>
<span class="go">True</span>
<span class="gp">>>> </span><span class="n">json</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="s1">'"</span><span class="se">\\</span><span class="s1">"foo</span><span class="se">\\</span><span class="s1">bar"'</span><span class="p">)</span> <span class="o">==</span> <span class="s1">u'"foo</span><span class="se">\x08</span><span class="s1">ar'</span>
<span class="go">True</span>
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">simplejson.compat</span> <span class="k">import</span> <span class="n">StringIO</span>
<span class="gp">>>> </span><span class="n">io</span> <span class="o">=</span> <span class="n">StringIO</span><span class="p">(</span><span class="s1">'["streaming API"]'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">json</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">io</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="s1">'streaming API'</span>
<span class="go">True</span>
</pre></div>
</div>
<p>Using Decimal instead of float:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">simplejson</span> <span class="k">as</span> <span class="nn">json</span>
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">decimal</span> <span class="k">import</span> <span class="n">Decimal</span>
<span class="gp">>>> </span><span class="n">json</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="s1">'1.1'</span><span class="p">,</span> <span class="n">use_decimal</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="o">==</span> <span class="n">Decimal</span><span class="p">(</span><span class="s1">'1.1'</span><span class="p">)</span>
<span class="go">True</span>
<span class="gp">>>> </span><span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">Decimal</span><span class="p">(</span><span class="s1">'1.1'</span><span class="p">),</span> <span class="n">use_decimal</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="o">==</span> <span class="s1">'1.1'</span>
<span class="go">True</span>
</pre></div>
</div>
<p>Specializing JSON object decoding:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">simplejson</span> <span class="k">as</span> <span class="nn">json</span>
<span class="gp">>>> </span><span class="k">def</span> <span class="nf">as_complex</span><span class="p">(</span><span class="n">dct</span><span class="p">):</span>
<span class="gp">... </span> <span class="k">if</span> <span class="s1">'__complex__'</span> <span class="ow">in</span> <span class="n">dct</span><span class="p">:</span>
<span class="gp">... </span> <span class="k">return</span> <span class="nb">complex</span><span class="p">(</span><span class="n">dct</span><span class="p">[</span><span class="s1">'real'</span><span class="p">],</span> <span class="n">dct</span><span class="p">[</span><span class="s1">'imag'</span><span class="p">])</span>
<span class="gp">... </span> <span class="k">return</span> <span class="n">dct</span>
<span class="gp">...</span>
<span class="gp">>>> </span><span class="n">json</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="s1">'{"__complex__": true, "real": 1, "imag": 2}'</span><span class="p">,</span>
<span class="gp">... </span> <span class="n">object_hook</span><span class="o">=</span><span class="n">as_complex</span><span class="p">)</span>
<span class="go">(1+2j)</span>
<span class="gp">>>> </span><span class="kn">import</span> <span class="nn">decimal</span>
<span class="gp">>>> </span><span class="n">json</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="s1">'1.1'</span><span class="p">,</span> <span class="n">parse_float</span><span class="o">=</span><span class="n">decimal</span><span class="o">.</span><span class="n">Decimal</span><span class="p">)</span> <span class="o">==</span> <span class="n">decimal</span><span class="o">.</span><span class="n">Decimal</span><span class="p">(</span><span class="s1">'1.1'</span><span class="p">)</span>
<span class="go">True</span>
</pre></div>
</div>
<p>Specializing JSON object encoding:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">simplejson</span> <span class="k">as</span> <span class="nn">json</span>
<span class="gp">>>> </span><span class="k">def</span> <span class="nf">encode_complex</span><span class="p">(</span><span class="n">obj</span><span class="p">):</span>
<span class="gp">... </span> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="nb">complex</span><span class="p">):</span>
<span class="gp">... </span> <span class="k">return</span> <span class="p">[</span><span class="n">obj</span><span class="o">.</span><span class="n">real</span><span class="p">,</span> <span class="n">obj</span><span class="o">.</span><span class="n">imag</span><span class="p">]</span>
<span class="gp">... </span> <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="nb">repr</span><span class="p">(</span><span class="n">obj</span><span class="p">)</span> <span class="o">+</span> <span class="s2">" is not JSON serializable"</span><span class="p">)</span>
<span class="gp">...</span>
<span class="gp">>>> </span><span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="mi">2</span> <span class="o">+</span> <span class="mi">1</span><span class="n">j</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="n">encode_complex</span><span class="p">)</span>
<span class="go">'[2.0, 1.0]'</span>
<span class="gp">>>> </span><span class="n">json</span><span class="o">.</span><span class="n">JSONEncoder</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="n">encode_complex</span><span class="p">)</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="mi">2</span> <span class="o">+</span> <span class="mi">1</span><span class="n">j</span><span class="p">)</span>
<span class="go">'[2.0, 1.0]'</span>
<span class="gp">>>> </span><span class="s1">''</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">json</span><span class="o">.</span><span class="n">JSONEncoder</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="n">encode_complex</span><span class="p">)</span><span class="o">.</span><span class="n">iterencode</span><span class="p">(</span><span class="mi">2</span> <span class="o">+</span> <span class="mi">1</span><span class="n">j</span><span class="p">))</span>
<span class="go">'[2.0, 1.0]'</span>
</pre></div>
</div>
<p>Using <code class="xref py py-mod docutils literal"><span class="pre">simplejson.tool</span></code> from the shell to validate and pretty-print:</p>
<div class="highlight-bash"><div class="highlight"><pre><span></span>$ <span class="nb">echo</span> <span class="s1">'{"json":"obj"}'</span> <span class="p">|</span> python -m simplejson.tool
<span class="o">{</span>
<span class="s2">"json"</span>: <span class="s2">"obj"</span>
<span class="o">}</span>
$ <span class="nb">echo</span> <span class="s1">'{ 1.2:3.4}'</span> <span class="p">|</span> python -m simplejson.tool
Expecting property name enclosed in double quotes: line <span class="m">1</span> column <span class="m">3</span> <span class="o">(</span>char 2<span class="o">)</span>
</pre></div>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">JSON is a subset of <a class="reference external" href="http://yaml.org/">YAML</a> 1.2. The JSON produced by
this module’s default settings (in particular, the default <em>separators</em>
value) is also a subset of YAML 1.0 and 1.1. This module can thus also be
used as a YAML serializer.</p>
</div>
<div class="section" id="basic-usage">
<h2>Basic Usage<a class="headerlink" href="#basic-usage" title="Permalink to this headline">¶</a></h2>
<dl class="function">
<dt id="simplejson.dump">
<code class="descclassname">simplejson.</code><code class="descname">dump</code><span class="sig-paren">(</span><em>obj</em>, <em>fp</em>, <em>skipkeys=False</em>, <em>ensure_ascii=True</em>, <em>check_circular=True</em>, <em>allow_nan=True</em>, <em>cls=None</em>, <em>indent=None</em>, <em>separators=None</em>, <em>encoding='utf-8'</em>, <em>default=None</em>, <em>use_decimal=True</em>, <em>namedtuple_as_object=True</em>, <em>tuple_as_array=True</em>, <em>bigint_as_string=False</em>, <em>sort_keys=False</em>, <em>item_sort_key=None</em>, <em>for_json=None</em>, <em>ignore_nan=False</em>, <em>int_as_string_bitcount=None</em>, <em>iterable_as_array=False</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#simplejson.dump" title="Permalink to this definition">¶</a></dt>
<dd><blockquote>
<div><p>Serialize <em>obj</em> as a JSON formatted stream to <em>fp</em> (a <code class="docutils literal"><span class="pre">.write()</span></code>-supporting
file-like object) using this <a class="reference internal" href="#py-to-json-table"><span class="std std-ref">conversion table</span></a>.</p>
<p>If <em>skipkeys</em> is true (default: <code class="docutils literal"><span class="pre">False</span></code>), then dict keys that are not
of a basic type (<code class="xref py py-class docutils literal"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal"><span class="pre">unicode</span></code>, <code class="xref py py-class docutils literal"><span class="pre">int</span></code>, <code class="xref py py-class docutils literal"><span class="pre">long</span></code>,
<code class="xref py py-class docutils literal"><span class="pre">float</span></code>, <code class="xref py py-class docutils literal"><span class="pre">bool</span></code>, <code class="docutils literal"><span class="pre">None</span></code>) will be skipped instead of raising a
<code class="xref py py-exc docutils literal"><span class="pre">TypeError</span></code>.</p>
<p>The <a class="reference internal" href="#module-simplejson" title="simplejson: Encode and decode the JSON format."><code class="xref py py-mod docutils literal"><span class="pre">simplejson</span></code></a> module will produce <code class="xref py py-class docutils literal"><span class="pre">str</span></code> objects in Python 3,
not <code class="xref py py-class docutils literal"><span class="pre">bytes</span></code> objects. Therefore, <code class="docutils literal"><span class="pre">fp.write()</span></code> must support
<code class="xref py py-class docutils literal"><span class="pre">str</span></code> input.</p>
<p>If <em>ensure_ascii</em> is false (default: <code class="docutils literal"><span class="pre">True</span></code>), then some chunks written
to <em>fp</em> may be <code class="xref py py-class docutils literal"><span class="pre">unicode</span></code> instances, subject to normal Python
<code class="xref py py-class docutils literal"><span class="pre">str</span></code> to <code class="xref py py-class docutils literal"><span class="pre">unicode</span></code> coercion rules. Unless <code class="docutils literal"><span class="pre">fp.write()</span></code>
explicitly understands <code class="xref py py-class docutils literal"><span class="pre">unicode</span></code> (as in <code class="xref py py-func docutils literal"><span class="pre">codecs.getwriter()</span></code>) this
is likely to cause an error. It’s best to leave the default settings, because
they are safe and it is highly optimized.</p>
<p>If <em>check_circular</em> is false (default: <code class="docutils literal"><span class="pre">True</span></code>), then the circular
reference check for container types will be skipped and a circular reference
will result in an <code class="xref py py-exc docutils literal"><span class="pre">OverflowError</span></code> (or worse).</p>
<p>If <em>allow_nan</em> is false (default: <code class="docutils literal"><span class="pre">True</span></code>), then it will be a
<code class="xref py py-exc docutils literal"><span class="pre">ValueError</span></code> to serialize out of range <code class="xref py py-class docutils literal"><span class="pre">float</span></code> values (<code class="docutils literal"><span class="pre">nan</span></code>,
<code class="docutils literal"><span class="pre">inf</span></code>, <code class="docutils literal"><span class="pre">-inf</span></code>) in strict compliance of the original JSON specification.
If <em>allow_nan</em> is true, their JavaScript equivalents will be used
(<code class="docutils literal"><span class="pre">NaN</span></code>, <code class="docutils literal"><span class="pre">Infinity</span></code>, <code class="docutils literal"><span class="pre">-Infinity</span></code>). See also <em>ignore_nan</em> for ECMA-262
compliant behavior.</p>
<p>If <em>indent</em> is a string, then JSON array elements and object members
will be pretty-printed with a newline followed by that string repeated
for each level of nesting. <code class="docutils literal"><span class="pre">None</span></code> (the default) selects the most compact
representation without any newlines. For backwards compatibility with
versions of simplejson earlier than 2.1.0, an integer is also accepted
and is converted to a string with that many spaces.</p>
<div class="versionchanged">
<p><span class="versionmodified">Changed in version 2.1.0: </span>Changed <em>indent</em> from an integer number of spaces to a string.</p>
</div>
<p>If specified, <em>separators</em> should be an <code class="docutils literal"><span class="pre">(item_separator,</span> <span class="pre">key_separator)</span></code>
tuple. The default is <code class="docutils literal"><span class="pre">(',</span> <span class="pre">',</span> <span class="pre">':</span> <span class="pre">')</span></code> if <em>indent</em> is <code class="docutils literal"><span class="pre">None</span></code> and
<code class="docutils literal"><span class="pre">(',',</span> <span class="pre">':</span> <span class="pre">')</span></code> otherwise. To get the most compact JSON representation,
you should specify <code class="docutils literal"><span class="pre">(',',</span> <span class="pre">':')</span></code> to eliminate whitespace.</p>
<div class="versionchanged">
<p><span class="versionmodified">Changed in version 2.1.4: </span>Use <code class="docutils literal"><span class="pre">(',',</span> <span class="pre">':</span> <span class="pre">')</span></code> as default if <em>indent</em> is not <code class="docutils literal"><span class="pre">None</span></code>.</p>
</div>
<p><em>encoding</em> is the character encoding for str instances, default is
<code class="docutils literal"><span class="pre">'utf-8'</span></code>.</p>
<p><em>default(obj)</em> is a function that should return a serializable version of
<em>obj</em> or raise <code class="xref py py-exc docutils literal"><span class="pre">TypeError</span></code>. The default simply raises <code class="xref py py-exc docutils literal"><span class="pre">TypeError</span></code>.</p>
<p>To use a custom <a class="reference internal" href="#simplejson.JSONEncoder" title="simplejson.JSONEncoder"><code class="xref py py-class docutils literal"><span class="pre">JSONEncoder</span></code></a> subclass (e.g. one that overrides the
<code class="xref py py-meth docutils literal"><span class="pre">default()</span></code> method to serialize additional types), specify it with the
<em>cls</em> kwarg.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Subclassing is not recommended. Use the <em>default</em> kwarg
or <em>for_json</em> instead. This is faster and more portable.</p>
</div>
<p>If <em>use_decimal</em> is true (default: <code class="docutils literal"><span class="pre">True</span></code>) then <code class="xref py py-class docutils literal"><span class="pre">decimal.Decimal</span></code>
will be natively serialized to JSON with full precision.</p>
<div class="versionchanged">
<p><span class="versionmodified">Changed in version 2.1.0: </span><em>use_decimal</em> is new in 2.1.0.</p>
</div>
<div class="versionchanged">
<p><span class="versionmodified">Changed in version 2.2.0: </span>The default of <em>use_decimal</em> changed to <code class="docutils literal"><span class="pre">True</span></code> in 2.2.0.</p>
</div>
<p>If <em>namedtuple_as_object</em> is true (default: <code class="docutils literal"><span class="pre">True</span></code>),
objects with <code class="docutils literal"><span class="pre">_asdict()</span></code> methods will be encoded
as JSON objects.</p>
<div class="versionchanged">
<p><span class="versionmodified">Changed in version 2.2.0: </span><em>namedtuple_as_object</em> is new in 2.2.0.</p>
</div>
<div class="versionchanged">
<p><span class="versionmodified">Changed in version 2.3.0: </span><em>namedtuple_as_object</em> no longer requires that these objects be
subclasses of <code class="xref py py-class docutils literal"><span class="pre">tuple</span></code>.</p>
</div>
<p>If <em>tuple_as_array</em> is true (default: <code class="docutils literal"><span class="pre">True</span></code>),
<code class="xref py py-class docutils literal"><span class="pre">tuple</span></code> (and subclasses) will be encoded as JSON arrays.</p>
</div></blockquote>
<p>If <em>iterable_as_array</em> is true (default: <code class="docutils literal"><span class="pre">False</span></code>),
any object not in the above table that implements <code class="docutils literal"><span class="pre">__iter__()</span></code>
will be encoded as a JSON array.</p>
<div class="versionchanged">
<p><span class="versionmodified">Changed in version 3.8.0: </span><em>iterable_as_array</em> is new in 3.8.0.</p>
<div class="versionchanged">
<p><span class="versionmodified">Changed in version 2.2.0: </span><em>tuple_as_array</em> is new in 2.2.0.</p>
</div>
<p>If <em>bigint_as_string</em> is true (default: <code class="docutils literal"><span class="pre">False</span></code>), <code class="xref py py-class docutils literal"><span class="pre">int</span></code> <code class="docutils literal"><span class="pre">2**53</span></code>
and higher or lower than <code class="docutils literal"><span class="pre">-2**53</span></code> will be encoded as strings. This is to
avoid the rounding that happens in Javascript otherwise. Note that this
option loses type information, so use with extreme caution.
See also <em>int_as_string_bitcount</em>.</p>
<div class="versionchanged">
<p><span class="versionmodified">Changed in version 2.4.0: </span><em>bigint_as_string</em> is new in 2.4.0.</p>
</div>
<p>If <em>sort_keys</em> is true (not the default), then the output of dictionaries
will be sorted by key; this is useful for regression tests to ensure that
JSON serializations can be compared on a day-to-day basis.</p>
<div class="versionchanged">
<p><span class="versionmodified">Changed in version 3.0.0: </span>Sorting now happens after the keys have been coerced to
strings, to avoid comparison of heterogeneously typed objects
(since this does not work in Python 3.3+)</p>
</div>
<p>If <em>item_sort_key</em> is a callable (not the default), then the output of
dictionaries will be sorted with it. The callable will be used like this:
<code class="docutils literal"><span class="pre">sorted(dct.items(),</span> <span class="pre">key=item_sort_key)</span></code>. This option takes precedence
over <em>sort_keys</em>.</p>
<div class="versionchanged">
<p><span class="versionmodified">Changed in version 2.5.0: </span><em>item_sort_key</em> is new in 2.5.0.</p>
</div>
<div class="versionchanged">
<p><span class="versionmodified">Changed in version 3.0.0: </span>Sorting now happens after the keys have been coerced to
strings, to avoid comparison of heterogeneously typed objects
(since this does not work in Python 3.3+)</p>
</div>
<p>If <em>for_json</em> is true (not the default), objects with a <code class="docutils literal"><span class="pre">for_json()</span></code>
method will use the return value of that method for encoding as JSON instead
of the object.</p>
<div class="versionchanged">
<p><span class="versionmodified">Changed in version 3.2.0: </span><em>for_json</em> is new in 3.2.0.</p>
</div>
<p>If <em>ignore_nan</em> is true (default: <code class="docutils literal"><span class="pre">False</span></code>), then out of range
<code class="xref py py-class docutils literal"><span class="pre">float</span></code> values (<code class="docutils literal"><span class="pre">nan</span></code>, <code class="docutils literal"><span class="pre">inf</span></code>, <code class="docutils literal"><span class="pre">-inf</span></code>) will be serialized as
<code class="docutils literal"><span class="pre">null</span></code> in compliance with the ECMA-262 specification. If true, this will
override <em>allow_nan</em>.</p>
<div class="versionchanged">
<p><span class="versionmodified">Changed in version 3.2.0: </span><em>ignore_nan</em> is new in 3.2.0.</p>
</div>
<p>If <em>int_as_string_bitcount</em> is a positive number <code class="docutils literal"><span class="pre">n</span></code> (default: <code class="docutils literal"><span class="pre">None</span></code>),
<code class="xref py py-class docutils literal"><span class="pre">int</span></code> <code class="docutils literal"><span class="pre">2**n</span></code> and higher or lower than <code class="docutils literal"><span class="pre">-2**n</span></code> will be encoded as strings. This is to
avoid the rounding that happens in Javascript otherwise. Note that this
option loses type information, so use with extreme caution.
See also <em>bigint_as_string</em> (which is equivalent to <cite>int_as_string_bitcount=53</cite>).</p>
<div class="versionchanged">
<p><span class="versionmodified">Changed in version 3.5.0: </span><em>int_as_string_bitcount</em> is new in 3.5.0.</p>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">JSON is not a framed protocol so unlike <code class="xref py py-mod docutils literal"><span class="pre">pickle</span></code> or <code class="xref py py-mod docutils literal"><span class="pre">marshal</span></code> it
does not make sense to serialize more than one JSON document without some
container protocol to delimit them.</p>
</div>
</div>
</dd></dl>
<dl class="function">
<dt id="simplejson.dumps">
<code class="descclassname">simplejson.</code><code class="descname">dumps</code><span class="sig-paren">(</span><em>obj</em>, <em>skipkeys=False</em>, <em>ensure_ascii=True</em>, <em>check_circular=True</em>, <em>allow_nan=True</em>, <em>cls=None</em>, <em>indent=None</em>, <em>separators=None</em>, <em>encoding='utf-8'</em>, <em>default=None</em>, <em>use_decimal=True</em>, <em>namedtuple_as_object=True</em>, <em>tuple_as_array=True</em>, <em>bigint_as_string=False</em>, <em>sort_keys=False</em>, <em>item_sort_key=None</em>, <em>for_json=None</em>, <em>ignore_nan=False</em>, <em>int_as_string_bitcount=None</em>, <em>iterable_as_array=False</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#simplejson.dumps" title="Permalink to this definition">¶</a></dt>
<dd><p>Serialize <em>obj</em> to a JSON formatted <code class="xref py py-class docutils literal"><span class="pre">str</span></code>.</p>
<p>If <em>ensure_ascii</em> is false, then the return value will be a
<code class="xref py py-class docutils literal"><span class="pre">unicode</span></code> instance. The other arguments have the same meaning as in
<a class="reference internal" href="#simplejson.dump" title="simplejson.dump"><code class="xref py py-func docutils literal"><span class="pre">dump()</span></code></a>. Note that the default <em>ensure_ascii</em> setting has much
better performance in Python 2.</p>
<p>The other options have the same meaning as in <a class="reference internal" href="#simplejson.dump" title="simplejson.dump"><code class="xref py py-func docutils literal"><span class="pre">dump()</span></code></a>.</p>
</dd></dl>
<dl class="function">
<dt id="simplejson.load">
<code class="descclassname">simplejson.</code><code class="descname">load</code><span class="sig-paren">(</span><em>fp</em>, <em>encoding='utf-8'</em>, <em>cls=None</em>, <em>object_hook=None</em>, <em>parse_float=None</em>, <em>parse_int=None</em>, <em>parse_constant=None</em>, <em>object_pairs_hook=None</em>, <em>use_decimal=None</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#simplejson.load" title="Permalink to this definition">¶</a></dt>
<dd><p>Deserialize <em>fp</em> (a <code class="docutils literal"><span class="pre">.read()</span></code>-supporting file-like object containing a JSON
document) to a Python object using this
<a class="reference internal" href="#json-to-py-table"><span class="std std-ref">conversion table</span></a>. <a class="reference internal" href="#simplejson.JSONDecodeError" title="simplejson.JSONDecodeError"><code class="xref py py-exc docutils literal"><span class="pre">JSONDecodeError</span></code></a> will be
raised if the given JSON document is not valid.</p>
<p>If the contents of <em>fp</em> are encoded with an ASCII based encoding other than
UTF-8 (e.g. latin-1), then an appropriate <em>encoding</em> name must be specified.
Encodings that are not ASCII based (such as UCS-2) are not allowed, and
should be wrapped with <code class="docutils literal"><span class="pre">codecs.getreader(fp)(encoding)</span></code>, or simply decoded
to a <code class="xref py py-class docutils literal"><span class="pre">unicode</span></code> object and passed to <a class="reference internal" href="#simplejson.loads" title="simplejson.loads"><code class="xref py py-func docutils literal"><span class="pre">loads()</span></code></a>. The default
setting of <code class="docutils literal"><span class="pre">'utf-8'</span></code> is fastest and should be using whenever possible.</p>
<p>If <em>fp.read()</em> returns <code class="xref py py-class docutils literal"><span class="pre">str</span></code> then decoded JSON strings that contain
only ASCII characters may be parsed as <code class="xref py py-class docutils literal"><span class="pre">str</span></code> for performance and
memory reasons. If your code expects only <code class="xref py py-class docutils literal"><span class="pre">unicode</span></code> the appropriate
solution is to wrap fp with a reader as demonstrated above.</p>
<p><em>object_hook</em> is an optional function that will be called with the result of
any object literal decode (a <code class="xref py py-class docutils literal"><span class="pre">dict</span></code>). The return value of
<em>object_hook</em> will be used instead of the <code class="xref py py-class docutils literal"><span class="pre">dict</span></code>. This feature can be used
to implement custom decoders (e.g. <a class="reference external" href="http://www.jsonrpc.org">JSON-RPC</a>
class hinting).</p>
<p><em>object_pairs_hook</em> is an optional function that will be called with the
result of any object literal decode with an ordered list of pairs. The
return value of <em>object_pairs_hook</em> will be used instead of the
<code class="xref py py-class docutils literal"><span class="pre">dict</span></code>. This feature can be used to implement custom decoders that
rely on the order that the key and value pairs are decoded (for example,
<code class="xref py py-class docutils literal"><span class="pre">collections.OrderedDict</span></code> will remember the order of insertion). If
<em>object_hook</em> is also defined, the <em>object_pairs_hook</em> takes priority.</p>
<div class="versionchanged">
<p><span class="versionmodified">Changed in version 2.1.0: </span>Added support for <em>object_pairs_hook</em>.</p>
</div>
<p><em>parse_float</em>, if specified, will be called with the string of every JSON
float to be decoded. By default, this is equivalent to <code class="docutils literal"><span class="pre">float(num_str)</span></code>.
This can be used to use another datatype or parser for JSON floats
(e.g. <code class="xref py py-class docutils literal"><span class="pre">decimal.Decimal</span></code>).</p>
<p><em>parse_int</em>, if specified, will be called with the string of every JSON int
to be decoded. By default, this is equivalent to <code class="docutils literal"><span class="pre">int(num_str)</span></code>. This can
be used to use another datatype or parser for JSON integers
(e.g. <code class="xref py py-class docutils literal"><span class="pre">float</span></code>).</p>
<p><em>parse_constant</em>, if specified, will be called with one of the following
strings: <code class="docutils literal"><span class="pre">'-Infinity'</span></code>, <code class="docutils literal"><span class="pre">'Infinity'</span></code>, <code class="docutils literal"><span class="pre">'NaN'</span></code>. This can be used to
raise an exception if invalid JSON numbers are encountered.</p>
<p>If <em>use_decimal</em> is true (default: <code class="docutils literal"><span class="pre">False</span></code>) then <em>parse_float</em> is set to
<code class="xref py py-class docutils literal"><span class="pre">decimal.Decimal</span></code>. This is a convenience for parity with the
<a class="reference internal" href="#simplejson.dump" title="simplejson.dump"><code class="xref py py-func docutils literal"><span class="pre">dump()</span></code></a> parameter.</p>
<div class="versionchanged">
<p><span class="versionmodified">Changed in version 2.1.0: </span><em>use_decimal</em> is new in 2.1.0.</p>
</div>
<p>If <em>iterable_as_array</em> is true (default: <code class="docutils literal"><span class="pre">False</span></code>),
any object not in the above table that implements <code class="docutils literal"><span class="pre">__iter__()</span></code>
will be encoded as a JSON array.</p>
<div class="versionchanged">
<p><span class="versionmodified">Changed in version 3.8.0: </span><em>iterable_as_array</em> is new in 3.8.0.</p>
</div>
<p>To use a custom <a class="reference internal" href="#simplejson.JSONDecoder" title="simplejson.JSONDecoder"><code class="xref py py-class docutils literal"><span class="pre">JSONDecoder</span></code></a> subclass, specify it with the <code class="docutils literal"><span class="pre">cls</span></code>
kwarg. Additional keyword arguments will be passed to the constructor of the
class. You probably shouldn’t do this.</p>
<blockquote>
<div><div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Subclassing is not recommended. You should use <em>object_hook</em> or
<em>object_pairs_hook</em>. This is faster and more portable than subclassing.</p>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last"><a class="reference internal" href="#simplejson.load" title="simplejson.load"><code class="xref py py-func docutils literal"><span class="pre">load()</span></code></a> will read the rest of the file-like object as a string and
then call <a class="reference internal" href="#simplejson.loads" title="simplejson.loads"><code class="xref py py-func docutils literal"><span class="pre">loads()</span></code></a>. It does not stop at the end of the first valid
JSON document it finds and it will raise an error if there is anything
other than whitespace after the document. Except for files containing
only one JSON document, it is recommended to use <a class="reference internal" href="#simplejson.loads" title="simplejson.loads"><code class="xref py py-func docutils literal"><span class="pre">loads()</span></code></a>.</p>
</div>
</div></blockquote>
</dd></dl>
<dl class="function">
<dt id="simplejson.loads">
<code class="descclassname">simplejson.</code><code class="descname">loads</code><span class="sig-paren">(</span><em>fp</em>, <em>encoding='utf-8'</em>, <em>cls=None</em>, <em>object_hook=None</em>, <em>parse_float=None</em>, <em>parse_int=None</em>, <em>parse_constant=None</em>, <em>object_pairs_hook=None</em>, <em>use_decimal=None</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#simplejson.loads" title="Permalink to this definition">¶</a></dt>
<dd><p>Deserialize <em>s</em> (a <code class="xref py py-class docutils literal"><span class="pre">str</span></code> or <code class="xref py py-class docutils literal"><span class="pre">unicode</span></code> instance containing a JSON
document) to a Python object. <a class="reference internal" href="#simplejson.JSONDecodeError" title="simplejson.JSONDecodeError"><code class="xref py py-exc docutils literal"><span class="pre">JSONDecodeError</span></code></a> will be
raised if the given JSON document is not valid.</p>
<p>If <em>s</em> is a <code class="xref py py-class docutils literal"><span class="pre">str</span></code> instance and is encoded with an ASCII based encoding
other than UTF-8 (e.g. latin-1), then an appropriate <em>encoding</em> name must be
specified. Encodings that are not ASCII based (such as UCS-2) are not
allowed and should be decoded to <code class="xref py py-class docutils literal"><span class="pre">unicode</span></code> first.</p>
<p>If <em>s</em> is a <code class="xref py py-class docutils literal"><span class="pre">str</span></code> then decoded JSON strings that contain
only ASCII characters may be parsed as <code class="xref py py-class docutils literal"><span class="pre">str</span></code> for performance and
memory reasons. If your code expects only <code class="xref py py-class docutils literal"><span class="pre">unicode</span></code> the appropriate
solution is decode <em>s</em> to <code class="xref py py-class docutils literal"><span class="pre">unicode</span></code> prior to calling loads.</p>
<p>The other arguments have the same meaning as in <a class="reference internal" href="#simplejson.load" title="simplejson.load"><code class="xref py py-func docutils literal"><span class="pre">load()</span></code></a>.</p>
</dd></dl>
</div>
<div class="section" id="encoders-and-decoders">
<h2>Encoders and decoders<a class="headerlink" href="#encoders-and-decoders" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="simplejson.JSONDecoder">
<em class="property">class </em><code class="descclassname">simplejson.</code><code class="descname">JSONDecoder</code><span class="sig-paren">(</span><em>encoding='utf-8'</em>, <em>object_hook=None</em>, <em>parse_float=None</em>, <em>parse_int=None</em>, <em>parse_constant=None</em>, <em>object_pairs_hook=None</em>, <em>strict=True</em><span class="sig-paren">)</span><a class="headerlink" href="#simplejson.JSONDecoder" title="Permalink to this definition">¶</a></dt>
<dd><p>Simple JSON decoder.</p>
<p>Performs the following translations in decoding by default:</p>
<table border="1" class="docutils" id="json-to-py-table">
<colgroup>
<col width="41%" />
<col width="30%" />
<col width="30%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">JSON</th>
<th class="head">Python 2</th>
<th class="head">Python 3</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>object</td>
<td>dict</td>
<td>dict</td>
</tr>
<tr class="row-odd"><td>array</td>
<td>list</td>
<td>list</td>
</tr>
<tr class="row-even"><td>string</td>
<td>unicode</td>
<td>str</td>
</tr>
<tr class="row-odd"><td>number (int)</td>
<td>int, long</td>
<td>int</td>
</tr>
<tr class="row-even"><td>number (real)</td>
<td>float</td>
<td>float</td>
</tr>
<tr class="row-odd"><td>true</td>
<td>True</td>
<td>True</td>
</tr>
<tr class="row-even"><td>false</td>
<td>False</td>
<td>False</td>
</tr>
<tr class="row-odd"><td>null</td>
<td>None</td>
<td>None</td>
</tr>
</tbody>
</table>
<p>It also understands <code class="docutils literal"><span class="pre">NaN</span></code>, <code class="docutils literal"><span class="pre">Infinity</span></code>, and <code class="docutils literal"><span class="pre">-Infinity</span></code> as their
corresponding <code class="docutils literal"><span class="pre">float</span></code> values, which is outside the JSON spec.</p>
<p><em>encoding</em> determines the encoding used to interpret any <code class="xref py py-class docutils literal"><span class="pre">str</span></code> objects
decoded by this instance (<code class="docutils literal"><span class="pre">'utf-8'</span></code> by default). It has no effect when decoding
<code class="xref py py-class docutils literal"><span class="pre">unicode</span></code> objects.</p>
<p>Note that currently only encodings that are a superset of ASCII work, strings
of other encodings should be passed in as <code class="xref py py-class docutils literal"><span class="pre">unicode</span></code>.</p>
<p><em>object_hook</em> is an optional function that will be called with the result of
every JSON object decoded and its return value will be used in place of the
given <code class="xref py py-class docutils literal"><span class="pre">dict</span></code>. This can be used to provide custom deserializations
(e.g. to support JSON-RPC class hinting).</p>
<p><em>object_pairs_hook</em> is an optional function that will be called with the
result of any object literal decode with an ordered list of pairs. The
return value of <em>object_pairs_hook</em> will be used instead of the
<code class="xref py py-class docutils literal"><span class="pre">dict</span></code>. This feature can be used to implement custom decoders that
rely on the order that the key and value pairs are decoded (for example,
<code class="xref py py-class docutils literal"><span class="pre">collections.OrderedDict</span></code> will remember the order of insertion). If
<em>object_hook</em> is also defined, the <em>object_pairs_hook</em> takes priority.</p>
<div class="versionchanged">
<p><span class="versionmodified">Changed in version 2.1.0: </span>Added support for <em>object_pairs_hook</em>.</p>
</div>
<p><em>parse_float</em>, if specified, will be called with the string of every JSON
float to be decoded. By default, this is equivalent to <code class="docutils literal"><span class="pre">float(num_str)</span></code>.
This can be used to use another datatype or parser for JSON floats
(e.g. <code class="xref py py-class docutils literal"><span class="pre">decimal.Decimal</span></code>).</p>
<p><em>parse_int</em>, if specified, will be called with the string of every JSON int
to be decoded. By default, this is equivalent to <code class="docutils literal"><span class="pre">int(num_str)</span></code>. This can
be used to use another datatype or parser for JSON integers
(e.g. <code class="xref py py-class docutils literal"><span class="pre">float</span></code>).</p>
<p><em>parse_constant</em>, if specified, will be called with one of the following
strings: <code class="docutils literal"><span class="pre">'-Infinity'</span></code>, <code class="docutils literal"><span class="pre">'Infinity'</span></code>, <code class="docutils literal"><span class="pre">'NaN'</span></code>. This can be used to
raise an exception if invalid JSON numbers are encountered.</p>
<p><em>strict</em> controls the parser’s behavior when it encounters an invalid
control character in a string. The default setting of <code class="docutils literal"><span class="pre">True</span></code> means that
unescaped control characters are parse errors, if <code class="docutils literal"><span class="pre">False</span></code> then control
characters will be allowed in strings.</p>
<dl class="method">
<dt id="simplejson.JSONDecoder.decode">
<code class="descname">decode</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="headerlink" href="#simplejson.JSONDecoder.decode" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the Python representation of <em>s</em> (a <code class="xref py py-class docutils literal"><span class="pre">str</span></code> or
<code class="xref py py-class docutils literal"><span class="pre">unicode</span></code> instance containing a JSON document)</p>
<p>If <em>s</em> is a <code class="xref py py-class docutils literal"><span class="pre">str</span></code> then decoded JSON strings that contain
only ASCII characters may be parsed as <code class="xref py py-class docutils literal"><span class="pre">str</span></code> for performance and
memory reasons. If your code expects only <code class="xref py py-class docutils literal"><span class="pre">unicode</span></code> the
appropriate solution is decode <em>s</em> to <code class="xref py py-class docutils literal"><span class="pre">unicode</span></code> prior to calling
decode.</p>
<p><a class="reference internal" href="#simplejson.JSONDecodeError" title="simplejson.JSONDecodeError"><code class="xref py py-exc docutils literal"><span class="pre">JSONDecodeError</span></code></a> will be raised if the given JSON
document is not valid.</p>
</dd></dl>
<dl class="method">
<dt id="simplejson.JSONDecoder.raw_decode">
<code class="descname">raw_decode</code><span class="sig-paren">(</span><em>s</em><span class="optional">[</span>, <em>idx=0</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#simplejson.JSONDecoder.raw_decode" title="Permalink to this definition">¶</a></dt>
<dd><p>Decode a JSON document from <em>s</em> (a <code class="xref py py-class docutils literal"><span class="pre">str</span></code> or <code class="xref py py-class docutils literal"><span class="pre">unicode</span></code>
beginning with a JSON document) starting from the index <em>idx</em> and return
a 2-tuple of the Python representation and the index in <em>s</em> where the
document ended.</p>
<p>This can be used to decode a JSON document from a string that may have
extraneous data at the end, or to decode a string that has a series of
JSON objects.</p>
<p><a class="reference internal" href="#simplejson.JSONDecodeError" title="simplejson.JSONDecodeError"><code class="xref py py-exc docutils literal"><span class="pre">JSONDecodeError</span></code></a> will be raised if the given JSON
document is not valid.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="simplejson.JSONEncoder">
<em class="property">class </em><code class="descclassname">simplejson.</code><code class="descname">JSONEncoder</code><span class="sig-paren">(</span><em>skipkeys=False</em>, <em>ensure_ascii=True</em>, <em>check_circular=True</em>, <em>allow_nan=True</em>, <em>sort_keys=False</em>, <em>indent=None</em>, <em>separators=None</em>, <em>encoding='utf-8'</em>, <em>default=None</em>, <em>use_decimal=True</em>, <em>namedtuple_as_object=True</em>, <em>tuple_as_array=True</em>, <em>bigint_as_string=False</em>, <em>item_sort_key=None</em>, <em>for_json=True</em>, <em>ignore_nan=False</em>, <em>int_as_string_bitcount=None</em>, <em>iterable_as_array=False</em><span class="sig-paren">)</span><a class="headerlink" href="#simplejson.JSONEncoder" title="Permalink to this definition">¶</a></dt>
<dd><p>Extensible JSON encoder for Python data structures.</p>
<p>Supports the following objects and types by default:</p>
<table border="1" class="docutils" id="py-to-json-table">
<colgroup>
<col width="56%" />
<col width="44%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Python</th>
<th class="head">JSON</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>dict, namedtuple</td>
<td>object</td>
</tr>
<tr class="row-odd"><td>list, tuple</td>
<td>array</td>
</tr>
<tr class="row-even"><td>str, unicode</td>
<td>string</td>
</tr>
<tr class="row-odd"><td>int, long, float</td>
<td>number</td>
</tr>
<tr class="row-even"><td>True</td>
<td>true</td>
</tr>
<tr class="row-odd"><td>False</td>
<td>false</td>
</tr>
<tr class="row-even"><td>None</td>
<td>null</td>
</tr>
</tbody>
</table>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">The JSON format only permits strings to be used as object
keys, thus any Python dicts to be encoded should only have string keys.
For backwards compatibility, several other types are automatically
coerced to strings: int, long, float, Decimal, bool, and None.
It is error-prone to rely on this behavior, so avoid it when possible.
Dictionaries with other types used as keys should be pre-processed or
wrapped in another type with an appropriate <cite>for_json</cite> method to
transform the keys during encoding.</p>
</div>
<p>It also understands <code class="docutils literal"><span class="pre">NaN</span></code>, <code class="docutils literal"><span class="pre">Infinity</span></code>, and <code class="docutils literal"><span class="pre">-Infinity</span></code> as their
corresponding <code class="docutils literal"><span class="pre">float</span></code> values, which is outside the JSON spec.</p>
<div class="versionchanged">
<p><span class="versionmodified">Changed in version 2.2.0: </span>Changed <em>namedtuple</em> encoding from JSON array to object.</p>
</div>
<p>To extend this to recognize other objects, subclass and implement a
<a class="reference internal" href="#simplejson.JSONEncoder.default" title="simplejson.JSONEncoder.default"><code class="xref py py-meth docutils literal"><span class="pre">default()</span></code></a> method with another method that returns a serializable object
for <code class="docutils literal"><span class="pre">o</span></code> if possible, otherwise it should call the superclass implementation
(to raise <code class="xref py py-exc docutils literal"><span class="pre">TypeError</span></code>).</p>
<blockquote>
<div><div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Subclassing is not recommended. You should use the <em>default</em>
or <em>for_json</em> kwarg. This is faster and more portable than subclassing.</p>
</div>
</div></blockquote>
<p>If <em>skipkeys</em> is false (the default), then it is a <code class="xref py py-exc docutils literal"><span class="pre">TypeError</span></code> to
attempt encoding of keys that are not str, int, long, float, Decimal, bool,
or None. If <em>skipkeys</em> is true, such items are simply skipped.</p>
<p>If <em>ensure_ascii</em> is true (the default), the output is guaranteed to be
<code class="xref py py-class docutils literal"><span class="pre">str</span></code> objects with all incoming unicode characters escaped. If
<em>ensure_ascii</em> is false, the output will be a unicode object.</p>
<p>If <em>check_circular</em> 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 <code class="xref py py-exc docutils literal"><span class="pre">OverflowError</span></code>).
Otherwise, no such check takes place.</p>
<p>If <em>allow_nan</em> is true (the default), then <code class="docutils literal"><span class="pre">NaN</span></code>, <code class="docutils literal"><span class="pre">Infinity</span></code>, and
<code class="docutils literal"><span class="pre">-Infinity</span></code> 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 <code class="xref py py-exc docutils literal"><span class="pre">ValueError</span></code> to encode
such floats. See also <em>ignore_nan</em> for ECMA-262 compliant behavior.</p>
<p>If <em>sort_keys</em> is true (not the default), then the output of dictionaries
will be sorted by key; this is useful for regression tests to ensure that
JSON serializations can be compared on a day-to-day basis.</p>
<div class="versionchanged">
<p><span class="versionmodified">Changed in version 3.0.0: </span>Sorting now happens after the keys have been coerced to
strings, to avoid comparison of heterogeneously typed objects
(since this does not work in Python 3.3+)</p>
</div>
<p>If <em>item_sort_key</em> is a callable (not the default), then the output of
dictionaries will be sorted with it. The callable will be used like this:
<code class="docutils literal"><span class="pre">sorted(dct.items(),</span> <span class="pre">key=item_sort_key)</span></code>. This option takes precedence
over <em>sort_keys</em>.</p>
<div class="versionchanged">
<p><span class="versionmodified">Changed in version 2.5.0: </span><em>item_sort_key</em> is new in 2.5.0.</p>
</div>
<div class="versionchanged">
<p><span class="versionmodified">Changed in version 3.0.0: </span>Sorting now happens after the keys have been coerced to
strings, to avoid comparison of heterogeneously typed objects
(since this does not work in Python 3.3+)</p>
</div>
<p>If <em>indent</em> is a string, then JSON array elements and object members
will be pretty-printed with a newline followed by that string repeated
for each level of nesting. <code class="docutils literal"><span class="pre">None</span></code> (the default) selects the most compact
representation without any newlines. For backwards compatibility with
versions of simplejson earlier than 2.1.0, an integer is also accepted
and is converted to a string with that many spaces.</p>
<div class="versionchanged">
<p><span class="versionmodified">Changed in version 2.1.0: </span>Changed <em>indent</em> from an integer number of spaces to a string.</p>
</div>
<p>If specified, <em>separators</em> should be an <code class="docutils literal"><span class="pre">(item_separator,</span> <span class="pre">key_separator)</span></code>
tuple. The default is <code class="docutils literal"><span class="pre">(',</span> <span class="pre">',</span> <span class="pre">':</span> <span class="pre">')</span></code> if <em>indent</em> is <code class="docutils literal"><span class="pre">None</span></code> and
<code class="docutils literal"><span class="pre">(',',</span> <span class="pre">':</span> <span class="pre">')</span></code> otherwise. To get the most compact JSON representation,
you should specify <code class="docutils literal"><span class="pre">(',',</span> <span class="pre">':')</span></code> to eliminate whitespace.</p>
<div class="versionchanged">
<p><span class="versionmodified">Changed in version 2.1.4: </span>Use <code class="docutils literal"><span class="pre">(',',</span> <span class="pre">':</span> <span class="pre">')</span></code> as default if <em>indent</em> is not <code class="docutils literal"><span class="pre">None</span></code>.</p>
</div>
<p>If specified, <em>default</em> 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 <code class="xref py py-exc docutils literal"><span class="pre">TypeError</span></code>.</p>
<p>If <em>encoding</em> is not <code class="docutils literal"><span class="pre">None</span></code>, then all input strings will be transformed
into unicode using that encoding prior to JSON-encoding. The default is
<code class="docutils literal"><span class="pre">'utf-8'</span></code>.</p>
<p>If <em>namedtuple_as_object</em> is true (default: <code class="docutils literal"><span class="pre">True</span></code>),
objects with <code class="docutils literal"><span class="pre">_asdict()</span></code> methods will be encoded
as JSON objects.</p>
<div class="versionchanged">
<p><span class="versionmodified">Changed in version 2.2.0: </span><em>namedtuple_as_object</em> is new in 2.2.0.</p>
</div>
<div class="versionchanged">
<p><span class="versionmodified">Changed in version 2.3.0: </span><em>namedtuple_as_object</em> no longer requires that these objects be
subclasses of <code class="xref py py-class docutils literal"><span class="pre">tuple</span></code>.</p>
</div>
<p>If <em>tuple_as_array</em> is true (default: <code class="docutils literal"><span class="pre">True</span></code>),
<code class="xref py py-class docutils literal"><span class="pre">tuple</span></code> (and subclasses) will be encoded as JSON arrays.</p>
<div class="versionchanged">
<p><span class="versionmodified">Changed in version 2.2.0: </span><em>tuple_as_array</em> is new in 2.2.0.</p>
</div>
<p>If <em>iterable_as_array</em> is true (default: <code class="docutils literal"><span class="pre">False</span></code>),
any object not in the above table that implements <code class="docutils literal"><span class="pre">__iter__()</span></code>
will be encoded as a JSON array.</p>
<div class="versionchanged">
<p><span class="versionmodified">Changed in version 3.8.0: </span><em>iterable_as_array</em> is new in 3.8.0.</p>
</div>
<p>If <em>bigint_as_string</em> is true (default: <code class="docutils literal"><span class="pre">False</span></code>), <code class="xref py py-class docutils literal"><span class="pre">int`</span></code> <code class="docutils literal"><span class="pre">2**53</span></code>
and higher or lower than <code class="docutils literal"><span class="pre">-2**53</span></code> will be encoded as strings. This is to
avoid the rounding that happens in Javascript otherwise. Note that this
option loses type information, so use with extreme caution.</p>
<div class="versionchanged">
<p><span class="versionmodified">Changed in version 2.4.0: </span><em>bigint_as_string</em> is new in 2.4.0.</p>
</div>
<p>If <em>for_json</em> is true (default: <code class="docutils literal"><span class="pre">False</span></code>), objects with a <code class="docutils literal"><span class="pre">for_json()</span></code>
method will use the return value of that method for encoding as JSON instead
of the object.</p>
<div class="versionchanged">
<p><span class="versionmodified">Changed in version 3.2.0: </span><em>for_json</em> is new in 3.2.0.</p>
</div>
<p>If <em>ignore_nan</em> is true (default: <code class="docutils literal"><span class="pre">False</span></code>), then out of range
<code class="xref py py-class docutils literal"><span class="pre">float</span></code> values (<code class="docutils literal"><span class="pre">nan</span></code>, <code class="docutils literal"><span class="pre">inf</span></code>, <code class="docutils literal"><span class="pre">-inf</span></code>) will be serialized as
<code class="docutils literal"><span class="pre">null</span></code> in compliance with the ECMA-262 specification. If true, this will
override <em>allow_nan</em>.</p>
<div class="versionchanged">
<p><span class="versionmodified">Changed in version 3.2.0: </span><em>ignore_nan</em> is new in 3.2.0.</p>
</div>
<dl class="method">
<dt id="simplejson.JSONEncoder.default">
<code class="descname">default</code><span class="sig-paren">(</span><em>o</em><span class="sig-paren">)</span><a class="headerlink" href="#simplejson.JSONEncoder.default" title="Permalink to this definition">¶</a></dt>
<dd><blockquote>
<div><p>Implement this method in a subclass such that it returns a serializable
object for <em>o</em>, or calls the base implementation (to raise a
<code class="xref py py-exc docutils literal"><span class="pre">TypeError</span></code>).</p>
<p>For example, to support arbitrary iterators, you could implement default
like this:</p>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">default</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">o</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">iterable</span> <span class="o">=</span> <span class="nb">iter</span><span class="p">(</span><span class="n">o</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">TypeError</span><span class="p">:</span>
<span class="k">pass</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="nb">list</span><span class="p">(</span><span class="n">iterable</span><span class="p">)</span>
<span class="k">return</span> <span class="n">JSONEncoder</span><span class="o">.</span><span class="n">default</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">o</span><span class="p">)</span>
</pre></div>
</div>
</div></blockquote>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Subclassing is not recommended. You should implement this
as a function and pass it to the <em>default</em> kwarg of <a class="reference internal" href="#simplejson.dumps" title="simplejson.dumps"><code class="xref py py-func docutils literal"><span class="pre">dumps()</span></code></a>.
This is faster and more portable than subclassing. The
semantics are the same, but without the self argument or the
call to the super implementation.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="simplejson.JSONEncoder.encode">
<code class="descname">encode</code><span class="sig-paren">(</span><em>o</em><span class="sig-paren">)</span><a class="headerlink" href="#simplejson.JSONEncoder.encode" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a JSON string representation of a Python data structure, <em>o</em>. For
example:</p>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">simplejson</span> <span class="kn">as</span> <span class="nn">json</span>
<span class="gp">>>> </span><span class="n">json</span><span class="o">.</span><span class="n">JSONEncoder</span><span class="p">()</span><span class="o">.</span><span class="n">encode</span><span class="p">({</span><span class="s2">"foo"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"bar"</span><span class="p">,</span> <span class="s2">"baz"</span><span class="p">]})</span>
<span class="go">'{"foo": ["bar", "baz"]}'</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="simplejson.JSONEncoder.iterencode">
<code class="descname">iterencode</code><span class="sig-paren">(</span><em>o</em><span class="sig-paren">)</span><a class="headerlink" href="#simplejson.JSONEncoder.iterencode" title="Permalink to this definition">¶</a></dt>
<dd><p>Encode the given object, <em>o</em>, and yield each string representation as
available. For example:</p>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="k">for</span> <span class="n">chunk</span> <span class="ow">in</span> <span class="n">JSONEncoder</span><span class="p">()</span><span class="o">.</span><span class="n">iterencode</span><span class="p">(</span><span class="n">bigobject</span><span class="p">):</span>
<span class="n">mysocket</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">chunk</span><span class="p">)</span>
</pre></div>
</div>
<p>Note that <a class="reference internal" href="#simplejson.JSONEncoder.encode" title="simplejson.JSONEncoder.encode"><code class="xref py py-meth docutils literal"><span class="pre">encode()</span></code></a> has much better performance than
<a class="reference internal" href="#simplejson.JSONEncoder.iterencode" title="simplejson.JSONEncoder.iterencode"><code class="xref py py-meth docutils literal"><span class="pre">iterencode()</span></code></a>.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="simplejson.JSONEncoderForHTML">
<em class="property">class </em><code class="descclassname">simplejson.</code><code class="descname">JSONEncoderForHTML</code><span class="sig-paren">(</span><em>skipkeys=False</em>, <em>ensure_ascii=True</em>, <em>check_circular=True</em>, <em>allow_nan=True</em>, <em>sort_keys=False</em>, <em>indent=None</em>, <em>separators=None</em>, <em>encoding='utf-8'</em>, <em>default=None</em>, <em>use_decimal=True</em>, <em>namedtuple_as_object=True</em>, <em>tuple_as_array=True</em>, <em>bigint_as_string=False</em>, <em>item_sort_key=None</em>, <em>for_json=True</em>, <em>ignore_nan=False</em>, <em>int_as_string_bitcount=None</em><span class="sig-paren">)</span><a class="headerlink" href="#simplejson.JSONEncoderForHTML" title="Permalink to this definition">¶</a></dt>
<dd><p>Subclass of <a class="reference internal" href="#simplejson.JSONEncoder" title="simplejson.JSONEncoder"><code class="xref py py-class docutils literal"><span class="pre">JSONEncoder</span></code></a> that escapes &, <, and > for embedding in HTML.</p>
<div class="versionchanged">
<p><span class="versionmodified">Changed in version 2.1.0: </span>New in 2.1.0</p>
</div>
</dd></dl>
</div>
<div class="section" id="exceptions">
<h2>Exceptions<a class="headerlink" href="#exceptions" title="Permalink to this headline">¶</a></h2>
<dl class="exception">
<dt id="simplejson.JSONDecodeError">
<em class="property">exception </em><code class="descclassname">simplejson.</code><code class="descname">JSONDecodeError</code><span class="sig-paren">(</span><em>msg</em>, <em>doc</em>, <em>pos</em>, <em>end=None</em><span class="sig-paren">)</span><a class="headerlink" href="#simplejson.JSONDecodeError" title="Permalink to this definition">¶</a></dt>
<dd><p>Subclass of <code class="xref py py-exc docutils literal"><span class="pre">ValueError</span></code> with the following additional attributes:</p>
<dl class="attribute">
<dt id="simplejson.JSONDecodeError.msg">
<code class="descname">msg</code><a class="headerlink" href="#simplejson.JSONDecodeError.msg" title="Permalink to this definition">¶</a></dt>
<dd><p>The unformatted error message</p>
</dd></dl>
<dl class="attribute">
<dt id="simplejson.JSONDecodeError.doc">
<code class="descname">doc</code><a class="headerlink" href="#simplejson.JSONDecodeError.doc" title="Permalink to this definition">¶</a></dt>
<dd><p>The JSON document being parsed</p>
</dd></dl>
<dl class="attribute">
<dt id="simplejson.JSONDecodeError.pos">
<code class="descname">pos</code><a class="headerlink" href="#simplejson.JSONDecodeError.pos" title="Permalink to this definition">¶</a></dt>
<dd><p>The start index of doc where parsing failed</p>
</dd></dl>
<dl class="attribute">
<dt id="simplejson.JSONDecodeError.end">
<code class="descname">end</code><a class="headerlink" href="#simplejson.JSONDecodeError.end" title="Permalink to this definition">¶</a></dt>
<dd><p>The end index of doc where parsing failed (may be <code class="docutils literal"><span class="pre">None</span></code>)</p>
</dd></dl>
<dl class="attribute">
<dt id="simplejson.JSONDecodeError.lineno">
<code class="descname">lineno</code><a class="headerlink" href="#simplejson.JSONDecodeError.lineno" title="Permalink to this definition">¶</a></dt>
<dd><p>The line corresponding to pos</p>
</dd></dl>
<dl class="attribute">
<dt id="simplejson.JSONDecodeError.colno">
<code class="descname">colno</code><a class="headerlink" href="#simplejson.JSONDecodeError.colno" title="Permalink to this definition">¶</a></dt>
<dd><p>The column corresponding to pos</p>
</dd></dl>
<dl class="attribute">
<dt id="simplejson.JSONDecodeError.endlineno">
<code class="descname">endlineno</code><a class="headerlink" href="#simplejson.JSONDecodeError.endlineno" title="Permalink to this definition">¶</a></dt>
<dd><p>The line corresponding to end (may be <code class="docutils literal"><span class="pre">None</span></code>)</p>
</dd></dl>
<dl class="attribute">
<dt id="simplejson.JSONDecodeError.endcolno">
<code class="descname">endcolno</code><a class="headerlink" href="#simplejson.JSONDecodeError.endcolno" title="Permalink to this definition">¶</a></dt>
<dd><p>The column corresponding to end (may be <code class="docutils literal"><span class="pre">None</span></code>)</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="standard-compliance-and-interoperability">
<h2>Standard Compliance and Interoperability<a class="headerlink" href="#standard-compliance-and-interoperability" title="Permalink to this headline">¶</a></h2>
<p>The JSON format is specified by <span class="target" id="index-2"></span><a class="rfc reference external" href="https://tools.ietf.org/html/rfc7159.html"><strong>RFC 7159</strong></a> and by
<a class="reference external" href="http://www.ecma-international.org/publications/standards/Ecma-404.htm">ECMA-404</a>.
This section details this module’s level of compliance with the RFC.
For simplicity, <a class="reference internal" href="#simplejson.JSONEncoder" title="simplejson.JSONEncoder"><code class="xref py py-class docutils literal"><span class="pre">JSONEncoder</span></code></a> and <a class="reference internal" href="#simplejson.JSONDecoder" title="simplejson.JSONDecoder"><code class="xref py py-class docutils literal"><span class="pre">JSONDecoder</span></code></a> subclasses, and
parameters other than those explicitly mentioned, are not considered.</p>
<p>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:</p>
<ul class="simple">
<li>Infinite and NaN number values are accepted and output;</li>
<li>Repeated names within an object are accepted, and only the value of the last
name-value pair is used.</li>
</ul>
<p>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.</p>
<div class="section" id="character-encodings">
<h3>Character Encodings<a class="headerlink" href="#character-encodings" title="Permalink to this headline">¶</a></h3>
<p>The RFC recommends that JSON be represented using either UTF-8, UTF-16, or
UTF-32, with UTF-8 being the recommended default for maximum interoperability.</p>
<p>As permitted, though not required, by the RFC, this module’s serializer sets
<em>ensure_ascii=True</em> by default, thus escaping the output so that the resulting
strings only contain ASCII characters.</p>
<p>Other than the <em>ensure_ascii</em> parameter, this module is defined strictly in
terms of conversion between Python objects and
<code class="xref py py-class docutils literal"><span class="pre">Unicode</span> <span class="pre">strings</span></code>, and thus does not otherwise directly address
the issue of character encodings.</p>
<p>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 will ignore an initial BOM, if
present.</p>
<div class="versionchanged">
<p><span class="versionmodified">Changed in version 3.6.0: </span>Older versions would raise <code class="xref py py-exc docutils literal"><span class="pre">ValueError</span></code> when an initial BOM is present</p>
</div>
<p>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
<code class="xref py py-class docutils literal"><span class="pre">str</span></code>) codepoints for such sequences.</p>
</div>
<div class="section" id="infinite-and-nan-number-values">
<h3>Infinite and NaN Number Values<a class="headerlink" href="#infinite-and-nan-number-values" title="Permalink to this headline">¶</a></h3>
<p>The RFC does not permit the representation of infinite or NaN number values.
Despite that, by default, this module accepts and outputs <code class="docutils literal"><span class="pre">Infinity</span></code>,
<code class="docutils literal"><span class="pre">-Infinity</span></code>, and <code class="docutils literal"><span class="pre">NaN</span></code> as if they were valid JSON number literal values:</p>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="c1"># Neither of these calls raises an exception, but the results are not valid JSON</span>
<span class="gp">>>> </span><span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="nb">float</span><span class="p">(</span><span class="s1">'-inf'</span><span class="p">))</span>
<span class="go">'-Infinity'</span>
<span class="gp">>>> </span><span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="nb">float</span><span class="p">(</span><span class="s1">'nan'</span><span class="p">))</span>
<span class="go">'NaN'</span>
<span class="gp">>>> </span><span class="c1"># Same when deserializing</span>
<span class="gp">>>> </span><span class="n">json</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="s1">'-Infinity'</span><span class="p">)</span>
<span class="go">-inf</span>
<span class="gp">>>> </span><span class="n">json</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="s1">'NaN'</span><span class="p">)</span>
<span class="go">nan</span>
</pre></div>
</div>
<p>In the serializer, the <em>allow_nan</em> parameter can be used to alter this
behavior. In the deserializer, the <em>parse_constant</em> parameter can be used to
alter this behavior.</p>
</div>
<div class="section" id="repeated-names-within-an-object">
<h3>Repeated Names Within an Object<a class="headerlink" href="#repeated-names-within-an-object" title="Permalink to this headline">¶</a></h3>
<p>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:</p>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">weird_json</span> <span class="o">=</span> <span class="s1">'{"x": 1, "x": 2, "x": 3}'</span>
<span class="gp">>>> </span><span class="n">json</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="n">weird_json</span><span class="p">)</span> <span class="o">==</span> <span class="p">{</span><span class="s1">'x'</span><span class="p">:</span> <span class="mi">3</span><span class="p">}</span>
<span class="go">True</span>
</pre></div>
</div>
<p>The <em>object_pairs_hook</em> parameter can be used to alter this behavior.</p>
</div>
<div class="section" id="top-level-non-object-non-array-values">
<h3>Top-level Non-Object, Non-Array Values<a class="headerlink" href="#top-level-non-object-non-array-values" title="Permalink to this headline">¶</a></h3>
<p>The old version of JSON specified by the obsolete <span class="target" id="index-3"></span><a class="rfc reference external" href="https://tools.ietf.org/html/rfc4627.html"><strong>RFC 4627</strong></a> required that
the top-level value of a JSON text must be either a JSON object or array
(Python <code class="xref py py-class docutils literal"><span class="pre">dict</span></code> or <code class="xref py py-class docutils literal"><span class="pre">list</span></code>), and could not be a JSON null,
boolean, number, or string value. <span class="target" id="index-4"></span><a class="rfc reference external" href="https://tools.ietf.org/html/rfc7159.html"><strong>RFC 7159</strong></a> removed that restriction, and
this module does not and has never implemented that restriction in either its
serializer or its deserializer.</p>
<p>Regardless, for maximum interoperability, you may wish to voluntarily adhere
to the restriction yourself.</p>
</div>
<div class="section" id="implementation-limitations">
<h3>Implementation Limitations<a class="headerlink" href="#implementation-limitations" title="Permalink to this headline">¶</a></h3>
<p>Some JSON deserializer implementations may set limits on:</p>
<ul class="simple">
<li>the size of accepted JSON texts</li>
<li>the maximum level of nesting of JSON objects and arrays</li>
<li>the range and precision of JSON numbers</li>
<li>the content and maximum length of JSON strings</li>
</ul>
<p>This module does not impose any such limits beyond those of the relevant
Python datatypes themselves or the Python interpreter itself.</p>
<p>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 <code class="xref py py-class docutils literal"><span class="pre">int</span></code> values of extremely large magnitude, or
when serializing instances of “exotic” numerical types such as
<code class="xref py py-class docutils literal"><span class="pre">decimal.Decimal</span></code>.</p>
</div>
</div>
<div class="section" id="command-line-interface">
<span id="json-commandline"></span><h2>Command Line Interface<a class="headerlink" href="#command-line-interface" title="Permalink to this headline">¶</a></h2>
<p>The <code class="xref py py-mod docutils literal"><span class="pre">simplejson.tool</span></code> module provides a simple command line interface to
validate and pretty-print JSON.</p>
<p>If the optional <a class="reference internal" href="#cmdoption-arg-infile"><code class="xref std std-option docutils literal"><span class="pre">infile</span></code></a> and <a class="reference internal" href="#cmdoption-arg-outfile"><code class="xref std std-option docutils literal"><span class="pre">outfile</span></code></a> arguments are not
specified, <code class="xref py py-attr docutils literal"><span class="pre">sys.stdin</span></code> and <code class="xref py py-attr docutils literal"><span class="pre">sys.stdout</span></code> will be used respectively:</p>
<div class="highlight-bash"><div class="highlight"><pre><span></span>$ <span class="nb">echo</span> <span class="s1">'{"json": "obj"}'</span> <span class="p">|</span> python -m simplejson.tool
<span class="o">{</span>
<span class="s2">"json"</span>: <span class="s2">"obj"</span>
<span class="o">}</span>
$ <span class="nb">echo</span> <span class="s1">'{1.2:3.4}'</span> <span class="p">|</span> python -m simplejson.tool
Expecting property name enclosed in double quotes: line <span class="m">1</span> column <span class="m">2</span> <span class="o">(</span>char 1<span class="o">)</span>
</pre></div>
</div>
<div class="section" id="command-line-options">
<h3>Command line options<a class="headerlink" href="#command-line-options" title="Permalink to this headline">¶</a></h3>
<dl class="cmdoption">
<dt id="cmdoption-arg-infile">
<code class="descname">infile</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-arg-infile" title="Permalink to this definition">¶</a></dt>
<dd><p>The JSON file to be validated or pretty-printed:</p>
<div class="highlight-bash"><div class="highlight"><pre><span></span>$ python -m simplejson.tool mp_films.json
<span class="o">[</span>
<span class="o">{</span>
<span class="s2">"title"</span>: <span class="s2">"And Now for Something Completely Different"</span>,
<span class="s2">"year"</span>: 1971
<span class="o">}</span>,
<span class="o">{</span>
<span class="s2">"title"</span>: <span class="s2">"Monty Python and the Holy Grail"</span>,
<span class="s2">"year"</span>: 1975
<span class="o">}</span>
<span class="o">]</span>
</pre></div>
</div>
<p>If <em>infile</em> is not specified, read from <code class="xref py py-attr docutils literal"><span class="pre">sys.stdin</span></code>.</p>
</dd></dl>
<dl class="cmdoption">
<dt id="cmdoption-arg-outfile">
<code class="descname">outfile</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-arg-outfile" title="Permalink to this definition">¶</a></dt>
<dd><p>Write the output of the <em>infile</em> to the given <em>outfile</em>. Otherwise, write it
to <code class="xref py py-attr docutils literal"><span class="pre">sys.stdout</span></code>.</p>
</dd></dl>
<p class="rubric">Footnotes</p>
<table class="docutils footnote" frame="void" id="rfc-errata" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id1">[1]</a></td><td>As noted in <a class="reference external" href="http://www.rfc-editor.org/errata_search.php?rfc=7159">the errata for RFC 7159</a>,
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.</td></tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="#">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#"><code class="docutils literal"><span class="pre">simplejson</span></code> — JSON encoder and decoder</a><ul>
<li><a class="reference internal" href="#basic-usage">Basic Usage</a></li>
<li><a class="reference internal" href="#encoders-and-decoders">Encoders and decoders</a></li>
<li><a class="reference internal" href="#exceptions">Exceptions</a></li>
<li><a class="reference internal" href="#standard-compliance-and-interoperability">Standard Compliance and Interoperability</a><ul>
<li><a class="reference internal" href="#character-encodings">Character Encodings</a></li>
<li><a class="reference internal" href="#infinite-and-nan-number-values">Infinite and NaN Number Values</a></li>
<li><a class="reference internal" href="#repeated-names-within-an-object">Repeated Names Within an Object</a></li>
<li><a class="reference internal" href="#top-level-non-object-non-array-values">Top-level Non-Object, Non-Array Values</a></li>
<li><a class="reference internal" href="#implementation-limitations">Implementation Limitations</a></li>
</ul>
</li>
<li><a class="reference internal" href="#command-line-interface">Command Line Interface</a><ul>
<li><a class="reference internal" href="#command-line-options">Command line options</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="#">Documentation overview</a><ul>
</ul></li>
</ul>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/index.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
©2016, Bob Ippolito.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.8</a>
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
|
<a href="_sources/index.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>
|