PYTHON-1321 Remove MongoReplicaSetClient (#552)

ShaneHarvey · web-flow · commit 56925fd97f0d · 2021-01-15T17:11:15.000-08:00
diff --git a/doc/api/pymongo/index.rst b/doc/api/pymongo/index.rst
@@ -9,10 +9,6 @@
 
       Alias for :class:`pymongo.mongo_client.MongoClient`.
 
-   .. data:: MongoReplicaSetClient
-
-      Alias for :class:`pymongo.mongo_replica_set_client.MongoReplicaSetClient`.
-
    .. data:: ReadPreference
 
       Alias for :class:`pymongo.read_preferences.ReadPreference`.
@@ -46,7 +42,6 @@ Sub-modules:
    errors
    message
    mongo_client
-   mongo_replica_set_client
    monitoring
    operations
    pool
diff --git a/doc/api/pymongo/mongo_replica_set_client.rst b/doc/api/pymongo/mongo_replica_set_client.rst
diff --git a/doc/changelog.rst b/doc/changelog.rst
@@ -25,6 +25,7 @@ Breaking Changes in 4.0
 - Removed :meth:`pymongo.database.Database.collection_names`.
 - Removed :meth:`pymongo.collection.Collection.parallel_scan`.
 - Removed :mod:`pymongo.thread_util`.
+- Removed :class:`~pymongo.mongo_replica_set_client.MongoReplicaSetClient`.
 
 Notable improvements
 ....................
diff --git a/doc/migrate-to-pymongo4.rst b/doc/migrate-to-pymongo4.rst
@@ -50,6 +50,15 @@ Warnings can also be changed to errors::
 .. note:: Not all deprecated features raise :exc:`DeprecationWarning` when
   used. See `Removed features with no migration path`_.
 
+MongoReplicaSetClient
+---------------------
+
+Removed :class:`~pymongo.mongo_replica_set_client.MongoReplicaSetClient`.
+Since PyMongo 3.0, ``MongoReplicaSetClient`` has been identical to
+:class:`pymongo.mongo_client.MongoClient`. Applications can simply replace
+``MongoReplicaSetClient`` with :class:`pymongo.mongo_client.MongoClient` and
+get the same behavior.
+
 MongoClient
 -----------
 
diff --git a/pymongo/__init__.py b/pymongo/__init__.py
@@ -89,7 +89,6 @@ def get_version_string():
                             MAX_SUPPORTED_WIRE_VERSION)
 from pymongo.cursor import CursorType
 from pymongo.mongo_client import MongoClient
-from pymongo.mongo_replica_set_client import MongoReplicaSetClient
 from pymongo.operations import (IndexModel,
                                 InsertOne,
                                 DeleteOne,
diff --git a/pymongo/common.py b/pymongo/common.py
@@ -364,7 +364,7 @@ def validate_read_preference(dummy, value):
 
 
 def validate_read_preference_mode(dummy, value):
-    """Validate read preference mode for a MongoReplicaSetClient.
+    """Validate read preference mode for a MongoClient.
 
     .. versionchanged:: 3.5
        Returns the original ``value`` instead of the validated read preference
diff --git a/pymongo/mongo_client.py b/pymongo/mongo_client.py
@@ -1001,8 +1001,7 @@ def primary(self):
         `replicaSet` option.
 
         .. versionadded:: 3.0
-           MongoClient gained this property in version 3.0 when
-           MongoReplicaSetClient's functionality was merged in.
+           MongoClient gained this property in version 3.0.
         """
         return self._topology.get_primary()
 
@@ -1015,8 +1014,7 @@ def secondaries(self):
         client was created without the `replicaSet` option.
 
         .. versionadded:: 3.0
-           MongoClient gained this property in version 3.0 when
-           MongoReplicaSetClient's functionality was merged in.
+           MongoClient gained this property in version 3.0.
         """
         return self._topology.get_secondaries()
 
diff --git a/pymongo/mongo_replica_set_client.py b/pymongo/mongo_replica_set_client.py
diff --git a/pymongo/read_preferences.py b/pymongo/read_preferences.py
@@ -38,7 +38,7 @@
 
 
 def _validate_tag_sets(tag_sets):
-    """Validate tag sets for a MongoReplicaSetClient.
+    """Validate tag sets for a MongoClient.
     """
     if tag_sets is None:
         return tag_sets
@@ -144,7 +144,7 @@ def tag_sets(self):
         To specify a priority-order for tag sets, provide a list of
         tag sets: ``[{'dc': 'ny'}, {'dc': 'la'}, {}]``. A final, empty tag
         set, ``{}``, means "read from any member that matches the mode,
-        ignoring tags." MongoReplicaSetClient tries each set of tags in turn
+        ignoring tags." MongoClient tries each set of tags in turn
         until it finds a set of tags with at least one matching member.
 
            .. seealso:: `Data-Center Awareness
diff --git a/test/test_gridfs.py b/test/test_gridfs.py
@@ -28,11 +28,10 @@
 from bson.py3compat import StringIO, string_type
 from pymongo.mongo_client import MongoClient
 from pymongo.errors import (ConfigurationError,
-                            ConnectionFailure,
+                            NotMasterError,
                             ServerSelectionTimeoutError)
 from pymongo.read_preferences import ReadPreference
 from gridfs.errors import CorruptGridFile, FileExists, NoFile
-from test.test_replica_set_client import TestReplicaSetClientBase
 from test import (client_context,
                   unittest,
                   IntegrationTest)
@@ -487,7 +486,7 @@ def test_md5(self):
         self.assertIsNone(gout.md5)
 
 
-class TestGridfsReplicaSet(TestReplicaSetClientBase):
+class TestGridfsReplicaSet(IntegrationTest):
 
     @classmethod
     @client_context.require_secondaries_count(1)
@@ -500,7 +499,7 @@ def tearDownClass(cls):
 
     def test_gridfs_replica_set(self):
         rsc = rs_client(
-            w=self.w,
+            w=client_context.w,
             read_preference=ReadPreference.SECONDARY)
 
         fs = gridfs.GridFS(rsc.gfsreplica, 'gfsreplicatest')
@@ -513,10 +512,7 @@ def test_gridfs_replica_set(self):
         self.assertEqual(b'foo', content)
 
     def test_gridfs_secondary(self):
-        primary_host, primary_port = self.primary
-        primary_connection = single_client(primary_host, primary_port)
-
-        secondary_host, secondary_port = one(self.secondaries)
+        secondary_host, secondary_port = one(self.client.secondaries)
         secondary_connection = single_client(
             secondary_host, secondary_port,
             read_preference=ReadPreference.SECONDARY)
@@ -526,12 +522,12 @@ def test_gridfs_secondary(self):
         fs = gridfs.GridFS(secondary_connection.gfsreplica, 'gfssecondarytest')
 
         # This won't detect secondary, raises error
-        self.assertRaises(ConnectionFailure, fs.put, b'foo')
+        self.assertRaises(NotMasterError, fs.put, b'foo')
 
     def test_gridfs_secondary_lazy(self):
         # Should detect it's connected to secondary and not attempt to
         # create index.
-        secondary_host, secondary_port = one(self.secondaries)
+        secondary_host, secondary_port = one(self.client.secondaries)
         client = single_client(
             secondary_host,
             secondary_port,
@@ -543,7 +539,7 @@ def test_gridfs_secondary_lazy(self):
 
         # Connects, doesn't create index.
         self.assertRaises(NoFile, fs.get_last_version)
-        self.assertRaises(ConnectionFailure, fs.put, 'data')
+        self.assertRaises(NotMasterError, fs.put, 'data')
 
 
 if __name__ == "__main__":
diff --git a/test/test_gridfs_bucket.py b/test/test_gridfs_bucket.py
@@ -30,14 +30,13 @@
 from bson.son import SON
 from gridfs.errors import NoFile, CorruptGridFile
 from pymongo.errors import (ConfigurationError,
-                            ConnectionFailure,
+                            NotMasterError,
                             ServerSelectionTimeoutError)
 from pymongo.mongo_client import MongoClient
 from pymongo.read_preferences import ReadPreference
 from test import (client_context,
                   unittest,
                   IntegrationTest)
-from test.test_replica_set_client import TestReplicaSetClientBase
 from test.utils import (ignore_deprecations,
                         joinall,
                         one,
@@ -504,7 +503,7 @@ def test_md5(self):
         self.assertIsNone(gout.md5)
 
 
-class TestGridfsBucketReplicaSet(TestReplicaSetClientBase):
+class TestGridfsBucketReplicaSet(IntegrationTest):
 
     @classmethod
     @client_context.require_secondaries_count(1)
@@ -517,7 +516,7 @@ def tearDownClass(cls):
 
     def test_gridfs_replica_set(self):
         rsc = rs_client(
-            w=self.w,
+            w=client_context.w,
             read_preference=ReadPreference.SECONDARY)
 
         gfs = gridfs.GridFSBucket(rsc.gfsbucketreplica, 'gfsbucketreplicatest')
@@ -526,10 +525,7 @@ def test_gridfs_replica_set(self):
         self.assertEqual(b'foo', content)
 
     def test_gridfs_secondary(self):
-        primary_host, primary_port = self.primary
-        primary_connection = single_client(primary_host, primary_port)
-
-        secondary_host, secondary_port = one(self.secondaries)
+        secondary_host, secondary_port = one(self.client.secondaries)
         secondary_connection = single_client(
             secondary_host, secondary_port,
             read_preference=ReadPreference.SECONDARY)
@@ -540,13 +536,13 @@ def test_gridfs_secondary(self):
             secondary_connection.gfsbucketreplica, 'gfsbucketsecondarytest')
 
         # This won't detect secondary, raises error
-        self.assertRaises(ConnectionFailure, gfs.upload_from_stream,
+        self.assertRaises(NotMasterError, gfs.upload_from_stream,
                           "test_filename", b'foo')
 
     def test_gridfs_secondary_lazy(self):
         # Should detect it's connected to secondary and not attempt to
         # create index.
-        secondary_host, secondary_port = one(self.secondaries)
+        secondary_host, secondary_port = one(self.client.secondaries)
         client = single_client(
             secondary_host,
             secondary_port,
@@ -560,7 +556,7 @@ def test_gridfs_secondary_lazy(self):
         # Connects, doesn't create index.
         self.assertRaises(NoFile, gfs.open_download_stream_by_name,
                           "test_filename")
-        self.assertRaises(ConnectionFailure, gfs.upload_from_stream,
+        self.assertRaises(NotMasterError, gfs.upload_from_stream,
                           "test_filename", b'data')
 
 
diff --git a/test/test_read_preferences.py b/test/test_read_preferences.py
@@ -39,10 +39,10 @@
 
 from test import (SkipTest,
                   client_context,
+                  IntegrationTest,
                   unittest,
                   db_user,
                   db_pwd)
-from test.test_replica_set_client import TestReplicaSetClientBase
 from test.utils import (connected,
                         ignore_deprecations,
                         one,
@@ -87,7 +87,7 @@ def test_deepcopy(self):
             self.assertEqual(pref, copy.deepcopy(pref))
 
 
-class TestReadPreferencesBase(TestReplicaSetClientBase):
+class TestReadPreferencesBase(IntegrationTest):
 
     @classmethod
     @client_context.require_secondaries_count(1)
@@ -100,7 +100,7 @@ def setUp(self):
         self.client.pymongo_test.test.drop()
         self.client.get_database(
             "pymongo_test",
-            write_concern=WriteConcern(w=self.w)).test.insert_many(
+            write_concern=WriteConcern(w=client_context.w)).test.insert_many(
                 [{'_id': i} for i in range(10)])
 
         self.addCleanup(self.client.pymongo_test.test.drop)
@@ -130,7 +130,7 @@ def read_from_which_kind(self, client):
     def assertReadsFrom(self, expected, **kwargs):
         c = rs_client(**kwargs)
         wait_until(
-            lambda: len(c.nodes - c.arbiters) == self.w,
+            lambda: len(c.nodes - c.arbiters) == client_context.w,
             "discovered all nodes")
 
         used = self.read_from_which_kind(c)
@@ -284,7 +284,7 @@ def test_nearest(self):
             read_preference=ReadPreference.NEAREST,
             localThresholdMS=10000)  # 10 seconds
 
-        data_members = set(self.hosts).difference(set(self.arbiters))
+        data_members = {self.client.primary} | self.client.secondaries
 
         # This is a probabilistic test; track which members we've read from so
         # far, and keep reading until we've used all the members or give up.
@@ -347,23 +347,23 @@ def record_a_read(self, address):
 ]
 
 
-class TestCommandAndReadPreference(TestReplicaSetClientBase):
+class TestCommandAndReadPreference(IntegrationTest):
 
     @classmethod
     @client_context.require_secondaries_count(1)
     def setUpClass(cls):
         super(TestCommandAndReadPreference, cls).setUpClass()
         cls.c = ReadPrefTester(
             client_context.pair,
-            replicaSet=cls.name,
+            replicaSet=client_context.replica_set_name,
             # Ignore round trip times, to test ReadPreference modes only.
             localThresholdMS=1000*1000)
         if client_context.auth_enabled:
             cls.c.admin.authenticate(db_user, db_pwd)
         cls.client_version = Version.from_client(cls.c)
         # mapReduce and group fail with no collection
         coll = cls.c.pymongo_test.get_collection(
-            'test', write_concern=WriteConcern(w=cls.w))
+            'test', write_concern=WriteConcern(w=client_context.w))
         coll.insert_one({})
 
     @classmethod
diff --git a/test/test_replica_set_client.py b/test/test_replica_set_client.py
