Merge pull request #13064 from ichard26/block-upgrade-prompt

Skip self version check on EXTERNALLY-MANAGED environments

Author: pradyunsg

news/11820.bugfix.rst

@@ -0,0 +1 @@
+The pip version self check is disabled on ``EXTERNALLY-MANAGED`` environments.

src/pip/_internal/self_outdated_check.py

@@ -26,7 +26,11 @@
     get_best_invocation_for_this_python,
 )
 from pip._internal.utils.filesystem import adjacent_tmp_file, check_path_owner, replace
-from pip._internal.utils.misc import ensure_dir
+from pip._internal.utils.misc import (
+    ExternallyManagedEnvironment,
+    check_externally_managed,
+    ensure_dir,
+)
 
 _WEEK = datetime.timedelta(days=7)
 
@@ -231,6 +235,10 @@ def pip_self_version_check(session: PipSession, options: optparse.Values) -> Non
     installed_dist = get_default_environment().get_distribution("pip")
     if not installed_dist:
         return
+    try:
+        check_externally_managed()
+    except ExternallyManagedEnvironment:
+        return
 
     upgrade_prompt = _self_version_check_logic(
         state=SelfCheckState(cache_dir=options.cache_dir),

tests/unit/test_self_check_outdated.py

@@ -14,6 +14,8 @@
 from pip._vendor.packaging.version import Version
 
 from pip._internal import self_outdated_check
+from pip._internal.self_outdated_check import UpgradePrompt, pip_self_version_check
+from pip._internal.utils.misc import ExternallyManagedEnvironment
 
 
 @pytest.mark.parametrize(
@@ -185,3 +187,15 @@ def test_writes_expected_statefile(self, tmpdir: Path) -> None:
             "last_check": "2000-01-01T00:00:00+00:00",
             "pypi_version": "1.0.0",
         }
+
+
+@patch("pip._internal.self_outdated_check._self_version_check_logic")
+def test_suppressed_by_externally_managed(mocked_function: Mock, tmpdir: Path) -> None:
+    mocked_function.return_value = UpgradePrompt(old="1.0", new="2.0")
+    fake_options = Values({"cache_dir": str(tmpdir)})
+    with patch(
+        "pip._internal.self_outdated_check.check_externally_managed",
+        side_effect=ExternallyManagedEnvironment("nope"),
+    ):
+        pip_self_version_check(session=Mock(), options=fake_options)
+    mocked_function.assert_not_called()