eric4.DebugClients.Python3.FlexCompleter

Word completion for the eric4 shell

NOTE for eric4 variant

This version is a re-implementation of rlcompleter as found in the Python3 library. It is modified to work with the eric4 debug clients.

Original rlcompleter documentation

This requires the latest extension to the readline module. The completer completes keywords, built-ins and globals in a selectable namespace (which defaults to __main__); when completing NAME.NAME..., it evaluates (!) the expression up to the last dot and completes its attributes.

It's very cool to do "import sys" type "sys.", hit the completion key (twice), and see the list of names defined by the sys module!

Tip: to use the tab key as the completion key, call

readline.parse_and_bind("tab: complete")

Notes:

Global Attributes

__all__

Classes

Completer Class implementing the command line completer object.

Functions

get_class_members Module function to retrieve the class members.


Completer

Class implementing the command line completer object.

Derived from

object

Class Attributes

None

Methods

Completer Create a new completer for the command line.
_callable_postfix Protected method to check for a callable.
attr_matches Compute matches when text contains a dot.
complete Return the next possible completion for 'text'.
global_matches Compute matches when text is a simple name.

Completer (Constructor)

Completer(namespace = None)

Create a new completer for the command line.

Completer([namespace]) -> completer instance.

If unspecified, the default namespace where completions are performed is __main__ (technically, __main__.__dict__). Namespaces should be given as dictionaries.

Completer instances should be used as the completion mechanism of readline via the set_completer() call:

readline.set_completer(Completer(my_namespace).complete)

namespace
The namespace for the completer.

Completer._callable_postfix

_callable_postfix(val, word)

Protected method to check for a callable.

val
value to check (object)
word
word to ammend (string)
Returns:
ammended word (string)

Completer.attr_matches

attr_matches(text)

Compute matches when text contains a dot.

Assuming the text is of the form NAME.NAME....[NAME], and is evaluatable in self.namespace, it will be evaluated and its attributes (as revealed by dir()) are used as possible completions. (For class instances, class members are are also considered.)

WARNING: this can still invoke arbitrary C code, if an object with a __getattr__ hook is evaluated.

text
The text to be completed. (string)
Returns:
A list of all matches.

Completer.complete

complete(text, state)

Return the next possible completion for 'text'.

This is called successively with state == 0, 1, 2, ... until it returns None. The completion should begin with 'text'.

text
The text to be completed. (string)
state
The state of the completion. (integer)
Returns:
The possible completions as a list of strings.

Completer.global_matches

global_matches(text)

Compute matches when text is a simple name.

text
The text to be completed. (string)
Returns:
A list of all keywords, built-in functions and names currently defined in self.namespace that match.
Up


get_class_members

get_class_members(klass)

Module function to retrieve the class members.

klass
The class object to be analysed.
Returns:
A list of all names defined in the class.
Up