WL#16962: Update the Python Protobuf version

oscpache · oscpache · commit 4b0ebc614bf5 · 2025-05-29T12:35:22.000-06:00
The required Python Protobuf version installed
with the X DevAPI connector was updated to version 5.29.4.

Change-Id: I7075108db1a3a3caadfff26c108770cb3dc0eb92
diff --git a/CHANGES.txt b/CHANGES.txt
@@ -11,6 +11,7 @@ Full release notes:
 v9.4.0
 ======
 
+- WL#16962: Update the Python Protobuf version
 - BUG#37820231: Text based django ORM filters doesn't work with Connector/Python
 - BUG#37806057: Rename extra option (when installing wheel package) to install webauthn functionality dependencies
 - BUG#37627508: mysql/connector python fetchmany() has an off by one bug when argument given as 1
diff --git a/mysqlx-connector-python/docs/mysqlx/installation.rst b/mysqlx-connector-python/docs/mysqlx/installation.rst
@@ -58,7 +58,7 @@ As of Connector/Python 2.2.3, source distributions include a C++ Extension, that
 To build Connector/Python C++ Extension for Protobuf, you must satisfy the following prerequisites:
 
 * A C/C++ compiler, such as ``gcc``
-* Protobuf C++ (version >= 4.21.1, <= 4.21.12)
+* Protobuf C++ (version 5.29.4)
 * Python development files
 * MySQL Connector/C or MySQL Server installed
 
diff --git a/mysqlx-connector-python/docs/mysqlx/requirements.rst b/mysqlx-connector-python/docs/mysqlx/requirements.rst
@@ -3,8 +3,8 @@ Requirements
 
 * MySQL 8.0.0 or higher, with the X Plugin enabled
 * Python >= 3.9
-* Protobuf C++ (version == 4.25.3)
-* Python Protobuf (version == 4.25.3)
+* Protobuf C++ (version == 5.29.4)
+* Python Protobuf (version == 5.29.4)
 * dnspython (version == 2.6.1) for DNS SRV support
 * lz4 (version >= 2.1.6, <= 4.3.2) for connection compression support
 * zstandard (version >= 0.12.0, <= 0.19.0) for connection compression support
diff --git a/mysqlx-connector-python/setup.py b/mysqlx-connector-python/setup.py
@@ -160,7 +160,7 @@ def main() -> None:
         ext_modules=EXTENSIONS,
         cmdclass=COMMAND_CLASSES,
         python_requires=">=3.9",
-        install_requires=["protobuf==4.25.3"],
+        install_requires=["protobuf==5.29.4"],
         extras_require={
             "dns-srv": ["dnspython==2.6.1"],
             "compression": ["lz4>=2.1.6,<=4.3.2", "zstandard==0.23.0"],
@@ -177,29 +177,31 @@ def copy_metadata_files() -> None:
 
 
 def get_long_description() -> str:
-    """Extracts a long description from the README.rst file that is suited for this specific package.
-    """
+    """Extracts a long description from the README.rst file that is suited for this specific package."""
     with open(pathlib.Path(os.getcwd(), "../README.rst")) as file_handle:
         # The README.rst text is meant to be shared by both mysql and mysqlx packages, so after getting it we need to
         # parse it in order to remove the bits of text that are not meaningful for this package (mysqlx)
         long_description = file_handle.read()
     block_matches = re.finditer(
         pattern=(
-            r'(?P<module_start>\.{2}\s+={2,}\s+(?P<module_tag>\<(?P<module_name>mysql|mysqlx|both)\>)(?P<repls>\s+'
+            r"(?P<module_start>\.{2}\s+={2,}\s+(?P<module_tag>\<(?P<module_name>mysql|mysqlx|both)\>)(?P<repls>\s+"
             r'\[(?:(?:,\s*)?(?:repl(?:-mysql(?:x)?)?)\("(?:[^"]+)",\s*"(?:[^"]*)"\))+\])?\s+={2,})'
-            r'(?P<block_text>.+?(?=\.{2}\s+={2,}))(?P<module_end>\.{2}\s+={2,}\s+\</(?P=module_name)\>\s+={2,})'
+            r"(?P<block_text>.+?(?=\.{2}\s+={2,}))(?P<module_end>\.{2}\s+={2,}\s+\</(?P=module_name)\>\s+={2,})"
         ),
         string=long_description,
-        flags=re.DOTALL)
+        flags=re.DOTALL,
+    )
     for block_match in block_matches:
-        if block_match.group("module_name") == 'mysql':
+        if block_match.group("module_name") == "mysql":
             long_description = long_description.replace(block_match.group(), "")
         else:
             block_text = block_match.group("block_text")
             if block_match.group("repls"):
-                repl_matches = re.finditer(pattern=r'(?P<repl_name>repl(?:-mysql(?:x)?)?)\("'
-                                                   r'(?P<repl_source>[^"]+)",\s*"(?P<repl_target>[^"]*)"\)+',
-                                           string=block_match.group("repls"))
+                repl_matches = re.finditer(
+                    pattern=r'(?P<repl_name>repl(?:-mysql(?:x)?)?)\("'
+                    r'(?P<repl_source>[^"]+)",\s*"(?P<repl_target>[^"]*)"\)+',
+                    string=block_match.group("repls"),
+                )
                 for repl_match in repl_matches:
                     repl_name = repl_match.group("repl_name")
                     repl_source = repl_match.group("repl_source")
@@ -211,9 +213,11 @@ def get_long_description() -> str:
             long_description = long_description.replace(block_match.group(), block_text)
     # Make replacements for files that are directly accessible within GitHub but not within PyPI
     files_regex_fragment = "|".join(mf.replace(".", r"\.") for mf in METADATA_FILES)
-    long_description = re.sub(pattern=rf"\<(?P<file_name>{files_regex_fragment})\>",
-                              repl=f"<{GITHUB_URL}/blob/trunk/\g<file_name>>",
-                              string=long_description)
+    long_description = re.sub(
+        pattern=rf"\<(?P<file_name>{files_regex_fragment})\>",
+        repl=f"<{GITHUB_URL}/blob/trunk/\g<file_name>>",
+        string=long_description,
+    )
     return long_description
 
 
diff --git a/mysqlx-connector-python/tests/requirements.txt b/mysqlx-connector-python/tests/requirements.txt
@@ -1,4 +1,4 @@
-protobuf==4.25.3
+protobuf==5.29.4
 dnspython==2.6.1
 lz4>=2.1.6,<=4.3.2
 zstandard>=0.12.0,<=0.19.0
