PYTHON-955 - Backport connect option.

Author: behackett

doc/migrate-to-pymongo3.rst

@@ -405,6 +405,42 @@ can be replaced by this with PyMongo 2.9 or later:
 MongoClient
 -----------
 
+MongoClient connects asynchronously
+...................................
+
+In PyMongo 3, the :class:`~pymongo.mongo_client.MongoClient` constructor no
+longer blocks while connecting to the server or servers, and it no longer
+raises :exc:`~pymongo.errors.ConnectionFailure` if they are unavailable, nor
+:exc:`~pymongo.errors.ConfigurationError` if the user’s credentials are wrong.
+Instead, the constructor returns immediately and launches the connection
+process on background threads. The `connect` option is added to control whether
+these threads are started immediately, or when the client is first used.
+
+For consistent behavior in PyMongo 2.x and PyMongo 3.x, code like this::
+
+  >>> from pymongo.errors import ConnectionFailure
+  >>> try:
+  ...     client = MongoClient()
+  ... except ConnectionFailure:
+  ...     print("Server not available")
+  >>>
+
+can be changed to this with PyMongo 2.9 or later:
+
+.. doctest::
+
+  >>> from pymongo.errors import ConnectionFailure
+  >>> client = MongoClient(connect=False)
+  >>> try:
+  ...     result = client.admin.command("ismaster")
+  ... except ConnectionFailure:
+  ...     print("Server not available")
+  >>>
+
+Any operation can be used to determine if the server is available. We choose
+the "ismaster" command here because it is cheap and does not require auth, so
+it is a simple way to check whether the server is available.
+
 The max_pool_size parameter is removed
 ......................................
 

pymongo/common.py

@@ -385,7 +385,9 @@ def validate_ok_for_update(update):
     'authmechanismproperties': validate_auth_mechanism_properties,
     'uuidrepresentation': validate_uuid_representation,
     'socketkeepalive': validate_boolean,
-    'maxpoolsize': validate_positive_integer_or_none
+    'maxpoolsize': validate_positive_integer_or_none,
+    'connect': validate_boolean,
+    '_connect': validate_boolean
 }
 
 

pymongo/connection.py

@@ -46,7 +46,7 @@ class Connection(MongoClient):
 
     def __init__(self, host=None, port=None, max_pool_size=None,
                  network_timeout=None, document_class=dict,
-                 tz_aware=False, _connect=True, **kwargs):
+                 tz_aware=False, **kwargs):
         """Create a new connection to a single MongoDB instance at *host:port*.
 
         .. warning::
@@ -237,8 +237,8 @@ def __init__(self, host=None, port=None, max_pool_size=None,
         kwargs['auto_start_request'] = kwargs.get('auto_start_request', True)
         kwargs['safe'] = kwargs.get('safe', False)
 
-        super(Connection, self).__init__(host, port,
-                max_pool_size, document_class, tz_aware, _connect, **kwargs)
+        super(Connection, self).__init__(
+            host, port, max_pool_size, document_class, tz_aware, **kwargs)
 
     def __repr__(self):
         if len(self.nodes) == 1:

pymongo/mongo_client.py

@@ -92,8 +92,7 @@ class MongoClient(common.BaseObject):
     _rs_client = False
 
     def __init__(self, host=None, port=None, max_pool_size=100,
-                 document_class=dict, tz_aware=False, _connect=True,
-                 **kwargs):
+                 document_class=dict, tz_aware=False, **kwargs):
         """Create a new connection to a single MongoDB instance at *host:port*.
 
         The resultant client object has connection-pooling built
@@ -161,6 +160,8 @@ def __init__(self, host=None, port=None, max_pool_size=100,
           - `use_greenlets`: If ``True``, :meth:`start_request()` will ensure
             that the current greenlet uses the same socket for all
             operations until :meth:`end_request()`. Defaults to ``False``.
+          - `connect`: if True (the default), immediately connect to MongoDB in
+            the foreground. Otherwise connect on the first operation.
 
           | **Write Concern options:**
           | (Only set if passed. No default values.)
@@ -399,6 +400,7 @@ def __init__(self, host=None, port=None, max_pool_size=100,
                           "use read_preference instead.", DeprecationWarning,
                           stacklevel=2)
 
+        _connect = options.get('_connect', options.get('connect', True))
         if _connect:
             try:
                 self._ensure_connected(True)

pymongo/mongo_replica_set_client.py

@@ -435,7 +435,7 @@ class MongoReplicaSetClient(common.BaseObject):
     _rs_client = True
 
     def __init__(self, hosts_or_uri=None, max_pool_size=100,
-                 document_class=dict, tz_aware=False, _connect=True, **kwargs):
+                 document_class=dict, tz_aware=False, **kwargs):
         """Create a new connection to a MongoDB replica set.
 
         The resultant client object has connection-pooling built
@@ -514,6 +514,8 @@ def __init__(self, hosts_or_uri=None, max_pool_size=100,
             rather than thread-local, socket. Defaults to ``False``.
             `use_greenlets` with :class:`MongoReplicaSetClient` requires
             `Gevent <http://gevent.org/>`_ to be installed.
+          - `connect`: if True (the default), immediately connect to MongoDB
+            in the foreground. Otherwise connect on the first operation.
 
           | **Write Concern options:**
           | (Only set if passed. No default values.)
@@ -715,6 +717,7 @@ def __init__(self, hosts_or_uri=None, max_pool_size=100,
                           "use read_preference instead.", DeprecationWarning,
                           stacklevel=2)
 
+        _connect = self.__opts.get('_connect', self.__opts.get('connect', True))
         if _connect:
             try:
                 self.refresh(initial=True)

test/test_client.py

@@ -182,6 +182,15 @@ def test_connect(self):
 
         self.assertTrue(MongoClient(host, port))
 
+        # Test that connect=False prevents the constructor from raising
+        # ConnectionFailure.
+        client = MongoClient("somedomainthatdoesnotexist.org",
+                             connectTimeoutMS=100, connect=False)
+        try:
+            client.admin.command("ismaster")
+        except AutoReconnect:
+            pass
+
     def test_equality(self):
         client = MongoClient(host, port)
         self.assertEqual(client, MongoClient(host, port))

test/test_replica_set_client.py

@@ -224,6 +224,16 @@ def test_connect(self):
                           pair, replicaSet='fdlksjfdslkjfd')
         self.assertTrue(MongoReplicaSetClient(pair, replicaSet=self.name))
 
+        # Test that connect=False prevents the constructor from raising
+        # ConnectionFailure.
+        client = MongoReplicaSetClient("somedomainthatdoesnotexist.org",
+                                       connectTimeoutMS=100, connect=False,
+                                       replicaSet=self.name)
+        try:
+            client.admin.command("ismaster")
+        except AutoReconnect:
+            pass
+
     def test_repr(self):
         client = self._get_client()