upstream/ipython Files · IPython/utils/rlineimpl.py

Multiple improvements to tab completion....

Multiple improvements to tab completion. I refactored the API quite a bit, to retain readline compatibility but make it more independent of readline. There's still more to do in cleaning up our init_readline() method, but now the completer objects have separate rlcomplete() and complete() methods. The former uses the quirky readline API with a state flag, while the latter is stateless, takes only text information, and is more suitable for GUIs and other frontends to call programatically. Made other minor fixes to ensure the test suite passes in full. While all this code is a bit messy, we're getting in the direction of the APIs we need in the long run.

Fernando Perez - - Load All Authors

File last commit:

r2560:4c75a870


                r2839:8cff4913

Download file

             rlineimpl.py
        
                    69 lines
            
             | 2.1 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / utils / rlineimpl.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      # -*- coding: utf-8 -*-

      """ Imports and provides the 'correct' version of readline for the platform.

      Readline is used throughout IPython as::

          import IPython.utils.rlineimpl as readline

      In addition to normal readline stuff, this module provides have_readline

      boolean and _outputfile variable used in IPython.utils.

      """

      import sys

      try:

          from readline import *

          import readline as _rl

          have_readline = True

      except ImportError:

          try:

              from pyreadline import *

              import pyreadline as _rl

              have_readline = True

          except ImportError:    

              have_readline = False

      if sys.platform == 'win32' and have_readline:

          try:

              _outputfile=_rl.GetOutputFile()

          except AttributeError:

              print "Failed GetOutputFile"

              have_readline = False

      # Test to see if libedit is being used instead of GNU readline.

      # Thanks to Boyd Waters for this patch.

      uses_libedit = False

      if sys.platform == 'darwin' and have_readline:

          import commands

          # Boyd's patch had a 'while True' here, I'm always a little worried about

          # infinite loops with such code, so for now I'm taking a more conservative

          # approach. See https://bugs.launchpad.net/ipython/+bug/411599.

          for i in range(10):

              try:

                  (status, result) = commands.getstatusoutput( "otool -L %s | grep libedit" % _rl.__file__ )

                  break

              except IOError, (errno, strerror):

                  if errno == 4:

                      continue

                  else:

                      break

          if status == 0 and len(result) > 0:

              # we are bound to libedit - new in Leopard

              _rl.parse_and_bind("bind ^I rl_complete")

              print "Leopard libedit detected."

              uses_libedit = True

      # the clear_history() function was only introduced in Python 2.4 and is

      # actually optional in the readline API, so we must explicitly check for its

      # existence.  Some known platforms actually don't have it.  This thread:

      # http://mail.python.org/pipermail/python-dev/2003-August/037845.html

      # has the original discussion.

      if have_readline:

          try:

              _rl.clear_history

          except AttributeError:

              def clear_history(): pass

              _rl.clear_history = clear_history

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

				# -- coding: utf-8 --
				""" Imports and provides the 'correct' version of readline for the platform.

				Readline is used throughout IPython as::

				import IPython.utils.rlineimpl as readline

				In addition to normal readline stuff, this module provides have_readline
				boolean and _outputfile variable used in IPython.utils.
				"""

				import sys

				try:
				from readline import *
				import readline as _rl
				have_readline = True
				except ImportError:
				try:
				from pyreadline import *
				import pyreadline as _rl
				have_readline = True
				except ImportError:
				have_readline = False

				if sys.platform == 'win32' and have_readline:
				try:
				_outputfile=_rl.GetOutputFile()
				except AttributeError:
				print "Failed GetOutputFile"
				have_readline = False

				# Test to see if libedit is being used instead of GNU readline.
				# Thanks to Boyd Waters for this patch.
				uses_libedit = False
				if sys.platform == 'darwin' and have_readline:
				import commands
				# Boyd's patch had a 'while True' here, I'm always a little worried about
				# infinite loops with such code, so for now I'm taking a more conservative
				# approach. See https://bugs.launchpad.net/ipython/+bug/411599.
				for i in range(10):
				try:
				(status, result) = commands.getstatusoutput( "otool -L %s \| grep libedit" % _rl.__file__ )
				break
				except IOError, (errno, strerror):
				if errno == 4:
				continue
				else:
				break

				if status == 0 and len(result) > 0:
				# we are bound to libedit - new in Leopard
				_rl.parse_and_bind("bind ^I rl_complete")
				print "Leopard libedit detected."
				uses_libedit = True


				# the clear_history() function was only introduced in Python 2.4 and is
				# actually optional in the readline API, so we must explicitly check for its
				# existence. Some known platforms actually don't have it. This thread:
				# http://mail.python.org/pipermail/python-dev/2003-August/037845.html
				# has the original discussion.

				if have_readline:
				try:
				_rl.clear_history
				except AttributeError:
				def clear_history(): pass
				_rl.clear_history = clear_history