Add a manipulate option to find(_one) PYTHON-224

Leaving this set to True by default so there are no
surprises when folks upgrade. We probably want to make
False the default in a later release.

Author: behackett

pymongo/cursor.py

@@ -41,8 +41,8 @@ class Cursor(object):
     def __init__(self, collection, spec=None, fields=None, skip=0, limit=0,
                  timeout=True, snapshot=False, tailable=False, sort=None,
                  max_scan=None, as_class=None, slave_okay=False,
-                 await_data=False, partial=False, _must_use_master=False,
-                 _is_command=False, **kwargs):
+                 await_data=False, partial=False, manipulate=True,
+                 _must_use_master=False, _is_command=False, **kwargs):
         """Create a new cursor.
 
         Should not be called directly by application developers - see
@@ -109,6 +109,7 @@ def __init__(self, collection, spec=None, fields=None, skip=0, limit=0,
         self.__hint = None
         self.__as_class = as_class
         self.__slave_okay = slave_okay
+        self.__manipulate = manipulate
         self.__tz_aware = collection.database.connection.tz_aware
         self.__must_use_master = _must_use_master
         self.__is_command = _is_command
@@ -173,6 +174,7 @@ def clone(self):
         copy.__slave_okay = self.__slave_okay
         copy.__await_data = self.__await_data
         copy.__partial = self.__partial
+        copy.__manipulate = self.__manipulate
         copy.__must_use_master = self.__must_use_master
         copy.__is_command = self.__is_command
         copy.__query_flags = self.__query_flags
@@ -651,10 +653,12 @@ def next(self):
             raise StopIteration
         db = self.__collection.database
         if len(self.__data) or self._refresh():
-            next = db._fix_outgoing(self.__data.pop(0), self.__collection)
+            if self.__manipulate:
+                return db._fix_outgoing(self.__data.pop(0), self.__collection)
+            else:
+                return self.__data.pop(0)
         else:
             raise StopIteration
-        return next
 
     def __enter__(self):
         return self

test/test_collection.py

@@ -33,6 +33,7 @@
 from bson.son import SON
 from pymongo import ASCENDING, DESCENDING
 from pymongo.collection import Collection
+from pymongo.son_manipulator import SONManipulator
 from pymongo.errors import (DuplicateKeyError,
                             InvalidDocument,
                             InvalidName,
@@ -1250,5 +1251,23 @@ def test_find_and_modify(self):
                          c.find_and_modify({'_id': 1}, {'$inc': {'i': 1}},
                                            new=True, fields={'i': 1}))
 
+    def test_disabling_manipulators(self):
+
+        class IncByTwo(SONManipulator):
+            def transform_outgoing(self, son, collection):
+                if 'foo' in son:
+                    son['foo'] += 2
+                return son
+
+        db = self.connection.pymongo_test
+        db.add_son_manipulator(IncByTwo())
+        c = db.test
+        c.drop()
+        c.insert({'foo': 0})
+        self.assertEqual(2, c.find_one()['foo'])
+        self.assertEqual(0, c.find_one(manipulate=False)['foo'])
+        self.assertEqual(2, c.find_one(manipulate=True)['foo'])
+        c.remove({})
+
 if __name__ == "__main__":
     unittest.main()

test/test_cursor.py

@@ -463,7 +463,8 @@ class MyClass(dict):
                                    as_class=MyClass,
                                    slave_okay=True,
                                    await_data=True,
-                                   partial=True).limit(2)
+                                   partial=True,
+                                   manipulate=False).limit(2)
         cursor.add_option(64)
 
         cursor2 = cursor.clone()
@@ -479,6 +480,8 @@ class MyClass(dict):
         self.assertEqual(cursor._Cursor__await_data,
                          cursor2._Cursor__await_data)
         self.assertEqual(cursor._Cursor__partial, cursor2._Cursor__partial)
+        self.assertEqual(cursor._Cursor__manipulate,
+                         cursor2._Cursor__manipulate)
         self.assertEqual(cursor._Cursor__query_flags,
                          cursor2._Cursor__query_flags)