<?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.package</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 package
</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 package</h1><p class="nomargin-top"><span class="codelink"><a href="flumotion.common.package-pysrc.html">source code</a></span></p>
<p>objects and functions used in dealing with packages</p>
<hr />
<div class="fields"> <p><strong>Version:</strong>
$Rev: 7927 $
</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.package._PatchedModuleImporter-class.html" class="summary-name" onclick="show_private();">_PatchedModuleImporter</a><br />
I am overriding ihook's ModuleImporter's import_module() method to
accept (and ignore) the 'level' keyword argument that appeared in
the built-in __import__() function in python2.5.
</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.package.PackageHooks-class.html" class="summary-name">PackageHooks</a><br />
I am an import Hooks object that makes sure that every package that
gets loaded has every necessary path in the module's __path__ list.
</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.package.Packager-class.html" class="summary-name">Packager</a><br />
I am an object through which package paths can be registered, to
support the partitioning of the module import namespace across
bundles.
</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 href="flumotion.common.package-module.html#_listDirRecursively" class="summary-sig-name" onclick="show_private();">_listDirRecursively</a>(<span class="summary-sig-arg">path</span>)</span><br />
I'm similar to os.listdir, but I work recursively and only return
directories containing python code.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.common.package-pysrc.html#_listDirRecursively">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">list</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="flumotion.common.package-module.html#_listPyFileRecursively" class="summary-sig-name" onclick="show_private();">_listPyFileRecursively</a>(<span class="summary-sig-arg">path</span>)</span><br />
I'm similar to os.listdir, but I work recursively and only return
files representing python non-package modules.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.common.package-pysrc.html#_listPyFileRecursively">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.package-module.html#_findPackageCandidates" class="summary-sig-name" onclick="show_private();">_findPackageCandidates</a>(<span class="summary-sig-arg">path</span>,
<span class="summary-sig-arg">prefix</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">flumotion</code><code class="variable-quote">'</code></span>)</span><br />
I take a directory and return a list of candidate python packages
under that directory that start with the given prefix.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.common.package-pysrc.html#_findPackageCandidates">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.package-module.html#findEndModuleCandidates" class="summary-sig-name">findEndModuleCandidates</a>(<span class="summary-sig-arg">path</span>,
<span class="summary-sig-arg">prefix</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">flumotion</code><code class="variable-quote">'</code></span>)</span><br />
I take a directory and return a list of candidate python end modules
(i.e., non-package modules) for the given module prefix.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.common.package-pysrc.html#findEndModuleCandidates">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><a href="flumotion.common.package.Packager-class.html"
class="link">Packager</a></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="getPackager"></a><span class="summary-sig-name">getPackager</span>()</span><br />
Return the (unique) packager.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.common.package-pysrc.html#getPackager">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="__packager"></a><span class="summary-name">__packager</span> = <code title="None">None</code>
</td>
</tr>
<tr>
<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="_listDirRecursively"></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">_listDirRecursively</span>(<span class="sig-arg">path</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.common.package-pysrc.html#_listDirRecursively">source code</a></span>
</td>
</tr></table>
<p>I'm similar to os.listdir, but I work recursively and only return
directories containing python code.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>path</code></strong> (string) - the path</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="_listPyFileRecursively"></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">_listPyFileRecursively</span>(<span class="sig-arg">path</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.common.package-pysrc.html#_listPyFileRecursively">source code</a></span>
</td>
</tr></table>
<p>I'm similar to os.listdir, but I work recursively and only return
files representing python non-package modules.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>path</code></strong> (string) - the path</li>
</ul></dd>
<dt>Returns: list</dt>
<dd>list of files underneath the given path containing python code</dd>
</dl>
</td></tr></table>
</div>
<a name="_findPackageCandidates"></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">_findPackageCandidates</span>(<span class="sig-arg">path</span>,
<span class="sig-arg">prefix</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">flumotion</code><code class="variable-quote">'</code></span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.common.package-pysrc.html#_findPackageCandidates">source code</a></span>
</td>
</tr></table>
<p>I take a directory and return a list of candidate python packages
under that directory that start with the given prefix. A package is a
module containing modules; typically the directory with the same name as
the package contains __init__.py</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>path</code></strong> (string) - the path</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="findEndModuleCandidates"></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">findEndModuleCandidates</span>(<span class="sig-arg">path</span>,
<span class="sig-arg">prefix</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">flumotion</code><code class="variable-quote">'</code></span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.common.package-pysrc.html#findEndModuleCandidates">source code</a></span>
</td>
</tr></table>
<p>I take a directory and return a list of candidate python end modules
(i.e., non-package modules) for the given module prefix.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>path</code></strong> (string) - the path under which to search for end modules</li>
<li><strong class="pname"><code>prefix</code></strong> (string) - module prefix to check candidates under</li>
</ul></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 Sun Sep 13 13:13:56 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>
distrib
>
Mandriva
>
2010.1
>
x86_64
>
media
>
contrib-release
>
by-pkgid
>
2eca861f24be6048290ed27335ec22aa
>
files
>
387
