eric7/Documentation/Source/eric7.DebugClients.Python.ModuleLoader.html

<!DOCTYPE html>
<html><head>
<title>eric7.DebugClients.Python.ModuleLoader</title>
<meta charset="UTF-8">
<style>
body {
    background: #EDECE6;
    margin: 0em 1em 10em 1em;
    color: black;
}

h1 { color: white; background: #85774A; }
h2 { color: white; background: #85774A; }
h3 { color: white; background: #9D936E; }
h4 { color: white; background: #9D936E; }
    
a { color: #BA6D36; }

</style>
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.DebugClients.Python.ModuleLoader</h1>

<p>
Module implementing an import hook patching modules to support debugging.
</p>
<h3>Global Attributes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>

<table>

<tr>
<td><a href="#ModuleLoader">ModuleLoader</a></td>
<td>Class implementing an import hook patching modules to support debugging.</td>
</tr>
</table>
<h3>Functions</h3>

<table>
<tr><td>None</td></tr>
</table>
<hr />
<hr />
<a NAME="ModuleLoader" ID="ModuleLoader"></a>
<h2>ModuleLoader</h2>

<p>
    Class implementing an import hook patching modules to support debugging.
</p>
<h3>Derived from</h3>
None
<h3>Class Attributes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Class Methods</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>

<table>

<tr>
<td><a href="#ModuleLoader.__init__">ModuleLoader</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#ModuleLoader.__loadModule">__loadModule</a></td>
<td>Private method to load a module.</td>
</tr>
<tr>
<td><a href="#ModuleLoader.create_module">create_module</a></td>
<td>Public method to create a module based on the passed in spec.</td>
</tr>
<tr>
<td><a href="#ModuleLoader.exec_module">exec_module</a></td>
<td>Public method to execute the created module.</td>
</tr>
<tr>
<td><a href="#ModuleLoader.find_spec">find_spec</a></td>
<td>Public method returning the module spec.</td>
</tr>
</table>
<h3>Static Methods</h3>

<table>
<tr><td>None</td></tr>
</table>

<a NAME="ModuleLoader.__init__" ID="ModuleLoader.__init__"></a>
<h4>ModuleLoader (Constructor)</h4>
<b>ModuleLoader</b>(<i>debugClient</i>)

<p>
        Constructor
</p>
<dl>

<dt><i>debugClient</i> (DebugClient)</dt>
<dd>
reference to the debug client object
</dd>
</dl>
<a NAME="ModuleLoader.__loadModule" ID="ModuleLoader.__loadModule"></a>
<h4>ModuleLoader.__loadModule</h4>
<b>__loadModule</b>(<i>fullname</i>)

<p>
        Private method to load a module.
</p>
<dl>

<dt><i>fullname</i> (str)</dt>
<dd>
name of the module to be loaded
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
reference to the loaded module
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
module
</dd>
</dl>
<a NAME="ModuleLoader.create_module" ID="ModuleLoader.create_module"></a>
<h4>ModuleLoader.create_module</h4>
<b>create_module</b>(<i>spec</i>)

<p>
        Public method to create a module based on the passed in spec.
</p>
<dl>

<dt><i>spec</i> (ModuleSpec)</dt>
<dd>
module spec object for loading the module
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
created and patched module
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
module
</dd>
</dl>
<a NAME="ModuleLoader.exec_module" ID="ModuleLoader.exec_module"></a>
<h4>ModuleLoader.exec_module</h4>
<b>exec_module</b>(<i>module</i>)

<p>
        Public method to execute the created module.
</p>
<dl>

<dt><i>module</i> (module)</dt>
<dd>
module to be executed
</dd>
</dl>
<a NAME="ModuleLoader.find_spec" ID="ModuleLoader.find_spec"></a>
<h4>ModuleLoader.find_spec</h4>
<b>find_spec</b>(<i>fullname, path, target=None</i>)

<p>
        Public method returning the module spec.
</p>
<dl>

<dt><i>fullname</i> (str)</dt>
<dd>
name of the module to be loaded
</dd>
<dt><i>path</i> (str)</dt>
<dd>
path to resolve the module name
</dd>
<dt><i>target</i> (module)</dt>
<dd>
module object to use for a more educated guess
            about what spec to return
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
module spec object pointing to the module loader
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
ModuleSpec
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>