PYTHON-709 insert _id in document after applying non-copying SONManipulators.

Author: ajdavis

pymongo/collection.py

@@ -378,11 +378,14 @@ def insert(self, doc_or_docs, manipulate=True,
  def gen():
  db = self.__database
  for doc in docs:
+ # Apply user-configured SON manipulators. This order of
+ # operations is required for backwards compatibility,
+ # see PYTHON-709.
+ doc = db._apply_incoming_manipulators(doc, self)
  if '_id' not in doc:
  doc['_id'] = ObjectId()
 
- # Apply user-configured SON manipulators.
- doc = db._fix_incoming(doc, self)
+ doc = db._apply_incoming_copying_manipulators(doc, self)
  ids.append(doc['_id'])
  yield doc
  else:

pymongo/database.py

@@ -247,17 +247,25 @@ def create_collection(self, name, **kwargs):
 
  return Collection(self, name, **opts)
 
+ def _apply_incoming_manipulators(self, son, collection):
+ for manipulator in self.__incoming_manipulators:
+ son = manipulator.transform_incoming(son, collection)
+ return son
+
+ def _apply_incoming_copying_manipulators(self, son, collection):
+ for manipulator in self.__incoming_copying_manipulators:
+ son = manipulator.transform_incoming(son, collection)
+ return son
+
  def _fix_incoming(self, son, collection):
  """Apply manipulators to an incoming SON object before it gets stored.
 
  :Parameters:
  - `son`: the son object going into the database
  - `collection`: the collection the son object is being saved in
  """
- for manipulator in self.__incoming_manipulators:
- son = manipulator.transform_incoming(son, collection)
- for manipulator in self.__incoming_copying_manipulators:
- son = manipulator.transform_incoming(son, collection)
+ son = self._apply_incoming_manipulators(son, collection)
+ son = self._apply_incoming_copying_manipulators(son, collection)
  return son
 
  def _fix_outgoing(self, son, collection):

test/test_database.py

@@ -45,6 +45,7 @@
  OperationFailure)
 from pymongo.son_manipulator import (AutoReference,
  NamespaceInjector,
+ SONManipulator,
  ObjectIdShuffler)
 from test import version
 from test.utils import (catch_warnings, get_command_line,
@@ -996,6 +997,29 @@ def test_command_max_time_ms(self):
  "maxTimeAlwaysTimeOut",
  mode="off")
 
+ def test_object_to_dict_transformer(self):
+ # PYTHON-709: Some users rely on their custom SONManipulators to run
+ # before any other checks, so they can insert non-dict objects and
+ # have them dictified before the _id is inserted or any other
+ # processing.
+ class Thing(object):
+ def __init__(self, value):
+ self.value = value
+
+ class ThingTransformer(SONManipulator):
+ def transform_incoming(self, thing, collection):
+ return {'value': thing.value}
+
+ db = self.client.foo
+ db.add_son_manipulator(ThingTransformer())
+ t = Thing('value')
+
+ db.test.remove()
+ db.test.insert([t])
+ out = db.test.find_one()
+ self.assertEqual('value', out.get('value'))
+
+
 
 if __name__ == "__main__":
  unittest.main()