refactor: used namedtuple

google/api_core/_python_package_support.py

@@ -16,18 +16,23 @@
 
 import warnings
 import sys
-from typing import Optional, Tuple
+from typing import Optional
+
+from collections import namedtuple
+
 from ._python_version_support import (
     _flatten_message,
     _get_distribution_and_import_packages,
 )
 
-from packaging.version import parse as parse_version, Version as PackagingVersion
+from packaging.version import parse as parse_version
+
+DependencyVersion = namedtuple("DependencyVersion", ["version", "version_string"])
 
 
 def get_dependency_version(
     dependency_name: str,
-) -> Tuple[Optional[PackagingVersion], str]:
+) -> DependencyVersion:
     """Get the parsed version of an installed package dependency.
 
     This function checks for an installed package and returns its version
@@ -38,16 +43,16 @@ def get_dependency_version(
         dependency_name: The distribution name of the package (e.g., 'requests').
 
     Returns:
-        A tuple containing the `packaging.version.Version` object and the
-        version string, or `(None, '--')` if the package is not found or
-        another error occurs during version discovery.
+        A DependencyVersion namedtuple with `version` and `version_string`
+        attributes, or `DependencyVersion(None, '--')` if the package is not
+        found or another error occurs during version discovery.
     """
     try:
         if sys.version_info >= (3, 8):
             from importlib import metadata
 
             version_string = metadata.version(dependency_name)
-            return (parse_version(version_string), version_string)
+            return DependencyVersion(parse_version(version_string), version_string)
 
         # TODO(https://github.com/googleapis/python-api-core/issues/835): Remove
         # this code path once we drop support for Python 3.7
@@ -56,10 +61,10 @@ def get_dependency_version(
             import pkg_resources
 
             version_string = pkg_resources.get_distribution(dependency_name).version
-            return (parse_version(version_string), version_string)
+            return DependencyVersion(parse_version(version_string), version_string)
 
     except Exception:
-        return (None, "--")
+        return DependencyVersion(None, "--")
 
 
 def warn_deprecation_for_versions_less_than(
@@ -107,12 +112,10 @@ def warn_deprecation_for_versions_less_than(
         or not next_supported_version
     ):  # pragma: NO COVER
         return
-    (version_used, version_used_string) = get_dependency_version(
-        dependency_import_package
-    )
-    if not version_used:
+    dependency_version = get_dependency_version(dependency_import_package)
+    if not dependency_version.version:
         return
-    if version_used < parse_version(next_supported_version):
+    if dependency_version.version < parse_version(next_supported_version):
         (
             dependency_package,
             dependency_distribution_package,
@@ -151,8 +154,8 @@ def warn_deprecation_for_versions_less_than(
                 dependent_package=dependent_package,
                 next_supported_version=next_supported_version,
                 recommendation=recommendation,
-                version_used=version_used,
-                version_used_string=version_used_string,
+                version_used=dependency_version.version,
+                version_used_string=dependency_version.version_string,
             ),
             FutureWarning,
         )

tests/unit/test_python_package_support.py

@@ -22,6 +22,7 @@
 from google.api_core._python_package_support import (
     get_dependency_version,
     warn_deprecation_for_versions_less_than,
+    DependencyVersion,
 )
 
 
@@ -32,12 +33,13 @@
 def test_get_dependency_version_py38_plus(mock_version):
     """Test get_dependency_version on Python 3.8+."""
     mock_version.return_value = "1.2.3"
-    assert get_dependency_version("some-package") == (parse_version("1.2.3"), "1.2.3")
+    expected = DependencyVersion(parse_version("1.2.3"), "1.2.3")
+    assert get_dependency_version("some-package") == expected
     mock_version.assert_called_once_with("some-package")
 
     # Test package not found
     mock_version.side_effect = ImportError
-    assert get_dependency_version("not-a-package") == (None, "--")
+    assert get_dependency_version("not-a-package") == DependencyVersion(None, "--")
 
 
 # TODO(https://github.com/googleapis/python-api-core/issues/835): Remove
@@ -49,17 +51,15 @@ def test_get_dependency_version_py37(mock_get_distribution):
     mock_dist = MagicMock()
     mock_dist.version = "4.5.6"
     mock_get_distribution.return_value = mock_dist
-    assert get_dependency_version("another-package") == (
-        parse_version("4.5.6"),
-        "4.5.6",
-    )
+    expected = DependencyVersion(parse_version("4.5.6"), "4.5.6")
+    assert get_dependency_version("another-package") == expected
     mock_get_distribution.assert_called_once_with("another-package")
 
     # Test package not found
     mock_get_distribution.side_effect = (
         Exception  # pkg_resources has its own exception types
     )
-    assert get_dependency_version("not-a-package") == (None, "--")
+    assert get_dependency_version("not-a-package") == DependencyVersion(None, "--")
 
 
 @patch("google.api_core._python_package_support._get_distribution_and_import_packages")
@@ -72,7 +72,7 @@ def test_warn_deprecation_for_versions_less_than(mock_get_version, mock_get_pack
         ("my-package (my.package)", "my-package"),
     ]
 
-    mock_get_version.return_value = (parse_version("1.0.0"), "1.0.0")
+    mock_get_version.return_value = DependencyVersion(parse_version("1.0.0"), "1.0.0")
     with pytest.warns(FutureWarning) as record:
         warn_deprecation_for_versions_less_than("my.package", "dep.package", "2.0.0")
     assert len(record) == 1
@@ -87,17 +87,21 @@ def test_warn_deprecation_for_versions_less_than(mock_get_version, mock_get_pack
 
         # Case 2: Installed version is equal to required, should not warn.
         mock_get_packages.reset_mock()
-        mock_get_version.return_value = (parse_version("2.0.0"), "2.0.0")
+        mock_get_version.return_value = DependencyVersion(
+            parse_version("2.0.0"), "2.0.0"
+        )
         warn_deprecation_for_versions_less_than("my.package", "dep.package", "2.0.0")
 
         # Case 3: Installed version is greater than required, should not warn.
         mock_get_packages.reset_mock()
-        mock_get_version.return_value = (parse_version("3.0.0"), "3.0.0")
+        mock_get_version.return_value = DependencyVersion(
+            parse_version("3.0.0"), "3.0.0"
+        )
         warn_deprecation_for_versions_less_than("my.package", "dep.package", "2.0.0")
 
         # Case 4: Dependency not found, should not warn.
         mock_get_packages.reset_mock()
-        mock_get_version.return_value = (None, "--")
+        mock_get_version.return_value = DependencyVersion(None, "--")
         warn_deprecation_for_versions_less_than("my.package", "dep.package", "2.0.0")
 
         # Assert that no warnings were recorded
@@ -109,7 +113,7 @@ def test_warn_deprecation_for_versions_less_than(mock_get_version, mock_get_pack
         ("dep-package (dep.package)", "dep-package"),
         ("my-package (my.package)", "my-package"),
     ]
-    mock_get_version.return_value = (parse_version("1.0.0"), "1.0.0")
+    mock_get_version.return_value = DependencyVersion(parse_version("1.0.0"), "1.0.0")
     template = "Custom warning for {dependency_package} used by {dependent_package}."
     with pytest.warns(FutureWarning) as record:
         warn_deprecation_for_versions_less_than(