Merge branch 'main' into uploaded-prior-to

Author: notatallshaw

news/13407.bugfix.rst

@@ -0,0 +1,3 @@
+Revisions in version control URLs now must be percent-encoded.
+For example, use ``git+https://example.com/repo.git@issue%231`` to specify the branch ``issue#1``.
+If you previously used a branch name containing a ``%`` character in a version control URL, you now need to replace it with ``%25`` to ensure correct percent-encoding.

news/13555.bugfix.rst

@@ -0,0 +1 @@
+Fix bash completion when the ``$IFS`` variable has been modified from its default.

news/6823.bugfix.rst

@@ -0,0 +1 @@
+Better preserve original casing when a path is displayed.

src/pip/_internal/commands/completion.py

@@ -14,9 +14,10 @@
     "bash": """
         _pip_completion()
         {{
+            local IFS=$' \\t\\n'
             COMPREPLY=( $( COMP_WORDS="${{COMP_WORDS[*]}}" \\
                            COMP_CWORD=$COMP_CWORD \\
-                           PIP_AUTO_COMPLETE=1 $1 2>/dev/null ) )
+                           PIP_AUTO_COMPLETE=1 "$1" 2>/dev/null ) )
         }}
         complete -o default -F _pip_completion {prog}
     """,

src/pip/_internal/utils/misc.py

@@ -182,10 +182,12 @@ def rmtree_errorhandler(
 def display_path(path: str) -> str:
     """Gives the display value for a given path, making it relative to cwd
     if possible."""
-    path = os.path.normcase(os.path.abspath(path))
-    if path.startswith(os.getcwd() + os.path.sep):
-        path = "." + path[len(os.getcwd()) :]
-    return path
+    try:
+        relative = Path(path).relative_to(Path.cwd())
+    except ValueError:
+        # If the path isn't relative to the CWD, leave it alone
+        return path
+    return os.path.join(".", relative)
 
 
 def backup_dir(dir: str, ext: str = ".bak") -> str:

src/pip/_internal/vcs/versioncontrol.py

@@ -62,8 +62,9 @@ def make_vcs_requirement_url(
       repo_url: the remote VCS url, with any needed VCS prefix (e.g. "git+").
       project_name: the (unescaped) project name.
     """
+    quoted_rev = urllib.parse.quote(rev, "/")
     egg_project_name = project_name.replace("-", "_")
-    req = f"{repo_url}@{rev}#egg={egg_project_name}"
+    req = f"{repo_url}@{quoted_rev}#egg={egg_project_name}"
     if subdir:
         req += f"&subdirectory={subdir}"
 
@@ -397,6 +398,7 @@ def get_url_rev_and_auth(cls, url: str) -> tuple[str, str | None, AuthInfo]:
                     "which is not supported. Include a revision after @ "
                     "or remove @ from the URL."
                 )
+            rev = urllib.parse.unquote(rev)
         url = urllib.parse.urlunsplit((scheme, netloc, path, query, ""))
         return url, rev, user_pass
 

tests/functional/test_completion.py

@@ -15,9 +15,10 @@
         """\
 _pip_completion()
 {
+    local IFS=$' \\t\\n'
     COMPREPLY=( $( COMP_WORDS="${COMP_WORDS[*]}" \\
                    COMP_CWORD=$COMP_CWORD \\
-                   PIP_AUTO_COMPLETE=1 $1 2>/dev/null ) )
+                   PIP_AUTO_COMPLETE=1 "$1" 2>/dev/null ) )
 }
 complete -o default -F _pip_completion pip""",
     ),

tests/unit/test_utils.py

@@ -14,7 +14,7 @@
 from io import BytesIO
 from pathlib import Path
 from typing import Any, Callable, NoReturn
-from unittest.mock import Mock
+from unittest.mock import Mock, patch
 
 import pytest
 
@@ -33,6 +33,7 @@
     HiddenText,
     build_netloc,
     build_url_from_netloc,
+    display_path,
     format_size,
     get_prog,
     hide_url,
@@ -320,6 +321,39 @@ def test_rmtree_retries_for_3sec(monkeypatch: pytest.MonkeyPatch) -> None:
     )
 
 
+class Test_display_path:
+    on_unix = pytest.mark.skipif("sys.platform == 'win32'")
+    on_win32 = pytest.mark.skipif("sys.platform != 'win32'")
+
+    @pytest.mark.parametrize(
+        "path, fake_cwd, expected",
+        [
+            pytest.param(
+                *("/home/name/project", Path("/home/name"), "./project"),
+                marks=on_unix,
+            ),
+            pytest.param(
+                *("/home", Path("/home/name"), "/home"),
+                marks=on_unix,
+                id="not-go-up",
+            ),
+            pytest.param(
+                *("C:\\Name\\Project", Path("C:\\Name"), ".\\Project"),
+                marks=on_win32,
+            ),
+            pytest.param(
+                *("D:\\Data", Path("C:\\Name"), "D:\\Data"),
+                marks=on_win32,
+            ),
+        ],
+    )
+    def test_display(self, path: str, fake_cwd: Path, expected: str) -> None:
+        with patch("pathlib.Path.cwd") as cwd_func:
+            cwd_func.return_value = fake_cwd
+            got = display_path(path)
+            assert got == expected
+
+
 class Test_normalize_path:
     # Technically, symlinks are possible on Windows, but you need a special
     # permission bit to create them, and Python 2 doesn't support it anyway, so

tests/unit/test_vcs.py

@@ -52,6 +52,11 @@ def test_ensure_svn_available() -> None:
             ("git+https://example.com/pkg", "dev", "zope-interface"),
             "git+https://example.com/pkg@dev#egg=zope_interface",
         ),
+        # Test a revision with special characters.
+        (
+            ("git+https://example.com/pkg", "dev@1#2", "myproj"),
+            "git+https://example.com/pkg@dev%401%232#egg=myproj",
+        ),
     ],
 )
 def test_make_vcs_requirement_url(args: tuple[Any, ...], expected: str) -> None:
@@ -394,6 +399,11 @@ def test_git__get_url_rev__idempotent() -> None:
             "svn+https://svn.example.com/My+Project",
             ("https://svn.example.com/My+Project", None, (None, None)),
         ),
+        # Test percent-encoded characters in revision.
+        (
+            "svn+https://svn.example.com/MyProject@dev%401%232",
+            ("https://svn.example.com/MyProject", "dev@1#2", (None, None)),
+        ),
     ],
 )
 def test_version_control__get_url_rev_and_auth(