<?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.registry</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> ::
Module registry
</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>
<!-- ==================== MODULE DESCRIPTION ==================== -->
<h1 class="epydoc">Module registry</h1><p class="nomargin-top"><span class="codelink"><a href="flumotion.common.registry-pysrc.html">source code</a></span></p>
<p>parsing of registry, which holds component and bundle information</p>
<hr />
<div class="fields"> <p><strong>Version:</strong>
$Rev: 7991 $
</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 class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="flumotion.common.registry.RegistryEntryScenario-class.html" class="summary-name" onclick="show_private();">RegistryEntryScenario</a><br />
I represent a <scenario> entry in the registry
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="flumotion.common.registry.RegistryEntryComponent-class.html" class="summary-name" onclick="show_private();">RegistryEntryComponent</a><br />
I represent a <component> entry in the registry
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="flumotion.common.registry.RegistryEntryPlug-class.html" class="summary-name" onclick="show_private();">RegistryEntryPlug</a><br />
I represent a <plug> entry in the registry
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="flumotion.common.registry.RegistryEntryBundle-class.html" class="summary-name" onclick="show_private();">RegistryEntryBundle</a><br />
This class represents a <bundle> entry in the registry
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="flumotion.common.registry.RegistryEntryBundleDirectory-class.html" class="summary-name" onclick="show_private();">RegistryEntryBundleDirectory</a><br />
This class represents a <directory> entry in the registry
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="flumotion.common.registry.RegistryEntryBundleFilename-class.html" class="summary-name" onclick="show_private();">RegistryEntryBundleFilename</a><br />
This class represents a <filename> entry in the registry
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="flumotion.common.registry.RegistryEntryProperty-class.html" class="summary-name" onclick="show_private();">RegistryEntryProperty</a><br />
This class represents a <property> entry in the registry
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="flumotion.common.registry.RegistryEntryCompoundProperty-class.html" class="summary-name" onclick="show_private();">RegistryEntryCompoundProperty</a><br />
This class represents a <compound-property> entry in the
registry
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="flumotion.common.registry.RegistryEntryFile-class.html" class="summary-name" onclick="show_private();">RegistryEntryFile</a><br />
This class represents a <file> entry in the registry
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="flumotion.common.registry.RegistryEntryEntry-class.html" class="summary-name" onclick="show_private();">RegistryEntryEntry</a><br />
This class represents a <entry> entry in the registry
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="flumotion.common.registry.RegistryEntryEater-class.html" class="summary-name" onclick="show_private();">RegistryEntryEater</a><br />
This class represents a <eater> entry in the registry
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="flumotion.common.registry.RegistryEntryWizard-class.html" class="summary-name" onclick="show_private();">RegistryEntryWizard</a><br />
This class represents a <wizard> entry in the registry
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="flumotion.common.registry.RegistryEntryWizardFormat-class.html" class="summary-name" onclick="show_private();">RegistryEntryWizardFormat</a><br />
This class represents an <accept-format> or
<provide-format> entry in the registry
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="flumotion.common.registry.RegistryParser-class.html" class="summary-name" onclick="show_private();">RegistryParser</a><br />
Registry parser
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="flumotion.common.registry.RegistryDirectory-class.html" class="summary-name" onclick="show_private();">RegistryDirectory</a><br />
I represent a directory under a path managed by the registry.
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="flumotion.common.registry.RegistryWriter-class.html" class="summary-name" onclick="show_private();">RegistryWriter</a>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="flumotion.common.registry.ComponentRegistry-class.html" class="summary-name">ComponentRegistry</a><br />
Registry, this is normally not instantiated.
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="flumotion.common.registry.RegistrySubsetWriter-class.html" class="summary-name" onclick="show_private();">RegistrySubsetWriter</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"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_getMTime"></a><span class="summary-sig-name">_getMTime</span>(<span class="summary-sig-arg">file</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.common.registry-pysrc.html#_getMTime">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 href="flumotion.common.registry-module.html#makeBundleFromLoadedModules" class="summary-sig-name" onclick="show_private();">makeBundleFromLoadedModules</a>(<span class="summary-sig-arg">outfile</span>,
<span class="summary-sig-arg">outreg</span>,
<span class="summary-sig-arg">*prefixes</span>)</span><br />
Make a bundle from a subset of all loaded modules, also writing out a
registry file that can apply to that subset of the global registry.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.common.registry-pysrc.html#makeBundleFromLoadedModules">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"><a href="flumotion.common.registry.ComponentRegistry-class.html"
class="link">ComponentRegistry</a></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="flumotion.common.registry-module.html#getRegistry" class="summary-sig-name" onclick="show_private();">getRegistry</a>()</span><br />
Return the registry.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.common.registry-pysrc.html#getRegistry">source 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 class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="READ_CACHE"></a><span class="summary-name">READ_CACHE</span> = <code title="False">False</code>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="flumotion.common.registry-module.html#_VALID_WIZARD_COMPONENT_TYPES" class="summary-name" onclick="show_private();">_VALID_WIZARD_COMPONENT_TYPES</a> = <code title="['audio-producer',
'video-producer',
'muxer',
'audio-encoder',
'video-encoder']"><code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">audio-producer</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">video-prod</code><code class="variable-ellipsis">...</code></code>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="_VALID_WIZARD_PLUG_TYPES"></a><span class="summary-name">_VALID_WIZARD_PLUG_TYPES</span> = <code title="['http-consumer']"><code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">http-consumer</code><code class="variable-quote">'</code><code class="variable-group">]</code></code>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="__registry"></a><span class="summary-name">__registry</span> = <code title="None">None</code><br />
hash(x)
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="__package__"></a><span class="summary-name">__package__</span> = <code title="'flumotion.common'"><code class="variable-quote">'</code><code class="variable-string">flumotion.common</code><code class="variable-quote">'</code></code>
</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="makeBundleFromLoadedModules"></a>
<div class="private">
<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">makeBundleFromLoadedModules</span>(<span class="sig-arg">outfile</span>,
<span class="sig-arg">outreg</span>,
<span class="sig-arg">*prefixes</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.common.registry-pysrc.html#makeBundleFromLoadedModules">source code</a></span>
</td>
</tr></table>
<p>Make a bundle from a subset of all loaded modules, also writing out a
registry file that can apply to that subset of the global registry.
Suitable for use as a FLU_ATEXIT handler.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>outfile</code></strong> (str) - The path to which a zip file will be written.</li>
<li><strong class="pname"><code>outreg</code></strong> (str) - The path to which a registry file will be written.</li>
<li><strong class="pname"><code>prefixes</code></strong> (list of str) - A list of prefixes to which to limit the export. If not given,
package up all modules. For example, "flumotion" would
limit the output to modules that start with
"flumotion".</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="getRegistry"></a>
<div class="private">
<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">getRegistry</span>()</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.common.registry-pysrc.html#getRegistry">source code</a></span>
</td>
</tr></table>
<p>Return the registry. Only one registry will ever be created.</p>
<dl class="fields">
<dt>Returns: <a href="flumotion.common.registry.ComponentRegistry-class.html"
class="link">ComponentRegistry</a></dt>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== VARIABLES DETAILS ==================== -->
<a name="section-VariablesDetails"></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">Variables Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-VariablesDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="_VALID_WIZARD_COMPONENT_TYPES"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">_VALID_WIZARD_COMPONENT_TYPES</h3>
<dl class="fields">
</dl>
<dl class="fields">
<dt>Value:</dt>
<dd><table><tr><td><pre class="variable">
<code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">audio-producer</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">video-producer</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">muxer</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">audio-encoder</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">video-encoder</code><code class="variable-quote">'</code><code class="variable-group">]</code>
</pre></td></tr></table>
</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:11 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>
