make public

Author: sleepyStick

pymongo/asynchronous/mongo_client.py

@@ -1041,7 +1041,10 @@ async def target() -> bool:
         self._kill_cursors_executor = executor
         self._opened = False
 
-    def _append_metadata(self, driver_info: DriverInfo) -> None:
+    def append_metadata(self, driver_info: DriverInfo) -> None:
+        """
+        Appends the given metadata to existing driver metadata.
+        """
         metadata = self._options.pool_options.metadata
         for k, v in driver_info._asdict().items():
             if v is None:

pymongo/synchronous/mongo_client.py

@@ -1041,7 +1041,10 @@ def target() -> bool:
         self._kill_cursors_executor = executor
         self._opened = False
 
-    def _append_metadata(self, driver_info: DriverInfo) -> None:
+    def append_metadata(self, driver_info: DriverInfo) -> None:
+        """
+        Appends the given metadata to existing driver metadata.
+        """
         metadata = self._options.pool_options.metadata
         for k, v in driver_info._asdict().items():
             if v is None:

test/mockupdb/test_client_metadata.py

@@ -83,7 +83,7 @@ def check_metadata_added(
         time.sleep(0.005)
 
         # add new metadata
-        client._append_metadata(DriverInfo(add_name, add_version, add_platform))
+        client.append_metadata(DriverInfo(add_name, add_version, add_platform))
         new_name, new_version, new_platform, new_metadata = self.send_ping_and_get_metadata(
             client, True
         )
@@ -148,7 +148,7 @@ def test_multiple_successive_metadata_updates(self):
         client = MongoClient(
             "mongodb://" + self.server.address_string, maxIdleTimeMS=1, connect=False
         )
-        client._append_metadata(DriverInfo("library", "1.2", "Library Platform"))
+        client.append_metadata(DriverInfo("library", "1.2", "Library Platform"))
         self.check_metadata_added(client, "framework", "2.0", "Framework Platform")
         client.close()
 
@@ -157,7 +157,7 @@ def test_multiple_successive_metadata_updates_platform_none(self):
             "mongodb://" + self.server.address_string,
             maxIdleTimeMS=1,
         )
-        client._append_metadata(DriverInfo("library", "1.2", "Library Platform"))
+        client.append_metadata(DriverInfo("library", "1.2", "Library Platform"))
         self.check_metadata_added(client, "framework", "2.0", None)
         client.close()
 
@@ -166,7 +166,7 @@ def test_multiple_successive_metadata_updates_version_none(self):
             "mongodb://" + self.server.address_string,
             maxIdleTimeMS=1,
         )
-        client._append_metadata(DriverInfo("library", "1.2", "Library Platform"))
+        client.append_metadata(DriverInfo("library", "1.2", "Library Platform"))
         self.check_metadata_added(client, "framework", None, "Framework Platform")
         client.close()
 
@@ -175,7 +175,7 @@ def test_multiple_successive_metadata_updates_platform_version_none(self):
             "mongodb://" + self.server.address_string,
             maxIdleTimeMS=1,
         )
-        client._append_metadata(DriverInfo("library", "1.2", "Library Platform"))
+        client.append_metadata(DriverInfo("library", "1.2", "Library Platform"))
         self.check_metadata_added(client, "framework", None, None)
         client.close()
 
@@ -196,7 +196,7 @@ def test_doesnt_update_established_connections(self):
 
         # add data
         add_name, add_version, add_platform = "framework", "2.0", "Framework Platform"
-        client._append_metadata(DriverInfo(add_name, add_version, add_platform))
+        client.append_metadata(DriverInfo(add_name, add_version, add_platform))
         # check new data isn't sent
         self.handshake_req: Optional[dict] = None
         client.admin.command("ping")