parthtamu/rag-code-assistant
0
1<!DOCTYPE html>2 3<html lang="en" data-content_root="../">4 <head>5 <meta charset="utf-8" />6 <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />7<meta property="og:title" content="marshal — Internal Python object serialization" />8<meta property="og:type" content="website" />9<meta property="og:url" content="https://docs.python.org/3/library/marshal.html" />10<meta property="og:site_name" content="Python documentation" />11<meta property="og:description" content="This module contains functions that can read and write Python values in a binary format. The format is specific to Python, but independent of machine architecture issues (e.g., you can write a Pyth..." />12<meta property="og:image:width" content="1146" />13<meta property="og:image:height" content="600" />14<meta property="og:image" content="https://docs.python.org/3.15/_images/social_previews/summary_library_marshal_563bf5b9.png" />15<meta property="og:image:alt" content="This module contains functions that can read and write Python values in a binary format. The format is specific to Python, but independent of machine architecture issues (e.g., you can write a Pyth..." />16<meta name="description" content="This module contains functions that can read and write Python values in a binary format. The format is specific to Python, but independent of machine architecture issues (e.g., you can write a Pyth..." />17<meta name="twitter:card" content="summary_large_image" />18<meta name="theme-color" content="#3776ab">19 20 <title>marshal — Internal Python object serialization — Python 3.15.0a6 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">21 22 <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" />23 <link rel="stylesheet" type="text/css" href="../_static/classic.css?v=234b1a7c" />24 <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?v=89a2f22a" />25 <link rel="stylesheet" type="text/css" href="../_static/profiling-sampling-visualization.css?v=0c2600ae" />26 <link id="pygments_dark_css" media="(prefers-color-scheme: dark)" rel="stylesheet" type="text/css" href="../_static/pygments_dark.css?v=5349f25f" />27 28 <script src="../_static/documentation_options.js?v=6b7c9ff5"></script>29 <script src="../_static/doctools.js?v=9bcbadda"></script>30 <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>31 <script src="../_static/profiling-sampling-visualization.js?v=9811ed04"></script>32 33 <script src="../_static/sidebar.js"></script>34 35 <link rel="search" type="application/opensearchdescription+xml"36 title="Search within Python 3.15.0a6 documentation"37 href="../_static/opensearch.xml"/>38 <link rel="author" title="About these documents" href="../about.html" />39 <link rel="index" title="Index" href="../genindex.html" />40 <link rel="search" title="Search" href="../search.html" />41 <link rel="copyright" title="Copyright" href="../copyright.html" />42 <link rel="next" title="dbm — Interfaces to Unix “databases”" href="dbm.html" />43 <link rel="prev" title="shelve — Python object persistence" href="shelve.html" />44 45 46 <script defer file-types="bz2,epub,zip" data-domain="docs.python.org" src="https://analytics.python.org/js/script.file-downloads.outbound-links.js"></script>47 48 <link rel="canonical" href="https://docs.python.org/3/library/marshal.html">49 50 51 52 53 <style>54 @media only screen {55 table.full-width-table {56 width: 100%;57 }58 }59 </style>60<link rel="stylesheet" href="../_static/pydoctheme_dark.css" media="(prefers-color-scheme: dark)" id="pydoctheme_dark_css">61 <link rel="shortcut icon" type="image/png" href="../_static/py.svg">62 <script type="text/javascript" src="../_static/copybutton.js"></script>63 <script type="text/javascript" src="../_static/menu.js"></script>64 <script type="text/javascript" src="../_static/search-focus.js"></script>65 <script type="text/javascript" src="../_static/themetoggle.js"></script> 66 <script type="text/javascript" src="../_static/rtd_switcher.js"></script>67 <meta name="readthedocs-addons-api-version" content="1">68 69 </head>70<body>71<div class="mobile-nav">72 <input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"73 aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu">74 <nav class="nav-content" role="navigation">75 <label for="menuToggler" class="toggler__label">76 <span></span>77 </label>78 <span class="nav-items-wrapper">79 <a href="https://www.python.org/" class="nav-logo">80 <img src="../_static/py.svg" alt="Python logo">81 </a>82 <span class="version_switcher_placeholder"></span>83 <form role="search" class="search" action="../search.html" method="get">84 <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">85 <path fill-rule="nonzero" fill="currentColor" d="M15.5 14h-.79l-.28-.27a6.5 6.5 0 001.48-5.34c-.47-2.78-2.79-5-5.59-5.34a6.505 6.505 0 00-7.27 7.27c.34 2.8 2.56 5.12 5.34 5.59a6.5 6.5 0 005.34-1.48l.27.28v.79l4.25 4.25c.41.41 1.08.41 1.49 0 .41-.41.41-1.08 0-1.49L15.5 14zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14z"></path>86 </svg>87 <input placeholder="Quick search" aria-label="Quick search" type="search" name="q">88 <input type="submit" value="Go">89 </form>90 </span>91 </nav>92 <div class="menu-wrapper">93 <nav class="menu" role="navigation" aria-label="main navigation">94 <div class="language_switcher_placeholder"></div>95 96<label class="theme-selector-label">97 Theme98 <select class="theme-selector" oninput="activateTheme(this.value)">99 <option value="auto" selected>Auto</option>100 <option value="light">Light</option>101 <option value="dark">Dark</option>102 </select>103</label>104 <div>105 <h4>Previous topic</h4>106 <p class="topless"><a href="shelve.html"107 title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">shelve</span></code> — Python object persistence</a></p>108 </div>109 <div>110 <h4>Next topic</h4>111 <p class="topless"><a href="dbm.html"112 title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">dbm</span></code> — Interfaces to Unix “databases”</a></p>113 </div>114 <script>115 document.addEventListener('DOMContentLoaded', () => {116 const title = document.querySelector('meta[property="og:title"]').content;117 const elements = document.querySelectorAll('.improvepage');118 const pageurl = window.location.href.split('?')[0];119 elements.forEach(element => {120 const url = new URL(element.href.split('?')[0].replace("-nojs", ""));121 url.searchParams.set('pagetitle', title);122 url.searchParams.set('pageurl', pageurl);123 url.searchParams.set('pagesource', "library/marshal.rst");124 element.href = url.toString();125 });126 });127 </script>128 <div role="note" aria-label="source link">129 <h3>This page</h3>130 <ul class="this-page-menu">131 <li><a href="../bugs.html">Report a bug</a></li>132 <li><a class="improvepage" href="../improve-page-nojs.html">Improve this page</a></li>133 <li>134 <a href="https://github.com/python/cpython/blob/main/Doc/library/marshal.rst?plain=1"135 rel="nofollow">Show source136 </a>137 </li>138 139 </ul>140 </div>141 </nav>142 </div>143</div>144 145 146 <div class="related" role="navigation" aria-label="Related">147 <h3>Navigation</h3>148 <ul>149 <li class="right" style="margin-right: 10px">150 <a href="../genindex.html" title="General Index"151 accesskey="I">index</a></li>152 <li class="right" >153 <a href="../py-modindex.html" title="Python Module Index"154 >modules</a> |</li>155 <li class="right" >156 <a href="dbm.html" title="dbm — Interfaces to Unix “databases”"157 accesskey="N">next</a> |</li>158 <li class="right" >159 <a href="shelve.html" title="shelve — Python object persistence"160 accesskey="P">previous</a> |</li>161 162 <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"></li>163 <li><a href="https://www.python.org/">Python</a> »</li>164 <li class="switchers">165 <div class="language_switcher_placeholder"></div>166 <div class="version_switcher_placeholder"></div>167 </li>168 <li>169 170 </li>171 <li id="cpython-language-and-version">172 <a href="../index.html">3.15.0a6 Documentation</a> »173 </li>174 175 <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> »</li>176 <li class="nav-item nav-item-2"><a href="persistence.html" accesskey="U">Data Persistence</a> »</li>177 <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">marshal</span></code> — Internal Python object serialization</a></li>178 <li class="right">179 180 181 <div class="inline-search" role="search">182 <form class="inline-search" action="../search.html" method="get">183 <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box">184 <input type="submit" value="Go">185 </form>186 </div>187 |188 </li>189 <li class="right">190<label class="theme-selector-label">191 Theme192 <select class="theme-selector" oninput="activateTheme(this.value)">193 <option value="auto" selected>Auto</option>194 <option value="light">Light</option>195 <option value="dark">Dark</option>196 </select>197</label> |</li>198 199 </ul>200 </div> 201 202 <div class="document">203 <div class="documentwrapper">204 <div class="bodywrapper">205 <div class="body" role="main">206 207 <section id="module-marshal">208<span id="marshal-internal-python-object-serialization"></span><h1><code class="xref py py-mod docutils literal notranslate"><span class="pre">marshal</span></code> — Internal Python object serialization<a class="headerlink" href="#module-marshal" title="Link to this heading">¶</a></h1>209<hr class="docutils" />210<p>This module contains functions that can read and write Python values in a binary211format. The format is specific to Python, but independent of machine212architecture issues (e.g., you can write a Python value to a file on a PC,213transport the file to a Mac, and read it back there). Details of the format are214undocumented on purpose; it may change between Python versions (although it215rarely does). <a class="footnote-reference brackets" href="#id2" id="id1" role="doc-noteref"><span class="fn-bracket">[</span>1<span class="fn-bracket">]</span></a></p>216<p id="index-0">This is not a general “persistence” module. For general persistence and217transfer of Python objects through RPC calls, see the modules <a class="reference internal" href="pickle.html#module-pickle" title="pickle: Convert Python objects to streams of bytes and back."><code class="xref py py-mod docutils literal notranslate"><span class="pre">pickle</span></code></a> and218<a class="reference internal" href="shelve.html#module-shelve" title="shelve: Python object persistence."><code class="xref py py-mod docutils literal notranslate"><span class="pre">shelve</span></code></a>. The <code class="xref py py-mod docutils literal notranslate"><span class="pre">marshal</span></code> module exists mainly to support reading and219writing the “pseudo-compiled” code for Python modules of <code class="file docutils literal notranslate"><span class="pre">.pyc</span></code> files.220Therefore, the Python maintainers reserve the right to modify the marshal format221in backward incompatible ways should the need arise.222The format of code objects is not compatible between Python versions,223even if the version of the format is the same.224De-serializing a code object in the incorrect Python version has undefined behavior.225If you’re serializing and226de-serializing Python objects, use the <code class="xref py py-mod docutils literal notranslate"><span class="pre">pickle</span></code> module instead – the227performance is comparable, version independence is guaranteed, and pickle228supports a substantially wider range of objects than marshal.</p>229<div class="admonition warning">230<p class="admonition-title">Warning</p>231<p>The <code class="xref py py-mod docutils literal notranslate"><span class="pre">marshal</span></code> module is not intended to be secure against erroneous or232maliciously constructed data. Never unmarshal data received from an233untrusted or unauthenticated source.</p>234</div>235<p>There are functions that read/write files as well as functions operating on236bytes-like objects.</p>237<p id="index-1">Not all Python object types are supported; in general, only objects whose value238is independent from a particular invocation of Python can be written and read by239this module. The following types are supported:</p>240<ul class="simple">241<li><p>Numeric types: <a class="reference internal" href="functions.html#int" title="int"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a>, <a class="reference internal" href="functions.html#bool" title="bool"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a>, <a class="reference internal" href="functions.html#float" title="float"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></a>, <a class="reference internal" href="functions.html#complex" title="complex"><code class="xref py py-class docutils literal notranslate"><span class="pre">complex</span></code></a>.</p></li>242<li><p>Strings (<a class="reference internal" href="stdtypes.html#str" title="str"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>) and <a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytes</span></code></a>.243<a class="reference internal" href="../glossary.html#term-bytes-like-object"><span class="xref std std-term">Bytes-like objects</span></a> like <a class="reference internal" href="stdtypes.html#bytearray" title="bytearray"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytearray</span></code></a> are244marshalled as <code class="xref py py-class docutils literal notranslate"><span class="pre">bytes</span></code>.</p></li>245<li><p>Containers: <a class="reference internal" href="stdtypes.html#tuple" title="tuple"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a>, <a class="reference internal" href="stdtypes.html#list" title="list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a>, <a class="reference internal" href="stdtypes.html#dict" title="dict"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a>, <a class="reference internal" href="stdtypes.html#frozendict" title="frozendict"><code class="xref py py-class docutils literal notranslate"><span class="pre">frozendict</span></code></a>246(since <a class="reference internal" href="#marshal.version" title="marshal.version"><code class="xref py py-data docutils literal notranslate"><span class="pre">version</span></code></a> 6), <a class="reference internal" href="stdtypes.html#set" title="set"><code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code></a>, <a class="reference internal" href="stdtypes.html#frozenset" title="frozenset"><code class="xref py py-class docutils literal notranslate"><span class="pre">frozenset</span></code></a>, and247<a class="reference internal" href="functions.html#slice" title="slice"><code class="xref py py-class docutils literal notranslate"><span class="pre">slice</span></code></a> (since <code class="xref py py-data docutils literal notranslate"><span class="pre">version</span></code> 5).248It should be understood that these are supported only if the values contained249therein are themselves supported.250Recursive containers are supported since <code class="xref py py-data docutils literal notranslate"><span class="pre">version</span></code> 3.</p></li>251<li><p>The singletons <a class="reference internal" href="constants.html#None" title="None"><code class="xref py py-const docutils literal notranslate"><span class="pre">None</span></code></a>, <a class="reference internal" href="constants.html#Ellipsis" title="Ellipsis"><code class="xref py py-const docutils literal notranslate"><span class="pre">Ellipsis</span></code></a> and <a class="reference internal" href="exceptions.html#StopIteration" title="StopIteration"><code class="xref py py-exc docutils literal notranslate"><span class="pre">StopIteration</span></code></a>.</p></li>252<li><p><a class="reference internal" href="code.html#module-code" title="code: Facilities to implement read-eval-print loops."><code class="xref py py-class docutils literal notranslate"><span class="pre">code</span></code></a> objects, if <em>allow_code</em> is true. See note above about253version dependence.</p></li>254</ul>255<div class="versionchanged">256<p><span class="versionmodified changed">Changed in version 3.4: </span></p>257<ul class="simple">258<li><p>Added format version 3, which supports marshalling recursive lists, sets259and dictionaries.</p></li>260<li><p>Added format version 4, which supports efficient representations261of short strings.</p></li>262</ul>263</div>264<div class="versionchanged">265<p><span class="versionmodified changed">Changed in version 3.14: </span>Added format version 5, which allows marshalling slices.</p>266</div>267<div class="versionchanged">268<p><span class="versionmodified changed">Changed in version 3.15.0a6 (unreleased): </span>Added format version 6, which allows marshalling <a class="reference internal" href="stdtypes.html#frozendict" title="frozendict"><code class="xref py py-class docutils literal notranslate"><span class="pre">frozendict</span></code></a>.</p>269</div>270<p>The module defines these functions:</p>271<dl class="py function">272<dt class="sig sig-object py" id="marshal.dump">273<span class="sig-prename descclassname"><span class="pre">marshal.</span></span><span class="sig-name descname"><span class="pre">dump</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">version</span></span></em>, <em class="sig-param"><span class="positional-only-separator o"><abbr title="Positional-only parameter separator (PEP 570)"><span class="pre">/</span></abbr></span></em>, <em class="sig-param"><span class="keyword-only-separator o"><abbr title="Keyword-only parameters separator (PEP 3102)"><span class="pre">*</span></abbr></span></em>, <em class="sig-param"><span class="n"><span class="pre">allow_code</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="#marshal.dump" title="Link to this definition">¶</a></dt>274<dd><p>Write the value on the open file. The value must be a supported type. The275file must be a writeable <a class="reference internal" href="../glossary.html#term-binary-file"><span class="xref std std-term">binary file</span></a>.</p>276<p>If the value has (or contains an object that has) an unsupported type, a277<a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code></a> exception is raised — but garbage data will also be written278to the file. The object will not be properly read back by <a class="reference internal" href="#marshal.load" title="marshal.load"><code class="xref py py-func docutils literal notranslate"><span class="pre">load()</span></code></a>.279<a class="reference internal" href="../reference/datamodel.html#code-objects"><span class="std std-ref">Code objects</span></a> are only supported if <em>allow_code</em> is true.</p>280<p>The <em>version</em> argument indicates the data format that <code class="docutils literal notranslate"><span class="pre">dump</span></code> should use281(see below).</p>282<p class="audit-hook">Raises an <a class="reference internal" href="sys.html#auditing"><span class="std std-ref">auditing event</span></a> <code class="docutils literal notranslate"><span class="pre">marshal.dumps</span></code> with arguments <code class="docutils literal notranslate"><span class="pre">value</span></code>, <code class="docutils literal notranslate"><span class="pre">version</span></code>.</p>283<div class="versionchanged">284<p><span class="versionmodified changed">Changed in version 3.13: </span>Added the <em>allow_code</em> parameter.</p>285</div>286</dd></dl>287 288<dl class="py function">289<dt class="sig sig-object py" id="marshal.load">290<span class="sig-prename descclassname"><span class="pre">marshal.</span></span><span class="sig-name descname"><span class="pre">load</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file</span></span></em>, <em class="sig-param"><span class="positional-only-separator o"><abbr title="Positional-only parameter separator (PEP 570)"><span class="pre">/</span></abbr></span></em>, <em class="sig-param"><span class="keyword-only-separator o"><abbr title="Keyword-only parameters separator (PEP 3102)"><span class="pre">*</span></abbr></span></em>, <em class="sig-param"><span class="n"><span class="pre">allow_code</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="#marshal.load" title="Link to this definition">¶</a></dt>291<dd><p>Read one value from the open file and return it. If no valid value is read292(e.g. because the data has a different Python version’s incompatible marshal293format), raise <a class="reference internal" href="exceptions.html#EOFError" title="EOFError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">EOFError</span></code></a>, <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code></a> or <a class="reference internal" href="exceptions.html#TypeError" title="TypeError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">TypeError</span></code></a>.294<a class="reference internal" href="../reference/datamodel.html#code-objects"><span class="std std-ref">Code objects</span></a> are only supported if <em>allow_code</em> is true.295The file must be a readable <a class="reference internal" href="../glossary.html#term-binary-file"><span class="xref std std-term">binary file</span></a>.</p>296<p class="audit-hook">Raises an <a class="reference internal" href="sys.html#auditing"><span class="std std-ref">auditing event</span></a> <code class="docutils literal notranslate"><span class="pre">marshal.load</span></code> with no arguments.</p>297<div class="admonition note">298<p class="admonition-title">Note</p>299<p>If an object containing an unsupported type was marshalled with <a class="reference internal" href="#marshal.dump" title="marshal.dump"><code class="xref py py-func docutils literal notranslate"><span class="pre">dump()</span></code></a>,300<code class="xref py py-func docutils literal notranslate"><span class="pre">load()</span></code> will substitute <code class="docutils literal notranslate"><span class="pre">None</span></code> for the unmarshallable type.</p>301</div>302<div class="versionchanged">303<p><span class="versionmodified changed">Changed in version 3.10: </span>This call used to raise a <code class="docutils literal notranslate"><span class="pre">code.__new__</span></code> audit event for each code object. Now304it raises a single <code class="docutils literal notranslate"><span class="pre">marshal.load</span></code> event for the entire load operation.</p>305</div>306<div class="versionchanged">307<p><span class="versionmodified changed">Changed in version 3.13: </span>Added the <em>allow_code</em> parameter.</p>308</div>309</dd></dl>310 311<dl class="py function">312<dt class="sig sig-object py" id="marshal.dumps">313<span class="sig-prename descclassname"><span class="pre">marshal.</span></span><span class="sig-name descname"><span class="pre">dumps</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">version</span></span></em>, <em class="sig-param"><span class="positional-only-separator o"><abbr title="Positional-only parameter separator (PEP 570)"><span class="pre">/</span></abbr></span></em>, <em class="sig-param"><span class="keyword-only-separator o"><abbr title="Keyword-only parameters separator (PEP 3102)"><span class="pre">*</span></abbr></span></em>, <em class="sig-param"><span class="n"><span class="pre">allow_code</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="#marshal.dumps" title="Link to this definition">¶</a></dt>314<dd><p>Return the bytes object that would be written to a file by <code class="docutils literal notranslate"><span class="pre">dump(value,</span> <span class="pre">file)</span></code>. The315value must be a supported type. Raise a <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code></a> exception if value316has (or contains an object that has) an unsupported type.317<a class="reference internal" href="../reference/datamodel.html#code-objects"><span class="std std-ref">Code objects</span></a> are only supported if <em>allow_code</em> is true.</p>318<p>The <em>version</em> argument indicates the data format that <code class="docutils literal notranslate"><span class="pre">dumps</span></code> should use319(see below).</p>320<p class="audit-hook">Raises an <a class="reference internal" href="sys.html#auditing"><span class="std std-ref">auditing event</span></a> <code class="docutils literal notranslate"><span class="pre">marshal.dumps</span></code> with arguments <code class="docutils literal notranslate"><span class="pre">value</span></code>, <code class="docutils literal notranslate"><span class="pre">version</span></code>.</p>321<div class="versionchanged">322<p><span class="versionmodified changed">Changed in version 3.13: </span>Added the <em>allow_code</em> parameter.</p>323</div>324</dd></dl>325 326<dl class="py function">327<dt class="sig sig-object py" id="marshal.loads">328<span class="sig-prename descclassname"><span class="pre">marshal.</span></span><span class="sig-name descname"><span class="pre">loads</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bytes</span></span></em>, <em class="sig-param"><span class="positional-only-separator o"><abbr title="Positional-only parameter separator (PEP 570)"><span class="pre">/</span></abbr></span></em>, <em class="sig-param"><span class="keyword-only-separator o"><abbr title="Keyword-only parameters separator (PEP 3102)"><span class="pre">*</span></abbr></span></em>, <em class="sig-param"><span class="n"><span class="pre">allow_code</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="#marshal.loads" title="Link to this definition">¶</a></dt>329<dd><p>Convert the <a class="reference internal" href="../glossary.html#term-bytes-like-object"><span class="xref std std-term">bytes-like object</span></a> to a value. If no valid value is found, raise330<a class="reference internal" href="exceptions.html#EOFError" title="EOFError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">EOFError</span></code></a>, <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code></a> or <a class="reference internal" href="exceptions.html#TypeError" title="TypeError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">TypeError</span></code></a>.331<a class="reference internal" href="../reference/datamodel.html#code-objects"><span class="std std-ref">Code objects</span></a> are only supported if <em>allow_code</em> is true.332Extra bytes in the input are ignored.</p>333<p class="audit-hook">Raises an <a class="reference internal" href="sys.html#auditing"><span class="std std-ref">auditing event</span></a> <code class="docutils literal notranslate"><span class="pre">marshal.loads</span></code> with argument <code class="docutils literal notranslate"><span class="pre">bytes</span></code>.</p>334<div class="versionchanged">335<p><span class="versionmodified changed">Changed in version 3.10: </span>This call used to raise a <code class="docutils literal notranslate"><span class="pre">code.__new__</span></code> audit event for each code object. Now336it raises a single <code class="docutils literal notranslate"><span class="pre">marshal.loads</span></code> event for the entire load operation.</p>337</div>338<div class="versionchanged">339<p><span class="versionmodified changed">Changed in version 3.13: </span>Added the <em>allow_code</em> parameter.</p>340</div>341</dd></dl>342 343<p>In addition, the following constants are defined:</p>344<dl class="py data">345<dt class="sig sig-object py" id="marshal.version">346<span class="sig-prename descclassname"><span class="pre">marshal.</span></span><span class="sig-name descname"><span class="pre">version</span></span><a class="headerlink" href="#marshal.version" title="Link to this definition">¶</a></dt>347<dd><p>Indicates the format that the module uses.348Version 0 is the historical first version; subsequent versions349add new features.350Generally, a new version becomes the default when it is introduced.</p>351<table class="docutils align-default">352<thead>353<tr class="row-odd"><th class="head"><p>Version</p></th>354<th class="head"><p>Available since</p></th>355<th class="head"><p>New features</p></th>356</tr>357</thead>358<tbody>359<tr class="row-even"><td><p>1</p></td>360<td><p>Python 2.4</p></td>361<td><p>Sharing interned strings</p></td>362</tr>363<tr class="row-odd"><td><p>2</p></td>364<td><p>Python 2.5</p></td>365<td><p>Binary representation of floats</p></td>366</tr>367<tr class="row-even"><td><p>3</p></td>368<td><p>Python 3.4</p></td>369<td><p>Support for object instancing and recursion</p></td>370</tr>371<tr class="row-odd"><td><p>4</p></td>372<td><p>Python 3.4</p></td>373<td><p>Efficient representation of short strings</p></td>374</tr>375<tr class="row-even"><td><p>5</p></td>376<td><p>Python 3.14</p></td>377<td><p>Support for <a class="reference internal" href="functions.html#slice" title="slice"><code class="xref py py-class docutils literal notranslate"><span class="pre">slice</span></code></a> objects</p></td>378</tr>379<tr class="row-odd"><td><p>6</p></td>380<td><p>Python 3.15</p></td>381<td><p>Support for <a class="reference internal" href="stdtypes.html#frozendict" title="frozendict"><code class="xref py py-class docutils literal notranslate"><span class="pre">frozendict</span></code></a> objects</p></td>382</tr>383</tbody>384</table>385</dd></dl>386 387<p class="rubric">Footnotes</p>388<aside class="footnote-list brackets">389<aside class="footnote brackets" id="id2" role="doc-footnote">390<span class="label"><span class="fn-bracket">[</span><a role="doc-backlink" href="#id1">1</a><span class="fn-bracket">]</span></span>391<p>The name of this module stems from a bit of terminology used by the designers of392Modula-3 (amongst others), who use the term “marshalling” for shipping of data393around in a self-contained form. Strictly speaking, “to marshal” means to394convert some data from internal to external form (in an RPC buffer for instance)395and “unmarshalling” for the reverse process.</p>396</aside>397</aside>398</section>399 400 401 <div class="clearer"></div>402 </div>403 </div>404 </div>405 <div class="sphinxsidebar" role="navigation" aria-label="Main">406 <div class="sphinxsidebarwrapper">407 <div>408 <h4>Previous topic</h4>409 <p class="topless"><a href="shelve.html"410 title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">shelve</span></code> — Python object persistence</a></p>411 </div>412 <div>413 <h4>Next topic</h4>414 <p class="topless"><a href="dbm.html"415 title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">dbm</span></code> — Interfaces to Unix “databases”</a></p>416 </div>417 <script>418 document.addEventListener('DOMContentLoaded', () => {419 const title = document.querySelector('meta[property="og:title"]').content;420 const elements = document.querySelectorAll('.improvepage');421 const pageurl = window.location.href.split('?')[0];422 elements.forEach(element => {423 const url = new URL(element.href.split('?')[0].replace("-nojs", ""));424 url.searchParams.set('pagetitle', title);425 url.searchParams.set('pageurl', pageurl);426 url.searchParams.set('pagesource', "library/marshal.rst");427 element.href = url.toString();428 });429 });430 </script>431 <div role="note" aria-label="source link">432 <h3>This page</h3>433 <ul class="this-page-menu">434 <li><a href="../bugs.html">Report a bug</a></li>435 <li><a class="improvepage" href="../improve-page-nojs.html">Improve this page</a></li>436 <li>437 <a href="https://github.com/python/cpython/blob/main/Doc/library/marshal.rst?plain=1"438 rel="nofollow">Show source439 </a>440 </li>441 442 </ul>443 </div>444 </div>445<div id="sidebarbutton" title="Collapse sidebar">446<span>«</span>447</div>448 449 </div>450 <div class="clearer"></div>451 </div> 452 <div class="related" role="navigation" aria-label="Related">453 <h3>Navigation</h3>454 <ul>455 <li class="right" style="margin-right: 10px">456 <a href="../genindex.html" title="General Index"457 >index</a></li>458 <li class="right" >459 <a href="../py-modindex.html" title="Python Module Index"460 >modules</a> |</li>461 <li class="right" >462 <a href="dbm.html" title="dbm — Interfaces to Unix “databases”"463 >next</a> |</li>464 <li class="right" >465 <a href="shelve.html" title="shelve — Python object persistence"466 >previous</a> |</li>467 468 <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"></li>469 <li><a href="https://www.python.org/">Python</a> »</li>470 <li class="switchers">471 <div class="language_switcher_placeholder"></div>472 <div class="version_switcher_placeholder"></div>473 </li>474 <li>475 476 </li>477 <li id="cpython-language-and-version">478 <a href="../index.html">3.15.0a6 Documentation</a> »479 </li>480 481 <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> »</li>482 <li class="nav-item nav-item-2"><a href="persistence.html" >Data Persistence</a> »</li>483 <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">marshal</span></code> — Internal Python object serialization</a></li>484 <li class="right">485 486 487 <div class="inline-search" role="search">488 <form class="inline-search" action="../search.html" method="get">489 <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box">490 <input type="submit" value="Go">491 </form>492 </div>493 |494 </li>495 <li class="right">496<label class="theme-selector-label">497 Theme498 <select class="theme-selector" oninput="activateTheme(this.value)">499 <option value="auto" selected>Auto</option>500 <option value="light">Light</option>501 <option value="dark">Dark</option>502 </select>503</label> |</li>504 505 </ul>506 </div> 507 <div class="footer">508 © <a href="../copyright.html">Copyright</a> 2001 Python Software Foundation.509 <br>510 This page is licensed under the Python Software Foundation License Version 2.511 <br>512 Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.513 <br>514 515 See <a href="/license.html">History and License</a> for more information.<br>516 517 518 <br>519 520 The Python Software Foundation is a non-profit corporation.521<a href="https://www.python.org/psf/donations/">Please donate.</a>522<br>523 <br>524 Last updated on Mar 10, 2026 (08:58 UTC).525 526 <a href="/bugs.html">Found a bug</a>?527 528 <br>529 530 Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.531 </div>532 533 </body>534</html>