--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/api/python/ats3.parsers.PkgFileParser-class.html Fri Sep 11 11:54:49 2009 +0100
@@ -0,0 +1,388 @@
+<?xml version="1.0" encoding="ascii"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+ <title>ats3.parsers.PkgFileParser</title>
+ <link rel="stylesheet" href="epydoc.css" type="text/css" />
+ <script type="text/javascript" src="epydoc.js"></script>
+</head>
+
+<body bgcolor="white" text="black" link="blue" vlink="#204080"
+ alink="#204080">
+<!-- ==================== NAVIGATION BAR ==================== -->
+<table class="navbar" border="0" width="100%" cellpadding="0"
+ bgcolor="#a0c0ff" cellspacing="0">
+ <tr valign="middle">
+
+ <!-- Tree link -->
+ <th> <a
+ href="module-tree.html">Trees</a> </th>
+
+ <!-- Index link -->
+ <th> <a
+ href="identifier-index.html">Indices</a> </th>
+
+ <!-- Help link -->
+ <th> <a
+ href="help.html">Help</a> </th>
+
+ <th class="navbar" width="100%"></th>
+ </tr>
+</table>
+<table width="100%" cellpadding="0" cellspacing="0">
+ <tr valign="top">
+ <td width="100%">
+ <span class="breadcrumbs">
+ <a href="ats3-module.html">Package ats3</a> ::
+ <a href="ats3.parsers-module.html">Module parsers</a> ::
+ Class PkgFileParser
+ </span>
+ </td>
+ <td>
+ <table cellpadding="0" cellspacing="0">
+ <!-- hide/show private -->
+ <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
+ onclick="toggle_private();">hide private</a>]</span></td></tr>
+ <tr><td align="right"><span class="options"
+ >[<a href="frames.html" target="_top">frames</a
+ >] | <a href="ats3.parsers.PkgFileParser-class.html"
+ target="_top">no frames</a>]</span></td></tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<!-- ==================== CLASS DESCRIPTION ==================== -->
+<h1 class="epydoc">Class PkgFileParser</h1><span class="codelink"><a href="ats3.parsers-pysrc.html#PkgFileParser">source code</a></span><br /><br />
+<pre class="base-tree">
+object --+
+ |
+ <strong class="uidshort">PkgFileParser</strong>
+</pre>
+
+<hr />
+<dl class="rst-docutils">
+<dt>Parses .pkg files. Returns a list of:</dt>
+<dd><ol class="rst-first rst-last rst-loweralpha simple">
+<li>src path of the file</li>
+<li>dst path on the phone</li>
+<li>type of the file</li>
+</ol>
+</dd>
+</dl>
+<p>for every file in the pkg file</p><br /><br />
+
+<!-- ==================== INSTANCE METHODS ==================== -->
+<a name="section-InstanceMethods"></a>
+<table class="summary" border="1" cellpadding="3"
+ cellspacing="0" width="100%" bgcolor="white">
+<tr bgcolor="#70b0f0" class="table-header">
+ <td colspan="2" class="table-header">
+ <table border="0" cellpadding="0" cellspacing="0" width="100%">
+ <tr valign="top">
+ <td align="left"><span class="table-header">Instance Methods</span></td>
+ <td align="right" valign="top"
+ ><span class="options">[<a href="#section-InstanceMethods"
+ class="privatelink" onclick="toggle_private();"
+ >hide private</a>]</span></td>
+ </tr>
+ </table>
+ </td>
+</tr>
+<tr>
+ <td width="15%" align="right" valign="top" class="summary">
+ <span class="summary-type"> </span>
+ </td><td class="summary">
+ <table width="100%" cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td><span class="summary-sig"><a href="ats3.parsers.PkgFileParser-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
+ <span class="summary-sig-arg">platform</span>=<span class="summary-sig-default">None</span>)</span><br />
+ x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td>
+ <td align="right" valign="top">
+ <span class="codelink"><a href="ats3.parsers-pysrc.html#PkgFileParser.__init__">source code</a></span>
+
+ </td>
+ </tr>
+ </table>
+
+ </td>
+ </tr>
+<tr>
+ <td width="15%" align="right" valign="top" class="summary">
+ <span class="summary-type"> </span>
+ </td><td class="summary">
+ <table width="100%" cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td><span class="summary-sig"><a href="ats3.parsers.PkgFileParser-class.html#get_pkg_files" class="summary-sig-name">get_pkg_files</a>(<span class="summary-sig-arg">self</span>,
+ <span class="summary-sig-arg">location</span>=<span class="summary-sig-default">None</span>,
+ <span class="summary-sig-arg">with_full_path</span>=<span class="summary-sig-default">True</span>)</span><br />
+ Returns list of PKG files on the given location.</td>
+ <td align="right" valign="top">
+ <span class="codelink"><a href="ats3.parsers-pysrc.html#PkgFileParser.get_pkg_files">source code</a></span>
+
+ </td>
+ </tr>
+ </table>
+
+ </td>
+ </tr>
+<tr>
+ <td width="15%" align="right" valign="top" class="summary">
+ <span class="summary-type"> </span>
+ </td><td class="summary">
+ <table width="100%" cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td><span class="summary-sig"><a href="ats3.parsers.PkgFileParser-class.html#get_data_files" class="summary-sig-name">get_data_files</a>(<span class="summary-sig-arg">self</span>,
+ <span class="summary-sig-arg">location</span>=<span class="summary-sig-default">[]</span>,
+ <span class="summary-sig-arg">drive</span>=<span class="summary-sig-default">""</span>,
+ <span class="summary-sig-arg">exclude</span>=<span class="summary-sig-default">""</span>)</span><br />
+ Returns data files, source and destination of the files to be installed
+on the phone
+e.g.</td>
+ <td align="right" valign="top">
+ <span class="codelink"><a href="ats3.parsers-pysrc.html#PkgFileParser.get_data_files">source code</a></span>
+
+ </td>
+ </tr>
+ </table>
+
+ </td>
+ </tr>
+<tr class="private">
+ <td width="15%" align="right" valign="top" class="summary">
+ <span class="summary-type"> </span>
+ </td><td class="summary">
+ <table width="100%" cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td><span class="summary-sig"><a name="__map_pkg_path"></a><span class="summary-sig-name">__map_pkg_path</span>(<span class="summary-sig-arg">self</span>,
+ <span class="summary-sig-arg">pkg_line</span>,
+ <span class="summary-sig-arg">pkg_file_path</span>)</span><br />
+ Parse package file to get the src and dst paths" for installing files</td>
+ <td align="right" valign="top">
+ <span class="codelink"><a href="ats3.parsers-pysrc.html#PkgFileParser.__map_pkg_path">source code</a></span>
+
+ </td>
+ </tr>
+ </table>
+
+ </td>
+ </tr>
+<tr class="private">
+ <td width="15%" align="right" valign="top" class="summary">
+ <span class="summary-type"> </span>
+ </td><td class="summary">
+ <table width="100%" cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td><span class="summary-sig"><a name="__read_pkg_file"></a><span class="summary-sig-name">__read_pkg_file</span>(<span class="summary-sig-arg">self</span>,
+ <span class="summary-sig-arg">pkg_files</span>)</span><br />
+ Reads contents of PKG file</td>
+ <td align="right" valign="top">
+ <span class="codelink"><a href="ats3.parsers-pysrc.html#PkgFileParser.__read_pkg_file">source code</a></span>
+
+ </td>
+ </tr>
+ </table>
+
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2" class="summary">
+ <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
+ <code>__delattr__</code>,
+ <code>__getattribute__</code>,
+ <code>__hash__</code>,
+ <code>__new__</code>,
+ <code>__reduce__</code>,
+ <code>__reduce_ex__</code>,
+ <code>__repr__</code>,
+ <code>__setattr__</code>,
+ <code>__str__</code>
+ </p>
+ </td>
+ </tr>
+</table>
+<!-- ==================== PROPERTIES ==================== -->
+<a name="section-Properties"></a>
+<table class="summary" border="1" cellpadding="3"
+ cellspacing="0" width="100%" bgcolor="white">
+<tr bgcolor="#70b0f0" class="table-header">
+ <td colspan="2" class="table-header">
+ <table border="0" cellpadding="0" cellspacing="0" width="100%">
+ <tr valign="top">
+ <td align="left"><span class="table-header">Properties</span></td>
+ <td align="right" valign="top"
+ ><span class="options">[<a href="#section-Properties"
+ class="privatelink" onclick="toggle_private();"
+ >hide private</a>]</span></td>
+ </tr>
+ </table>
+ </td>
+</tr>
+ <tr>
+ <td colspan="2" class="summary">
+ <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
+ <code>__class__</code>
+ </p>
+ </td>
+ </tr>
+</table>
+<!-- ==================== METHOD DETAILS ==================== -->
+<a name="section-MethodDetails"></a>
+<table class="details" border="1" cellpadding="3"
+ cellspacing="0" width="100%" bgcolor="white">
+<tr bgcolor="#70b0f0" class="table-header">
+ <td colspan="2" class="table-header">
+ <table border="0" cellpadding="0" cellspacing="0" width="100%">
+ <tr valign="top">
+ <td align="left"><span class="table-header">Method Details</span></td>
+ <td align="right" valign="top"
+ ><span class="options">[<a href="#section-MethodDetails"
+ class="privatelink" onclick="toggle_private();"
+ >hide private</a>]</span></td>
+ </tr>
+ </table>
+ </td>
+</tr>
+</table>
+<a name="__init__"></a>
+<div>
+<table class="details" border="1" cellpadding="3"
+ cellspacing="0" width="100%" bgcolor="white">
+<tr><td>
+ <table width="100%" cellpadding="0" cellspacing="0" border="0">
+ <tr valign="top"><td>
+ <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
+ <span class="sig-arg">platform</span>=<span class="sig-default">None</span>)</span>
+ <br /><em class="fname">(Constructor)</em>
+ </h3>
+ </td><td align="right" valign="top"
+ ><span class="codelink"><a href="ats3.parsers-pysrc.html#PkgFileParser.__init__">source code</a></span>
+ </td>
+ </table>
+
+ x.__init__(...) initializes x; see x.__class__.__doc__ for signature
+ <dl class="fields">
+ <dt>Overrides:
+ object.__init__
+ <dd><em class="note">(inherited documentation)</em></dd>
+ </dt>
+ </dl>
+</td></tr></table>
+</div>
+<a name="get_pkg_files"></a>
+<div>
+<table class="details" border="1" cellpadding="3"
+ cellspacing="0" width="100%" bgcolor="white">
+<tr><td>
+ <table width="100%" cellpadding="0" cellspacing="0" border="0">
+ <tr valign="top"><td>
+ <h3 class="epydoc"><span class="sig"><span class="sig-name">get_pkg_files</span>(<span class="sig-arg">self</span>,
+ <span class="sig-arg">location</span>=<span class="sig-default">None</span>,
+ <span class="sig-arg">with_full_path</span>=<span class="sig-default">True</span>)</span>
+ </h3>
+ </td><td align="right" valign="top"
+ ><span class="codelink"><a href="ats3.parsers-pysrc.html#PkgFileParser.get_pkg_files">source code</a></span>
+ </td>
+ </table>
+
+ <pre class="literalblock">
+
+Returns list of PKG files on the given location. If True, full path is returned
+otherwise only filenames. Default is set to True
+
+Assume at location "c:bd iles", two pkg file '1.pkg' and '2.pkg', then the funtion
+can be called as:
+1. get_pkg_files("c:bd iles") - will return a list of pkg files with full paths.
+ like ['c:bd iles.pkg', 'c:bd iles.pkg']
+2. get_pkg_files("c:bd iles", False) - will return a list of pkg files only.
+ like ['1.pkg', '2.pkg']
+
+</pre>
+ <dl class="fields">
+ </dl>
+</td></tr></table>
+</div>
+<a name="get_data_files"></a>
+<div>
+<table class="details" border="1" cellpadding="3"
+ cellspacing="0" width="100%" bgcolor="white">
+<tr><td>
+ <table width="100%" cellpadding="0" cellspacing="0" border="0">
+ <tr valign="top"><td>
+ <h3 class="epydoc"><span class="sig"><span class="sig-name">get_data_files</span>(<span class="sig-arg">self</span>,
+ <span class="sig-arg">location</span>=<span class="sig-default">[]</span>,
+ <span class="sig-arg">drive</span>=<span class="sig-default">""</span>,
+ <span class="sig-arg">exclude</span>=<span class="sig-default">""</span>)</span>
+ </h3>
+ </td><td align="right" valign="top"
+ ><span class="codelink"><a href="ats3.parsers-pysrc.html#PkgFileParser.get_data_files">source code</a></span>
+ </td>
+ </table>
+
+ <pre class="literalblock">
+
+Returns data files, source and destination of the files to be installed
+on the phone
+e.g. location = tsrc estComponent\group
+
+Function can be called in any of the following ways:
+1. get_data_files("c:bcbc.pkg") - only data files' paths are returnd
+ as they are mention in the pkg file
+2. get_data_files("c:bcbc.pkg", "x:") - Proper data files' paths are returnd
+ with drive letter included
+3. get_data_files("c:bcbc.pkg", "x:", "\.dll") - Data files' paths are returnd with
+ drive letter included but the dll
+ files will be excluded if found in
+ the pkg file
+
+if pkg file is not given, the function will try to find the file(s) on the given location with extension ".pkg"
+
+</pre>
+ <dl class="fields">
+ </dl>
+</td></tr></table>
+</div>
+<br />
+<!-- ==================== NAVIGATION BAR ==================== -->
+<table class="navbar" border="0" width="100%" cellpadding="0"
+ bgcolor="#a0c0ff" cellspacing="0">
+ <tr valign="middle">
+
+ <!-- Tree link -->
+ <th> <a
+ href="module-tree.html">Trees</a> </th>
+
+ <!-- Index link -->
+ <th> <a
+ href="identifier-index.html">Indices</a> </th>
+
+ <!-- Help link -->
+ <th> <a
+ href="help.html">Help</a> </th>
+
+ <th class="navbar" width="100%"></th>
+ </tr>
+</table>
+<table border="0" cellpadding="0" cellspacing="0" width="100%%">
+ <tr>
+ <td align="left" class="footer">
+ Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:17 2009
+ </td>
+ <td align="right" class="footer">
+ <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
+ </td>
+ </tr>
+</table>
+
+<script type="text/javascript">
+ <!--
+ // Private objects are initially displayed (because if
+ // javascript is turned off then we want them to be
+ // visible); but by default, we want to hide them. So hide
+ // them unless we have a cookie that says to show them.
+ checkCookie()
+ // -->
+</script>
+
+</body>
+</html>