OwlCyberSecurity - MANAGER
Edit File: aepack.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="X-UA-Compatible" content="IE=Edge" /> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>38.3. aepack — Conversion between Python variables and AppleEvent data containers — Python 2.7.18 documentation</title> <link rel="stylesheet" href="../_static/classic.css" type="text/css" /> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> <script type="text/javascript" src="../_static/jquery.js"></script> <script type="text/javascript" src="../_static/underscore.js"></script> <script type="text/javascript" src="../_static/doctools.js"></script> <script type="text/javascript" src="../_static/language_data.js"></script> <script type="text/javascript" src="../_static/sidebar.js"></script> <link rel="search" type="application/opensearchdescription+xml" title="Search within Python 2.7.18 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="38.4. aetypes — AppleEvent objects" href="aetypes.html" /> <link rel="prev" title="38.2. aetools — OSA client support" href="aetools.html" /> <link rel="shortcut icon" type="image/png" href="../_static/py.png" /> <link rel="canonical" href="file:///usr/share/doc/python2.7/html/library/aepack.html" /> <script type="text/javascript" src="../_static/copybutton.js"></script> </head><body> <div id="outdated-warning" style="padding: .5em; text-align: center; background-color: #FFBABA; color: #6A0E0E;"> This document is for an old version of Python that is <a href="https://devguide.python.org/devcycle/#end-of-life-branches">no longer supported</a>. You should install the python3 and python3-doc packages and read the <a href="file:///usr/share/doc/python3-doc/html/library/aepack.html"> Python documentation for the Python3 version packaged in this release</a>. </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="aetypes.html" title="38.4. aetypes — AppleEvent objects" accesskey="N">next</a> |</li> <li class="right" > <a href="aetools.html" title="38.2. aetools — OSA client support" accesskey="P">previous</a> |</li> <li><img src="../_static/py.png" alt="" style="vertical-align: middle; margin-top: -1px"/></li> <li><a href="https://www.python.org/">Python</a> »</li> <li> <a href="../index.html">Python 2.7.18 documentation</a> » </li> <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> »</li> <li class="nav-item nav-item-2"><a href="macosa.html" accesskey="U">38. MacPython OSA Modules</a> »</li> </ul> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body" role="main"> <div class="section" id="module-aepack"> <span id="aepack-conversion-between-python-variables-and-appleevent-data-containers"></span><h1>38.3. <a class="reference internal" href="#module-aepack" title="aepack: Conversion between Python variables and AppleEvent data containers. (deprecated) (Mac)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">aepack</span></code></a> — Conversion between Python variables and AppleEvent data containers<a class="headerlink" href="#module-aepack" title="Permalink to this headline">¶</a></h1> <p>The <a class="reference internal" href="#module-aepack" title="aepack: Conversion between Python variables and AppleEvent data containers. (deprecated) (Mac)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">aepack</span></code></a> module defines functions for converting (packing) Python variables to AppleEvent descriptors and back (unpacking). Within Python the AppleEvent descriptor is handled by Python objects of built-in type <code class="xref py py-class docutils literal notranslate"><span class="pre">AEDesc</span></code>, defined in module <a class="reference internal" href="carbon.html#module-Carbon.AE" title="Carbon.AE: Interface to the Apple Events toolbox. (deprecated) (Mac)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">Carbon.AE</span></code></a>.</p> <div class="admonition note"> <p class="first admonition-title">Note</p> <p class="last">This module has been removed in Python 3.x.</p> </div> <p>The <a class="reference internal" href="#module-aepack" title="aepack: Conversion between Python variables and AppleEvent data containers. (deprecated) (Mac)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">aepack</span></code></a> module defines the following functions:</p> <dl class="function"> <dt id="aepack.pack"> <code class="descclassname">aepack.</code><code class="descname">pack</code><span class="sig-paren">(</span><em>x</em><span class="optional">[</span>, <em>forcetype</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#aepack.pack" title="Permalink to this definition">¶</a></dt> <dd><p>Returns an <code class="xref py py-class docutils literal notranslate"><span class="pre">AEDesc</span></code> object containing a conversion of Python value x. If <em>forcetype</em> is provided it specifies the descriptor type of the result. Otherwise, a default mapping of Python types to Apple Event descriptor types is used, as follows:</p> <table border="1" class="docutils"> <colgroup> <col width="33%" /> <col width="67%" /> </colgroup> <thead valign="bottom"> <tr class="row-odd"><th class="head">Python type</th> <th class="head">descriptor type</th> </tr> </thead> <tbody valign="top"> <tr class="row-even"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">FSSpec</span></code></td> <td>typeFSS</td> </tr> <tr class="row-odd"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">FSRef</span></code></td> <td>typeFSRef</td> </tr> <tr class="row-even"><td><code class="xref py py-class docutils literal notranslate"><span class="pre">Alias</span></code></td> <td>typeAlias</td> </tr> <tr class="row-odd"><td>integer</td> <td>typeLong (32 bit integer)</td> </tr> <tr class="row-even"><td>float</td> <td>typeFloat (64 bit floating point)</td> </tr> <tr class="row-odd"><td>string</td> <td>typeText</td> </tr> <tr class="row-even"><td>unicode</td> <td>typeUnicodeText</td> </tr> <tr class="row-odd"><td>list</td> <td>typeAEList</td> </tr> <tr class="row-even"><td>dictionary</td> <td>typeAERecord</td> </tr> <tr class="row-odd"><td>instance</td> <td><em>see below</em></td> </tr> </tbody> </table> <p>If <em>x</em> is a Python instance then this function attempts to call an <code class="xref py py-meth docutils literal notranslate"><span class="pre">__aepack__()</span></code> method. This method should return an <code class="xref py py-class docutils literal notranslate"><span class="pre">AEDesc</span></code> object.</p> <p>If the conversion <em>x</em> is not defined above, this function returns the Python string representation of a value (the repr() function) encoded as a text descriptor.</p> </dd></dl> <dl class="function"> <dt id="aepack.unpack"> <code class="descclassname">aepack.</code><code class="descname">unpack</code><span class="sig-paren">(</span><em>x</em><span class="optional">[</span>, <em>formodulename</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#aepack.unpack" title="Permalink to this definition">¶</a></dt> <dd><p><em>x</em> must be an object of type <code class="xref py py-class docutils literal notranslate"><span class="pre">AEDesc</span></code>. This function returns a Python object representation of the data in the Apple Event descriptor <em>x</em>. Simple AppleEvent data types (integer, text, float) are returned as their obvious Python counterparts. Apple Event lists are returned as Python lists, and the list elements are recursively unpacked. Object references (ex. <code class="docutils literal notranslate"><span class="pre">line</span> <span class="pre">3</span> <span class="pre">of</span> <span class="pre">document</span> <span class="pre">1</span></code>) are returned as instances of <a class="reference internal" href="aetypes.html#aetypes.ObjectSpecifier" title="aetypes.ObjectSpecifier"><code class="xref py py-class docutils literal notranslate"><span class="pre">aetypes.ObjectSpecifier</span></code></a>, unless <code class="docutils literal notranslate"><span class="pre">formodulename</span></code> is specified. AppleEvent descriptors with descriptor type typeFSS are returned as <code class="xref py py-class docutils literal notranslate"><span class="pre">FSSpec</span></code> objects. AppleEvent record descriptors are returned as Python dictionaries, with 4-character string keys and elements recursively unpacked.</p> <p>The optional <code class="docutils literal notranslate"><span class="pre">formodulename</span></code> argument is used by the stub packages generated by <a class="reference internal" href="gensuitemodule.html#module-gensuitemodule" title="gensuitemodule: Create a stub package from an OSA dictionary (Mac)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">gensuitemodule</span></code></a>, and ensures that the OSA classes for object specifiers are looked up in the correct module. This ensures that if, say, the Finder returns an object specifier for a window you get an instance of <code class="docutils literal notranslate"><span class="pre">Finder.Window</span></code> and not a generic <code class="docutils literal notranslate"><span class="pre">aetypes.Window</span></code>. The former knows about all the properties and elements a window has in the Finder, while the latter knows no such things.</p> </dd></dl> <div class="admonition seealso"> <p class="first admonition-title">See also</p> <dl class="last docutils"> <dt>Module <a class="reference internal" href="carbon.html#module-Carbon.AE" title="Carbon.AE: Interface to the Apple Events toolbox. (deprecated) (Mac)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">Carbon.AE</span></code></a></dt> <dd>Built-in access to Apple Event Manager routines.</dd> <dt>Module <a class="reference internal" href="aetypes.html#module-aetypes" title="aetypes: Python representation of the Apple Event Object Model. (deprecated) (Mac)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">aetypes</span></code></a></dt> <dd>Python definitions of codes for Apple Event descriptor types.</dd> </dl> </div> </div> </div> </div> </div> <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> <div class="sphinxsidebarwrapper"> <h4>Previous topic</h4> <p class="topless"><a href="aetools.html" title="previous chapter">38.2. <code class="docutils literal notranslate"><span class="pre">aetools</span></code> — OSA client support</a></p> <h4>Next topic</h4> <p class="topless"><a href="aetypes.html" title="next chapter">38.4. <code class="docutils literal notranslate"><span class="pre">aetypes</span></code> — AppleEvent objects</a></p> <div role="note" aria-label="source link"> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="../_sources/library/aepack.rst.txt" rel="nofollow">Show Source</a></li> </ul> </div> <div id="searchbox" style="display: none" role="search"> <h3>Quick search</h3> <div class="searchformwrapper"> <form class="search" action="../search.html" method="get"> <input 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> </div> <script type="text/javascript">$('#searchbox').show(0);</script> </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="aetypes.html" title="38.4. aetypes — AppleEvent objects" >next</a> |</li> <li class="right" > <a href="aetools.html" title="38.2. aetools — OSA client support" >previous</a> |</li> <li><img src="../_static/py.png" alt="" style="vertical-align: middle; margin-top: -1px"/></li> <li><a href="https://www.python.org/">Python</a> »</li> <li> <a href="../index.html">Python 2.7.18 documentation</a> » </li> <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> »</li> <li class="nav-item nav-item-2"><a href="macosa.html" >38. MacPython OSA Modules</a> »</li> </ul> </div> <div class="footer"> © <a href="../copyright.html">Copyright</a> 1990-2024, Python Software Foundation. <br /> The Python Software Foundation is a non-profit corporation. <a href="https://www.python.org/psf/donations/">Please donate.</a> <br /> Last updated on December 09, 2024. <a href="../bugs.html">Found a bug</a>? <br /> Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.8.5. </div> </body> </html>