<?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>flumotion.common.bundle.BundlerBasket</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">
Package flumotion ::
<a href="flumotion.common-module.html">Package common</a> ::
<a href="flumotion.common.bundle-module.html">Module bundle</a> ::
Class BundlerBasket
</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>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class BundlerBasket</h1><p class="nomargin-top"><span class="codelink"><a href="flumotion.common.bundle-pysrc.html#BundlerBasket">source code</a></span></p>
<p>I manage bundlers that are registered through me.</p>
<!-- ==================== 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 name="__init__"></a><span class="summary-sig-name">__init__</span>(<span class="summary-sig-arg">self</span>)</span><br />
Create a new bundler basket.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.common.bundle-pysrc.html#BundlerBasket.__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="flumotion.common.bundle.BundlerBasket-class.html#add" class="summary-sig-name">add</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">bundleName</span>,
<span class="summary-sig-arg">source</span>,
<span class="summary-sig-arg">destination</span>=<span class="summary-sig-default">None</span>)</span><br />
Add files to the bundler basket for the given bundle.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.common.bundle-pysrc.html#BundlerBasket.add">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="flumotion.common.bundle.BundlerBasket-class.html#depend" class="summary-sig-name">depend</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">depender</span>,
<span class="summary-sig-arg">*dependencies</span>)</span><br />
Make the given bundle depend on the other given bundles.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.common.bundle-pysrc.html#BundlerBasket.depend">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="flumotion.common.bundle.BundlerBasket-class.html#getDependencies" class="summary-sig-name">getDependencies</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">bundlerName</span>)</span><br />
Return names of all the dependencies of this bundle, including this
bundle itself.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.common.bundle-pysrc.html#BundlerBasket.getDependencies">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 name="getBundlerByName"></a><span class="summary-sig-name">getBundlerByName</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">bundlerName</span>)</span><br />
Return the bundle by name, or None if not found.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.common.bundle-pysrc.html#BundlerBasket.getBundlerByName">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 name="getBundlerNameByImport"></a><span class="summary-sig-name">getBundlerNameByImport</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">importString</span>)</span><br />
Return the bundler name by import statement, or None if not found.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.common.bundle-pysrc.html#BundlerBasket.getBundlerNameByImport">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 name="getBundlerNameByFile"></a><span class="summary-sig-name">getBundlerNameByFile</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">filename</span>)</span><br />
Return the bundler name by filename, or None if not found.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.common.bundle-pysrc.html#BundlerBasket.getBundlerNameByFile">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">list of str</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="flumotion.common.bundle.BundlerBasket-class.html#getBundlerNames" class="summary-sig-name">getBundlerNames</a>(<span class="summary-sig-arg">self</span>)</span><br />
Get all bundler names.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.common.bundle-pysrc.html#BundlerBasket.getBundlerNames">source code</a></span>
</td>
</tr>
</table>
</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="add"></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">add</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">bundleName</span>,
<span class="sig-arg">source</span>,
<span class="sig-arg">destination</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.common.bundle-pysrc.html#BundlerBasket.add">source code</a></span>
</td>
</tr></table>
<p>Add files to the bundler basket for the given bundle.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>bundleName</code></strong> - the name of the bundle this file is a part of</li>
<li><strong class="pname"><code>source</code></strong> - the path to the file to add to the bundle</li>
<li><strong class="pname"><code>destination</code></strong> - a relative path to store this file in the bundle. If unspecified,
this will be stored in the top level</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="depend"></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">depend</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">depender</span>,
<span class="sig-arg">*dependencies</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.common.bundle-pysrc.html#BundlerBasket.depend">source code</a></span>
</td>
</tr></table>
<p>Make the given bundle depend on the other given bundles.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>depender</code></strong> (string)</li>
<li><strong class="pname"><code>dependencies</code></strong> (list of strings)</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="getDependencies"></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">getDependencies</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">bundlerName</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.common.bundle-pysrc.html#BundlerBasket.getDependencies">source code</a></span>
</td>
</tr></table>
<p>Return names of all the dependencies of this bundle, including this
bundle itself. The dependencies are returned in a correct depending
order.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="getBundlerNames"></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">getBundlerNames</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.common.bundle-pysrc.html#BundlerBasket.getBundlerNames">source code</a></span>
</td>
</tr></table>
<p>Get all bundler names.</p>
<dl class="fields">
<dt>Returns: list of str</dt>
<dd>a list of all bundler names in this basket.</dd>
</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.0.1 on Wed Aug 11 21:33:13 2010
</td>
<td align="right" class="footer">
<a target="mainFrame" 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>
