Merge branch 'master' of github.com:mongodb/mongo-python-driver into PYTHON-5413

Author: blink1073

.evergreen/resync-specs.sh

@@ -131,6 +131,9 @@ do
     gridfs)
       cpjson gridfs/tests gridfs
       ;;
+    handshake)
+      cpjson mongodb-handshake/tests handshake
+      ;;
     index|index-management)
       cpjson index-management/tests index_management
       ;;

.github/CODEOWNERS

@@ -0,0 +1 @@
+* @mongodb/dbx-python

.github/workflows/codeql.yml

@@ -46,7 +46,7 @@ jobs:
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@ce28f5bb42b7a9f2c824e633a3f6ee835bab6858 # v3
+      uses: github/codeql-action/init@39edc492dbe16b1465b0cafca41432d857bdb31a # v3
       with:
         languages: ${{ matrix.language }}
         build-mode: ${{ matrix.build-mode }}
@@ -63,6 +63,6 @@ jobs:
         pip install -e .
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@ce28f5bb42b7a9f2c824e633a3f6ee835bab6858 # v3
+      uses: github/codeql-action/analyze@39edc492dbe16b1465b0cafca41432d857bdb31a # v3
       with:
         category: "/language:${{matrix.language}}"

.github/workflows/test-python.yml

@@ -25,7 +25,7 @@ jobs:
       - name: Install just
         uses: extractions/setup-just@e33e0265a09d6d736e2ee1e0eb685ef1de4669ff # v3
       - name: Install uv
-        uses: astral-sh/setup-uv@f0ec1fc3b38f5e7cd731bb6ce540c5af426746bb # v5
+        uses: astral-sh/setup-uv@bd01e18f51369d5a26f1651c3cb451d3417e3bba # v5
         with:
           enable-cache: true
           python-version: "3.9"
@@ -65,7 +65,7 @@ jobs:
       - name: Install just
         uses: extractions/setup-just@e33e0265a09d6d736e2ee1e0eb685ef1de4669ff # v3
       - name: Install uv
-        uses: astral-sh/setup-uv@f0ec1fc3b38f5e7cd731bb6ce540c5af426746bb # v5
+        uses: astral-sh/setup-uv@bd01e18f51369d5a26f1651c3cb451d3417e3bba # v5
         with:
           enable-cache: true
           python-version: ${{ matrix.python-version }}
@@ -88,7 +88,7 @@ jobs:
       - name: Install just
         uses: extractions/setup-just@e33e0265a09d6d736e2ee1e0eb685ef1de4669ff # v3
       - name: Install uv
-        uses: astral-sh/setup-uv@f0ec1fc3b38f5e7cd731bb6ce540c5af426746bb # v5
+        uses: astral-sh/setup-uv@bd01e18f51369d5a26f1651c3cb451d3417e3bba # v5
         with:
           enable-cache: true
           python-version: "3.9"
@@ -111,7 +111,7 @@ jobs:
         with:
           persist-credentials: false
       - name: Install uv
-        uses: astral-sh/setup-uv@f0ec1fc3b38f5e7cd731bb6ce540c5af426746bb # v5
+        uses: astral-sh/setup-uv@bd01e18f51369d5a26f1651c3cb451d3417e3bba # v5
         with:
           enable-cache: true
           python-version: "3.9"
@@ -130,7 +130,7 @@ jobs:
         with:
           persist-credentials: false
       - name: Install uv
-        uses: astral-sh/setup-uv@f0ec1fc3b38f5e7cd731bb6ce540c5af426746bb # v5
+        uses: astral-sh/setup-uv@bd01e18f51369d5a26f1651c3cb451d3417e3bba # v5
         with:
           enable-cache: true
           python-version: "3.9"
@@ -152,7 +152,7 @@ jobs:
         with:
           persist-credentials: false
       - name: Install uv
-        uses: astral-sh/setup-uv@f0ec1fc3b38f5e7cd731bb6ce540c5af426746bb # v5
+        uses: astral-sh/setup-uv@bd01e18f51369d5a26f1651c3cb451d3417e3bba # v5
         with:
           enable-cache: true
           python-version: "${{matrix.python}}"
@@ -220,3 +220,55 @@ jobs:
             which python
             pip install -e ".[test]"
             PYMONGO_MUST_CONNECT=1 pytest -v -k client_context
+
+  test_minimum:
+      permissions:
+        contents: read
+      runs-on: ubuntu-latest
+      name: Test using minimum dependencies and supported Python
+      steps:
+        - uses: actions/checkout@v4
+          with:
+            persist-credentials: false
+        - name: Install uv
+          uses: astral-sh/setup-uv@bd01e18f51369d5a26f1651c3cb451d3417e3bba # v5
+          with:
+            python-version: '3.9'
+        - name: Start MongoDB
+          uses: supercharge/mongodb-github-action@90004df786821b6308fb02299e5835d0dae05d0d # 1.12.0
+          with:
+            mongodb-version: 6.0
+        # Async and our test_dns do not support dnspython 1.X, so we don't run async or dns tests here
+        - name: Run tests
+          shell: bash
+          run: |
+            uv venv
+            source .venv/bin/activate
+            uv pip install -e ".[test]" --resolution=lowest-direct
+            pytest -v test/test_srv_polling.py
+
+  test_minimum_for_async:
+      permissions:
+        contents: read
+      runs-on: ubuntu-latest
+      name: Test async's minimum dependencies and Python
+      steps:
+        - uses: actions/checkout@v4
+          with:
+            persist-credentials: false
+        - name: Install uv
+          uses: astral-sh/setup-uv@bd01e18f51369d5a26f1651c3cb451d3417e3bba # v5
+          with:
+            python-version: '3.9'
+        - name: Start MongoDB
+          uses: supercharge/mongodb-github-action@90004df786821b6308fb02299e5835d0dae05d0d # 1.12.0
+          with:
+            mongodb-version: 6.0
+        # The lifetime kwarg we use in srv resolution was added to the async resolver API in dnspython 2.1.0
+        - name: Run tests
+          shell: bash
+          run: |
+            uv venv
+            source .venv/bin/activate
+            uv pip install -e ".[test]" --resolution=lowest-direct dnspython==2.1.0 --force-reinstall
+            pytest -v test/test_srv_polling.py test/test_dns.py test/asynchronous/test_srv_polling.py test/asynchronous/test_dns.py

.github/workflows/zizmor.yml

@@ -18,15 +18,15 @@ jobs:
         with:
           persist-credentials: false
       - name: Setup Rust
-        uses: actions-rust-lang/setup-rust-toolchain@9d7e65c320fdb52dcd45ffaa68deb6c02c8754d9 # v1
+        uses: actions-rust-lang/setup-rust-toolchain@fb51252c7ba57d633bc668f941da052e410add48 # v1
       - name: Get zizmor
         run: cargo install zizmor
       - name: Run zizmor 🌈
         run: zizmor --format sarif . > results.sarif
         env:
           GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       - name: Upload SARIF file
-        uses: github/codeql-action/upload-sarif@ce28f5bb42b7a9f2c824e633a3f6ee835bab6858 # v3
+        uses: github/codeql-action/upload-sarif@39edc492dbe16b1465b0cafca41432d857bdb31a # v3
         with:
           sarif_file: results.sarif
           category: zizmor

CONTRIBUTING.md

@@ -467,3 +467,15 @@ partially-converted asynchronous version of the same name to the `test/asynchron
 Use this generated file as a starting point for the completed conversion.
 
 The script is used like so: `python tools/convert_test_to_async.py [test_file.py]`
+
+## Generating a flame graph using py-spy
+To profile a test script and generate a flame graph, follow these steps:
+1. Install `py-spy` if you haven't already:
+   ```bash
+   pip install py-spy
+   ```
+2. Inside your test script, perform any required setup and then loop over the code you want to profile for improved sampling.
+3. Run `py-spy record -o <output.svg> -r <sample_rate=100> -- python <path/to/script>` to generate a `.svg` file containing the flame graph.
+   (Note: on macOS you will need to run this command using `sudo` to allow `py-spy` to attach to the Python process.)
+4. If you need to include native code (for example the C extensions), profiling should be done on a Linux system, as macOS and Windows do not support the `--native` option of `py-spy`.
+   Creating an ubuntu Evergreen spawn host and using `scp` to copy the flamegraph `.svg` file back to your local machine is the best way to do this.

doc/changelog.rst

@@ -7,6 +7,9 @@ PyMongo 4.14 brings a number of changes including:
 
 - Added :attr:`bson.codec_options.TypeRegistry.codecs` and :attr:`bson.codec_options.TypeRegistry.fallback_encoder` properties
   to allow users to directly access the type codecs and fallback encoder for a given :class:`bson.codec_options.TypeRegistry`.
+- Added :meth:`pymongo.asynchronous.mongo_client.AsyncMongoClient.append_metadata` and
+  :meth:`pymongo.mongo_client.MongoClient.append_metadata` to allow instantiated MongoClients to send client metadata
+  on-demand
 
 - Introduces a minor breaking change. When encoding :class:`bson.binary.BinaryVector`, a ``ValueError`` will be raised
   if the 'padding' metadata field is < 0 or > 7, or non-zero for any type other than PACKED_BIT.

hatch_build.py

@@ -19,7 +19,7 @@ def initialize(self, version, build_data):
         here = Path(__file__).parent.resolve()
         sys.path.insert(0, str(here))
 
-        subprocess.check_call([sys.executable, "_setup.py", "build_ext", "-i"])
+        subprocess.run([sys.executable, "_setup.py", "build_ext", "-i"], check=True)
 
         # Ensure wheel is marked as binary and contains the binary files.
         build_data["infer_tag"] = True

pymongo/asynchronous/mongo_client.py

@@ -70,6 +70,7 @@
 from pymongo.asynchronous.settings import TopologySettings
 from pymongo.asynchronous.topology import Topology, _ErrorContext
 from pymongo.client_options import ClientOptions
+from pymongo.driver_info import DriverInfo
 from pymongo.errors import (
     AutoReconnect,
     BulkWriteError,
@@ -1040,6 +1041,20 @@ async def target() -> bool:
         self._kill_cursors_executor = executor
         self._opened = False
 
+    def append_metadata(self, driver_info: DriverInfo) -> None:
+        """Appends the given metadata to existing driver metadata.
+
+        :param driver_info: a :class:`~pymongo.driver_info.DriverInfo`
+
+        .. versionadded:: 4.14
+        """
+
+        if not isinstance(driver_info, DriverInfo):
+            raise TypeError(
+                f"driver_info must be an instance of DriverInfo, not {type(driver_info)}"
+            )
+        self._options.pool_options._update_metadata(driver_info)
+
     def _should_pin_cursor(self, session: Optional[AsyncClientSession]) -> Optional[bool]:
         return self._options.load_balanced and not (session and session.in_transaction)
 

pymongo/pool_options.py

@@ -376,25 +376,33 @@ def __init__(
                 "async",
             )
         if driver:
-            if driver.name:
-                self.__metadata["driver"]["name"] = "{}|{}".format(
-                    self.__metadata["driver"]["name"],
-                    driver.name,
-                )
-            if driver.version:
-                self.__metadata["driver"]["version"] = "{}|{}".format(
-                    _METADATA["driver"]["version"],
-                    driver.version,
-                )
-            if driver.platform:
-                self.__metadata["platform"] = "{}|{}".format(_METADATA["platform"], driver.platform)
+            self._update_metadata(driver)
 
         env = _metadata_env()
         if env:
             self.__metadata["env"] = env
 
         _truncate_metadata(self.__metadata)
 
+    def _update_metadata(self, driver: DriverInfo) -> None:
+        """Updates the client's metadata"""
+
+        metadata = copy.deepcopy(self.__metadata)
+        if driver.name:
+            metadata["driver"]["name"] = "{}|{}".format(
+                metadata["driver"]["name"],
+                driver.name,
+            )
+        if driver.version:
+            metadata["driver"]["version"] = "{}|{}".format(
+                metadata["driver"]["version"],
+                driver.version,
+            )
+        if driver.platform:
+            metadata["platform"] = "{}|{}".format(metadata["platform"], driver.platform)
+
+        self.__metadata = metadata
+
     @property
     def _credentials(self) -> Optional[MongoCredential]:
         """A :class:`~pymongo.auth.MongoCredentials` instance or None."""