Fix documentation for file: URLs, and add an assist for malformed URLs
#13272
Conversation
| "work with proxies or for access via the filesystem through a file:// URL.\n\nUse " | ||
| "`{version}` to have the value from --version substituted, and `{platform}` to " | ||
| "work with proxies or for access via the filesystem through a `file:$path` URL (e.g. " | ||
| "`file:/this/is/absolute` or `file:this/is/relative`).\n\n" |
There was a problem hiding this comment.
Is it not common for url like paths such as these to have a file:// prefix in front of the path?
There was a problem hiding this comment.
It is. But the impact of that syntax in this case is that the first token is parsed as a hostname (which apparently is supported as part of the standard: see the loc%61lhost example in https://url.spec.whatwg.org/#urls). I think that what these are instead is path-absolute-URL strings.
There was a problem hiding this comment.
OK, haven't seen that page before. And it was anything but clear. However, from my understanding the general syntax is (simplified) scheme://<server>/<path>, and <server> may be the empty string, so for file schemes, this translates to: file:///this/is/absolute rather than file:/this/is/absolute.
I didn't find any reference to a scheme followed by :/ (single slash only) in there..
There was a problem hiding this comment.
See https://url.spec.whatwg.org/#relative-url-string:
"file"
..
a path-absolute-URL string if base URL’s host is an empty host
# Building wheels and fs_util will be skipped. Delete if not intended. [ci skip-build-wheels]
stuhood
force-pushed
the
stuhood/document-file-urls-and-add-assist
branch
from
5972809
to
d0c116e
Compare
|
I was wrong about relative paths being supported: they aren't without supplying a base URL, which doesn't seem worth it in this case. Have cleaned up the assist and the docs to account for that. |
| url.path(), | ||
| url.path(), |
There was a problem hiding this comment.
I'm so excited for Rust to have f-strings...
There was a problem hiding this comment.
That's what format! is. This code should have just used named substitutions:
format!("The file Url `{url}` has a host component. Instead, use `file:$path`, \
which in this case might be either `file:{host}{path}` or `file:{path}`.",
url = url,
host = host,
path = url.path(),
)
There was a problem hiding this comment.
Fix documentation for
file:URLs, and add an assist if the URL contains a hostname.Fixes #13054.
[ci skip-build-wheels]