eric7.DebugClients.Python.FlexCompleter

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

None

Class Attributes

None

Class Methods

None

Methods

Completer Constructor
_callable_postfix Protected method to check for a callable.
attr_matches Public method to compute matches when text contains a dot.
complete Public method to return the next possible completion for 'text'.
global_matches Public method to compute matches when text is a simple name.

Static Methods

None

Completer (Constructor)

Completer(namespace=None)

Constructor

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 (dict or FrameLocalsProxy (optional))
namespace for the completer (defaults to None)
Raises TypeError:
raised to indicate a wrong data structure of the namespace object

Completer._callable_postfix

_callable_postfix(val, word)

Protected method to check for a callable.

val (Any)
value to check
word (str)
word to amend
Return:
amended word
Return Type:
str

Completer.attr_matches

attr_matches(text)

Public method to 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 (str)
text to be completed
Return:
list of all matches
Return Type:
list of str

Completer.complete

complete(text, state)

Public method to 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 (str)
text to be completed
state (int)
state of the completion
Return:
possible completions
Return Type:
list of str

Completer.global_matches

global_matches(text)

Public method to compute matches when text is a simple name.

text (str)
text to be completed
Return:
list of all keywords, built-in functions and names currently defined in self.namespace that match
Return Type:
list of str
Up

get_class_members

get_class_members(klass)

Module function to retrieve the class members.

klass (Any)
class object to be analyzed
Return:
list of all names defined in the class
Return Type:
list of str
Up