def from_pipfile(cls, name, pipfile):
# Parse the values out. After this dance we should have two variables:
# path - Local filesystem path.
# uri - Absolute URI that is parsable with urlsplit.
# One of these will be a string; the other would be None.
uri = pipfile.get("uri")
fil = pipfile.get("file")
path = pipfile.get("path")
if path:
if isinstance(path, Path) and not path.is_absolute():
path = get_converted_relative_path(path.as_posix())
elif not os.path.isabs(path):
path = get_converted_relative_path(path)
if path and uri:
raise ValueError("do not specify both 'path' and 'uri'")
if path and fil:
raise ValueError("do not specify both 'path' and 'file'")
uri = uri or fil
# Decide that scheme to use.
# 'path' - local filesystem path.
# 'file' - A file:// URI (possibly with VCS prefix).
# 'uri' - Any other URI.
if path:
uri_scheme = "path"
else:
# URI is not currently a valid key in pipfile entries
# see https://github.com/pypa/pipfile/issues/110
uri_scheme = "file"
if not uri:
uri = path_to_url(path)
link = create_link(uri)
arg_dict = {
"name": name,
"path": path,
"uri": unquote(link.url_without_fragment),
"editable": pipfile.get("editable", False),
"link": link,
"uri_scheme": uri_scheme,
}
return cls(**arg_dict)
def get_link_from_line(cls, line):
"""Parse link information from given requirement line.
Return a 6-tuple:
- `vcs_type` indicates the VCS to use (e.g. "git"), or None.
- `prefer` is either "file", "path" or "uri", indicating how the
information should be used in later stages.
- `relpath` is the relative path to use when recording the dependency,
instead of the absolute path/URI used to perform installation.
This can be None (to prefer the absolute path or URI).
- `path` is the absolute file path to the package. This will always use
forward slashes. Can be None if the line is a remote URI.
- `uri` is the absolute URI to the package. Can be None if the line is
not a URI.
- `link` is an instance of :class:`pip._internal.index.Link`,
representing a URI parse result based on the value of `uri`.
This function is provided to deal with edge cases concerning URIs
without a valid netloc. Those URIs are problematic to a straight
``urlsplit` call because they cannot be reliably reconstructed with
``urlunsplit`` due to a bug in the standard library:
>>> from urllib.parse import urlsplit, urlunsplit
>>> urlunsplit(urlsplit('git+file:///this/breaks'))
'git+file:/this/breaks'
>>> urlunsplit(urlsplit('file:///this/works'))
'file:///this/works'
See `https://bugs.python.org/issue23505#msg277350`.
"""
# Git allows `[email protected]...` lines that are not really URIs.
# Add "ssh://" so we can parse correctly, and restore afterwards.
fixed_line = add_ssh_scheme_to_git_uri(line)
added_ssh_scheme = fixed_line != line
# We can assume a lot of things if this is a local filesystem path.
if "://" not in fixed_line:
p = Path(fixed_line).absolute()
path = p.as_posix()
uri = p.as_uri()
link = create_link(uri)
try:
relpath = get_converted_relative_path(path)
except ValueError:
relpath = None
return LinkInfo(None, "path", relpath, path, uri, link)
# This is an URI. We'll need to perform some elaborated parsing.
parsed_url = urllib_parse.urlsplit(fixed_line)
original_url = parsed_url._replace()
if added_ssh_scheme and ':' in parsed_url.netloc:
original_netloc, original_path_start = parsed_url.netloc.rsplit(
':', 1)
uri_path = '/{0}{1}'.format(original_path_start, parsed_url.path)
parsed_url = original_url._replace(netloc=original_netloc,
path=uri_path)
# Split the VCS part out if needed.
original_scheme = parsed_url.scheme
if "+" in original_scheme:
vcs_type, scheme = original_scheme.split("+", 1)
parsed_url = parsed_url._replace(scheme=scheme)
prefer = "uri"
else:
vcs_type = None
prefer = "file"
if parsed_url.scheme == "file" and parsed_url.path:
# This is a "file://" URI. Use url_to_path and path_to_url to
# ensure the path is absolute. Also we need to build relpath.
path = Path(url_to_path(
urllib_parse.urlunsplit(parsed_url))).as_posix()
try:
relpath = get_converted_relative_path(path)
except ValueError:
relpath = None
uri = path_to_url(path)
else:
# This is a remote URI. Simply use it.
path = None
relpath = None
# Cut the fragment, but otherwise this is fixed_line.
uri = urllib_parse.urlunsplit(
parsed_url._replace(scheme=original_scheme, fragment=""))
if added_ssh_scheme:
original_uri = urllib_parse.urlunsplit(
original_url._replace(scheme=original_scheme, fragment=""))
uri = strip_ssh_from_git_uri(original_uri)
# Re-attach VCS prefix to build a Link.
link = create_link(
urllib_parse.urlunsplit(
parsed_url._replace(scheme=original_scheme)))
return LinkInfo(vcs_type, prefer, relpath, path, uri, link)
