Skip to content

Adjust path_to_url et al. to produce the same results on Python 3.14+ #13423

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions news/13423.bugfix.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fix remaining test failures in Python 3.14 by adjusting ``path_to_url`` and similar functions.
7 changes: 6 additions & 1 deletion src/pip/_internal/models/link.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
import os
import posixpath
import re
import sys
import urllib.parse
from collections.abc import Mapping
from dataclasses import dataclass
Expand Down Expand Up @@ -131,7 +132,11 @@ def _clean_file_url_path(part: str) -> str:
# should not be quoted. On Linux where drive letters do not
# exist, the colon should be quoted. We rely on urllib.request
# to do the right thing here.
return urllib.request.pathname2url(urllib.request.url2pathname(part))
ret = urllib.request.pathname2url(urllib.request.url2pathname(part))
if sys.version_info >= (3, 14):
# https://discuss.python.org/t/pathname2url-changes-in-python-3-14-breaking-pip-tests/97091
ret = ret.removeprefix("//")
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not proud of this :(

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It wasn't obvious to me how else to do this either 🙁

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there something in cpython we can reference here so people reading this later knows what’s going on?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can try digging a reference to the change.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ideally, if we could find something that explained why cpython changed what they did, and why the new result is "correct" and why pip needs something different from the "correct" answer, that would be best (as it would give us a much better basis for informed decisions if this code ever needs to change again).

Unfortunately, I get the impression that there's no real "correct" answer here, and the cpython change was "because it's more consistent with (something or other that pip maybe doesn't even care about)". If so, then documenting what precisely pip is using to base its idea of what "the url for a pathname" is, would be better than nothing.

Worst case scenario would be that there's simply no standard for how to convert a pathname to a URL in general, and it's all just a mess of guesswork and hacks 🙁

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

According to this comment it is this is a result of CPython's attempt to follow RFC 3986, Section 5.2.2: python/cpython#125974 (comment)

I beleive python/cpython#125989 and python/cpython#123273 are the related PRs.

Previous discussions on the "standards" around path to url: #13062 (comment)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't get to this today. If you want, feel free to adjust this PR with some comments.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My main point here is that as a pip maintainer, the removeprefix('//') line looks like complete magic - there's no clear reason why it's needed, why it's 3.14+ only, or why urllib.request isn't doing the right thing for us in the first place. And I'm not particularly comfortable with a comment that essentially just says that we're compensating for a change in CPython, because that begs the question why are we having to effectively revert the CPython change, rather than raising this as a bug on the stdlib function. I'd like to see something that explains why it isn't a CPython bug, and why in that case we need to alter the behaviour.

Having said all of this, I don't think it's fair to expect @hroncok to do all that research and analysis, so if we have to go with a comment that says "CPython changed behaviour in a way that broke our code, so we're patching the result back to what we expect" then I'll live with it.

@barneygale as the author of #13062 (comment) can you shed any light on this?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if having a custom wrapper around just urllib.request.pathname2url wouldn't be clearer. Call it e.g. path2url_fragment and describe what it should return and that it cannot start with //.

return ret


# percent-encoded: /
Expand Down
2 changes: 1 addition & 1 deletion src/pip/_internal/utils/urls.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ def path_to_url(path: str) -> str:
quoted path parts.
"""
path = os.path.normpath(os.path.abspath(path))
url = urllib.parse.urljoin("file:", urllib.request.pathname2url(path))
url = urllib.parse.urljoin("file://", urllib.request.pathname2url(path))
return url


Expand Down
2 changes: 1 addition & 1 deletion tests/unit/test_urls.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
def test_path_to_url_unix() -> None:
assert path_to_url("/tmp/file") == "file:///tmp/file"
path = os.path.join(os.getcwd(), "file")
assert path_to_url("file") == "file://" + urllib.request.pathname2url(path)
assert path_to_url("file") == "file://" + path


@pytest.mark.skipif("sys.platform != 'win32'")
Expand Down