pip._internal.utils.urls Namespace Reference

Functions
Optional[str]	get_url_scheme (str url)
str	path_to_url (str path)
str	url_to_path (str url)

Function Documentation

get_url_scheme()

Optional[str] get_url_scheme

(

str

url

)

Definition at line 10 of file urls.py.

def get_url_scheme(url: str) -> Optional[str]:
    if ":" not in url:
        return None
    return url.split(":", 1)[0].lower()
 
 

References i.

path_to_url()

str path_to_url

(

str

path

)

Convert a path to a file: URL.  The path will be made absolute and have
quoted path parts.

Definition at line 16 of file urls.py.

def path_to_url(path: str) -> str:
    """
    Convert a path to a file: URL.  The path will be made absolute and have
    quoted path parts.
    """
    path = os.path.normpath(os.path.abspath(path))
    url = urllib.parse.urljoin("file:", urllib.request.pathname2url(path))
    return url
 
 

References i.

url_to_path()

str url_to_path

(

str

url

)

Convert a file: URL to a path.

Definition at line 26 of file urls.py.

def url_to_path(url: str) -> str:
    """
    Convert a file: URL to a path.
    """
    assert url.startswith(
        "file:"
    ), f"You can only turn file: urls into filenames (not {url!r})"
 
    _, netloc, path, _, _ = urllib.parse.urlsplit(url)
 
    if not netloc or netloc == "localhost":
        # According to RFC 8089, same as empty authority.
        netloc = ""
    elif WINDOWS:
        # If we have a UNC path, prepend UNC share notation.
        netloc = "\\\\" + netloc
    else:
        raise ValueError(
            f"non-local file URIs are not supported on this platform: {url!r}"
        )
 
    path = urllib.request.url2pathname(netloc + path)
 
    # On Windows, urlsplit parses the path as something like "/C:/Users/foo".
    # This creates issues for path-related functions like io.open(), so we try
    # to detect and strip the leading slash.
    if (
        WINDOWS
        and not netloc  # Not UNC.
        and len(path) >= 3
        and path[0] == "/"  # Leading slash to strip.
        and path[1] in string.ascii_letters  # Drive letter.
        and path[2:4] in (":", ":/")  # Colon + end of string, or colon + absolute path.
    ):
        path = path[1:]
 
    return path

References i.