cinap_lenrekadd hg and python4bb9e2215 years agoHistory
65 lines · 2.3 KB · TeX
RawDownload
\section{\module{rlcompleter} ---         Completion function for GNU readline} \declaremodule{standard}{rlcompleter}\sectionauthor{Moshe Zadka}{moshez@zadka.site.co.il}\modulesynopsis{Python identifier completion, suitable for the GNU readline library.} The \module{rlcompleter} module defines a completion function suitable forthe \refmodule{readline} module by completing valid Python identifiersand keywords. When this module is imported on a \UNIX\ platform with the \module{readline}module available, an instance of the \class{Completer} class is automaticallycreated and its \method{complete} method is set as the \module{readline}completer. Example: \begin{verbatim}>>> import rlcompleter>>> import readline>>> readline.parse_and_bind("tab: complete")>>> readline. <TAB PRESSED>readline.__doc__          readline.get_line_buffer  readline.read_init_filereadline.__file__         readline.insert_text      readline.set_completerreadline.__name__         readline.parse_and_bind>>> readline.\end{verbatim} The \module{rlcompleter} module is designed for use with Python'sinteractive mode.  A user can add the following lines to his or herinitialization file (identified by the \envvar{PYTHONSTARTUP}environment variable) to get automatic \kbd{Tab} completion: \begin{verbatim}try:    import readlineexcept ImportError:    print "Module readline not available."else:    import rlcompleter    readline.parse_and_bind("tab: complete")\end{verbatim}  On platforms without \module{readline}, the \class{Completer} class definedby this module can still be used for custom purposes. \subsection{Completer Objects \label{completer-objects}} Completer objects have the following method: \begin{methoddesc}[Completer]{complete}{text, state}Return the \var{state}th completion for \var{text}. If called for \var{text} that doesn't include a period character(\character{.}), it will complete from names currently defined in\refmodule[main]{__main__}, \refmodule[builtin]{__builtin__} andkeywords (as defined by the \refmodule{keyword} module). If called for a dotted name, it will try to evaluate anything withoutobvious side-effects (functions will not be evaluated, but itcan generate calls to \method{__getattr__()}) up to the last part, andfind matches for the rest via the \function{dir()} function.\end{methoddesc}