Use warnings module instead of logging module

Author: vchudnov-g

google/api_core/_python_package_support.py

@@ -14,7 +14,7 @@
 
 """Code to check versions of dependencies used by Google Cloud Client Libraries."""
 
-import logging
+import warnings
 import sys
 from typing import Optional
 from ._python_version_support import (
@@ -128,7 +128,7 @@ def warn_deprecation_for_versions_less_than(
             {dependency_package}.
             """
         )
-        logging.warning(
+        warnings.warn(
             message_template.format(
                 dependent_import_package=dependent_import_package,
                 dependency_import_package=dependency_import_package,

google/api_core/_python_version_support.py

@@ -16,7 +16,7 @@
 
 import datetime
 import enum
-import logging
+import warnings
 import sys
 import textwrap
 from typing import Any, NamedTuple, Optional, Dict, Tuple
@@ -195,7 +195,7 @@ def min_python(date: datetime.date) -> str:
             {min_python(today)}, and then update {package_label}.
             """
         )
-        logging.warning(message)
+        warnings.warn(message)
         return PythonVersionStatus.PYTHON_VERSION_UNSUPPORTED
 
     eol_date = version_info.python_eol + EOL_GRACE_PERIOD
@@ -210,7 +210,7 @@ def min_python(date: datetime.date) -> str:
             {min_python(today)}, and then update {package_label}.
             """
         )
-        logging.warning(message)
+        warnings.warn(message)
         return PythonVersionStatus.PYTHON_VERSION_EOL
 
     if gapic_deprecation <= today <= gapic_end:
@@ -224,7 +224,7 @@ def min_python(date: datetime.date) -> str:
             then update {package_label}.
             """
         )
-        logging.warning(message)
+        warnings.warn(message)
         return PythonVersionStatus.PYTHON_VERSION_DEPRECATED
 
     return PythonVersionStatus.PYTHON_VERSION_SUPPORTED

tests/unit/test_python_package_support.py

@@ -13,6 +13,7 @@
 # limitations under the License.
 
 import sys
+import warnings
 from unittest.mock import patch, MagicMock
 
 import pytest
@@ -60,9 +61,8 @@ def test_get_dependency_version_py37(mock_get_distribution):
 
 @patch("google.api_core._python_package_support._get_distribution_and_import_packages")
 @patch("google.api_core._python_package_support.get_dependency_version")
-@patch("google.api_core._python_package_support.logging.warning")
 def test_warn_deprecation_for_versions_less_than(
-    mock_log_warning, mock_get_version, mock_get_packages
+    mock_get_version, mock_get_packages
 ):
     """Test the deprecation warning logic."""
     # Mock the helper function to return predictable package strings
@@ -73,48 +73,50 @@ def test_warn_deprecation_for_versions_less_than(
 
     # Case 1: Installed version is less than required, should warn.
     mock_get_version.return_value = parse_version("1.0.0")
-    warn_deprecation_for_versions_less_than("my.package", "dep.package", "2.0.0")
-    mock_log_warning.assert_called_once()
+    with pytest.warns(UserWarning) as record:
+        warn_deprecation_for_versions_less_than("my.package", "dep.package", "2.0.0")
+    assert len(record) == 1
     assert (
         "DEPRECATION: Package my-package (my.package) depends on dep-package (dep.package)"
-        in mock_log_warning.call_args[0][0]
+        in str(record[0].message)
     )
 
-    # Case 2: Installed version is equal to required, should not warn.
-    mock_log_warning.reset_mock()
-    mock_get_packages.reset_mock()
-    mock_get_version.return_value = parse_version("2.0.0")
-    warn_deprecation_for_versions_less_than("my.package", "dep.package", "2.0.0")
-    mock_log_warning.assert_not_called()
+    # Cases where no warning should be issued
+    with warnings.catch_warnings(record=True) as w:
+        warnings.simplefilter("always")  # Capture all warnings
 
-    # Case 3: Installed version is greater than required, should not warn.
-    mock_log_warning.reset_mock()
-    mock_get_packages.reset_mock()
-    mock_get_version.return_value = parse_version("3.0.0")
-    warn_deprecation_for_versions_less_than("my.package", "dep.package", "2.0.0")
-    mock_log_warning.assert_not_called()
+        # 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")
+        warn_deprecation_for_versions_less_than("my.package", "dep.package", "2.0.0")
 
-    # Case 4: Dependency not found, should not warn.
-    mock_log_warning.reset_mock()
-    mock_get_packages.reset_mock()
-    mock_get_version.return_value = None
-    warn_deprecation_for_versions_less_than("my.package", "dep.package", "2.0.0")
-    mock_log_warning.assert_not_called()
+        # 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")
+        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
+        warn_deprecation_for_versions_less_than("my.package", "dep.package", "2.0.0")
+
+        # Assert that no warnings were recorded
+        assert len(w) == 0
 
     # Case 5: Custom message template.
-    mock_log_warning.reset_mock()
     mock_get_packages.reset_mock()
     mock_get_packages.side_effect = [
         ("dep-package (dep.package)", "dep-package"),
         ("my-package (my.package)", "my-package"),
     ]
     mock_get_version.return_value = parse_version("1.0.0")
     template = "Custom warning for {dependency_package} used by {dependent_package}."
-    warn_deprecation_for_versions_less_than(
-        "my.package", "dep.package", "2.0.0", message_template=template
-    )
-    mock_log_warning.assert_called_once()
+    with pytest.warns(UserWarning) as record:
+        warn_deprecation_for_versions_less_than(
+            "my.package", "dep.package", "2.0.0", message_template=template
+        )
+    assert len(record) == 1
     assert (
         "Custom warning for dep-package (dep.package) used by my-package (my.package)."
-        in mock_log_warning.call_args[0][0]
+        in str(record[0].message)
     )

tests/unit/test_python_version_support.py

@@ -15,6 +15,7 @@
 import pytest
 import datetime
 import textwrap
+import warnings
 from collections import namedtuple
 
 from unittest.mock import patch
@@ -120,30 +121,33 @@ def test_all_tracked_versions_and_date_scenarios(
     mock_py_v = VersionInfoMock(major=version_tuple[0], minor=version_tuple[1])
 
     with patch("google.api_core._python_version_support.sys.version_info", mock_py_v):
-        with patch(
-            "google.api_core._python_version_support.logging.warning"
-        ) as mock_log:
-            result = check_python_version(today=mock_date)
-
-            if (
-                (result != expected_status)
-                or (result != PythonVersionStatus.PYTHON_VERSION_SUPPORTED)
-                and mock_log.call_count != 1
-            ):  # pragma: NO COVER
-                py_version_str = f"{version_tuple[0]}.{version_tuple[1]}"
-                version_info = PYTHON_VERSION_INFO[version_tuple]
-
-                fail_msg = _create_failure_message(
-                    expected_status,
-                    result,
-                    py_version_str,
-                    mock_date,
-                    gapic_dep,
-                    version_info.python_eol,
-                    eol_warning_starts,
-                    gapic_end,
-                )
-                pytest.fail(fail_msg, pytrace=False)
+        # Supported versions should not issue warnings
+        if expected_status == PythonVersionStatus.PYTHON_VERSION_SUPPORTED:
+            with warnings.catch_warnings(record=True) as w:
+                warnings.simplefilter("always")
+                result = check_python_version(today=mock_date)
+                assert len(w) == 0
+        # All other statuses should issue a warning
+        else:
+            with pytest.warns(UserWarning) as record:
+                result = check_python_version(today=mock_date)
+            assert len(record) == 1
+
+        if result != expected_status:  # pragma: NO COVER
+            py_version_str = f"{version_tuple[0]}.{version_tuple[1]}"
+            version_info = PYTHON_VERSION_INFO[version_tuple]
+
+            fail_msg = _create_failure_message(
+                expected_status,
+                result,
+                py_version_str,
+                mock_date,
+                gapic_dep,
+                version_info.python_eol,
+                eol_warning_starts,
+                gapic_end,
+            )
+            pytest.fail(fail_msg, pytrace=False)
 
 
 def test_override_gapic_end_only():
@@ -212,16 +216,13 @@ def test_untracked_older_version_is_unsupported():
     with patch(
         "google.api_core._python_version_support.sys.version_info", mock_py_version
     ):
-        with patch(
-            "google.api_core._python_version_support.logging.warning"
-        ) as mock_log:
+        with pytest.warns(UserWarning) as record:
             mock_date = datetime.date(2025, 1, 15)
             result = check_python_version(today=mock_date)
 
             assert result == PythonVersionStatus.PYTHON_VERSION_UNSUPPORTED
-            mock_log.assert_called_once()
-            call_args = mock_log.call_args[0][0]
-            assert "non-supported" in call_args
+            assert len(record) == 1
+            assert "non-supported" in str(record[0].message)
 
 
 def test_untracked_newer_version_is_supported():
@@ -231,11 +232,10 @@ def test_untracked_newer_version_is_supported():
     with patch(
         "google.api_core._python_version_support.sys.version_info", mock_py_version
     ):
-        with patch(
-            "google.api_core._python_version_support.logging.warning"
-        ) as mock_log:
+        with warnings.catch_warnings(record=True) as w:
+            warnings.simplefilter("always")
             mock_date = datetime.date(2025, 1, 15)
             result = check_python_version(today=mock_date)
 
             assert result == PythonVersionStatus.PYTHON_VERSION_SUPPORTED
-            mock_log.assert_not_called()
+            assert len(w) == 0