Gecko [ fernandoquevedodop.com ]

Name	Size	Permission
abstract.html	13.46 KB	-rw-r--r--
allocation.html	21.28 KB	-rw-r--r--
apiabiversion.html	15.83 KB	-rw-r--r--
arg.html	105.47 KB	-rw-r--r--
bool.html	14.58 KB	-rw-r--r--
buffer.html	83.05 KB	-rw-r--r--
bytearray.html	24.02 KB	-rw-r--r--
bytes.html	38.82 KB	-rw-r--r--
call.html	64.15 KB	-rw-r--r--
capsule.html	33.48 KB	-rw-r--r--
cell.html	17.69 KB	-rw-r--r--
code.html	24.99 KB	-rw-r--r--
codec.html	39.51 KB	-rw-r--r--
complex.html	30.48 KB	-rw-r--r--
concrete.html	21.41 KB	-rw-r--r--
contextvars.html	30.26 KB	-rw-r--r--
conversion.html	28.6 KB	-rw-r--r--
coro.html	14.01 KB	-rw-r--r--
datetime.html	53.09 KB	-rw-r--r--
descriptor.html	19.49 KB	-rw-r--r--
dict.html	56.11 KB	-rw-r--r--
exceptions.html	190.81 KB	-rw-r--r--
file.html	24.95 KB	-rw-r--r--
float.html	21.84 KB	-rw-r--r--
function.html	27.12 KB	-rw-r--r--
gcsupport.html	43.43 KB	-rw-r--r--
gen.html	16.21 KB	-rw-r--r--
import.html	61.83 KB	-rw-r--r--
index.html	22.24 KB	-rw-r--r--
init.html	225.02 KB	-rw-r--r--
init_config.html	204.18 KB	-rw-r--r--
intro.html	96.61 KB	-rw-r--r--
iter.html	19.62 KB	-rw-r--r--
iterator.html	16.87 KB	-rw-r--r--
list.html	34.91 KB	-rw-r--r--
long.html	62.14 KB	-rw-r--r--
mapping.html	28.43 KB	-rw-r--r--
marshal.html	23.89 KB	-rw-r--r--
memory.html	95.91 KB	-rw-r--r--
memoryview.html	20 KB	-rw-r--r--
method.html	23.98 KB	-rw-r--r--
module.html	98.3 KB	-rw-r--r--
none.html	12.1 KB	-rw-r--r--
number.html	74.63 KB	-rw-r--r--
objbuffer.html	19.12 KB	-rw-r--r--
object.html	80.93 KB	-rw-r--r--
objimpl.html	13.03 KB	-rw-r--r--
refcounting.html	25.62 KB	-rw-r--r--
reflection.html	20.69 KB	-rw-r--r--
sequence.html	46.94 KB	-rw-r--r--
set.html	41.5 KB	-rw-r--r--
slice.html	30.93 KB	-rw-r--r--
stable.html	195.79 KB	-rw-r--r--
structures.html	73.73 KB	-rw-r--r--
sys.html	69.43 KB	-rw-r--r--
tuple.html	47.5 KB	-rw-r--r--
type.html	55.03 KB	-rw-r--r--
typehints.html	16.62 KB	-rw-r--r--
typeobj.html	428.4 KB	-rw-r--r--
unicode.html	287.18 KB	-rw-r--r--
utilities.html	11.88 KB	-rw-r--r--
veryhigh.html	81.69 KB	-rw-r--r--
weakref.html	21.05 KB	-rw-r--r--

Code Editor : marshal.html

<!DOCTYPE html>

<title>Data marshalling support &#8212; Python 3.10.12 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">
 
 <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
 <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?2022.1" />
 
 <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
 <script src="../_static/jquery.js"></script>
 <script src="../_static/underscore.js"></script>
 <script src="../_static/doctools.js"></script>
 
 <script src="../_static/sidebar.js"></script>
 
 <link rel="search" type="application/opensearchdescription+xml"
 title="Search within Python 3.10.12 documentation"
 href="../_static/opensearch.xml"/>
 <link rel="author" title="About these documents" href="../about.html" />
 <link rel="index" title="Index" href="../genindex.html" />
 <link rel="search" title="Search" href="../search.html" />
 <link rel="copyright" title="Copyright" href="../copyright.html" />
 <link rel="next" title="Parsing arguments and building values" href="arg.html" />
 <link rel="prev" title="Importing Modules" href="import.html" />
 <link rel="canonical" href="file:///usr/share/doc/python3.10/html/c-api/marshal.html" />

</head>
<body>
<div class="mobile-nav">
 <input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"
 aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu" />
 <label for="menuToggler" class="toggler__label">
 
 </label>
 <nav class="nav-content" role="navigation">
 <a href="https://www.python.org/" class="nav-logo">
 <img src="../_static/py.svg" alt="Logo"/>
 </a>
 <div class="version_switcher_placeholder"></div>
 <form role="search" class="search" action="../search.html" method="get">
 <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">
 <path fill-rule="nonzero"
 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" fill="#444"></path>
 </svg>
 <input type="text" name="q" aria-label="Quick search"/>
 <input type="submit" value="Go"/>
 </form>
 </nav>
 <div class="menu-wrapper">
 <nav class="menu" role="navigation" aria-label="main navigation">
 <div class="language_switcher_placeholder"></div>
 <h4>Previous topic</h4>
 <a href="import.html"
 title="previous chapter">Importing Modules</a>
 <h4>Next topic</h4>
 <a href="arg.html"
 title="next chapter">Parsing arguments and building values</a>
 <div role="note" aria-label="source link">
 <h3>This Page</h3>
 <ul class="this-page-menu">
 <li><a href="../bugs.html">Report a Bug</a></li>
 <li>
 <a href="https://github.com/python/cpython/blob/3.10/Doc/c-api/marshal.rst"
 rel="nofollow">Show Source
 </a>
 </li>
 </ul>
 </div>
 </nav>
 </div>
</div>

<div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 accesskey="I">index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="arg.html" title="Parsing arguments and building values"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="import.html" title="Importing Modules"
 accesskey="P">previous</a> |</li>

<li><img src="../_static/py.svg" alt="python logo" style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="https://www.python.org/">Python</a> &#187;</li>
 <li class="switchers">
 <div class="language_switcher_placeholder"></div>
 <div class="version_switcher_placeholder"></div>
 </li>
 <li>
 
 </li>
 <li id="cpython-language-and-version">
 <a href="../index.html">3.10.12 Documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" >Python/C API Reference Manual</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="utilities.html" accesskey="U">Utilities</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">Data marshalling support</a></li>
 <li class="right">

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <section id="data-marshalling-support">
<h1>Data marshalling support<a class="headerlink" href="#data-marshalling-support" title="Permalink to this headline">¶</a></h1>
These routines allow C code to work with serialized objects using the same
data format as the <a class="reference internal" href="../library/marshal.html#module-marshal" title="marshal: Convert Python objects to streams of bytes and back (with different constraints)."><code class="xref py py-mod docutils literal notranslate">marshal</code></a> module. There are functions to write data
into the serialization format, and additional functions that can be used to
read the data back. Files used to store marshalled data must be opened in
binary mode.
Numeric values are stored with the least significant byte first.
The module supports two versions of the data format: version 0 is the
historical version, version 1 shares interned strings in the file, and upon
unmarshalling. Version 2 uses a binary format for floating point numbers.
<code class="docutils literal notranslate">Py_MARSHAL_VERSION</code> indicates the current file format (currently 2).
<dl class="c function">
<dt class="sig sig-object c" id="c.PyMarshal_WriteLongToFile">
void PyMarshal_WriteLongToFile(long value, FILE *file, int version)<a class="headerlink" href="#c.PyMarshal_WriteLongToFile" title="Permalink to this definition">¶</a> </dt>
<dd>Marshal a long integer, value, to file. This will only write
the least-significant 32 bits of value; regardless of the size of the
native long type. version indicates the file format.
This function can fail, in which case it sets the error indicator.
Use <a class="reference internal" href="exceptions.html#c.PyErr_Occurred" title="PyErr_Occurred"><code class="xref c c-func docutils literal notranslate">PyErr_Occurred()</code></a> to check for that.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyMarshal_WriteObjectToFile">
void PyMarshal_WriteObjectToFile(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *value, FILE *file, int version)<a class="headerlink" href="#c.PyMarshal_WriteObjectToFile" title="Permalink to this definition">¶</a> </dt>
<dd>Marshal a Python object, value, to file.
version indicates the file format.
This function can fail, in which case it sets the error indicator.
Use <a class="reference internal" href="exceptions.html#c.PyErr_Occurred" title="PyErr_Occurred"><code class="xref c c-func docutils literal notranslate">PyErr_Occurred()</code></a> to check for that.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyMarshal_WriteObjectToString">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyMarshal_WriteObjectToString(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *value, int version)<a class="headerlink" href="#c.PyMarshal_WriteObjectToString" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference.Return a bytes object containing the marshalled representation of value.
version indicates the file format.
</dd></dl>

The following functions allow marshalled values to be read back in.
<dl class="c function">
<dt class="sig sig-object c" id="c.PyMarshal_ReadLongFromFile">
long PyMarshal_ReadLongFromFile(FILE *file)<a class="headerlink" href="#c.PyMarshal_ReadLongFromFile" title="Permalink to this definition">¶</a> </dt>
<dd>Return a C long from the data stream in a FILE* opened
for reading. Only a 32-bit value can be read in using this function,
regardless of the native size of long.
On error, sets the appropriate exception (<a class="reference internal" href="../library/exceptions.html#EOFError" title="EOFError"><code class="xref py py-exc docutils literal notranslate">EOFError</code></a>) and returns
<code class="docutils literal notranslate">-1</code>.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyMarshal_ReadShortFromFile">
int PyMarshal_ReadShortFromFile(FILE *file)<a class="headerlink" href="#c.PyMarshal_ReadShortFromFile" title="Permalink to this definition">¶</a> </dt>
<dd>Return a C short from the data stream in a FILE* opened
for reading. Only a 16-bit value can be read in using this function,
regardless of the native size of short.
On error, sets the appropriate exception (<a class="reference internal" href="../library/exceptions.html#EOFError" title="EOFError"><code class="xref py py-exc docutils literal notranslate">EOFError</code></a>) and returns
<code class="docutils literal notranslate">-1</code>.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyMarshal_ReadObjectFromFile">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyMarshal_ReadObjectFromFile(FILE *file)<a class="headerlink" href="#c.PyMarshal_ReadObjectFromFile" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference.Return a Python object from the data stream in a FILE* opened for
reading.
On error, sets the appropriate exception (<a class="reference internal" href="../library/exceptions.html#EOFError" title="EOFError"><code class="xref py py-exc docutils literal notranslate">EOFError</code></a>, <a class="reference internal" href="../library/exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate">ValueError</code></a>
or <a class="reference internal" href="../library/exceptions.html#TypeError" title="TypeError"><code class="xref py py-exc docutils literal notranslate">TypeError</code></a>) and returns <code class="docutils literal notranslate">NULL</code>.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyMarshal_ReadLastObjectFromFile">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyMarshal_ReadLastObjectFromFile(FILE *file)<a class="headerlink" href="#c.PyMarshal_ReadLastObjectFromFile" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference.Return a Python object from the data stream in a FILE* opened for
reading. Unlike <a class="reference internal" href="#c.PyMarshal_ReadObjectFromFile" title="PyMarshal_ReadObjectFromFile"><code class="xref c c-func docutils literal notranslate">PyMarshal_ReadObjectFromFile()</code></a>, this function
assumes that no further objects will be read from the file, allowing it to
aggressively load file data into memory so that the de-serialization can
operate from data in memory rather than reading a byte at a time from the
file. Only use these variant if you are certain that you won’t be reading
anything else from the file.
On error, sets the appropriate exception (<a class="reference internal" href="../library/exceptions.html#EOFError" title="EOFError"><code class="xref py py-exc docutils literal notranslate">EOFError</code></a>, <a class="reference internal" href="../library/exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate">ValueError</code></a>
or <a class="reference internal" href="../library/exceptions.html#TypeError" title="TypeError"><code class="xref py py-exc docutils literal notranslate">TypeError</code></a>) and returns <code class="docutils literal notranslate">NULL</code>.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyMarshal_ReadObjectFromString">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyMarshal_ReadObjectFromString(const char *data, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> len)<a class="headerlink" href="#c.PyMarshal_ReadObjectFromString" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference.Return a Python object from the data stream in a byte buffer
containing len bytes pointed to by data.
On error, sets the appropriate exception (<a class="reference internal" href="../library/exceptions.html#EOFError" title="EOFError"><code class="xref py py-exc docutils literal notranslate">EOFError</code></a>, <a class="reference internal" href="../library/exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate">ValueError</code></a>
or <a class="reference internal" href="../library/exceptions.html#TypeError" title="TypeError"><code class="xref py py-exc docutils literal notranslate">TypeError</code></a>) and returns <code class="docutils literal notranslate">NULL</code>.
</dd></dl>

</section>

<div class="clearer"></div>
 </div>
 </div>
 </div>
 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 <div class="sphinxsidebarwrapper">
 <h4>Previous topic</h4>
 <a href="import.html"
 title="previous chapter">Importing Modules</a>
 <h4>Next topic</h4>
 <a href="arg.html"
 title="next chapter">Parsing arguments and building values</a>
 <div role="note" aria-label="source link">
 <h3>This Page</h3>
 <ul class="this-page-menu">
 <li><a href="../bugs.html">Report a Bug</a></li>
 <li>
 <a href="https://github.com/python/cpython/blob/3.10/Doc/c-api/marshal.rst"
 rel="nofollow">Show Source
 </a>
 </li>
 </ul>
 </div>
 </div>
 </div>
 <div class="clearer"></div>
 </div> 
 <div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 >index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="arg.html" title="Parsing arguments and building values"
 >next</a> |</li>
 <li class="right" >
 <a href="import.html" title="Importing Modules"
 >previous</a> |</li>

<li class="nav-item nav-item-1"><a href="index.html" >Python/C API Reference Manual</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="utilities.html" >Utilities</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">Data marshalling support</a></li>
 <li class="right">

<div class="inline-search" role="search">
 <form class="inline-search" action="../search.html" method="get">
 <input placeholder="Quick search" aria-label="Quick search" type="text" name="q" />
 <input type="submit" value="Go" />
 <input type="hidden" name="check_keywords" value="yes" />
 <input type="hidden" name="area" value="default" />
 </form>
 </div>
 |
 </li>
 
 </ul>
 </div> 
 <div class="footer">
 &copy; <a href="../copyright.html">Copyright</a> 2001-2026, Python Software Foundation.
 
 This page is licensed under the Python Software Foundation License Version 2.
 
 Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.
 
 See <a href="/license.html">History and License</a> for more information.

The Python Software Foundation is a non-profit corporation.
<a href="https://www.python.org/psf/donations/">Please donate.</a>

Last updated on January 26, 2026.
 <a href="/bugs.html">Found a bug</a>?

Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.2.
 </div>

</body>
</html>

${this.title}

Code Editor : marshal.html