103 </table> |
103 </table> |
104 <h3>Methods</h3> |
104 <h3>Methods</h3> |
105 <table> |
105 <table> |
106 <tr> |
106 <tr> |
107 <td><a href="#Completer.__init__">Completer</a></td> |
107 <td><a href="#Completer.__init__">Completer</a></td> |
108 <td>Create a new completer for the command line.</td> |
108 <td>Constructor</td> |
109 </tr><tr> |
109 </tr><tr> |
110 <td><a href="#Completer._callable_postfix">_callable_postfix</a></td> |
110 <td><a href="#Completer._callable_postfix">_callable_postfix</a></td> |
111 <td>Protected method to check for a callable.</td> |
111 <td>Protected method to check for a callable.</td> |
112 </tr><tr> |
112 </tr><tr> |
113 <td><a href="#Completer.attr_matches">attr_matches</a></td> |
113 <td><a href="#Completer.attr_matches">attr_matches</a></td> |
114 <td>Compute matches when text contains a dot.</td> |
114 <td>Public method to compute matches when text contains a dot.</td> |
115 </tr><tr> |
115 </tr><tr> |
116 <td><a href="#Completer.complete">complete</a></td> |
116 <td><a href="#Completer.complete">complete</a></td> |
117 <td>Return the next possible completion for 'text'.</td> |
117 <td>Public method to return the next possible completion for 'text'.</td> |
118 </tr><tr> |
118 </tr><tr> |
119 <td><a href="#Completer.global_matches">global_matches</a></td> |
119 <td><a href="#Completer.global_matches">global_matches</a></td> |
120 <td>Compute matches when text is a simple name.</td> |
120 <td>Public method to compute matches when text is a simple name.</td> |
121 </tr> |
121 </tr> |
122 </table> |
122 </table> |
123 <h3>Static Methods</h3> |
123 <h3>Static Methods</h3> |
124 <table> |
124 <table> |
125 <tr><td>None</td></tr> |
125 <tr><td>None</td></tr> |
126 </table> |
126 </table> |
127 <a NAME="Completer.__init__" ID="Completer.__init__"></a> |
127 <a NAME="Completer.__init__" ID="Completer.__init__"></a> |
128 <h4>Completer (Constructor)</h4> |
128 <h4>Completer (Constructor)</h4> |
129 <b>Completer</b>(<i>namespace=None</i>) |
129 <b>Completer</b>(<i>namespace=None</i>) |
130 <p> |
130 <p> |
131 Create a new completer for the command line. |
131 Constructor |
132 </p><p> |
132 </p><p> |
133 Completer([namespace]) -> completer instance. |
133 Completer([namespace]) -> completer instance. |
134 </p><p> |
134 </p><p> |
135 If unspecified, the default namespace where completions are performed |
135 If unspecified, the default namespace where completions are performed |
136 is __main__ (technically, __main__.__dict__). Namespaces should be |
136 is __main__ (technically, __main__.__dict__). Namespaces should be |
171 </dd> |
171 </dd> |
172 </dl><a NAME="Completer.attr_matches" ID="Completer.attr_matches"></a> |
172 </dl><a NAME="Completer.attr_matches" ID="Completer.attr_matches"></a> |
173 <h4>Completer.attr_matches</h4> |
173 <h4>Completer.attr_matches</h4> |
174 <b>attr_matches</b>(<i>text</i>) |
174 <b>attr_matches</b>(<i>text</i>) |
175 <p> |
175 <p> |
176 Compute matches when text contains a dot. |
176 Public method to compute matches when text contains a dot. |
177 </p><p> |
177 </p><p> |
178 Assuming the text is of the form NAME.NAME....[NAME], and is |
178 Assuming the text is of the form NAME.NAME....[NAME], and is |
179 evaluatable in self.namespace, it will be evaluated and its attributes |
179 evaluatable in self.namespace, it will be evaluated and its attributes |
180 (as revealed by dir()) are used as possible completions. (For class |
180 (as revealed by dir()) are used as possible completions. (For class |
181 instances, class members are are also considered.) |
181 instances, class members are are also considered.) |
194 </dd> |
194 </dd> |
195 </dl><a NAME="Completer.complete" ID="Completer.complete"></a> |
195 </dl><a NAME="Completer.complete" ID="Completer.complete"></a> |
196 <h4>Completer.complete</h4> |
196 <h4>Completer.complete</h4> |
197 <b>complete</b>(<i>text, state</i>) |
197 <b>complete</b>(<i>text, state</i>) |
198 <p> |
198 <p> |
199 Return the next possible completion for 'text'. |
199 Public method to return the next possible completion for 'text'. |
200 </p><p> |
200 </p><p> |
201 This is called successively with state == 0, 1, 2, ... until it |
201 This is called successively with state == 0, 1, 2, ... until it |
202 returns None. The completion should begin with 'text'. |
202 returns None. The completion should begin with 'text'. |
203 </p><dl> |
203 </p><dl> |
204 <dt><i>text</i></dt> |
204 <dt><i>text</i></dt> |
215 </dd> |
215 </dd> |
216 </dl><a NAME="Completer.global_matches" ID="Completer.global_matches"></a> |
216 </dl><a NAME="Completer.global_matches" ID="Completer.global_matches"></a> |
217 <h4>Completer.global_matches</h4> |
217 <h4>Completer.global_matches</h4> |
218 <b>global_matches</b>(<i>text</i>) |
218 <b>global_matches</b>(<i>text</i>) |
219 <p> |
219 <p> |
220 Compute matches when text is a simple name. |
220 Public method to compute matches when text is a simple name. |
221 </p><dl> |
221 </p><dl> |
222 <dt><i>text</i></dt> |
222 <dt><i>text</i></dt> |
223 <dd> |
223 <dd> |
224 The text to be completed. (string) |
224 The text to be completed. (string) |
225 </dd> |
225 </dd> |