Sophie

Sophie

distrib > Mandriva > 2010.1 > x86_64 > media > contrib-release > by-pkgid > 2eca861f24be6048290ed27335ec22aa > files > 1209

flumotion-doc-0.6.1-1mdv2010.0.x86_64.rpm

<?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.manager.config</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>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</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&nbsp;flumotion ::
        <a href="flumotion.manager-module.html">Package&nbsp;manager</a> ::
        Module&nbsp;config
      </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&nbsp;private</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== MODULE DESCRIPTION ==================== -->
<h1 class="epydoc">Module config</h1><p class="nomargin-top"><span class="codelink"><a href="flumotion.manager.config-pysrc.html">source&nbsp;code</a></span></p>
<p>parsing of manager configuration files</p>

<hr />
<div class="fields">      <p><strong>Version:</strong>
        $Rev: 7669 $
      </p>
</div><!-- ==================== CLASSES ==================== -->
<a name="section-Classes"></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">Classes</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Classes"
         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">&nbsp;</span>
    </td><td class="summary">
        <a href="flumotion.manager.config.ConfigEntryComponent-class.html" class="summary-name">ConfigEntryComponent</a><br />
      I represent a &lt;component&gt; entry in a planet config file
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="flumotion.manager.config.ConfigEntryFlow-class.html" class="summary-name">ConfigEntryFlow</a><br />
      I represent a &lt;flow&gt; entry in a planet config file
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="flumotion.manager.config.ConfigEntryManager-class.html" class="summary-name">ConfigEntryManager</a><br />
      I represent a &lt;manager&gt; entry in a planet config file
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="flumotion.manager.config.ConfigEntryAtmosphere-class.html" class="summary-name">ConfigEntryAtmosphere</a><br />
      I represent a &lt;atmosphere&gt; entry in a planet config file
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="flumotion.manager.config.FlumotionConfigParser-class.html" class="summary-name">FlumotionConfigParser</a><br />
      This is a base class for parsing planet configuration files (both 
        manager and flow files).
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="flumotion.manager.config.PlanetConfigParser-class.html" class="summary-name">PlanetConfigParser</a><br />
      I represent a planet configuration file for Flumotion.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="flumotion.manager.config.ManagerConfigParser-class.html" class="summary-name">ManagerConfigParser</a><br />
      I parse manager configuration out of a planet configuration file.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="flumotion.manager.config.PlanetXMLWriter-class.html" class="summary-name">PlanetXMLWriter</a>
    </td>
  </tr>
</table>
<!-- ==================== FUNCTIONS ==================== -->
<a name="section-Functions"></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">Functions</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Functions"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="_ignore"></a><span class="summary-sig-name">_ignore</span>(<span class="summary-sig-arg">*args</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="flumotion.manager.config-pysrc.html#_ignore">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="upgradeEaters"></a><span class="summary-sig-name">upgradeEaters</span>(<span class="summary-sig-arg">conf</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="flumotion.manager.config-pysrc.html#upgradeEaters">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="upgradeAliases"></a><span class="summary-sig-name">upgradeAliases</span>(<span class="summary-sig-arg">conf</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="flumotion.manager.config-pysrc.html#upgradeAliases">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="flumotion.manager.config-module.html#buildEatersDict" class="summary-sig-name">buildEatersDict</a>(<span class="summary-sig-arg">eatersList</span>,
        <span class="summary-sig-arg">eaterDefs</span>)</span><br />
      Build a eaters dict suitable for forming part of a component config.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="flumotion.manager.config-pysrc.html#buildEatersDict">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="flumotion.manager.config-module.html#buildVirtualFeeds" class="summary-sig-name">buildVirtualFeeds</a>(<span class="summary-sig-arg">feedPairs</span>,
        <span class="summary-sig-arg">feeders</span>)</span><br />
      Build a virtual feeds dict suitable for forming part of a component 
      config.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="flumotion.manager.config-pysrc.html#buildVirtualFeeds">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="flumotion.manager.config-module.html#dictDiff" class="summary-sig-name">dictDiff</a>(<span class="summary-sig-arg">old</span>,
        <span class="summary-sig-arg">new</span>,
        <span class="summary-sig-arg">onlyOld</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">onlyNew</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">diff</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">keyBase</span>=<span class="summary-sig-default">None</span>)</span><br />
      Compute the difference between two config dicts.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="flumotion.manager.config-pysrc.html#dictDiff">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="dictDiffMessageString"></a><span class="summary-sig-name">dictDiffMessageString</span>(<span class="summary-sig-arg">(old, new, diff)</span>,
        <span class="summary-sig-arg">oldLabel</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">old</code><code class="variable-quote">'</code></span>,
        <span class="summary-sig-arg">newLabel</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">new</code><code class="variable-quote">'</code></span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="flumotion.manager.config-pysrc.html#dictDiffMessageString">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="exportPlanetXml"></a><span class="summary-sig-name">exportPlanetXml</span>(<span class="summary-sig-arg">p</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="flumotion.manager.config-pysrc.html#exportPlanetXml">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
</table>
<!-- ==================== VARIABLES ==================== -->
<a name="section-Variables"></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">Variables</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Variables"
         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">&nbsp;</span>
    </td><td class="summary">
        <a name="UPGRADERS"></a><span class="summary-name">UPGRADERS</span> = <code title="[upgradeEaters, upgradeAliases]">[upgradeEaters, upgradeAliases]</code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="CURRENT_VERSION"></a><span class="summary-name">CURRENT_VERSION</span> = <code title="2">2</code><br />
      hash(x)
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="__package__"></a><span class="summary-name">__package__</span> = <code title="None">None</code><br />
      hash(x)
    </td>
  </tr>
</table>
<!-- ==================== FUNCTION DETAILS ==================== -->
<a name="section-FunctionDetails"></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">Function Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-FunctionDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="buildEatersDict"></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">buildEatersDict</span>(<span class="sig-arg">eatersList</span>,
        <span class="sig-arg">eaterDefs</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="flumotion.manager.config-pysrc.html#buildEatersDict">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Build a eaters dict suitable for forming part of a component 
  config.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>eatersList</code></strong> (List of (eaterName, feedId, eaterAlias?)) - List of eaters. For example, [('default', 'othercomp:feeder', 
          'foo')] says that our eater 'default' will be fed by the feed 
          identified by the feedId 'othercomp:feeder', and that it has the 
          alias 'foo'. Alias is optional.</li>
        <li><strong class="pname"><code>eaterDefs</code></strong> (List of <a 
          href="flumotion.common.registry.RegistryEntryEater-class.html" 
          class="link" 
          onclick="show_private();">flumotion.common.registry.RegistryEntryEater</a>) - The set of allowed and required eaters</li>
    </ul></dd>
    <dt>Returns:</dt>
        <dd>Dict of eaterName =&gt; [(feedId, eaterAlias)]</dd>
  </dl>
</td></tr></table>
</div>
<a name="buildVirtualFeeds"></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">buildVirtualFeeds</span>(<span class="sig-arg">feedPairs</span>,
        <span class="sig-arg">feeders</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="flumotion.manager.config-pysrc.html#buildVirtualFeeds">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Build a virtual feeds dict suitable for forming part of a component 
  config.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>feedPairs</code></strong> (List of (feedId, feedName) -- both strings.) - List of virtual feeds, as name-feederName pairs. For example, 
          [('bar:baz', 'qux')] defines one virtual feed 'bar:baz', which is
          provided by the component's 'qux' feed.</li>
        <li><strong class="pname"><code>feeders</code></strong> (List of str.) - The feeders exported by this component, from the registry.</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="dictDiff"></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">dictDiff</span>(<span class="sig-arg">old</span>,
        <span class="sig-arg">new</span>,
        <span class="sig-arg">onlyOld</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">onlyNew</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">diff</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">keyBase</span>=<span class="sig-default">None</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="flumotion.manager.config-pysrc.html#dictDiff">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Compute the difference between two config dicts.</p>
  <dl class="fields">
    <dt>Returns:</dt>
        <dd>3 tuple: (onlyOld, onlyNew, diff) where: onlyOld is a list of 
          (key, value), representing key-value pairs that are only in old; 
          onlyNew is a list of (key, value), representing key-value pairs 
          that are only in new; diff is a list of (key, oldValue, 
          newValue), representing keys with different values in old and 
          new; and key is a tuple of strings representing the recursive key
          to get to a value. For example, ('foo', 'bar') represents the 
          value d['foo']['bar'] on a dict d.</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>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</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 Sun Sep 13 13:13:57 2009
    </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>