Python 3 preparation: StringIO.

This generally arranges for StringIO and cStringIO references to use
io.StringIO for Python 3 but io.BytesIO for Python 2, consistent with
the string representations generally used in Roundup.  A special
FasterStringIO in the TAL code, which referenced internals of the old
Python 2 StringIO module, is cut down so it doesn't actually do
anything beyond the StringIO class it inherits from (it would also be
reasonable to remove FasterStringIO completely).  One place in
roundup_server.py clearly needing binary I/O is made to use io.BytesIO
unconditionally.

Author: jsm28

frontends/roundup.cgi

@@ -71,12 +71,13 @@ LOG = DevNull()
 # Set up the error handler
 # 
 try:
-    import traceback, StringIO, cgi
+    import traceback, cgi
+    from roundup.anypy.strings import StringIO
     from roundup.cgi import cgitb
 except:
     print("Content-Type: text/plain\n")
     print(_("Failed to import cgitb!\n\n"))
-    s = StringIO.StringIO()
+    s = StringIO()
     traceback.print_exc(None, s)
     print(s.getvalue())
 

roundup/anypy/strings.py

@@ -7,6 +7,12 @@
 import sys
 _py3 = sys.version_info[0] > 2
 
+import io
+if _py3:
+    StringIO = io.StringIO
+else:
+    StringIO = io.BytesIO
+
 def b2s(b):
     """Convert a UTF-8 encoded bytes object to the internal string format."""
     if _py3:

roundup/cgi/PageTemplates/PageTemplate.py

@@ -25,7 +25,6 @@
 from roundup.cgi.TAL.TALParser import TALParser
 from roundup.cgi.TAL.HTMLTALParser import HTMLTALParser
 from roundup.cgi.TAL.TALGenerator import TALGenerator
-# Do not use cStringIO here!  It's not unicode aware. :(
 from roundup.cgi.TAL.TALInterpreter import TALInterpreter, FasterStringIO
 from .Expressions import getEngine
 

roundup/cgi/TAL/TALInterpreter.py

@@ -22,8 +22,7 @@
 import re
 from types import ListType
 from cgi import escape
-# Do not use cStringIO here!  It's not unicode aware. :(
-from StringIO import StringIO
+from roundup.anypy.strings import StringIO
 #from DocumentTemplate.DT_Util import ustr
 ustr = str
 
@@ -758,18 +757,7 @@ class FasterStringIO(StringIO):
 
     This let's us have a much faster write() method.
     """
-    def close(self):
-        if not self.closed:
-            self.write = _write_ValueError
-            StringIO.close(self)
-
-    def seek(self, pos, mode=0):
-        raise RuntimeError("FasterStringIO.seek() not allowed")
-
-    def write(self, s):
-        #assert self.pos == self.len
-        self.buflist.append(s)
-        self.len = self.pos = self.pos + len(s)
+    pass
 
 
 def _write_ValueError(s):

roundup/cgi/engine_chameleon.py

@@ -5,7 +5,7 @@
 import os.path
 import chameleon
 
-from roundup.cgi.templating import StringIO, context, TALLoaderBase
+from roundup.cgi.templating import context, TALLoaderBase
 from roundup.anypy.strings import s2u
 
 class Loader(TALLoaderBase):

roundup/cgi/engine_zopetal.py

@@ -86,7 +86,7 @@ def render(self, client, classname, request, **options):
         c.update({'options': options})
 
         # and go
-        output = StringIO.StringIO()
+        output = StringIO()
         TALInterpreter.TALInterpreter(self._v_program, self.macros,
             getEngine().getContext(c), output, tal=1, strictinsert=0)()
         return output.getvalue()

roundup/cgi/templating.py

@@ -29,7 +29,7 @@
 from roundup import hyperdb, date, support
 from roundup import i18n
 from roundup.i18n import _
-from roundup.anypy.strings import is_us, us2s, s2u, u2s
+from roundup.anypy.strings import is_us, us2s, s2u, u2s, StringIO
 
 from .KeywordsExpr import render_keywords_expression_editor
 
@@ -43,10 +43,6 @@
     import cPickle as pickle
 except ImportError:
     import pickle
-try:
-    import cStringIO as StringIO
-except ImportError:
-    import StringIO
 try:
     from StructuredText.StructuredText import HTML as StructuredText
 except ImportError:
@@ -647,7 +643,7 @@ def csv(self):
         """ Return the items of this class as a chunk of CSV text.
         """
         props = self.propnames()
-        s = StringIO.StringIO()
+        s = StringIO()
         writer = csv.writer(s)
         writer.writerow(props)
         check = self._client.db.security.hasPermission

roundup/mailer.py

@@ -4,8 +4,6 @@
 
 import time, quopri, os, socket, smtplib, re, sys, traceback, email, logging
 
-from cStringIO import StringIO
-
 from roundup import __version__
 from roundup.date import get_timezone, Date
 

roundup/mailgw.py

@@ -95,7 +95,7 @@ class node. Any parts of other types are each stored in separate files
 from __future__ import print_function
 __docformat__ = 'restructuredtext'
 
-import string, re, os, mimetools, cStringIO, smtplib, socket, binascii, quopri
+import string, re, os, mimetools, smtplib, socket, binascii, quopri
 import time, random, sys, logging
 import codecs
 import traceback
@@ -108,6 +108,7 @@ class node. Any parts of other types are each stored in separate files
 from roundup.mailer import Mailer, MessageSendError
 from roundup.i18n import _
 from roundup.hyperdb import iter_roles
+from roundup.anypy.strings import StringIO
 
 try:
     import pyme, pyme.core, pyme.constants, pyme.constants.sigsum
@@ -223,7 +224,7 @@ def getpart(self):
         '''
         boundary = self.getparam('boundary')
         mid, end = '--'+boundary, '--'+boundary+'--'
-        s = cStringIO.StringIO()
+        s = StringIO()
         while 1:
             line = self.fp.readline()
             if not line:
@@ -303,7 +304,7 @@ def getname(self):
             # the subject of the actual e-mail embedded here
             # we add a '.eml' extension like other email software does it
             self.fp.seek(0)
-            s = cStringIO.StringIO(self.getbody())
+            s = StringIO(self.getbody())
             name = Message(s).getheader('subject')
             if name:
                 name = name + '.eml'
@@ -329,7 +330,7 @@ def getbody(self):
             data = binascii.a2b_base64(self.fp.read())
         elif encoding == 'quoted-printable':
             # the quopri module wants to work with files
-            decoded = cStringIO.StringIO()
+            decoded = StringIO()
             quopri.decode(self.fp, decoded)
             data = decoded.getvalue()
         elif encoding == 'uuencoded':
@@ -449,7 +450,7 @@ def extract_content(self, parent_type=None, ignore_alternatives=False,
                 attachments = []
             html_part = False
         elif unpack_rfc822 and content_type == 'message/rfc822':
-            s = cStringIO.StringIO(self.getbody())
+            s = StringIO(self.getbody())
             m = Message(s)
             ig = ignore_alternatives and not content
             new_content, attachments, html_part = m.extract_content(m.gettype(), ig,
@@ -527,7 +528,7 @@ def decrypt(self, author, may_be_unsigned=False):
         # pyme.core.Data implements a seek method with a different signature
         # than roundup can handle. So we'll put the data in a container that
         # the Message class can work with.
-        c = cStringIO.StringIO()
+        c = StringIO()
         c.write(plaintext.read())
         c.seek(0)
         return Message(c)
@@ -1328,7 +1329,7 @@ def do_pipe(self):
 
             XXX: we may want to read this into a temporary file instead...
         """
-        s = cStringIO.StringIO()
+        s = StringIO()
         s.write(sys.stdin.read())
         s.seek(0)
         self.main(s)
@@ -1424,7 +1425,7 @@ def do_imap(self, server, user='', password='', mailbox='', ssl=0,
                 server.store(str(i), '+FLAGS', r'(\Deleted)')
 
                 # process the message
-                s = cStringIO.StringIO(data[0][1])
+                s = StringIO(data[0][1])
                 s.seek(0)
                 self.handle_Message(Message(s))
             server.close()
@@ -1493,7 +1494,7 @@ def _do_pop(self, server, user, password, apop, ssl):
             #   [ array of message lines ],
             #   number of octets ]
             lines = server.retr(i)[1]
-            s = cStringIO.StringIO('\n'.join(lines))
+            s = StringIO('\n'.join(lines))
             s.seek(0)
             self.handle_Message(Message(s))
             # delete the message

roundup/roundupdb.py

@@ -21,7 +21,7 @@
 __docformat__ = 'restructuredtext'
 
 import re, os, smtplib, socket, time, random
-import cStringIO, base64, mimetypes
+import base64, mimetypes
 import os.path
 import logging
 from email import Encoders