Remove egg_link_path()

Author: sbidoul

src/pip/_internal/req/req_uninstall.py

@@ -12,12 +12,12 @@
 from pip._internal.exceptions import UninstallationError
 from pip._internal.locations import get_bin_prefix, get_bin_user
 from pip._internal.utils.compat import WINDOWS
+from pip._internal.utils.egg_link import egg_link_path_from_location
 from pip._internal.utils.logging import getLogger, indent_log
 from pip._internal.utils.misc import (
     ask,
     dist_in_usersite,
     dist_is_local,
-    egg_link_path,
     is_local,
     normalize_path,
     renames,
@@ -459,7 +459,7 @@ def from_dist(cls, dist: Distribution) -> "UninstallPathSet":
             return cls(dist)
 
         paths_to_remove = cls(dist)
-        develop_egg_link = egg_link_path(dist)
+        develop_egg_link = egg_link_path_from_location(dist.project_name)
         develop_egg_link_egg_info = "{}.egg-info".format(
             pkg_resources.to_filename(dist.project_name)
         )

src/pip/_internal/utils/egg_link.py

@@ -6,8 +6,6 @@
 import sys
 from typing import Optional
 
-from pip._vendor.pkg_resources import Distribution
-
 from pip._internal.locations import site_packages, user_site
 from pip._internal.utils.virtualenv import (
     running_under_virtualenv,
@@ -17,7 +15,6 @@
 __all__ = [
     "egg_link_path_from_sys_path",
     "egg_link_path_from_location",
-    "egg_link_path",
 ]
 
 
@@ -76,8 +73,3 @@ def egg_link_path_from_location(raw_name: str) -> Optional[str]:
         if os.path.isfile(egglink):
             return egglink
     return None
-
-
-def egg_link_path(dist):
-    # type: (Distribution) -> Optional[str]
-    return egg_link_path_from_location(dist.project_name)

src/pip/_internal/utils/misc.py

@@ -39,7 +39,7 @@
 from pip._internal.exceptions import CommandError
 from pip._internal.locations import get_major_minor_version, site_packages, user_site
 from pip._internal.utils.compat import WINDOWS
-from pip._internal.utils.egg_link import egg_link_path
+from pip._internal.utils.egg_link import egg_link_path_from_location
 from pip._internal.utils.virtualenv import running_under_virtualenv
 
 __all__ = [
@@ -380,7 +380,7 @@ def dist_location(dist: Distribution) -> str:
 
     The returned location is normalized (in particular, with symlinks removed).
     """
-    egg_link = egg_link_path(dist)
+    egg_link = egg_link_path_from_location(dist.project_name)
     if egg_link:
         return normalize_path(egg_link)
     return normalize_path(dist.location)

tests/unit/test_utils.py

@@ -17,6 +17,7 @@
 
 from pip._internal.exceptions import HashMismatch, HashMissing, InstallationError
 from pip._internal.utils.deprecation import PipDeprecationWarning, deprecated
+from pip._internal.utils.egg_link import egg_link_path_from_location
 from pip._internal.utils.encoding import BOMS, auto_decode
 from pip._internal.utils.glibc import (
     glibc_version_string,
@@ -28,7 +29,6 @@
     HiddenText,
     build_netloc,
     build_url_from_netloc,
-    egg_link_path,
     format_size,
     get_distribution,
     get_prog,
@@ -51,7 +51,7 @@
 
 
 class Tests_EgglinkPath:
-    "util.egg_link_path() tests"
+    "util.egg_link_path_from_location() tests"
 
     def setup(self):
 
@@ -106,19 +106,25 @@ def test_egglink_in_usersite_notvenv(self):
         self.mock_virtualenv_no_global.return_value = False
         self.mock_running_under_virtualenv.return_value = False
         self.mock_isfile.side_effect = self.eggLinkInUserSite
-        assert egg_link_path(self.mock_dist) == self.user_site_egglink
+        assert (
+            egg_link_path_from_location(self.mock_dist.project_name)
+            == self.user_site_egglink
+        )
 
     def test_egglink_in_usersite_venv_noglobal(self):
         self.mock_virtualenv_no_global.return_value = True
         self.mock_running_under_virtualenv.return_value = True
         self.mock_isfile.side_effect = self.eggLinkInUserSite
-        assert egg_link_path(self.mock_dist) is None
+        assert egg_link_path_from_location(self.mock_dist.project_name) is None
 
     def test_egglink_in_usersite_venv_global(self):
         self.mock_virtualenv_no_global.return_value = False
         self.mock_running_under_virtualenv.return_value = True
         self.mock_isfile.side_effect = self.eggLinkInUserSite
-        assert egg_link_path(self.mock_dist) == self.user_site_egglink
+        assert (
+            egg_link_path_from_location(self.mock_dist.project_name)
+            == self.user_site_egglink
+        )
 
     # ####################### #
     # # egglink in sitepkgs # #
@@ -127,19 +133,28 @@ def test_egglink_in_sitepkgs_notvenv(self):
         self.mock_virtualenv_no_global.return_value = False
         self.mock_running_under_virtualenv.return_value = False
         self.mock_isfile.side_effect = self.eggLinkInSitePackages
-        assert egg_link_path(self.mock_dist) == self.site_packages_egglink
+        assert (
+            egg_link_path_from_location(self.mock_dist.project_name)
+            == self.site_packages_egglink
+        )
 
     def test_egglink_in_sitepkgs_venv_noglobal(self):
         self.mock_virtualenv_no_global.return_value = True
         self.mock_running_under_virtualenv.return_value = True
         self.mock_isfile.side_effect = self.eggLinkInSitePackages
-        assert egg_link_path(self.mock_dist) == self.site_packages_egglink
+        assert (
+            egg_link_path_from_location(self.mock_dist.project_name)
+            == self.site_packages_egglink
+        )
 
     def test_egglink_in_sitepkgs_venv_global(self):
         self.mock_virtualenv_no_global.return_value = False
         self.mock_running_under_virtualenv.return_value = True
         self.mock_isfile.side_effect = self.eggLinkInSitePackages
-        assert egg_link_path(self.mock_dist) == self.site_packages_egglink
+        assert (
+            egg_link_path_from_location(self.mock_dist.project_name)
+            == self.site_packages_egglink
+        )
 
     # ################################## #
     # # egglink in usersite & sitepkgs # #
@@ -148,19 +163,28 @@ def test_egglink_in_both_notvenv(self):
         self.mock_virtualenv_no_global.return_value = False
         self.mock_running_under_virtualenv.return_value = False
         self.mock_isfile.return_value = True
-        assert egg_link_path(self.mock_dist) == self.user_site_egglink
+        assert (
+            egg_link_path_from_location(self.mock_dist.project_name)
+            == self.user_site_egglink
+        )
 
     def test_egglink_in_both_venv_noglobal(self):
         self.mock_virtualenv_no_global.return_value = True
         self.mock_running_under_virtualenv.return_value = True
         self.mock_isfile.return_value = True
-        assert egg_link_path(self.mock_dist) == self.site_packages_egglink
+        assert (
+            egg_link_path_from_location(self.mock_dist.project_name)
+            == self.site_packages_egglink
+        )
 
     def test_egglink_in_both_venv_global(self):
         self.mock_virtualenv_no_global.return_value = False
         self.mock_running_under_virtualenv.return_value = True
         self.mock_isfile.return_value = True
-        assert egg_link_path(self.mock_dist) == self.site_packages_egglink
+        assert (
+            egg_link_path_from_location(self.mock_dist.project_name)
+            == self.site_packages_egglink
+        )
 
     # ############## #
     # # no egglink # #
@@ -169,19 +193,19 @@ def test_noegglink_in_sitepkgs_notvenv(self):
         self.mock_virtualenv_no_global.return_value = False
         self.mock_running_under_virtualenv.return_value = False
         self.mock_isfile.return_value = False
-        assert egg_link_path(self.mock_dist) is None
+        assert egg_link_path_from_location(self.mock_dist.project_name) is None
 
     def test_noegglink_in_sitepkgs_venv_noglobal(self):
         self.mock_virtualenv_no_global.return_value = True
         self.mock_running_under_virtualenv.return_value = True
         self.mock_isfile.return_value = False
-        assert egg_link_path(self.mock_dist) is None
+        assert egg_link_path_from_location(self.mock_dist.project_name) is None
 
     def test_noegglink_in_sitepkgs_venv_global(self):
         self.mock_virtualenv_no_global.return_value = False
         self.mock_running_under_virtualenv.return_value = True
         self.mock_isfile.return_value = False
-        assert egg_link_path(self.mock_dist) is None
+        assert egg_link_path_from_location(self.mock_dist.project_name) is None
 
 
 @patch("pip._internal.utils.misc.dist_in_usersite")