PYTHON-965 Backport MongoClient.address.

This change also deprecates MongoClient.host and MongoClient.port,
which are removed in PyMongo 3.

Author: behackett

doc/migrate-to-pymongo3.rst

@@ -469,6 +469,21 @@ can be replaced by this with PyMongo 2.9 or later:
 
   >>> client.close()
 
+The host and port attributes are removed
+........................................
+
+Code like this::
+
+  >>> host = client.host
+  >>> port = client.port
+
+can be replaced by this with PyMongo 2.9 or later:
+
+.. doctest::
+
+  >>> address = client.address
+  >>> host, port = address or (None, None)
+
 BSON
 ----
 

pymongo/mongo_client.py

@@ -558,11 +558,19 @@ def __member_property(self, attr_name, default=None):
 
     @property
     def host(self):
-        """Current connected host.
+        """**DEPRECATED** Current connected host.
 
+        .. warning:: :attr:`host` is deprecated in this version of PyMongo and
+          removed in PyMongo 3.0. Use :attr:`address` instead.
+
+        .. versionchanged:: 2.9
+           Deprecated :attr:`host`.
         .. versionchanged:: 1.3
            ``host`` is now a property rather than a method.
         """
+        warnings.warn("host is deprecated in this version of PyMongo and "
+                      "removed in PyMongo 3. Use address instead.",
+                      DeprecationWarning, stacklevel=2)
         member = self.__member
         if member:
             return member.host[0]
@@ -571,16 +579,34 @@ def host(self):
 
     @property
     def port(self):
-        """Current connected port.
+        """**DEPRECATED** Current connected port.
+
+        .. warning:: :attr:`port` is deprecated in this version of PyMongo and
+          removed in PyMongo 3.0. Use :attr:`address` instead.
 
+        .. versionchanged:: 2.9
+           Deprecated :attr:`port`.
         .. versionchanged:: 1.3
            ``port`` is now a property rather than a method.
         """
+        warnings.warn("port is deprecated in this version of PyMongo and "
+                      "removed in PyMongo 3. Use address instead.",
+                      DeprecationWarning, stacklevel=2)
         member = self.__member
         if member:
             return member.host[1]
 
+    @property
+    def address(self):
+        """(host, port) of the current standalone, primary, or mongos, or None.
+
+        .. versionadded:: 2.9
+        """
+        member = self.__member
+        if member:
+            return member.host
         return None
+
     @property
     def is_primary(self):
         """If this instance is connected to a standalone, a replica set
@@ -1415,15 +1441,15 @@ def end_request(self):
 
     def __eq__(self, other):
         if isinstance(other, self.__class__):
-            return self.host == other.host and self.port == other.port
+            return self.address == other.address
         return NotImplemented
 
     def __ne__(self, other):
         return not self == other
 
     def __repr__(self):
         if len(self.__nodes) == 1:
-            return "MongoClient(%r, %r)" % (self.host, self.port)
+            return "MongoClient(%r, %r)" % self.address
         else:
             return "MongoClient(%r)" % ["%s:%d" % n for n in self.__nodes]
 

pymongo/mongo_replica_set_client.py

@@ -901,6 +901,16 @@ def hosts(self):
         """
         return self.__rs_state.hosts
 
+    @property
+    def address(self):
+        """The (host, port) of the current primary of the replica set.
+
+        Returns None if there is no primary.
+
+        .. versionadded:: 2.9
+        """
+        return self.__rs_state.writer
+
     @property
     def primary(self):
         """The (host, port) of the current primary of the replica set.

test/test_client.py

@@ -162,8 +162,7 @@ def test_init_disconnected(self):
             ctx.exit()
 
         c.pymongo_test.test.find_one()  # Auto-connect.
-        self.assertEqual(host, c.host)
-        self.assertEqual(port, c.port)
+        self.assertEqual((host, port), c.address)
 
         if version.at_least(c, (2, 5, 4, -1)):
             self.assertTrue(c.max_wire_version > 0)
@@ -219,8 +218,7 @@ def test_repr(self):
                          "MongoClient('%s', %d)" % (host, port))
 
     def test_getters(self):
-        self.assertEqual(MongoClient(host, port).host, host)
-        self.assertEqual(MongoClient(host, port).port, port)
+        self.assertEqual(MongoClient(host, port).address, (host, port))
         self.assertEqual(set([(host, port)]),
                          MongoClient(host, port).nodes)
 
@@ -1056,7 +1054,7 @@ def test_wire_version_mongos_ha(self):
         c.db.collection.find_one()  # Connect.
 
         # Which member did we use?
-        used_host = '%s:%s' % (c.host, c.port)
+        used_host = '%s:%s' % c.address
         expected_min, expected_max = c.mock_wire_versions[used_host]
         self.assertEqual(expected_min, c.min_wire_version)
         self.assertEqual(expected_max, c.max_wire_version)
@@ -1066,7 +1064,7 @@ def test_wire_version_mongos_ha(self):
         c.set_wire_version_range('c:3', 0, 0)
         c.close()
         c.db.collection.find_one()
-        used_host = '%s:%s' % (c.host, c.port)
+        used_host = '%s:%s' % c.address
         expected_min, expected_max = c.mock_wire_versions[used_host]
         self.assertEqual(expected_min, c.min_wire_version)
         self.assertEqual(expected_max, c.max_wire_version)
@@ -1184,8 +1182,7 @@ def test_discover_primary(self):
             host='b:2',  # Pass a secondary.
             replicaSet='rs')
 
-        self.assertEqual('a', c.host)
-        self.assertEqual(1, c.port)
+        self.assertEqual(('a', 1), c.address)
         self.assertEqual(3, len(c.nodes))
 
         # Fail over.
@@ -1195,8 +1192,7 @@ def test_discover_primary(self):
         # Force reconnect.
         c.close()
         c.db.collection.find_one()
-        self.assertEqual('b', c.host)
-        self.assertEqual(2, c.port)
+        self.assertEqual(('b', 2), c.address)
 
         # a:1 is still in nodes.
         self.assertEqual(3, len(c.nodes))

test/test_collection.py

@@ -1440,8 +1440,8 @@ def test_aggregation_cursor(self):
         db = self.db
         if self.setname:
             # Test that getMore messages are sent to the right server.
-            db = MongoReplicaSetClient(host=self.client.host,
-                                       port=self.client.port,
+            db = MongoReplicaSetClient(host=self.client.address[0],
+                                       port=self.client.address[1],
                                        replicaSet=self.setname,
                                        readPreference='secondary')[db.name]
 
@@ -1482,8 +1482,8 @@ def test_parallel_scan(self):
         db.drop_collection("test")
         if self.setname:
             # Test that getMore messages are sent to the right server.
-            db = MongoReplicaSetClient(host=self.client.host,
-                                       port=self.client.port,
+            db = MongoReplicaSetClient(host=self.client.address[0],
+                                       port=self.client.address[1],
                                        replicaSet=self.setname,
                                        readPreference='secondary')[db.name]
         coll = db.test

test/test_mongos_ha.py

@@ -93,7 +93,7 @@ def test_failover(self):
         self.assertEqual(len(mock_hosts), len(client.nodes))
 
         # Our chosen mongos goes down.
-        client.kill_host('%s:%s' % (client.host, client.port))
+        client.kill_host('%s:%s' % client.address)
 
         # Trigger failover. AutoReconnect should be raised exactly once.
         errors = []
@@ -146,7 +146,7 @@ def test_acceptable_latency(self):
         # No error
         client.db.collection.find_one()
         # Our chosen mongos goes down.
-        client.kill_host('%s:%s' % (client.host, client.port))
+        client.kill_host('%s:%s' % client.address)
         try:
             client.db.collection.find_one()
         except:
@@ -185,7 +185,7 @@ def test_backport_localthresholdms_kwarg(self):
         # secondaryAcceptableLatencyMS.
         client.db.collection.find_one()
         # Our chosen mongos goes down.
-        client.kill_host('%s:%s' % (client.host, client.port))
+        client.kill_host('%s:%s' % client.address)
         try:
             client.db.collection.find_one()
         except:

test/test_pymongo.py

@@ -25,8 +25,7 @@ class TestPyMongo(unittest.TestCase):
     def test_mongo_client_alias(self):
         # Testing that pymongo module imports mongo_client.MongoClient
         c = pymongo.MongoClient(host, port)
-        self.assertEqual(c.host, host)
-        self.assertEqual(c.port, port)
+        self.assertEqual(c.address, (host, port))
 
 
 if __name__ == "__main__":

test/test_replica_set_client.py

@@ -264,6 +264,7 @@ def test_properties(self):
         try:
             warnings.simplefilter("ignore", DeprecationWarning)
             self.assertEqual(c.primary, self.primary)
+            self.assertEqual(c.address, self.primary)
             self.assertEqual(c.hosts, self.hosts)
             self.assertEqual(c.arbiters, self.arbiters)
             self.assertEqual(c.max_pool_size, 100)
@@ -296,6 +297,7 @@ def test_properties(self):
                                       tag_sets=copy.deepcopy(tag_sets),
                                       secondary_acceptable_latency_ms=77)
             self.assertEqual(c.primary, self.primary)
+            self.assertEqual(c.address, self.primary)
             self.assertEqual(c.hosts, self.hosts)
             self.assertEqual(c.arbiters, self.arbiters)
             self.assertEqual(c.max_pool_size, 25)

test/test_replica_set_reconfig.py

@@ -41,8 +41,7 @@ def test_client(self):
             replicaSet='rs')
 
         # MongoClient connects to primary by default.
-        self.assertEqual('a', c.host)
-        self.assertEqual(1, c.port)
+        self.assertEqual(('a', 1), c.address)
 
         # C is brought up as a standalone.
         c.mock_members.remove('c:3')
@@ -62,8 +61,7 @@ def test_client(self):
         else:
             self.fail("MongoClient didn't raise AutoReconnect")
 
-        self.assertEqual(None, c.host)
-        self.assertEqual(None, c.port)
+        self.assertEqual(None, c.address)
 
     def test_replica_set_client(self):
         c = MockReplicaSetClient(
@@ -137,8 +135,7 @@ def test_client(self):
             replicaSet='rs')
 
         # MongoClient connects to primary by default.
-        self.assertEqual('a', c.host)
-        self.assertEqual(1, c.port)
+        self.assertEqual(('a', 1), c.address)
         self.assertEqual(set([('a', 1), ('b', 2)]), c.nodes)
 
         # C is added.
@@ -148,8 +145,7 @@ def test_client(self):
         c.close()
         c.db.collection.find_one()
 
-        self.assertEqual('a', c.host)
-        self.assertEqual(1, c.port)
+        self.assertEqual(('a', 1), c.address)
         self.assertEqual(set([('a', 1), ('b', 2), ('c', 3)]), c.nodes)
 
     def test_replica_set_client(self):