Merge branch 'master' into fork

Author: wolfmanx

bson/binary.py

@@ -68,8 +68,9 @@
 """
 
 JAVA_LEGACY = 5
-"""Specify that UUIDs should be stored in the legacy
-byte order used by the Java driver.
+"""Used with :attr:`pymongo.collection.Collection.uuid_subtype`
+to specify that UUIDs should be stored in the legacy byte order
+used by the Java driver.
 
 :class:`uuid.UUID` instances will automatically be encoded
 by :mod:`bson` using :data:`OLD_UUID_SUBTYPE`.
@@ -78,8 +79,9 @@
 """
 
 CSHARP_LEGACY = 6
-"""Specify that UUIDs should be stored in the legacy
-byte order used by the C# driver.
+"""Used with :attr:`pymongo.collection.Collection.uuid_subtype`
+to specify that UUIDs should be stored in the legacy byte order
+used by the C# driver.
 
 :class:`uuid.UUID` instances will automatically be encoded
 by :mod:`bson` using :data:`OLD_UUID_SUBTYPE`.

bson/objectid.py

@@ -130,7 +130,7 @@ def is_valid(cls, oid):
         :Parameters:
           - `oid`: the object id to validate
 
-        .. versionadded:: 2.2.1+
+        .. versionadded:: 2.3
         """
         try:
             ObjectId(oid)

doc/api/bson/binary.rst

@@ -7,8 +7,10 @@
    .. autodata:: BINARY_SUBTYPE
    .. autodata:: FUNCTION_SUBTYPE
    .. autodata:: OLD_BINARY_SUBTYPE
-   .. autodata:: UUID_SUBTYPE
    .. autodata:: OLD_UUID_SUBTYPE
+   .. autodata:: UUID_SUBTYPE
+   .. autodata:: JAVA_LEGACY
+   .. autodata:: CSHARP_LEGACY
    .. autodata:: MD5_SUBTYPE
    .. autodata:: USER_DEFINED_SUBTYPE
 

doc/changelog.rst

@@ -16,6 +16,7 @@ Important New Features:
 - A new :meth:`~pymongo.collection.Collection.aggregate` method to support
   MongoDB's new `aggregation framework
   <http://docs.mongodb.org/manual/applications/aggregation/>`_.
+- Support for legacy Java and C# byte order when encoding and decoding UUIDs.
 - Support for connecting directly to an arbiter.
 
 .. warning::

pymongo/__init__.py

@@ -48,7 +48,7 @@
 ALL = 2
 """Profile all operations."""
 
-version_tuple = (2, 2, 1, '+')
+version_tuple = (2, 3, 'rc1+')
 
 def get_version_string():
     if isinstance(version_tuple[-1], basestring):

pymongo/collection.py

@@ -189,14 +189,14 @@ def __set_uuid_subtype(self, subtype):
         self.__uuid_subtype = subtype
 
     uuid_subtype = property(__get_uuid_subtype, __set_uuid_subtype,
-                            doc="""This setting specifies which BSON Binary
+                            doc="""This attribute specifies which BSON Binary
                             subtype is used when storing UUIDs. Historically
                             UUIDs have been stored as BSON Binary subtype 3.
-                            This setting is used to switch to the newer BSON
-                            binary subtype 4. This setting can also be used to
-                            force legacy byte order and subtype compatibility
-                            with the Java and C# drivers. See the bson.binary
-                            module for all options.""")
+                            This attribute is used to switch to the newer BSON
+                            binary subtype 4. It can also be used to force
+                            legacy byte order and subtype compatibility with
+                            the Java and C# drivers. See the
+                            :mod:`bson.binary` module for all options.""")
 
     def __get_context(self):
         return self.__context
@@ -659,7 +659,7 @@ def count(self):
         """
         return self.find().count()
 
-    def create_index(self, key_or_list, ttl=300, **kwargs):
+    def create_index(self, key_or_list, cache_for=300, **kwargs):
         """Creates an index on this collection.
 
         Takes either a single key or a list of (key, direction) pairs.
@@ -696,13 +696,18 @@ def create_index(self, key_or_list, ttl=300, **kwargs):
         :Parameters:
           - `key_or_list`: a single key or a list of (key, direction)
             pairs specifying the index to create
-          - `ttl` (optional): time window (in seconds) during which
+          - `cache_for` (optional): time window (in seconds) during which
             this index will be recognized by subsequent calls to
             :meth:`ensure_index` - see documentation for
             :meth:`ensure_index` for details
           - `**kwargs` (optional): any additional index creation
             options (see the above list) should be passed as keyword
             arguments
+          - `ttl` (deprecated): Use `cache_for` instead.
+
+        .. versionchanged:: 2.3
+            The `ttl` parameter has been deprecated to avoid confusion with
+            TTL collections.  Use `cache_for` instead.
 
         .. versionchanged:: 2.2
            Removed deprecated argument: deprecated_unique
@@ -717,6 +722,12 @@ def create_index(self, key_or_list, ttl=300, **kwargs):
 
         .. mongodoc:: indexes
         """
+
+        if 'ttl' in kwargs:
+            cache_for = kwargs.pop('ttl')
+            warnings.warn("ttl is deprecated. Please use cache_for instead.",
+                          DeprecationWarning)
+
         keys = helpers._index_list(key_or_list)
         index_doc = helpers._index_document(keys)
 
@@ -738,11 +749,11 @@ def create_index(self, key_or_list, ttl=300, **kwargs):
                                               safe=True)
 
         self.__database.connection._cache_index(self.__database.name,
-                                                self.__name, name, ttl)
+                                                self.__name, name, cache_for)
 
         return name
 
-    def ensure_index(self, key_or_list, ttl=300, **kwargs):
+    def ensure_index(self, key_or_list, cache_for=300, **kwargs):
         """Ensures that an index exists on this collection.
 
         Takes either a single key or a list of (key, direction) pairs.
@@ -788,12 +799,17 @@ def ensure_index(self, key_or_list, ttl=300, **kwargs):
         :Parameters:
           - `key_or_list`: a single key or a list of (key, direction)
             pairs specifying the index to create
-          - `ttl` (optional): time window (in seconds) during which
+          - `cache_for` (optional): time window (in seconds) during which
             this index will be recognized by subsequent calls to
             :meth:`ensure_index`
           - `**kwargs` (optional): any additional index creation
             options (see the above list) should be passed as keyword
             arguments
+          - `ttl` (deprecated): Use `cache_for` instead.
+
+        .. versionchanged:: 2.3
+            The `ttl` parameter has been deprecated to avoid confusion with
+            TTL collections.  Use `cache_for` instead.
 
         .. versionchanged:: 2.2
            Removed deprecated argument: deprecated_unique
@@ -814,7 +830,7 @@ def ensure_index(self, key_or_list, ttl=300, **kwargs):
 
         if not self.__database.connection._cached(self.__database.name,
                                                   self.__name, name):
-            return self.create_index(key_or_list, ttl, **kwargs)
+            return self.create_index(key_or_list, cache_for, **kwargs)
         return None
 
     def drop_indexes(self):

pymongo/connection.py

@@ -320,11 +320,11 @@ def _cached(self, dbname, coll, index):
                 index in cache[dbname][coll] and
                 now < cache[dbname][coll][index])
 
-    def _cache_index(self, database, collection, index, ttl):
+    def _cache_index(self, database, collection, index, cache_for):
         """Add an index to the index cache for ensure_index operations.
         """
         now = datetime.datetime.utcnow()
-        expire = datetime.timedelta(seconds=ttl) + now
+        expire = datetime.timedelta(seconds=cache_for) + now
 
         if database not in self.__index_cache:
             self.__index_cache[database] = {}

pymongo/master_slave_connection.py

@@ -281,9 +281,10 @@ def _cached(self, database_name, collection_name, index_name):
         return self.__master._cached(database_name,
                                      collection_name, index_name)
 
-    def _cache_index(self, database_name, collection_name, index_name, ttl):
+    def _cache_index(self, database_name, collection_name,
+                     index_name, cache_for):
         return self.__master._cache_index(database_name, collection_name,
-                                          index_name, ttl)
+                                          index_name, cache_for)
 
     def _purge_index(self, database_name,
                      collection_name=None, index_name=None):

pymongo/replica_set_connection.py

@@ -454,11 +454,11 @@ def _cached(self, dbname, coll, index):
                 index in cache[dbname][coll] and
                 now < cache[dbname][coll][index])
 
-    def _cache_index(self, dbase, collection, index, ttl):
+    def _cache_index(self, dbase, collection, index, cache_for):
         """Add an index to the index cache for ensure_index operations.
         """
         now = datetime.datetime.utcnow()
-        expire = datetime.timedelta(seconds=ttl) + now
+        expire = datetime.timedelta(seconds=cache_for) + now
 
         if dbase not in self.__index_cache:
             self.__index_cache[dbase] = {}
@@ -815,7 +815,7 @@ def __check_is_primary(self, host):
             if member:
                 member.pool.discard_socket(sock_info)
             raise ConnectionFailure("%s:%d: %s" % (host[0], host[1], str(why)))
-        
+
         if member and sock_info:
             member.pool.maybe_return_socket(sock_info)
 

setup.py

@@ -31,7 +31,7 @@
 from distutils.errors import DistutilsPlatformError, DistutilsExecError
 from distutils.core import Extension
 
-version = "2.2.1+"
+version = "2.3rc1+"
 
 f = open("README.rst")
 try:
@@ -129,6 +129,13 @@ class custom_build_ext(build_ext):
 WARNING: %s could not
 be compiled. No C extensions are essential for PyMongo to run,
 although they do result in significant speed improvements.
+%s
+
+Please see the installation docs for solutions to build issues:
+
+http://api.mongodb.org/python/current/installation.html
+
+Here are some hints for popular operating systems:
 
 If you are seeing this message on Linux you probably need to
 install GCC and/or the Python development package for your
@@ -142,7 +149,16 @@ class custom_build_ext(build_ext):
 
     $ sudo yum install gcc python-devel
 
-%s
+If you are seeing this message on Microsoft Windows please install
+PyMongo using the MS Windows installer for your version of Python,
+available on pypi here:
+
+http://pypi.python.org/pypi/pymongo/#downloads
+
+If you are seeing this message on OSX please read the documentation
+here:
+
+http://api.mongodb.org/python/current/installation.html#osx
 ********************************************************************
 """
 
@@ -180,9 +196,10 @@ def build_extension(self, ext):
                 sys.stdout.write('%s\n' % str(e))
                 warnings.warn(self.warning_message % ("The %s extension "
                                                       "module" % (name,),
-                                                      "Above is the ouput "
-                                                      "showing how the "
-                                                      "compilation failed."))
+                                                      "The output above "
+                                                      "this warning shows how "
+                                                      "the compilation "
+                                                      "failed."))
         else:
             warnings.warn(self.warning_message % ("The %s extension "
                                                   "module" % (name,),