|
250 | 250 | </div> |
251 | 251 | <article role="main" id="furo-main-content"> |
252 | 252 | <section id="jsonpickle-api"> |
253 | | -<span id="id1"></span><h1><a class="toc-backref" href="#id2" role="doc-backlink">jsonpickle API</a><a class="headerlink" href="#jsonpickle-api" title="Link to this heading">¶</a></h1> |
254 | | -<nav class="contents" id="contents"> |
255 | | -<p class="topic-title">Contents</p> |
256 | | -<ul class="simple"> |
257 | | -<li><p><a class="reference internal" href="#jsonpickle-api" id="id2">jsonpickle API</a></p> |
258 | | -<ul> |
259 | | -<li><p><a class="reference internal" href="#jsonpickle-high-level-api" id="id3"><a class="reference internal" href="index.html#module-jsonpickle" title="jsonpickle"><code class="xref py py-mod docutils literal notranslate"><span class="pre">jsonpickle</span></code></a> – High Level API</a></p> |
260 | | -<ul> |
261 | | -<li><p><a class="reference internal" href="#choosing-and-loading-backends" id="id4">Choosing and Loading Backends</a></p></li> |
262 | | -<li><p><a class="reference internal" href="#customizing-json-output" id="id5">Customizing JSON output</a></p></li> |
263 | | -<li><p><a class="reference internal" href="#jsonpickle-handlers-custom-serialization-handlers" id="id6"><a class="reference internal" href="#module-jsonpickle.handlers" title="jsonpickle.handlers"><code class="xref py py-mod docutils literal notranslate"><span class="pre">jsonpickle.handlers</span></code></a> – Custom Serialization Handlers</a></p></li> |
264 | | -</ul> |
265 | | -</li> |
266 | | -<li><p><a class="reference internal" href="#low-level-api" id="id7">Low Level API</a></p> |
267 | | -<ul> |
268 | | -<li><p><a class="reference internal" href="#module-jsonpickle.pickler" id="id8"><a class="reference internal" href="#module-jsonpickle.pickler" title="jsonpickle.pickler"><code class="xref py py-mod docutils literal notranslate"><span class="pre">jsonpickle.pickler</span></code></a> – Python to JSON-compatible dict</a></p></li> |
269 | | -<li><p><a class="reference internal" href="#module-jsonpickle.unpickler" id="id9"><a class="reference internal" href="#module-jsonpickle.unpickler" title="jsonpickle.unpickler"><code class="xref py py-mod docutils literal notranslate"><span class="pre">jsonpickle.unpickler</span></code></a> – JSON-compatible dict to Python</a></p></li> |
270 | | -<li><p><a class="reference internal" href="#module-jsonpickle.backend" id="id10"><a class="reference internal" href="#module-jsonpickle.backend" title="jsonpickle.backend"><code class="xref py py-mod docutils literal notranslate"><span class="pre">jsonpickle.backend</span></code></a> – JSON Backend Management</a></p></li> |
271 | | -<li><p><a class="reference internal" href="#module-jsonpickle.util" id="id11"><a class="reference internal" href="#module-jsonpickle.util" title="jsonpickle.util"><code class="xref py py-mod docutils literal notranslate"><span class="pre">jsonpickle.util</span></code></a> – Helper functions</a></p></li> |
272 | | -</ul> |
273 | | -</li> |
274 | | -</ul> |
275 | | -</li> |
276 | | -</ul> |
277 | | -</nav> |
| 253 | +<span id="id1"></span><h1>jsonpickle API<a class="headerlink" href="#jsonpickle-api" title="Link to this heading">¶</a></h1> |
278 | 254 | <section id="jsonpickle-high-level-api"> |
279 | | -<span id="api-docs"></span><h2><a class="toc-backref" href="#id3" role="doc-backlink"><a class="reference internal" href="index.html#module-jsonpickle" title="jsonpickle"><code class="xref py py-mod docutils literal notranslate"><span class="pre">jsonpickle</span></code></a> – High Level API</a><a class="headerlink" href="#jsonpickle-high-level-api" title="Link to this heading">¶</a></h2> |
| 255 | +<span id="api-docs"></span><h2><a class="reference internal" href="index.html#module-jsonpickle" title="jsonpickle"><code class="xref py py-mod docutils literal notranslate"><span class="pre">jsonpickle</span></code></a> – High Level API<a class="headerlink" href="#jsonpickle-high-level-api" title="Link to this heading">¶</a></h2> |
280 | 256 | <div class="admonition note"> |
281 | 257 | <p class="admonition-title">Note</p> |
282 | 258 | <p>For performance and compatibility reasons, jsonpickle does not preserve |
|
462 | 438 | </dd></dl> |
463 | 439 |
|
464 | 440 | <section id="choosing-and-loading-backends"> |
465 | | -<h3><a class="toc-backref" href="#id4" role="doc-backlink">Choosing and Loading Backends</a><a class="headerlink" href="#choosing-and-loading-backends" title="Link to this heading">¶</a></h3> |
| 441 | +<h3>Choosing and Loading Backends<a class="headerlink" href="#choosing-and-loading-backends" title="Link to this heading">¶</a></h3> |
466 | 442 | <p>jsonpickle allows the user to specify what JSON backend to use |
467 | 443 | when encoding and decoding. By default, jsonpickle will try to use, in |
468 | 444 | the following order: <code class="docutils literal notranslate"><span class="pre">simplejson</span></code> and <a class="reference external" href="https://docs.python.org/3/library/json.html#module-json" title="(in Python v3.13)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">json</span></code></a>. |
@@ -575,7 +551,7 @@ <h3><a class="toc-backref" href="#id4" role="doc-backlink">Choosing and Loading |
575 | 551 |
|
576 | 552 | </section> |
577 | 553 | <section id="customizing-json-output"> |
578 | | -<h3><a class="toc-backref" href="#id5" role="doc-backlink">Customizing JSON output</a><a class="headerlink" href="#customizing-json-output" title="Link to this heading">¶</a></h3> |
| 554 | +<h3>Customizing JSON output<a class="headerlink" href="#customizing-json-output" title="Link to this heading">¶</a></h3> |
579 | 555 | <p>jsonpickle supports the standard <a class="reference external" href="https://docs.python.org/3/library/pickle.html#module-pickle" title="(in Python v3.13)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pickle</span></code></a> <cite>__getstate__</cite> and <cite>__setstate__</cite> |
580 | 556 | protocol for representing object instances.</p> |
581 | 557 | <dl class="py method"> |
@@ -609,7 +585,7 @@ <h3><a class="toc-backref" href="#id5" role="doc-backlink">Customizing JSON outp |
609 | 585 |
|
610 | 586 | </section> |
611 | 587 | <section id="jsonpickle-handlers-custom-serialization-handlers"> |
612 | | -<h3><a class="toc-backref" href="#id6" role="doc-backlink"><a class="reference internal" href="#module-jsonpickle.handlers" title="jsonpickle.handlers"><code class="xref py py-mod docutils literal notranslate"><span class="pre">jsonpickle.handlers</span></code></a> – Custom Serialization Handlers</a><a class="headerlink" href="#jsonpickle-handlers-custom-serialization-handlers" title="Link to this heading">¶</a></h3> |
| 588 | +<h3><a class="reference internal" href="#module-jsonpickle.handlers" title="jsonpickle.handlers"><code class="xref py py-mod docutils literal notranslate"><span class="pre">jsonpickle.handlers</span></code></a> – Custom Serialization Handlers<a class="headerlink" href="#jsonpickle-handlers-custom-serialization-handlers" title="Link to this heading">¶</a></h3> |
613 | 589 | <p>The <cite>jsonpickle.handlers</cite> module allows plugging in custom |
614 | 590 | serialization handlers at run-time. This feature is useful when |
615 | 591 | jsonpickle is unable to serialize objects that are not |
@@ -973,12 +949,12 @@ <h3><a class="toc-backref" href="#id6" role="doc-backlink"><a class="reference i |
973 | 949 | </section> |
974 | 950 | </section> |
975 | 951 | <section id="low-level-api"> |
976 | | -<h2><a class="toc-backref" href="#id7" role="doc-backlink">Low Level API</a><a class="headerlink" href="#low-level-api" title="Link to this heading">¶</a></h2> |
| 952 | +<h2>Low Level API<a class="headerlink" href="#low-level-api" title="Link to this heading">¶</a></h2> |
977 | 953 | <p>Typically this low level functionality is not needed by clients.</p> |
978 | 954 | <p>Note that arguments like <code class="docutils literal notranslate"><span class="pre">safe=True</span></code> do not make it safe to load an untrusted |
979 | 955 | jsonpickle string.</p> |
980 | 956 | <section id="module-jsonpickle.pickler"> |
981 | | -<span id="jsonpickle-pickler-python-to-json-compatible-dict"></span><h3><a class="toc-backref" href="#id8" role="doc-backlink"><a class="reference internal" href="#module-jsonpickle.pickler" title="jsonpickle.pickler"><code class="xref py py-mod docutils literal notranslate"><span class="pre">jsonpickle.pickler</span></code></a> – Python to JSON-compatible dict</a><a class="headerlink" href="#module-jsonpickle.pickler" title="Link to this heading">¶</a></h3> |
| 957 | +<span id="jsonpickle-pickler-python-to-json-compatible-dict"></span><h3><a class="reference internal" href="#module-jsonpickle.pickler" title="jsonpickle.pickler"><code class="xref py py-mod docutils literal notranslate"><span class="pre">jsonpickle.pickler</span></code></a> – Python to JSON-compatible dict<a class="headerlink" href="#module-jsonpickle.pickler" title="Link to this heading">¶</a></h3> |
982 | 958 | <dl class="py class"> |
983 | 959 | <dt class="sig sig-object py" id="jsonpickle.pickler.Pickler"> |
984 | 960 | <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">jsonpickle.pickler.</span></span><span class="sig-name descname"><span class="pre">Pickler</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">unpicklable</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">make_refs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_depth</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">backend</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">keys</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">warn</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_iter</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">numeric_keys</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_decimal</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_base85</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fail_safe</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include_properties</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">handle_readonly</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">original_object</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#jsonpickle.pickler.Pickler" title="Link to this definition">¶</a></dt> |
@@ -1138,7 +1114,7 @@ <h2><a class="toc-backref" href="#id7" role="doc-backlink">Low Level API</a><a c |
1138 | 1114 |
|
1139 | 1115 | </section> |
1140 | 1116 | <section id="module-jsonpickle.unpickler"> |
1141 | | -<span id="jsonpickle-unpickler-json-compatible-dict-to-python"></span><h3><a class="toc-backref" href="#id9" role="doc-backlink"><a class="reference internal" href="#module-jsonpickle.unpickler" title="jsonpickle.unpickler"><code class="xref py py-mod docutils literal notranslate"><span class="pre">jsonpickle.unpickler</span></code></a> – JSON-compatible dict to Python</a><a class="headerlink" href="#module-jsonpickle.unpickler" title="Link to this heading">¶</a></h3> |
| 1117 | +<span id="jsonpickle-unpickler-json-compatible-dict-to-python"></span><h3><a class="reference internal" href="#module-jsonpickle.unpickler" title="jsonpickle.unpickler"><code class="xref py py-mod docutils literal notranslate"><span class="pre">jsonpickle.unpickler</span></code></a> – JSON-compatible dict to Python<a class="headerlink" href="#module-jsonpickle.unpickler" title="Link to this heading">¶</a></h3> |
1142 | 1118 | <dl class="py class"> |
1143 | 1119 | <dt class="sig sig-object py" id="jsonpickle.unpickler.Unpickler"> |
1144 | 1120 | <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">jsonpickle.unpickler.</span></span><span class="sig-name descname"><span class="pre">Unpickler</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">backend</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">keys</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">safe</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">v1_decode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">on_missing</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'ignore'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">handle_readonly</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#jsonpickle.unpickler.Unpickler" title="Link to this definition">¶</a></dt> |
@@ -1321,7 +1297,7 @@ <h2><a class="toc-backref" href="#id7" role="doc-backlink">Low Level API</a><a c |
1321 | 1297 |
|
1322 | 1298 | </section> |
1323 | 1299 | <section id="module-jsonpickle.backend"> |
1324 | | -<span id="jsonpickle-backend-json-backend-management"></span><h3><a class="toc-backref" href="#id10" role="doc-backlink"><a class="reference internal" href="#module-jsonpickle.backend" title="jsonpickle.backend"><code class="xref py py-mod docutils literal notranslate"><span class="pre">jsonpickle.backend</span></code></a> – JSON Backend Management</a><a class="headerlink" href="#module-jsonpickle.backend" title="Link to this heading">¶</a></h3> |
| 1300 | +<span id="jsonpickle-backend-json-backend-management"></span><h3><a class="reference internal" href="#module-jsonpickle.backend" title="jsonpickle.backend"><code class="xref py py-mod docutils literal notranslate"><span class="pre">jsonpickle.backend</span></code></a> – JSON Backend Management<a class="headerlink" href="#module-jsonpickle.backend" title="Link to this heading">¶</a></h3> |
1325 | 1301 | <dl class="py class"> |
1326 | 1302 | <dt class="sig sig-object py" id="jsonpickle.backend.JSONBackend"> |
1327 | 1303 | <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">jsonpickle.backend.</span></span><span class="sig-name descname"><span class="pre">JSONBackend</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fallthrough</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#jsonpickle.backend.JSONBackend" title="Link to this definition">¶</a></dt> |
@@ -1465,7 +1441,7 @@ <h2><a class="toc-backref" href="#id7" role="doc-backlink">Low Level API</a><a c |
1465 | 1441 |
|
1466 | 1442 | </section> |
1467 | 1443 | <section id="module-jsonpickle.util"> |
1468 | | -<span id="jsonpickle-util-helper-functions"></span><h3><a class="toc-backref" href="#id11" role="doc-backlink"><a class="reference internal" href="#module-jsonpickle.util" title="jsonpickle.util"><code class="xref py py-mod docutils literal notranslate"><span class="pre">jsonpickle.util</span></code></a> – Helper functions</a><a class="headerlink" href="#module-jsonpickle.util" title="Link to this heading">¶</a></h3> |
| 1444 | +<span id="jsonpickle-util-helper-functions"></span><h3><a class="reference internal" href="#module-jsonpickle.util" title="jsonpickle.util"><code class="xref py py-mod docutils literal notranslate"><span class="pre">jsonpickle.util</span></code></a> – Helper functions<a class="headerlink" href="#module-jsonpickle.util" title="Link to this heading">¶</a></h3> |
1469 | 1445 | <p>Helper functions for pickling and unpickling. Most functions assist in |
1470 | 1446 | determining the type of an object.</p> |
1471 | 1447 | <dl class="py function"> |
|
0 commit comments