WL#16954: Make sdist packages pip installable

oscpache · oscpache · commit 73b60b05fd69 · 2025-06-13T07:53:58.000-06:00
Classic and XDevAPI connector Python source distribution (sdist) name was updated to comply with [PEP 625](https://peps.python.org/pep-0625/). Additionally, setup.py was updated to make sure metadata files are correctly included in the sdist when generated. Ultimately, to make the sdist pip installable. Change-Id: I0de7f1657ef9f5539f93139eff9881c23957273b
diff --git a/.gitignore b/.gitignore
@@ -24,26 +24,16 @@ docs
 dist
 build
 
-# Classic protocol connector (aka mysql)
-mysql-connector-python/build/
-mysql-connector-python/dist/
-mysql-connector-python/docs/INFO_BIN
-mysql-connector-python/docs/INFO_SRC
-mysql-connector-python/lib/mysql/vendor/
-mysql-connector-python/tests_*.log
-mysql-connector-python/README.txt
-mysql-connector-python/README.rst
-mysql-connector-python/LICENSE.txt
-mysql-connector-python/CHANGES.txt
-
-# X protocol connector (aka XDevAPI or mysqlx)
-mysqlx-connector-python/build/
-mysqlx-connector-python/dist/
-mysqlx-connector-python/docs/INFO_BIN
-mysqlx-connector-python/docs/INFO_SRC
-mysqlx-connector-python/src/mysqlxpb/mysqlx/mysqlx*
-mysqlx-connector-python/README.txt
-mysqlx-connector-python/README.rst
-mysqlx-connector-python/LICENSE.txt
-mysqlx-connector-python/CHANGES.txt
-
+# Classic/XDevAPI protocol connector (aka mysql)
+mysql*-connector-python/build/
+mysql*-connector-python/dist/
+mysql*-connector-python/docs/INFO_BIN
+mysql*-connector-python/docs/INFO_SRC
+mysql*-connector-python/lib/mysql/vendor/
+mysql*-connector-python/tests_*.log
+mysql*-connector-python/README.txt
+mysql*-connector-python/README.rst
+mysql*-connector-python/LICENSE.txt
+mysql*-connector-python/CHANGES.txt
+mysql*-connector-python/CONTRIBUTING.md
+mysql*-connector-python/SECURITY.md
diff --git a/CHANGES.txt b/CHANGES.txt
@@ -14,6 +14,7 @@ v9.4.0
 - WL#16966: Upgrade Python lz4 version
 - WL#16963: Update the OpenTelemetry version
 - WL#16962: Update the Python Protobuf version
+- WL#16954: Make sdist packages pip installable
 - BUG#37868219: RPM packages have incorrect copyright year in their metadata
 - BUG#37859771: mysql/connector python version 9.3.0 has a regression which cannot persist binary data with percent signs in it
 - BUG#37820231: Text based django ORM filters doesn't work with Connector/Python
diff --git a/mysql-connector-python/MANIFEST.in b/mysql-connector-python/MANIFEST.in
@@ -4,6 +4,7 @@ include LICENSE.txt
 include CONTRIBUTING.md
 include SECURITY.md
 include CHANGES.txt
+include src/version_info.rc
 include setup.py
 include unittests.py
 include MANIFEST.in
diff --git a/mysql-connector-python/cpydist/sdist.py b/mysql-connector-python/cpydist/sdist.py
@@ -108,11 +108,13 @@ def finalize_options(self):
         """Finalize the options."""
 
         def _get_fullname():
-            name = self.distribution.get_name()
-            label = f"-{self.label if self.label else ''}"
+            # Comply with [PEP 625](https://peps.python.org/pep-0625/).
+            # Use the normalized project name 'mysql_connector_python'.
+            distribution = self.distribution.get_name().replace("-", "_")
+            label = f"-{self.label}" if self.label else ""
             version = self.distribution.get_version()
             edition = self.edition or ""
-            return f"{name}{label}-{version}{edition}"
+            return f"{distribution}{label}-{version}{edition}"
 
         self.distribution.get_fullname = _get_fullname
         sdist.finalize_options(self)
diff --git a/mysql-connector-python/setup.py b/mysql-connector-python/setup.py
@@ -171,13 +171,19 @@ def copy_metadata_files() -> None:
     parent directory to the current directory.
     """
     for filename in METADATA_FILES:
-        shutil.copy(pathlib.Path(os.getcwd(), f"../{filename}"), pathlib.Path(f"./"))
+        # if file is not in current directory, then try to load it from one level above
+        if not os.path.exists(
+            pathlib.Path(os.getcwd(), f"./{filename}")
+        ) and os.path.exists(pathlib.Path(os.getcwd(), f"../{filename}")):
+            shutil.copy(
+                pathlib.Path(os.getcwd(), f"../{filename}"), pathlib.Path(f"./")
+            )
 
 
 def get_long_description() -> str:
     """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:
+    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 (mysql)
         long_description = file_handle.read()
@@ -223,10 +229,4 @@ def remove_metadata_files() -> None:
 
 if __name__ == "__main__":
     copy_metadata_files()
-
-    try:
-        main()
-    except Exception as err:
-        raise err
-    finally:
-        remove_metadata_files()
+    main()
diff --git a/mysqlx-connector-python/cpydist/sdist.py b/mysqlx-connector-python/cpydist/sdist.py
@@ -108,11 +108,13 @@ def finalize_options(self):
         """Finalize the options."""
 
         def _get_fullname():
-            name = self.distribution.get_name()
-            label = f"-{self.label if self.label else ''}"
+            # Comply with [PEP 625](https://peps.python.org/pep-0625/).
+            # Use the normalized project name 'mysql_connector_python'.
+            distribution = self.distribution.get_name().replace("-", "_")
+            label = f"-{self.label}" if self.label else ""
             version = self.distribution.get_version()
             edition = self.edition or ""
-            return f"{name}{label}-{version}{edition}"
+            return f"{distribution}{label}-{version}{edition}"
 
         self.distribution.get_fullname = _get_fullname
         sdist.finalize_options(self)
diff --git a/mysqlx-connector-python/setup.py b/mysqlx-connector-python/setup.py
@@ -173,12 +173,19 @@ def copy_metadata_files() -> None:
     parent directory to the current directory.
     """
     for filename in METADATA_FILES:
-        shutil.copy(pathlib.Path(os.getcwd(), f"../{filename}"), pathlib.Path(f"./"))
+        # if file is not in current directory, then try to load it from one level above
+        if not os.path.exists(
+            pathlib.Path(os.getcwd(), f"./{filename}")
+        ) and os.path.exists(pathlib.Path(os.getcwd(), f"../{filename}")):
+            shutil.copy(
+                pathlib.Path(os.getcwd(), f"../{filename}"), pathlib.Path(f"./")
+            )
 
 
 def get_long_description() -> str:
-    """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:
+    """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()
@@ -229,10 +236,4 @@ def remove_metadata_files() -> None:
 
 if __name__ == "__main__":
     copy_metadata_files()
-
-    try:
-        main()
-    except Exception as err:
-        raise err
-    finally:
-        remove_metadata_files()
+    main()
