Add compatibility package to allow us to deal with Python versions 2.3..2.6.

Outstanding issues noted in roundup/anypy/TODO.txt

Author: Richard Jones

CHANGES.txt

@@ -10,6 +10,7 @@ Fixes:
 - HTML file uploads served as application/octet-stream
 - New item action reject creation of new users
 - Item retirement was not being controlled
+- Roundup is now compatible with Python 2.6
 - XXX need to include Stefan's changes in here too
 
 

doc/upgrading.txt

@@ -61,6 +61,22 @@ Should be replaced with::
      </form>
 
 
+Fix for Python 2.6+ users
+-------------------------
+
+If you use Python 2.6 you should edit your tracker's
+``detectors/nosyreaction.py`` file to change::
+
+   import sets
+
+at the top to::
+
+   from roundup.anypy.sets_ import set
+
+and then all instances of ``sets.Set()`` to ``set()`` in the later code.
+
+
+
 Trackers currently allowing HTML file uploading
 -----------------------------------------------
 

roundup/admin.py

@@ -729,7 +729,7 @@ def do_specification(self, args):
                 print _('%(key)s: %(value)s')%locals()
 
     def do_display(self, args):
-        """Usage: display designator[,designator]*
+        ''"""Usage: display designator[,designator]*
         Show the property values for the given node(s).
 
         This lists the properties and their associated values for the given

roundup/anypy/README.txt

@@ -0,0 +1,57 @@
+roundup.anypy package - Python version compatibility layer
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Roundup currently supports Python 2.3 to 2.6; however, some modules
+have been introduced, while others have been deprecated.  The modules
+in this package provide the functionalities which are used by Roundup
+
+- adapting the most recent Python usage
+- using new built-in functionality
+- avoiding deprecation warnings
+
+Use the modules in this package to preserve Roundup's compatibility.
+
+sets_: sets compatibility module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Since Python 2.4, there is a built-in type 'set'; therefore, the 'sets'
+module is deprecated since version 2.6.  As far as Roundup is concerned,
+the usage is identical; see 
+http://docs.python.org/library/sets.html#comparison-to-the-built-in-set-types
+
+Uses the built-in type 'set' if available, and thus avoids
+deprecation warnings. Simple usage:
+
+Change all::
+  from sets import Set
+
+to::
+  from roundup.anypy.sets_ import set
+
+and use 'set' instead of 'Set' (or sets.Set, respectively).
+To avoid unnecessary imports, you can::
+
+  try:
+      set
+  except NameError:
+      from roundup.anypy.sets_ import set
+
+hashlib_: md5/sha/hashlib compatibility
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The md5 and sha modules are deprecated since Python 2.6; the hashlib
+module, introduced with Python 2.5, is recommended instead.
+
+Change all::
+  import md5
+  md5.md5(), md5.new()
+  import sha
+  sha.sha(), sha.new()
+
+to::
+  from roundup.anypy.hashlib_ import md5
+  md5()
+  from roundup.anypy.hashlib_ import sha1
+  sha1()
+
+# vim: si

roundup/anypy/TODO.txt

@@ -0,0 +1,27 @@
+Python compatiblity TODO
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+- the popen2 module is deprecated as of Python 2.6;
+  the subprocess module is available since Python 2.4,
+  thus a roundup.anypy.subprocess_ module is needed
+
+- the MimeWriter module is deprecated as of Python 2.6.  The email package is
+  available since Python 2.2, thus we should manage without a ...email_
+  module;  however, it has suffered some API changes over the time
+  (http://docs.python.org/library/email.html#package-history),
+  so this is not sure.
+
+  Here's an incomplete replacement table:
+
+  MimeWriter usage                        checked for
+  -> email usage                          Python ...
+  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~
+  MimeWriter.MimeWriter
+  -> email.Message.Message                (2.3)
+
+  MimeWriter.MimeWrite.addheader
+  -> email.Message.Message.add_header     (2.3)
+
+- test.test_sqlite.sqliteDBTest.testStringUnicode fails
+
+# vim: si

roundup/anypy/__init__.py

@@ -0,0 +1,7 @@
+"""
+roundup.anypy - compatibility layer for any Python 2.3+
+"""
+VERSION = '.'.join(map(str,
+                       (0,
+                        1,  # hashlib_, sets_
+                        )))

roundup/anypy/hashlib_.py

@@ -0,0 +1,11 @@
+"""
+anypy.hashlib_: encapsulation of hashlib/md5/sha1/sha
+"""
+
+try:
+    from hashlib import md5, sha1 # new in Python 2.5
+except ImportError:
+    from md5 import md5           # deprecated in Python 2.6
+    from sha import sha as sha1   # deprecated in Python 2.6
+
+# vim: ts=8 sts=4 sw=4 si

roundup/anypy/sets_.py

@@ -0,0 +1,30 @@
+"""
+anypy.sets_: sets compatibility module
+
+uses the built-in type 'set' if available, and thus avoids
+deprecation warnings. Simple usage:
+
+Change all
+    from sets import Set
+to
+    from roundup.anypy.sets_ import set
+
+and use 'set' instead of 'Set'.
+To avoid unnecessary imports, you can:
+
+    try:
+        set
+    except NameError:
+        from roundup.anypy.sets_ import set
+
+see:
+http://docs.python.org/library/sets.html#comparison-to-the-built-in-set-types
+
+"""
+
+try:
+    set = set                     # built-in since Python 2.4
+except NameError, TypeError:
+    from sets import Set as set   # deprecated as of Python 2.6
+
+# vim: ts=8 sts=4 sw=4 si et

roundup/backends/indexer_common.py

@@ -1,5 +1,7 @@
 #$Id: indexer_common.py,v 1.11 2008-09-11 19:41:07 schlatterbeck Exp $
-import re, sets
+import re
+# Python 2.3 ... 2.6 compatibility:
+from roundup.anypy.sets_ import set
 
 from roundup import hyperdb
 
@@ -17,7 +19,7 @@ def _isLink(propclass):
 
 class Indexer:
     def __init__(self, db):
-        self.stopwords = sets.Set(STOPWORDS)
+        self.stopwords = set(STOPWORDS)
         for word in db.config[('main', 'indexer_stopwords')]:
             self.stopwords.add(word)
 
@@ -28,11 +30,11 @@ def getHits(self, search_terms, klass):
         return self.find(search_terms)
 
     def search(self, search_terms, klass, ignore={}):
-        '''Display search results looking for [search, terms] associated
+        """Display search results looking for [search, terms] associated
         with the hyperdb Class "klass". Ignore hits on {class: property}.
 
         "dre" is a helper, not an argument.
-        '''
+        """
         # do the index lookup
         hits = self.getHits(search_terms, klass)
         if not hits:

roundup/backends/indexer_rdbms.py

@@ -1,9 +1,11 @@
 #$Id: indexer_rdbms.py,v 1.18 2008-09-01 00:43:02 richard Exp $
-''' This implements the full-text indexer over two RDBMS tables. The first
+""" This implements the full-text indexer over two RDBMS tables. The first
 is a mapping of words to occurance IDs. The second maps the IDs to (Class,
 propname, itemid) instances.
-'''
-import re, sets
+"""
+import re
+# Python 2.3 ... 2.6 compatibility:
+from roundup.anypy.sets_ import set
 
 from roundup.backends.indexer_common import Indexer as IndexerBase
 
@@ -14,27 +16,27 @@ def __init__(self, db):
         self.reindex = 0
 
     def close(self):
-        '''close the indexing database'''
+        """close the indexing database"""
         # just nuke the circular reference
         self.db = None
 
     def save_index(self):
-        '''Save the changes to the index.'''
+        """Save the changes to the index."""
         # not necessary - the RDBMS connection will handle this for us
         pass
 
     def force_reindex(self):
-        '''Force a reindexing of the database.  This essentially
+        """Force a reindexing of the database.  This essentially
         empties the tables ids and index and sets a flag so
-        that the databases are reindexed'''
+        that the databases are reindexed"""
         self.reindex = 1
 
     def should_reindex(self):
-        '''returns True if the indexes need to be rebuilt'''
+        """returns True if the indexes need to be rebuilt"""
         return self.reindex
 
     def add_text(self, identifier, text, mime_type='text/plain'):
-        ''' "identifier" is  (classname, itemid, property) '''
+        """ "identifier" is  (classname, itemid, property) """
         if mime_type != 'text/plain':
             return
 
@@ -65,7 +67,7 @@ def add_text(self, identifier, text, mime_type='text/plain'):
         text = unicode(text, "utf-8", "replace").upper()
         wordlist = [w.encode("utf-8", "replace")
                 for w in re.findall(r'(?u)\b\w{2,25}\b', text)]
-        words = sets.Set()
+        words = set()
         for word in wordlist:
             if self.is_stopword(word): continue
             if len(word) > 25: continue
@@ -77,10 +79,10 @@ def add_text(self, identifier, text, mime_type='text/plain'):
         self.db.cursor.executemany(sql, words)
 
     def find(self, wordlist):
-        '''look up all the words in the wordlist.
+        """look up all the words in the wordlist.
         If none are found return an empty dictionary
         * more rules here
-        '''
+        """
         if not wordlist:
             return []