Mr.Combet Webshell 🔥

Edit File Name : plistlib.html

<!DOCTYPE html>

<title>plistlib — Generate and parse Apple .plist files &#8212; Python 3.12.3 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">
 
 <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
 <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?v=bb723527" />
 <link id="pygments_dark_css" media="(prefers-color-scheme: dark)" rel="stylesheet" type="text/css" href="../_static/pygments_dark.css?v=b20cc3f5" />
 
 <script src="../_static/documentation_options.js?v=2c828074"></script>
 <script src="../_static/doctools.js?v=888ff710"></script>
 <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
 
 <script src="../_static/sidebar.js"></script>
 
 <link rel="search" type="application/opensearchdescription+xml"
 title="Search within Python 3.12.3 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="Cryptographic Services" href="crypto.html" />
 <link rel="prev" title="netrc — netrc file processing" href="netrc.html" />
 <link rel="canonical" href="https://docs.python.org/3/library/plistlib.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" />
 <nav class="nav-content" role="navigation">
 <label for="menuToggler" class="toggler__label">
 
 </label>
 
 <a href="https://www.python.org/" class="nav-logo">
 <img src="../_static/py.svg" alt="Python logo"/>
 </a>
 
 <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" 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>
 </svg>
 <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" />
 <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>
 
<label class="theme-selector-label">
 Theme
 <select class="theme-selector" oninput="activateTheme(this.value)">
 <option value="auto" selected>Auto</option>
 <option value="light">Light</option>
 <option value="dark">Dark</option>
 </select>
</label>
 <div>
 <h3><a href="../contents.html">Table of Contents</a></h3>
 <ul>
<li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate">plistlib</code> — Generate and parse Apple <code class="docutils literal notranslate">.plist</code> files</a><ul>
<li><a class="reference internal" href="#examples">Examples</a></li>
</ul>
</li>
</ul>

</div>
 <div>
 <h4>Previous topic</h4>
 <a href="netrc.html"
 title="previous chapter"><code class="xref py py-mod docutils literal notranslate">netrc</code> — netrc file processing</a>
 </div>
 <div>
 <h4>Next topic</h4>
 <a href="crypto.html"
 title="next chapter">Cryptographic Services</a>
 </div>
 <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/main/Doc/library/plistlib.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="crypto.html" title="Cryptographic Services"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="netrc.html" title="netrc — netrc file processing"
 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.12.3 Documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="fileformats.html" accesskey="U">File Formats</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate">plistlib</code> — Generate and parse Apple <code class="docutils literal notranslate">.plist</code> files</a></li>
 <li class="right">

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <section id="module-plistlib">
<h1><a class="reference internal" href="#module-plistlib" title="plistlib: Generate and parse Apple plist files."><code class="xref py py-mod docutils literal notranslate">plistlib</code></a> — Generate and parse Apple <code class="docutils literal notranslate">.plist</code> files<a class="headerlink" href="#module-plistlib" title="Link to this heading">¶</a></h1>
Source code: <a class="reference external" href="https://github.com/python/cpython/tree/3.12/Lib/plistlib.py">Lib/plistlib.py</a>
<hr class="docutils" id="index-0" />
This module provides an interface for reading and writing the “property list”
files used by Apple, primarily on macOS and iOS. This module supports both binary
and XML plist files.
The property list (<code class="docutils literal notranslate">.plist</code>) file format is a simple serialization supporting
basic object types, like dictionaries, lists, numbers and strings. Usually the
top level object is a dictionary.
To write out and to parse a plist file, use the <a class="reference internal" href="#plistlib.dump" title="plistlib.dump"><code class="xref py py-func docutils literal notranslate">dump()</code></a> and
<a class="reference internal" href="#plistlib.load" title="plistlib.load"><code class="xref py py-func docutils literal notranslate">load()</code></a> functions.
To work with plist data in bytes objects, use <a class="reference internal" href="#plistlib.dumps" title="plistlib.dumps"><code class="xref py py-func docutils literal notranslate">dumps()</code></a>
and <a class="reference internal" href="#plistlib.loads" title="plistlib.loads"><code class="xref py py-func docutils literal notranslate">loads()</code></a>.
Values can be strings, integers, floats, booleans, tuples, lists, dictionaries
(but only with string keys), <a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate">bytes</code></a>, <a class="reference internal" href="stdtypes.html#bytearray" title="bytearray"><code class="xref py py-class docutils literal notranslate">bytearray</code></a>
or <a class="reference internal" href="datetime.html#datetime.datetime" title="datetime.datetime"><code class="xref py py-class docutils literal notranslate">datetime.datetime</code></a> objects.
<div class="versionchanged">
Changed in version 3.4: New API, old API deprecated. Support for binary format plists added.
</div>
<div class="versionchanged">
Changed in version 3.8: Support added for reading and writing <a class="reference internal" href="#plistlib.UID" title="plistlib.UID"><code class="xref py py-class docutils literal notranslate">UID</code></a> tokens in binary plists as used
by NSKeyedArchiver and NSKeyedUnarchiver.
</div>
<div class="versionchanged">
Changed in version 3.9: Old API removed.
</div>
<div class="admonition seealso">
See also
<dl class="simple">
<dt><a class="reference external" href="https://developer.apple.com/library/archive/documentation/Cocoa/Conceptual/PropertyLists/">PList manual page</a></dt><dd>Apple’s documentation of the file format.
</dd>
</dl>
</div>
This module defines the following functions:
<dl class="py function">
<dt class="sig sig-object py" id="plistlib.load">
plistlib.load(fp, *, fmt=None, dict_type=dict)<a class="headerlink" href="#plistlib.load" title="Link to this definition">¶</a></dt>
<dd>Read a plist file. fp should be a readable and binary file object.
Return the unpacked root object (which usually is a
dictionary).
The fmt is the format of the file and the following values are valid:
<ul class="simple">
<li><a class="reference internal" href="constants.html#None" title="None"><code class="xref py py-data docutils literal notranslate">None</code></a>: Autodetect the file format</li>
<li><a class="reference internal" href="#plistlib.FMT_XML" title="plistlib.FMT_XML"><code class="xref py py-data docutils literal notranslate">FMT_XML</code></a>: XML file format</li>
<li><a class="reference internal" href="#plistlib.FMT_BINARY" title="plistlib.FMT_BINARY"><code class="xref py py-data docutils literal notranslate">FMT_BINARY</code></a>: Binary plist format</li>
</ul>
The dict_type is the type used for dictionaries that are read from the
plist file.
XML data for the <a class="reference internal" href="#plistlib.FMT_XML" title="plistlib.FMT_XML"><code class="xref py py-data docutils literal notranslate">FMT_XML</code></a> format is parsed using the Expat parser
from <a class="reference internal" href="pyexpat.html#module-xml.parsers.expat" title="xml.parsers.expat: An interface to the Expat non-validating XML parser."><code class="xref py py-mod docutils literal notranslate">xml.parsers.expat</code></a> – see its documentation for possible
exceptions on ill-formed XML. Unknown elements will simply be ignored
by the plist parser.
The parser for the binary format raises <code class="xref py py-exc docutils literal notranslate">InvalidFileException</code>
when the file cannot be parsed.
<div class="versionadded">
New in version 3.4.
</div>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="plistlib.loads">
plistlib.loads(data, *, fmt=None, dict_type=dict)<a class="headerlink" href="#plistlib.loads" title="Link to this definition">¶</a></dt>
<dd>Load a plist from a bytes object. See <a class="reference internal" href="#plistlib.load" title="plistlib.load"><code class="xref py py-func docutils literal notranslate">load()</code></a> for an explanation of
the keyword arguments.
<div class="versionadded">
New in version 3.4.
</div>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="plistlib.dump">
plistlib.dump(value, fp, *, fmt=FMT_XML, sort_keys=True, skipkeys=False)<a class="headerlink" href="#plistlib.dump" title="Link to this definition">¶</a></dt>
<dd>Write value to a plist file. Fp should be a writable, binary
file object.
The fmt argument specifies the format of the plist file and can be
one of the following values:
<ul class="simple">
<li><a class="reference internal" href="#plistlib.FMT_XML" title="plistlib.FMT_XML"><code class="xref py py-data docutils literal notranslate">FMT_XML</code></a>: XML formatted plist file</li>
<li><a class="reference internal" href="#plistlib.FMT_BINARY" title="plistlib.FMT_BINARY"><code class="xref py py-data docutils literal notranslate">FMT_BINARY</code></a>: Binary formatted plist file</li>
</ul>
When sort_keys is true (the default) the keys for dictionaries will be
written to the plist in sorted order, otherwise they will be written in
the iteration order of the dictionary.
When skipkeys is false (the default) the function raises <a class="reference internal" href="exceptions.html#TypeError" title="TypeError"><code class="xref py py-exc docutils literal notranslate">TypeError</code></a>
when a key of a dictionary is not a string, otherwise such keys are skipped.
A <a class="reference internal" href="exceptions.html#TypeError" title="TypeError"><code class="xref py py-exc docutils literal notranslate">TypeError</code></a> will be raised if the object is of an unsupported type or
a container that contains objects of unsupported types.
An <a class="reference internal" href="exceptions.html#OverflowError" title="OverflowError"><code class="xref py py-exc docutils literal notranslate">OverflowError</code></a> will be raised for integer values that cannot
be represented in (binary) plist files.
<div class="versionadded">
New in version 3.4.
</div>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="plistlib.dumps">
plistlib.dumps(value, *, fmt=FMT_XML, sort_keys=True, skipkeys=False)<a class="headerlink" href="#plistlib.dumps" title="Link to this definition">¶</a></dt>
<dd>Return value as a plist-formatted bytes object. See
the documentation for <a class="reference internal" href="#plistlib.dump" title="plistlib.dump"><code class="xref py py-func docutils literal notranslate">dump()</code></a> for an explanation of the keyword
arguments of this function.
<div class="versionadded">
New in version 3.4.
</div>
</dd></dl>

The following classes are available:
<dl class="py class">
<dt class="sig sig-object py" id="plistlib.UID">
class plistlib.UID(data)<a class="headerlink" href="#plistlib.UID" title="Link to this definition">¶</a></dt>
<dd>Wraps an <a class="reference internal" href="functions.html#int" title="int"><code class="xref py py-class docutils literal notranslate">int</code></a>. This is used when reading or writing NSKeyedArchiver
encoded data, which contains UID (see PList manual).
It has one attribute, <code class="xref py py-attr docutils literal notranslate">data</code>, which can be used to retrieve the int value
of the UID. <code class="xref py py-attr docutils literal notranslate">data</code> must be in the range <code class="docutils literal notranslate">0 &lt;= data &lt; 2**64</code>.
<div class="versionadded">
New in version 3.8.
</div>
</dd></dl>

The following constants are available:
<dl class="py data">
<dt class="sig sig-object py" id="plistlib.FMT_XML">
plistlib.FMT_XML<a class="headerlink" href="#plistlib.FMT_XML" title="Link to this definition">¶</a></dt>
<dd>The XML format for plist files.
<div class="versionadded">
New in version 3.4.
</div>
</dd></dl>

<dl class="py data">
<dt class="sig sig-object py" id="plistlib.FMT_BINARY">
plistlib.FMT_BINARY<a class="headerlink" href="#plistlib.FMT_BINARY" title="Link to this definition">¶</a></dt>
<dd>The binary format for plist files
<div class="versionadded">
New in version 3.4.
</div>
</dd></dl>

<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Link to this heading">¶</a></h2>
Generating a plist:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>import datetime
import plistlib

pl = dict(
 aString = &quot;Doodah&quot;,
 aList = [&quot;A&quot;, &quot;B&quot;, 12, 32.1, [1, 2, 3]],
 aFloat = 0.1,
 anInt = 728,
 aDict = dict(
 anotherString = &quot;&lt;hello &amp; hi there!&gt;&quot;,
 aThirdString = &quot;M\xe4ssig, Ma\xdf&quot;,
 aTrueValue = True,
 aFalseValue = False,
 ),
 someData = b&quot;&lt;binary gunk&gt;&quot;,
 someMoreData = b&quot;&lt;lots of binary gunk&gt;&quot; * 10,
 aDate = datetime.datetime.now()
)
print(plistlib.dumps(pl).decode())
</pre></div>
</div>
Parsing a plist:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>import plistlib

plist = b&quot;&quot;&quot;&lt;plist version=&quot;1.0&quot;&gt;
&lt;dict&gt;
 &lt;key&gt;foo&lt;/key&gt;
 &lt;string&gt;bar&lt;/string&gt;
&lt;/dict&gt;
&lt;/plist&gt;&quot;&quot;&quot;
pl = plistlib.loads(plist)
print(pl[&quot;foo&quot;])
</pre></div>
</div>
</section>
</section>

<div class="clearer"></div>
 </div>
 </div>
 </div>
 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 <div class="sphinxsidebarwrapper">
 <div>
 <h3><a href="../contents.html">Table of Contents</a></h3>
 <ul>
<li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate">plistlib</code> — Generate and parse Apple <code class="docutils literal notranslate">.plist</code> files</a><ul>
<li><a class="reference internal" href="#examples">Examples</a></li>
</ul>
</li>
</ul>

</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="crypto.html" title="Cryptographic Services"
 >next</a> |</li>
 <li class="right" >
 <a href="netrc.html" title="netrc — netrc file processing"
 >previous</a> |</li>

<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="fileformats.html" >File Formats</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate">plistlib</code> — Generate and parse Apple <code class="docutils literal notranslate">.plist</code> files</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="search" name="q" id="search-box" />
 <input type="submit" value="Go" />
 </form>
 </div>
 |
 </li>
 <li class="right">
<label class="theme-selector-label">
 Theme
 <select class="theme-selector" oninput="activateTheme(this.value)">
 <option value="auto" selected>Auto</option>
 <option value="light">Light</option>
 <option value="dark">Dark</option>
 </select>
</label> |</li>
 
 </ul>
 </div> 
 <div class="footer">
 &copy; 
 <a href="../copyright.html">
 
 Copyright
 
 </a>
 2001-2024, 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 Apr 09, 2024 (13:47 UTC).
 
 <a href="/bugs.html">Found a bug</a>?

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

</body>
</html>