|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric7.DebugClients.Python.ModuleLoader</title> |
|
4 <meta charset="UTF-8"> |
|
5 <link rel="stylesheet" href="styles.css"> |
|
6 </head> |
|
7 <body> |
|
8 <a NAME="top" ID="top"></a> |
|
9 <h1>eric7.DebugClients.Python.ModuleLoader</h1> |
|
10 |
|
11 <p> |
|
12 Module implementing an import hook patching modules to support debugging. |
|
13 </p> |
|
14 <h3>Global Attributes</h3> |
|
15 |
|
16 <table> |
|
17 <tr><td>None</td></tr> |
|
18 </table> |
|
19 <h3>Classes</h3> |
|
20 |
|
21 <table> |
|
22 |
|
23 <tr> |
|
24 <td><a href="#ModuleLoader">ModuleLoader</a></td> |
|
25 <td>Class implementing an import hook patching modules to support debugging.</td> |
|
26 </tr> |
|
27 </table> |
|
28 <h3>Functions</h3> |
|
29 |
|
30 <table> |
|
31 <tr><td>None</td></tr> |
|
32 </table> |
|
33 <hr /> |
|
34 <hr /> |
|
35 <a NAME="ModuleLoader" ID="ModuleLoader"></a> |
|
36 <h2>ModuleLoader</h2> |
|
37 |
|
38 <p> |
|
39 Class implementing an import hook patching modules to support debugging. |
|
40 </p> |
|
41 <h3>Derived from</h3> |
|
42 None |
|
43 <h3>Class Attributes</h3> |
|
44 |
|
45 <table> |
|
46 <tr><td>None</td></tr> |
|
47 </table> |
|
48 <h3>Class Methods</h3> |
|
49 |
|
50 <table> |
|
51 <tr><td>None</td></tr> |
|
52 </table> |
|
53 <h3>Methods</h3> |
|
54 |
|
55 <table> |
|
56 |
|
57 <tr> |
|
58 <td><a href="#ModuleLoader.__init__">ModuleLoader</a></td> |
|
59 <td>Constructor</td> |
|
60 </tr> |
|
61 <tr> |
|
62 <td><a href="#ModuleLoader.__loadModule">__loadModule</a></td> |
|
63 <td>Private method to load a module.</td> |
|
64 </tr> |
|
65 <tr> |
|
66 <td><a href="#ModuleLoader.create_module">create_module</a></td> |
|
67 <td>Public method to create a module based on the passed in spec.</td> |
|
68 </tr> |
|
69 <tr> |
|
70 <td><a href="#ModuleLoader.exec_module">exec_module</a></td> |
|
71 <td>Public method to execute the created module.</td> |
|
72 </tr> |
|
73 <tr> |
|
74 <td><a href="#ModuleLoader.find_spec">find_spec</a></td> |
|
75 <td>Public method returning the module spec.</td> |
|
76 </tr> |
|
77 </table> |
|
78 <h3>Static Methods</h3> |
|
79 |
|
80 <table> |
|
81 <tr><td>None</td></tr> |
|
82 </table> |
|
83 |
|
84 <a NAME="ModuleLoader.__init__" ID="ModuleLoader.__init__"></a> |
|
85 <h4>ModuleLoader (Constructor)</h4> |
|
86 <b>ModuleLoader</b>(<i>debugClient</i>) |
|
87 |
|
88 <p> |
|
89 Constructor |
|
90 </p> |
|
91 <dl> |
|
92 |
|
93 <dt><i>debugClient</i> (DebugClient)</dt> |
|
94 <dd> |
|
95 reference to the debug client object |
|
96 </dd> |
|
97 </dl> |
|
98 <a NAME="ModuleLoader.__loadModule" ID="ModuleLoader.__loadModule"></a> |
|
99 <h4>ModuleLoader.__loadModule</h4> |
|
100 <b>__loadModule</b>(<i>fullname</i>) |
|
101 |
|
102 <p> |
|
103 Private method to load a module. |
|
104 </p> |
|
105 <dl> |
|
106 |
|
107 <dt><i>fullname</i> (str)</dt> |
|
108 <dd> |
|
109 name of the module to be loaded |
|
110 </dd> |
|
111 </dl> |
|
112 <dl> |
|
113 <dt>Return:</dt> |
|
114 <dd> |
|
115 reference to the loaded module |
|
116 </dd> |
|
117 </dl> |
|
118 <dl> |
|
119 <dt>Return Type:</dt> |
|
120 <dd> |
|
121 module |
|
122 </dd> |
|
123 </dl> |
|
124 <a NAME="ModuleLoader.create_module" ID="ModuleLoader.create_module"></a> |
|
125 <h4>ModuleLoader.create_module</h4> |
|
126 <b>create_module</b>(<i>spec</i>) |
|
127 |
|
128 <p> |
|
129 Public method to create a module based on the passed in spec. |
|
130 </p> |
|
131 <dl> |
|
132 |
|
133 <dt><i>spec</i> (ModuleSpec)</dt> |
|
134 <dd> |
|
135 module spec object for loading the module |
|
136 </dd> |
|
137 </dl> |
|
138 <dl> |
|
139 <dt>Return:</dt> |
|
140 <dd> |
|
141 created and patched module |
|
142 </dd> |
|
143 </dl> |
|
144 <dl> |
|
145 <dt>Return Type:</dt> |
|
146 <dd> |
|
147 module |
|
148 </dd> |
|
149 </dl> |
|
150 <a NAME="ModuleLoader.exec_module" ID="ModuleLoader.exec_module"></a> |
|
151 <h4>ModuleLoader.exec_module</h4> |
|
152 <b>exec_module</b>(<i>module</i>) |
|
153 |
|
154 <p> |
|
155 Public method to execute the created module. |
|
156 </p> |
|
157 <dl> |
|
158 |
|
159 <dt><i>module</i> (module)</dt> |
|
160 <dd> |
|
161 module to be executed |
|
162 </dd> |
|
163 </dl> |
|
164 <a NAME="ModuleLoader.find_spec" ID="ModuleLoader.find_spec"></a> |
|
165 <h4>ModuleLoader.find_spec</h4> |
|
166 <b>find_spec</b>(<i>fullname, path, target=None</i>) |
|
167 |
|
168 <p> |
|
169 Public method returning the module spec. |
|
170 </p> |
|
171 <dl> |
|
172 |
|
173 <dt><i>fullname</i> (str)</dt> |
|
174 <dd> |
|
175 name of the module to be loaded |
|
176 </dd> |
|
177 <dt><i>path</i> (str)</dt> |
|
178 <dd> |
|
179 path to resolve the module name |
|
180 </dd> |
|
181 <dt><i>target</i> (module)</dt> |
|
182 <dd> |
|
183 module object to use for a more educated guess |
|
184 about what spec to return |
|
185 </dd> |
|
186 </dl> |
|
187 <dl> |
|
188 <dt>Return:</dt> |
|
189 <dd> |
|
190 module spec object pointing to the module loader |
|
191 </dd> |
|
192 </dl> |
|
193 <dl> |
|
194 <dt>Return Type:</dt> |
|
195 <dd> |
|
196 ModuleSpec |
|
197 </dd> |
|
198 </dl> |
|
199 <div align="right"><a href="#top">Up</a></div> |
|
200 <hr /> |
|
201 </body></html> |