Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.DebugClients.Python.FlexCompleter.html
src/eric7/Documentation/Source/eric7.DebugClients.Python.FlexCompleter.html
- branch
- eric7
- changeset 10479
- 856476537696
- parent 10417
- c6011e501282
equal
deleted
inserted
replaced
| 10478:de9106c55c3d | 10479:856476537696 |
|---|---|
| 5 <link rel="stylesheet" href="styles.css"> | 5 <link rel="stylesheet" href="styles.css"> |
| 6 </head> | 6 </head> |
| 7 <body> | 7 <body> |
| 8 <a NAME="top" ID="top"></a> | 8 <a NAME="top" ID="top"></a> |
| 9 <h1>eric7.DebugClients.Python.FlexCompleter</h1> | 9 <h1>eric7.DebugClients.Python.FlexCompleter</h1> |
| 10 | |
| 11 <p> | 10 <p> |
| 12 Word completion for the eric shell. | 11 Word completion for the eric shell. |
| 13 </p> | 12 </p> |
| 14 <p> | 13 <p> |
| 15 <h4>NOTE for eric variant</h4> | 14 <h4>NOTE for eric variant</h4> |
| 61 When the original stdin is not a tty device, GNU readline is never | 60 When the original stdin is not a tty device, GNU readline is never |
| 62 used, and this module (and the readline module) are silently inactive. | 61 used, and this module (and the readline module) are silently inactive. |
| 63 </li> | 62 </li> |
| 64 </ul> | 63 </ul> |
| 65 </p> | 64 </p> |
| 65 | |
| 66 <h3>Global Attributes</h3> | 66 <h3>Global Attributes</h3> |
| 67 | |
| 68 <table> | 67 <table> |
| 69 <tr><td>__all__</td></tr> | 68 <tr><td>__all__</td></tr> |
| 70 </table> | 69 </table> |
| 70 | |
| 71 <h3>Classes</h3> | 71 <h3>Classes</h3> |
| 72 | 72 <table> |
| 73 <table> | |
| 74 | |
| 75 <tr> | 73 <tr> |
| 76 <td><a href="#Completer">Completer</a></td> | 74 <td><a href="#Completer">Completer</a></td> |
| 77 <td>Class implementing the command line completer object.</td> | 75 <td>Class implementing the command line completer object.</td> |
| 78 </tr> | 76 </tr> |
| 79 </table> | 77 </table> |
| 78 | |
| 80 <h3>Functions</h3> | 79 <h3>Functions</h3> |
| 81 | 80 <table> |
| 82 <table> | |
| 83 | |
| 84 <tr> | 81 <tr> |
| 85 <td><a href="#get_class_members">get_class_members</a></td> | 82 <td><a href="#get_class_members">get_class_members</a></td> |
| 86 <td>Module function to retrieve the class members.</td> | 83 <td>Module function to retrieve the class members.</td> |
| 87 </tr> | 84 </tr> |
| 88 </table> | 85 </table> |
| 86 | |
| 89 <hr /> | 87 <hr /> |
| 90 <hr /> | 88 <hr /> |
| 91 <a NAME="Completer" ID="Completer"></a> | 89 <a NAME="Completer" ID="Completer"></a> |
| 92 <h2>Completer</h2> | 90 <h2>Completer</h2> |
| 93 | |
| 94 <p> | 91 <p> |
| 95 Class implementing the command line completer object. | 92 Class implementing the command line completer object. |
| 96 </p> | 93 </p> |
| 94 | |
| 97 <h3>Derived from</h3> | 95 <h3>Derived from</h3> |
| 98 None | 96 None |
| 99 <h3>Class Attributes</h3> | 97 <h3>Class Attributes</h3> |
| 100 | |
| 101 <table> | 98 <table> |
| 102 <tr><td>None</td></tr> | 99 <tr><td>None</td></tr> |
| 103 </table> | 100 </table> |
| 101 | |
| 104 <h3>Class Methods</h3> | 102 <h3>Class Methods</h3> |
| 105 | |
| 106 <table> | 103 <table> |
| 107 <tr><td>None</td></tr> | 104 <tr><td>None</td></tr> |
| 108 </table> | 105 </table> |
| 106 | |
| 109 <h3>Methods</h3> | 107 <h3>Methods</h3> |
| 110 | 108 <table> |
| 111 <table> | |
| 112 | |
| 113 <tr> | 109 <tr> |
| 114 <td><a href="#Completer.__init__">Completer</a></td> | 110 <td><a href="#Completer.__init__">Completer</a></td> |
| 115 <td>Constructor</td> | 111 <td>Constructor</td> |
| 116 </tr> | 112 </tr> |
| 117 <tr> | 113 <tr> |
| 129 <tr> | 125 <tr> |
| 130 <td><a href="#Completer.global_matches">global_matches</a></td> | 126 <td><a href="#Completer.global_matches">global_matches</a></td> |
| 131 <td>Public method to compute matches when text is a simple name.</td> | 127 <td>Public method to compute matches when text is a simple name.</td> |
| 132 </tr> | 128 </tr> |
| 133 </table> | 129 </table> |
| 130 | |
| 134 <h3>Static Methods</h3> | 131 <h3>Static Methods</h3> |
| 135 | |
| 136 <table> | 132 <table> |
| 137 <tr><td>None</td></tr> | 133 <tr><td>None</td></tr> |
| 138 </table> | 134 </table> |
| 135 | |
| 139 | 136 |
| 140 <a NAME="Completer.__init__" ID="Completer.__init__"></a> | 137 <a NAME="Completer.__init__" ID="Completer.__init__"></a> |
| 141 <h4>Completer (Constructor)</h4> | 138 <h4>Completer (Constructor)</h4> |
| 142 <b>Completer</b>(<i>namespace=None</i>) | 139 <b>Completer</b>(<i>namespace=None</i>) |
| 143 | |
| 144 <p> | 140 <p> |
| 145 Constructor | 141 Constructor |
| 146 </p> | 142 </p> |
| 147 <p> | 143 <p> |
| 148 Completer([namespace]) -> completer instance. | 144 Completer([namespace]) -> completer instance. |
| 157 readline via the set_completer() call: | 153 readline via the set_completer() call: |
| 158 </p> | 154 </p> |
| 159 <p> | 155 <p> |
| 160 readline.set_completer(Completer(my_namespace).complete) | 156 readline.set_completer(Completer(my_namespace).complete) |
| 161 </p> | 157 </p> |
| 158 | |
| 162 <dl> | 159 <dl> |
| 163 | 160 |
| 164 <dt><i>namespace</i> (dict)</dt> | 161 <dt><i>namespace</i> (dict)</dt> |
| 165 <dd> | 162 <dd> |
| 166 namespace for the completer | 163 namespace for the completer |
| 175 </dd> | 172 </dd> |
| 176 </dl> | 173 </dl> |
| 177 <a NAME="Completer._callable_postfix" ID="Completer._callable_postfix"></a> | 174 <a NAME="Completer._callable_postfix" ID="Completer._callable_postfix"></a> |
| 178 <h4>Completer._callable_postfix</h4> | 175 <h4>Completer._callable_postfix</h4> |
| 179 <b>_callable_postfix</b>(<i>val, word</i>) | 176 <b>_callable_postfix</b>(<i>val, word</i>) |
| 180 | |
| 181 <p> | 177 <p> |
| 182 Protected method to check for a callable. | 178 Protected method to check for a callable. |
| 183 </p> | 179 </p> |
| 180 | |
| 184 <dl> | 181 <dl> |
| 185 | 182 |
| 186 <dt><i>val</i> (Any)</dt> | 183 <dt><i>val</i> (Any)</dt> |
| 187 <dd> | 184 <dd> |
| 188 value to check | 185 value to check |
| 205 </dd> | 202 </dd> |
| 206 </dl> | 203 </dl> |
| 207 <a NAME="Completer.attr_matches" ID="Completer.attr_matches"></a> | 204 <a NAME="Completer.attr_matches" ID="Completer.attr_matches"></a> |
| 208 <h4>Completer.attr_matches</h4> | 205 <h4>Completer.attr_matches</h4> |
| 209 <b>attr_matches</b>(<i>text</i>) | 206 <b>attr_matches</b>(<i>text</i>) |
| 210 | |
| 211 <p> | 207 <p> |
| 212 Public method to compute matches when text contains a dot. | 208 Public method to compute matches when text contains a dot. |
| 213 </p> | 209 </p> |
| 214 <p> | 210 <p> |
| 215 Assuming the text is of the form NAME.NAME....[NAME], and is | 211 Assuming the text is of the form NAME.NAME....[NAME], and is |
| 219 </p> | 215 </p> |
| 220 <p> | 216 <p> |
| 221 <b>WARNING</b>: this can still invoke arbitrary C code, if an object | 217 <b>WARNING</b>: this can still invoke arbitrary C code, if an object |
| 222 with a __getattr__ hook is evaluated. | 218 with a __getattr__ hook is evaluated. |
| 223 </p> | 219 </p> |
| 220 | |
| 224 <dl> | 221 <dl> |
| 225 | 222 |
| 226 <dt><i>text</i> (str)</dt> | 223 <dt><i>text</i> (str)</dt> |
| 227 <dd> | 224 <dd> |
| 228 text to be completed | 225 text to be completed |
| 241 </dd> | 238 </dd> |
| 242 </dl> | 239 </dl> |
| 243 <a NAME="Completer.complete" ID="Completer.complete"></a> | 240 <a NAME="Completer.complete" ID="Completer.complete"></a> |
| 244 <h4>Completer.complete</h4> | 241 <h4>Completer.complete</h4> |
| 245 <b>complete</b>(<i>text, state</i>) | 242 <b>complete</b>(<i>text, state</i>) |
| 246 | |
| 247 <p> | 243 <p> |
| 248 Public method to return the next possible completion for 'text'. | 244 Public method to return the next possible completion for 'text'. |
| 249 </p> | 245 </p> |
| 250 <p> | 246 <p> |
| 251 This is called successively with state == 0, 1, 2, ... until it | 247 This is called successively with state == 0, 1, 2, ... until it |
| 252 returns None. The completion should begin with 'text'. | 248 returns None. The completion should begin with 'text'. |
| 253 </p> | 249 </p> |
| 250 | |
| 254 <dl> | 251 <dl> |
| 255 | 252 |
| 256 <dt><i>text</i> (str)</dt> | 253 <dt><i>text</i> (str)</dt> |
| 257 <dd> | 254 <dd> |
| 258 text to be completed | 255 text to be completed |
| 275 </dd> | 272 </dd> |
| 276 </dl> | 273 </dl> |
| 277 <a NAME="Completer.global_matches" ID="Completer.global_matches"></a> | 274 <a NAME="Completer.global_matches" ID="Completer.global_matches"></a> |
| 278 <h4>Completer.global_matches</h4> | 275 <h4>Completer.global_matches</h4> |
| 279 <b>global_matches</b>(<i>text</i>) | 276 <b>global_matches</b>(<i>text</i>) |
| 280 | |
| 281 <p> | 277 <p> |
| 282 Public method to compute matches when text is a simple name. | 278 Public method to compute matches when text is a simple name. |
| 283 </p> | 279 </p> |
| 280 | |
| 284 <dl> | 281 <dl> |
| 285 | 282 |
| 286 <dt><i>text</i> (str)</dt> | 283 <dt><i>text</i> (str)</dt> |
| 287 <dd> | 284 <dd> |
| 288 text to be completed | 285 text to be completed |
| 305 <hr /> | 302 <hr /> |
| 306 <hr /> | 303 <hr /> |
| 307 <a NAME="get_class_members" ID="get_class_members"></a> | 304 <a NAME="get_class_members" ID="get_class_members"></a> |
| 308 <h2>get_class_members</h2> | 305 <h2>get_class_members</h2> |
| 309 <b>get_class_members</b>(<i>klass</i>) | 306 <b>get_class_members</b>(<i>klass</i>) |
| 310 | |
| 311 <p> | 307 <p> |
| 312 Module function to retrieve the class members. | 308 Module function to retrieve the class members. |
| 313 </p> | 309 </p> |
| 310 | |
| 314 <dl> | 311 <dl> |
| 315 | 312 |
| 316 <dt><i>klass</i> (Any)</dt> | 313 <dt><i>klass</i> (Any)</dt> |
| 317 <dd> | 314 <dd> |
| 318 class object to be analyzed | 315 class object to be analyzed |
