<?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>web2py.gluon.custom_import._Web2pyImporter</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">
<!-- Home link -->
<th> <a
href="web2py.gluon-module.html">Home</a> </th>
<!-- 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>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://www.web2py.com">web2py Web Framework</a></th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
Package web2py ::
<a href="web2py.gluon-module.html">Package gluon</a> ::
<a href="web2py.gluon.custom_import-module.html">Module custom_import</a> ::
Class _Web2pyImporter
</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="web2py.gluon.custom_import._Web2pyImporter-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class _Web2pyImporter</h1><span class="codelink"><a href="web2py.gluon.custom_import-pysrc.html#_Web2pyImporter">source code</a></span><br /><br />
<pre class="base-tree">
object --+
|
<a href="web2py.gluon.custom_import._BaseImporter-class.html">_BaseImporter</a> --+
|
<strong class="uidshort">_Web2pyImporter</strong>
</pre>
<dl><dt>Known Subclasses:</dt>
<dd>
<a href="web2py.gluon.custom_import._Web2pyDateTrackerImporter-class.html">_Web2pyDateTrackerImporter</a>
</dd></dl>
<hr />
The standard web2py importer. Like the standard Python importer but it
tries to transform import statements as something like "import
applications.app_name.modules.x". If the import failed, fall back on
_BaseImporter.<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="web2py.gluon.custom_import._Web2pyImporter-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">web2py_path</span>)</span><br />
x.__init__(...) initializes x; see x.__class__.__doc__ for
signature</td>
<td align="right" valign="top">
<span class="codelink"><a href="web2py.gluon.custom_import-pysrc.html#_Web2pyImporter.__init__">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="_matchAppDir"></a><span class="summary-sig-name">_matchAppDir</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">file_path</span>)</span><br />
Does the file in a directory inside the "applications"
directory?</td>
<td align="right" valign="top">
<span class="codelink"><a href="web2py.gluon.custom_import-pysrc.html#_Web2pyImporter._matchAppDir">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="web2py.gluon.custom_import._Web2pyImporter-class.html#__call__" class="summary-sig-name">__call__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">name</span>,
<span class="summary-sig-arg">globals</span>=<span class="summary-sig-default"><code class="variable-group">{</code><code class="variable-group">}</code></span>,
<span class="summary-sig-arg">locals</span>=<span class="summary-sig-default"><code class="variable-group">{</code><code class="variable-group">}</code></span>,
<span class="summary-sig-arg">fromlist</span>=<span class="summary-sig-default"><code class="variable-group">[</code><code class="variable-group">]</code></span>,
<span class="summary-sig-arg">level</span>=<span class="summary-sig-default">-1</span>)</span><br />
The import method itself.</td>
<td align="right" valign="top">
<span class="codelink"><a href="web2py.gluon.custom_import-pysrc.html#_Web2pyImporter.__call__">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="web2py.gluon.custom_import._Web2pyImporter-class.html#__import__dot" class="summary-sig-name">__import__dot</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">prefix</span>,
<span class="summary-sig-arg">name</span>,
<span class="summary-sig-arg">globals</span>,
<span class="summary-sig-arg">locals</span>,
<span class="summary-sig-arg">fromlist</span>,
<span class="summary-sig-arg">level</span>)</span><br />
Here we will import x.y.z as many imports like: from
applications.app_name.modules import x from
applications.app_name.modules.x import y from
applications.app_name.modules.x.y import z.</td>
<td align="right" valign="top">
<span class="codelink"><a href="web2py.gluon.custom_import-pysrc.html#_Web2pyImporter.__import__dot">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="web2py.gluon.custom_import._Web2pyImporter-class.html#_Web2pyImporter__import__dot" class="summary-sig-name">_Web2pyImporter__import__dot</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">prefix</span>,
<span class="summary-sig-arg">name</span>,
<span class="summary-sig-arg">globals</span>,
<span class="summary-sig-arg">locals</span>,
<span class="summary-sig-arg">fromlist</span>,
<span class="summary-sig-arg">level</span>)</span><br />
Here we will import x.y.z as many imports like: from
applications.app_name.modules import x from
applications.app_name.modules.x import y from
applications.app_name.modules.x.y import z.</td>
<td align="right" valign="top">
<span class="codelink"><a href="web2py.gluon.custom_import-pysrc.html#_Web2pyImporter._Web2pyImporter__import__dot">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="web2py.gluon.custom_import._BaseImporter-class.html">_BaseImporter</a></code></b>:
<code><a href="web2py.gluon.custom_import._BaseImporter-class.html#begin">begin</a></code>,
<code><a href="web2py.gluon.custom_import._BaseImporter-class.html#end">end</a></code>
</p>
<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>
<!-- ==================== CLASS VARIABLES ==================== -->
<a name="section-ClassVariables"></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">Class Variables</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-ClassVariables"
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="_RE_ESCAPED_PATH_SEP"></a><span class="summary-name">_RE_ESCAPED_PATH_SEP</span> = <code title="'\\/'"><code class="variable-quote">'</code><code class="variable-string">\\/</code><code class="variable-quote">'</code></code>
</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">web2py_path</span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="web2py.gluon.custom_import-pysrc.html#_Web2pyImporter.__init__">source code</a></span>
</td>
</table>
x.__init__(...) initializes x; see x.__class__.__doc__ for
signature
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>web2py_path</code></strong> - The absolute path of the web2py installation.</li>
</ul></dd>
<dt>Overrides:
object.__init__
</dt>
</dl>
</td></tr></table>
</div>
<a name="__call__"></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">__call__</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">name</span>,
<span class="sig-arg">globals</span>=<span class="sig-default"><code class="variable-group">{</code><code class="variable-group">}</code></span>,
<span class="sig-arg">locals</span>=<span class="sig-default"><code class="variable-group">{</code><code class="variable-group">}</code></span>,
<span class="sig-arg">fromlist</span>=<span class="sig-default"><code class="variable-group">[</code><code class="variable-group">]</code></span>,
<span class="sig-arg">level</span>=<span class="sig-default">-1</span>)</span>
<br /><em class="fname">(Call operator)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="web2py.gluon.custom_import-pysrc.html#_Web2pyImporter.__call__">source code</a></span>
</td>
</table>
The import method itself.
<dl class="fields">
<dt>Overrides:
<a href="web2py.gluon.custom_import._BaseImporter-class.html#__call__">_BaseImporter.__call__</a>
</dt>
</dl>
</td></tr></table>
</div>
<a name="__import__dot"></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">__import__dot</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">prefix</span>,
<span class="sig-arg">name</span>,
<span class="sig-arg">globals</span>,
<span class="sig-arg">locals</span>,
<span class="sig-arg">fromlist</span>,
<span class="sig-arg">level</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="web2py.gluon.custom_import-pysrc.html#_Web2pyImporter.__import__dot">source code</a></span>
</td>
</table>
Here we will import x.y.z as many imports like: from
applications.app_name.modules import x from
applications.app_name.modules.x import y from
applications.app_name.modules.x.y import z. x will be the module
returned.
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="_Web2pyImporter__import__dot"></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">_Web2pyImporter__import__dot</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">prefix</span>,
<span class="sig-arg">name</span>,
<span class="sig-arg">globals</span>,
<span class="sig-arg">locals</span>,
<span class="sig-arg">fromlist</span>,
<span class="sig-arg">level</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="web2py.gluon.custom_import-pysrc.html#_Web2pyImporter._Web2pyImporter__import__dot">source code</a></span>
</td>
</table>
Here we will import x.y.z as many imports like: from
applications.app_name.modules import x from
applications.app_name.modules.x import y from
applications.app_name.modules.x.y import z. x will be the module
returned.
<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">
<!-- Home link -->
<th> <a
href="web2py.gluon-module.html">Home</a> </th>
<!-- 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>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://www.web2py.com">web2py Web Framework</a></th>
</tr></table></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0beta1 on Thu Aug 4 00:47:00 2011
</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>