add sort parameter for find

Mike Dirolf · Mike Dirolf · commit 3411bde4f7ce · 2010-05-09T16:30:11.000+03:00
diff --git a/doc/api/pymongo/cursor.rst b/doc/api/pymongo/cursor.rst
@@ -4,7 +4,7 @@
 .. automodule:: pymongo.cursor
    :synopsis: Tools for iterating over MongoDB query results
 
-   .. autoclass:: pymongo.cursor.Cursor(collection, spec, fields, skip, limit, slave_okay, timeout, tailable[, snapshot=False])
+   .. autoclass:: pymongo.cursor.Cursor(collection, spec, fields, skip, limit, slave_okay, timeout, tailable[, snapshot=False[, sort=None]])
       :members:
 
       .. describe:: c[index]
diff --git a/pymongo/collection.py b/pymongo/collection.py
@@ -422,7 +422,7 @@ def _fields_list_to_dict(self, fields):
         return as_dict
 
     def find(self, spec=None, fields=None, skip=0, limit=0,
-             timeout=True, snapshot=False, tailable=False,
+             timeout=True, snapshot=False, tailable=False, sort=None,
              _sock=None, _must_use_master=False, _is_command=False):
         """Query the database.
 
@@ -473,6 +473,12 @@ def find(self, spec=None, fields=None, skip=0, limit=0,
             continue from the last document received. For details, see
             the `tailable cursor documentation
             <http://www.mongodb.org/display/DOCS/Tailable+Cursors>`_.
+          - `sort` (optional): a list of (key, direction) pairs
+            specifying the sort order for this query. See
+            :meth:`~pymongo.cursor.Cursor.sort` for details.
+
+        .. versionadded:: 1.6+
+           The `sort` parameter.
 
         .. versionchanged:: 1.6+
            The `fields` parameter can now be a dict or any iterable in
@@ -484,7 +490,7 @@ def find(self, spec=None, fields=None, skip=0, limit=0,
         .. mongodoc:: find
         """
         if spec is None:
-            spec = SON()
+            spec = {}
 
         slave_okay = self.__database.connection.slave_okay
 
@@ -508,7 +514,7 @@ def find(self, spec=None, fields=None, skip=0, limit=0,
                 fields = self._fields_list_to_dict(fields)
 
         return Cursor(self, spec, fields, skip, limit, slave_okay, timeout,
-                      tailable, snapshot, _sock=_sock,
+                      tailable, snapshot, sort, _sock=_sock,
                       _must_use_master=_must_use_master,
                       _is_command=_is_command)
 
diff --git a/pymongo/cursor.py b/pymongo/cursor.py
@@ -37,14 +37,17 @@ class Cursor(object):
     """
 
     def __init__(self, collection, spec, fields, skip, limit, slave_okay,
-                 timeout, tailable, snapshot=False,
+                 timeout, tailable, snapshot=False, sort=None,
                  _sock=None, _must_use_master=False, _is_command=False):
         """Create a new cursor.
 
-        Should not be called directly by application developers.
+        Should not be called directly by application developers - see
+        :meth:`~pymongo.collection.Collection.find` instead.
 
         .. mongodoc:: cursors
         """
+        self.__id = None
+
         self.__collection = collection
         self.__spec = spec
         self.__fields = fields
@@ -54,15 +57,14 @@ def __init__(self, collection, spec, fields, skip, limit, slave_okay,
         self.__timeout = timeout
         self.__tailable = tailable
         self.__snapshot = snapshot
-        self.__ordering = None
+        self.__ordering = sort and helpers._index_document(sort) or None
         self.__explain = False
         self.__hint = None
         self.__socket = _sock
         self.__must_use_master = _must_use_master
         self.__is_command = _is_command
 
         self.__data = []
-        self.__id = None
         self.__connection_id = None
         self.__retrieved = 0
         self.__killed = False
diff --git a/test/test_collection.py b/test/test_collection.py
@@ -869,6 +869,29 @@ def test_find_one_with_find_args(self):
         self.assertEqual(1, db.test.find_one()["x"])
         self.assertEqual(2, db.test.find_one(skip=1, limit=2)["x"])
 
+    def test_find_with_sort(self):
+        db = self.db
+        db.drop_collection("test")
+
+        db.test.save({"x": 2})
+        db.test.save({"x": 1})
+        db.test.save({"x": 3})
+
+        self.assertEqual(2, db.test.find_one()["x"])
+        self.assertEqual(1, db.test.find_one(sort=[("x", 1)])["x"])
+        self.assertEqual(3, db.test.find_one(sort=[("x", -1)])["x"])
+
+        def to_list(foo):
+            return [bar["x"] for bar in foo]
+
+        self.assertEqual([2,1,3], to_list(db.test.find()))
+        self.assertEqual([1,2,3], to_list(db.test.find(sort=[("x", 1)])))
+        self.assertEqual([3,2,1], to_list(db.test.find(sort=[("x", -1)])))
+
+        self.assertRaises(TypeError, db.test.find, sort=5)
+        self.assertRaises(TypeError, db.test.find, sort="hello")
+        self.assertRaises(ValueError, db.test.find, sort=["hello", 1])
+
     def test_insert_adds_id(self):
         doc = {"hello": "world"}
         self.db.test.insert(doc)
