Compatibility with Python 3 and pymongo >= 3.0.0

.gitignore

@@ -0,0 +1,4 @@
+.eggs
+*.egg-info
+.venv*
+*.pyc

mongodb_gridfs_beaker/__init__.py

@@ -20,8 +20,16 @@
 from beaker.synchronization import file_synchronizer
 from beaker.util import SyncDict, verify_directory
 
+# Compatibility between pymongo<>3.0.0.
+import pymongo
+from distutils.version import LooseVersion
+try:
+    from pymongo import MongoClient as Connection
+    from pymongo.read_preferences import ReadPreference
+except ImportError:
+    from pymongo.connection import Connection
+
 from pymongo.uri_parser import parse_uri
-from pymongo.connection import Connection
 from pymongo import ASCENDING, DESCENDING
 
 from gridfs import GridFS
@@ -33,7 +41,7 @@
     import pickle
 
 class MongoDBGridFSNamespaceManager(NamespaceManager):
-    
+
     clients = SyncDict()
 
     def __init__(self, namespace, url=None, data_dir=None, lock_dir=None, **params):
@@ -49,7 +57,7 @@ def __init__(self, namespace, url=None, data_dir=None, lock_dir=None, **params):
         if not url:
             raise MissingCacheParameter("MongoDB url is required")
 
-        for k, v in parse_uri(url).iteritems():
+        for k, v in parse_uri(url).items():
             setattr(self, "url_%s"%k, v)
 
         if not self.url_database or not self.url_nodelist:
@@ -64,16 +72,23 @@ def _create_mongo_connection(self):
             'mongodb://%s' % (",".join(["%s:%s" % h for h in self.url_nodelist]))
         log.info("[MongoDBGridFS] Host URI: %s" % host_uri)
 
+        is_pymongo3 = LooseVersion(pymongo.version) >= LooseVersion('3.0.0')
+
         params = {}
-        params['slaveok'] = self.url_options.get("slaveok", False)
-        if self.url_options.has_key("replicaset"):
+        if "slaveok" in self.url_options and self.url_options['slaveok']:
+            if is_pymongo3:
+                params['readPreference'] = ReadPreference.SECONDARY_PREFERRED
+            else:
+                params['slaveok'] = True
+
+        if "replicaset" in self.url_options:
             params['replicaset'] = self.url_options["replicaset"] or ""
 
         conn = Connection(host_uri, **params)
         db = conn[self.url_database]
 
         if self.url_username:
-            log.info("[MongoDBGridFS] Attempting to authenticate %s/%s " % 
+            log.info("[MongoDBGridFS] Attempting to authenticate %s/%s " %
                      (self.url_username, self.url_password))
             if not db.authenticate(self.url_username, self.url_password):
                 raise InvalidCacheBackendError('Cannot authenticate to MongoDB.')
@@ -123,7 +138,7 @@ def __getitem__(self, key):
 
         try:
             value = pickle.loads(value)
-        except Exception, e:
+        except Exception as e:
             log.exception("[MongoDBGridFS] Failed to unpickle value.")
             return None
 
@@ -138,7 +153,7 @@ def __contains__(self, key):
     def has_key(self, key):
         return key in self
 
-    def set_value(self, key, value):
+    def set_value(self, key, value, expiretime=None):
         query = {'namespace': self.namespace, 'filename': key}
         log.debug("[MongoDBGridFS %s] Set Key: %s" % (self.gridfs, query))
 

setup.py

@@ -12,15 +12,15 @@
 
 setup(
     name = 'mongodb_gridfs_beaker',
-    version = '0.5.4',
+    version = '0.6.0dev1',
     description = 'Beaker backend to write sessions and caches to a MongoDB GridFS',
     long_description = '\n' + open('README.rst').read(),
     author='Lukasz Biedrycki',
     author_email = '[email protected]',
     keywords = 'mongo mongodb gridfs beaker cache session',
     license = 'New BSD License',
     url = 'https://github.com/loucash/mongodb_gridfs_beaker',
-    tests_require = ['nose', 'webtest'],
+    tests_require = ['nose', 'WebTest'],
     test_suite='nose.collector',
     classifiers = [
         'Development Status :: 4 - Beta',

tests/test_default.py

@@ -7,10 +7,18 @@
 from beaker.exceptions import InvalidCacheBackendError
 from nose import SkipTest
 from webtest import TestApp
-from pymongo.connection import Connection
 import unittest
 import time
 
+# Compatibility between Python 2 <=> Python 3
+IS_PYTHON_3 = (sys.version_info[0] >= 3)
+
+# Compatibility between pymongo<>3.0.0.
+try:
+    from pymongo import MongoClient as Connection
+except ImportError:
+    from pymongo.connection import Connection
+
 try:
     clsmap['mongodb_gridfs']._init_dependencies()
 except InvalidCacheBackendError:
@@ -49,8 +57,8 @@ def simple_session_app(environ, start_response):
         if not environ['PATH_INFO'].startswith('/nosave'):
             session.save()
     start_response('200 OK', [('Content-type', 'text/plain')])
-    return ['The current value is: %d, session id is %s' % (session['value'],
-                                                            session.id)]
+    return [_b('The current value is: %d, session id is %s' % (session['value'],
+                                                               session.id))]
 
 def simple_app(environ, start_response):
     extra_args = {}
@@ -70,7 +78,7 @@ def simple_app(environ, start_response):
         value = 0
     cache.set_value('value', value+1)
     start_response('200 OK', [('Content-type', 'text/plain')])
-    return ['The current value is: %s' % cache.get_value('value')]
+    return [_b('The current value is: %s' % cache.get_value('value'))]
 
 
 def using_none_app(environ, start_response):
@@ -91,24 +99,33 @@ def using_none_app(environ, start_response):
         value = 10
     cache.set_value('value', None)
     start_response('200 OK', [('Content-type', 'text/plain')])
-    return ['The current value is: %s' % value]
+    return [_b('The current value is: %s' % value)]
 
 
 def cache_manager_app(environ, start_response):
     cm = environ['beaker.cache']
     cm.get_cache('test')['test_key'] = 'test value'
 
     start_response('200 OK', [('Content-type', 'text/plain')])
-    yield "test_key is: %s\n" % cm.get_cache('test')['test_key']
+    yield _b("test_key is: %s\n" % cm.get_cache('test')['test_key'])
     cm.get_cache('test').clear()
 
     try:
         test_value = cm.get_cache('test')['test_key']
     except KeyError:
-        yield "test_key cleared"
+        yield _b("test_key cleared")
+    else:
+        yield _b("test_key wasn't cleared, is: %s\n" % \
+            cm.get_cache('test')['test_key'])
+
+
+def _b(value):
+    # Utility function as WebTest and its machinery want
+    # to yield byte-responses when running on Python3.
+    if IS_PYTHON_3:
+        return bytes(value, 'ascii')
     else:
-        yield "test_key wasn't cleared, is: %s\n" % \
-            cm.get_cache('test')['test_key']
+        return value
 
 
 def test_session():