Merge lp:~shimizukawa/pyreadline/python3 into lp:pyreadline

[Shimizukawa]

Now pyreadline become python3 ready.

pyreadline's code-base is still python2, but setup.py convert code into python3 with using distribute and 2to3 library.

[lp:~shimizukawa/pyreadline/python3]

119. By shimizukawa on 2011-04-23

fixed: bytes iteration generate int literal instead of bytes literal

[B. Striegel (b-striegel)]

With Python 3.2.1 on Windows XP, successfully used this branch to enable readline for both the built-in Python interactive shell and for IPython3. This is exactly what I was looking for. :)

One weird thing that may or may not be related to pyreadline: while the built-in Python interactive shell exhibits no issues, using IPython3 with this library causes the "In [x]" prompt to double up after each command, and then a print a third time as soon as you begin typing a new command. Example:

-------

In [1]:
In [1]:
In [1]: a = [1,2,3]

In [2]:
In [2]:
In [2]: a
Out[2]: [1, 2, 3]

In [3]:
In [3]:
In [3]: print('hello')
hello

In [4]:
In [4]:

-------

I realize that IPython itself only barely supports Py3k (and even required a few manual hacks to get it to run at all on XP), but it did not exhibit this behavior before installing pyreadline. I also haven't had this problem using IPython3 on CentOS with the usual readline library.

review: Approve

[Shimizukawa (shimizukawa)]

> One weird thing that may or may not be related to pyreadline: while the built-
> in Python interactive shell exhibits no issues, using IPython3 with this
> library causes the "In [x]" prompt to double up after each command, and then a
> print a third time as soon as you begin typing a new command. Example:
>
> -------
>
> In [1]:
> In [1]:
> In [1]: a = [1,2,3]

I'm trying IPython3 got from https://github.com/ipython/ipython-py3k/commit/17bd8dfb1da9940799c3c3e0e19af098f4f93a45 and it works for me on Windows7+Python-3.2 (but I found another bug..)

Next, I'll try with Windows XP.

=== modified file '.bzrignore'
--- .bzrignore	2008-06-22 12:30:47 +0000
+++ .bzrignore	2011-04-23 08:41:27 +0000
@@ -1,1 +1,4 @@
 build
+dist
+pyreadline.egg-info/
+__pycache__/

=== modified file 'doc/ChangeLog'
--- doc/ChangeLog	2008-08-25 17:12:51 +0000
+++ doc/ChangeLog	2011-04-23 08:41:27 +0000
@@ -1,3 +1,6 @@
[phone] Takayuki SHIMIZUKAWA <shimizukawa -at- gmail.com>
+	* Python3 ready.
+
 2008-08-25 Jörgen Stenarson  <jorgen.stenarson -at- bostream.nu>
 	* Merging tab insert patch from Vivian De Smedt. Removed comments
 	  with vds initials.

=== modified file 'doc/source/introduction.rst'
--- doc/source/introduction.rst	2011-04-14 19:00:46 +0000
+++ doc/source/introduction.rst	2011-04-23 08:41:27 +0000
@@ -11,7 +11,7 @@
 interfaces in GUIs. The use of pyreadline for anything but the windows 
 console is still under development.
 
-The pyreadline module does not yet support Python 3.x this will be targeted for the 2.0 version.
+The pyreadline module support also Python 3.x.
 
 Version 1.7 will be the last release with compatibility with 2.4 and 2.5. The next
 major release will target 2.6, 2.7 and 3.x. The 1.7 series will only receive bugfixes

=== modified file 'eggsetup.py'
--- eggsetup.py	2006-03-12 14:52:00 +0000
+++ eggsetup.py	2011-04-23 08:41:27 +0000
@@ -8,7 +8,7 @@
 #*****************************************************************************
 import glob
 from setuptools import setup,find_packages
-execfile('pyreadline/release.py')
+exec(compile(open('pyreadline/release.py').read(), 'pyreadline/release.py', 'exec'))
 
 setup(name=name,
       version          = version,

=== modified file 'pyreadline/console/console.py'
--- pyreadline/console/console.py	2009-10-06 17:36:27 +0000
+++ pyreadline/console/console.py	2011-04-23 08:41:27 +0000
@@ -30,6 +30,9 @@
 except ImportError:
     raise ImportError(u"You need ctypes to run this code")
 
+if sys.version_info < (2, 6):
+    bytes = str
+
 def nolog(string):
     pass
     
@@ -286,7 +289,7 @@
 
     # This pattern should match all characters that change the cursor position differently
     # than a normal character.
-    motion_char_re = re.compile(u'([\n\r\t\010\007])')
+    motion_char_re = re.compile('([\n\r\t\010\007])'.encode('ascii'))
 
     def write_scrolling(self, text, attr=None):
         u'''write text at current cursor position while watching for scrolling.
@@ -306,7 +309,7 @@
         w, h = self.size()
         scroll = 0 # the result
         # split the string into ordinary characters and funny characters
-        chunks = self.motion_char_re.split(text)
+        chunks = self.motion_char_re.split(ensure_str(text))
         for chunk in chunks:
             n = self.write_color(chunk, attr)
             if len(chunk) == 1: # the funny characters will be alone
@@ -690,7 +693,7 @@
         # call the Python hook
         res = ensure_str(readline_hook(prompt))
         # make sure it returned the right sort of thing
-        if res and not isinstance(res, str):
+        if res and not isinstance(res, bytes):
             raise TypeError, u'readline must return a string.'
     except KeyboardInterrupt:
         # GNU readline returns 0 on keyboard interrupt
@@ -714,7 +717,7 @@
         # call the Python hook
         res = ensure_str(readline_hook(prompt))
         # make sure it returned the right sort of thing
-        if res and not isinstance(res, str):
+        if res and not isinstance(res, bytes):
             raise TypeError, u'readline must return a string.'
     except KeyboardInterrupt:
         # GNU readline returns 0 on keyboard interrupt
@@ -738,7 +741,7 @@
     readline_hook = hook
     # get the address of PyOS_ReadlineFunctionPointer so we can update it
     PyOS_RFP = c_int.from_address(Console.GetProcAddress(sys.dllhandle,
-                                            "PyOS_ReadlineFunctionPointer"))
+                           "PyOS_ReadlineFunctionPointer".encode('ascii')))
     # save a reference to the generated C-callable so it doesn't go away
     if sys.version < '2.3':
         readline_ref = HOOKFUNC22(hook_wrapper)

=== modified file 'pyreadline/lineeditor/history.py'
--- pyreadline/lineeditor/history.py	2011-04-14 18:36:47 +0000
+++ pyreadline/lineeditor/history.py	2011-04-23 08:41:27 +0000
@@ -15,9 +15,7 @@
 
 import lineobj
 
-import exceptions
-
-class EscapeHistory(exceptions.Exception):
+class EscapeHistory(Exception):
     pass
 
 from pyreadline.logger import log
@@ -93,7 +91,7 @@
         fp = open(filename, u'wb')
         for line in self.history[-self.history_length:]:
             fp.write(ensure_str(line.get_line_text()))
-            fp.write(u'\n')
+            fp.write('\n'.encode('ascii'))
         fp.close()
 
 

=== modified file 'pyreadline/lineeditor/lineobj.py'
--- pyreadline/lineeditor/lineobj.py	2008-11-12 21:56:56 +0000
+++ pyreadline/lineeditor/lineobj.py	2011-04-23 08:41:27 +0000
@@ -10,7 +10,7 @@
 import wordmatcher
 import pyreadline.clipboard as clipboard
 from pyreadline.logger import  log
-from pyreadline.unicode_helper import ensure_unicode
+from pyreadline.unicode_helper import ensure_unicode, biter
 
 kill_ring_to_clipboard = False #set to true to copy every addition to kill ring to clipboard
 
@@ -272,12 +272,12 @@
     def _insert_text(self, text, argument=1):
         text = text * argument
         if self.overwrite:
-            for c in text:
+            for c in biter(text):
                 #if self.point:
                 self.line_buffer[self.point] = c
                 self.point += 1
         else:            
-            for c in text:
+            for c in biter(text):
                 self.line_buffer.insert(self.point, c)
                 self.point += 1
     

=== modified file 'pyreadline/modes/basemode.py'
--- pyreadline/modes/basemode.py	2011-04-14 16:52:22 +0000
+++ pyreadline/modes/basemode.py	2011-04-23 08:41:27 +0000
@@ -195,7 +195,7 @@
             i = 0
             while 1:
                 try:
-                    r = ensure_unicode(self.completer(text, i))
+                    r = self.completer(ensure_unicode(text), i)
                 except IndexError:
                     break
                 i += 1
@@ -215,7 +215,7 @@
                     break
             text = ensure_str(u''.join(buf[self.begidx:self.endidx]))
             log(u'file complete text="%s"' % ensure_unicode(text))
-            completions = map(ensure_unicode, glob.glob(os.path.expanduser(text) + '*'))
+            completions = map(ensure_unicode, glob.glob(os.path.expanduser(text) + '*'.encode('ascii')))
             if self.mark_directories == u'on':
                 mc = []
                 for f in completions:

=== modified file 'pyreadline/release.py'
--- pyreadline/release.py	2011-04-14 19:00:46 +0000
+++ pyreadline/release.py	2011-04-23 08:41:27 +0000
@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-u"""Release data for the pyreadline project.
+"""Release data for the pyreadline project.
 
 $Id$"""
 
@@ -13,23 +13,23 @@
 
 # Name of the package for release purposes.  This is the name which labels
 # the tarballs and RPMs made by distutils, so it's best to lowercase it.
-name = u'pyreadline'
+name = 'pyreadline'
 
 # For versions with substrings (like 0.6.16.svn), use an extra . to separate
 # the new substring.  We have to avoid using either dashes or underscores,
 # because bdist_rpm does not accept dashes (an RPM) convention, and
 # bdist_deb does not accept underscores (a Debian convention).
 
-branch = u''
-
-version = u'1.7'
-
-revision = u'$Revision$'
-
-description = u"A python implmementation of GNU readline."
+branch = ''
+
+version = '1.7'
+
+revision = '$Revision$'
+
+description = "A python implmementation of GNU readline."
 
 long_description = \
-u"""
+"""
 The pyreadline package is a python implementation of GNU readline functionality
 it is based on the ctypes based UNC readline package by Gary Bishop. 
 It is not complete. It has been tested for use with windows 2000 and windows xp.
@@ -55,31 +55,32 @@
 .. _repository:
  """
 
-license = u'BSD'
+license = 'BSD'
 
-authors = {u'Jorgen' : (u'Jorgen Stenarson',u'[e-mail]'),
-           u'Gary':    (u'Gary Bishop', ''),         
-           u'Jack':    (u'Jack Trainor', ''),         
+authors = {'Jorgen' : ('Jorgen Stenarson','[e-mail]'),
+           'Gary':    ('Gary Bishop', ''),         
+           'Jack':    ('Jack Trainor', ''),         
            }
 
-url = u'http://ipython.scipy.org/moin/PyReadline/Intro'
-
-download_url = u'https://launchpad.net/pyreadline/+download'
-
-platforms = [u'Windows XP/2000/NT',
-             u'Windows 95/98/ME']
-
-keywords = [u'readline',
-            u'pyreadline']
-
-classifiers = [u'Development Status :: 5 - Production/Stable',
-               u'Environment :: Console',
-               u'Operating System :: Microsoft :: Windows',
-               u'License :: OSI Approved :: BSD License',
-               u'Programming Language :: Python :: 2.4',
-               u'Programming Language :: Python :: 2.5',
-               u'Programming Language :: Python :: 2.6',
-               u'Programming Language :: Python :: 2.7',
+url = 'http://ipython.scipy.org/moin/PyReadline/Intro'
+
+download_url = 'https://launchpad.net/pyreadline/+download'
+
+platforms = ['Windows XP/2000/NT',
+             'Windows 95/98/ME']
+
+keywords = ['readline',
+            'pyreadline']
+
+classifiers = ['Development Status :: 5 - Production/Stable',
+               'Environment :: Console',
+               'Operating System :: Microsoft :: Windows',
+               'License :: OSI Approved :: BSD License',
+               'Programming Language :: Python :: 2.4',
+               'Programming Language :: Python :: 2.5',
+               'Programming Language :: Python :: 2.6',
+               'Programming Language :: Python :: 2.7',
+               'Programming Language :: Python :: 3.2',
                ]
                
                

=== modified file 'pyreadline/rlmain.py'
--- pyreadline/rlmain.py	2011-02-25 19:22:11 +0000
+++ pyreadline/rlmain.py	2011-04-23 08:41:27 +0000
@@ -282,9 +282,9 @@
             self.mode = modes[name]
 
         def bind_key(key, name):
-            import new
+            import types
             if callable(name):
-                modes[mode]._bind_key(key, new.instancemethod(name, modes[mode], modes[mode].__class__))
+                modes[mode]._bind_key(key, types.MethodType(name, modes[mode]))
             elif hasattr(modes[mode], name):
                 modes[mode]._bind_key(key, getattr(modes[mode], name))
             else:

=== modified file 'pyreadline/test/test_emacs.py'
--- pyreadline/test/test_emacs.py	2010-07-20 16:30:15 +0000
+++ pyreadline/test/test_emacs.py	2011-04-23 08:41:27 +0000
@@ -9,12 +9,12 @@
 
 import sys, unittest
 import pdb
-sys.path.append (u'../..')
+sys.path.insert(0, u'../..')
 from pyreadline.modes.emacs import *
 from pyreadline import keysyms
 from pyreadline.lineeditor import lineobj
 
-from common import *
+from pyreadline.test.common import *
 from pyreadline.logger import log
 import pyreadline.logger as logger
 logger.sock_silent=True

=== modified file 'pyreadline/test/test_vi.py'
--- pyreadline/test/test_vi.py	2010-07-20 17:12:13 +0000
+++ pyreadline/test/test_vi.py	2011-04-23 08:41:27 +0000
@@ -7,15 +7,15 @@
 #*****************************************************************************
 
 import sys, unittest,pdb
-sys.path.append (u'../..')
+sys.path.insert(0, u'../..')
 from pyreadline.modes.vi import *
 from pyreadline import keysyms
 from pyreadline.lineeditor import lineobj
 from pyreadline.logger import log
 import pyreadline.logger as logger
-from common import *
+from pyreadline.test.common import *
 
-from common import *
+from pyreadline.test.common import *
 #----------------------------------------------------------------------
 
 class ViModeTest (ViMode):

=== modified file 'pyreadline/unicode_helper.py'
--- pyreadline/unicode_helper.py	2010-07-15 16:23:16 +0000
+++ pyreadline/unicode_helper.py	2011-04-23 08:41:27 +0000
@@ -17,9 +17,14 @@
 if pyreadline_codepage is None:  
     pyreadline_codepage = u"ascii"
 
+if sys.version_info < (2, 6):
+    bytes = str
+
+PY3 = (sys.version_info >= (3, 0))
+
 def ensure_unicode(text):
     u"""helper to ensure that text passed to WriteConsoleW is unicode"""
-    if isinstance(text, str):
+    if isinstance(text, bytes):
         try:
             return text.decode(pyreadline_codepage, u"replace")
         except (LookupError, TypeError):
@@ -34,3 +39,9 @@
         except (LookupError, TypeError):
             return text.encode(u"ascii", u"replace")
     return text
+
+def biter(text):
+    if PY3 and isinstance(text, bytes):
+        return (s.to_bytes(1, 'big') for s in text)
+    else:
+        return iter(text)

=== modified file 'setup.py'
--- setup.py	2010-07-19 17:09:00 +0000
+++ setup.py	2011-04-23 08:41:27 +0000
@@ -9,6 +9,7 @@
 #*****************************************************************************
 
 import os
+import sys
 import glob
 
 # BEFORE importing distutils, remove MANIFEST. distutils doesn't properly
@@ -16,8 +17,25 @@
 if os.path.exists('MANIFEST'): os.remove('MANIFEST')
 #
 
-from distutils.core import setup
-execfile('pyreadline/release.py')
+extra = {}
+_distribute = False
+
+try:
+    import setuptools
+    setup = setuptools.setup
+    _distribute = getattr(setuptools, '_distribute', False)
+except ImportError:
+    from distutils.core import setup
+
+if sys.version_info >= (3, 0):
+    if _distribute == False:
+        raise RuntimeError('You must installed `distribute` to setup pyreadline with Python3')
+
+    extra.update(
+        use_2to3=True
+    )
+
+exec(compile(open('pyreadline/release.py').read(), 'pyreadline/release.py', 'exec'))
 
 try:
     import sphinx
@@ -50,5 +68,6 @@
       package_data     = {'pyreadline':['configuration/*']},
       data_files       = [],
       cmdclass = cmd_class,
+      **extra
       )