diff options
Diffstat (limited to 'Doc')
| -rw-r--r-- | Doc/library/urllib.request.rst | 26 |
1 files changed, 19 insertions, 7 deletions
diff --git a/Doc/library/urllib.request.rst b/Doc/library/urllib.request.rst index a093a50..9055556 100644 --- a/Doc/library/urllib.request.rst +++ b/Doc/library/urllib.request.rst @@ -148,9 +148,15 @@ The :mod:`urllib.request` module defines the following functions: .. function:: pathname2url(path) - Convert the pathname *path* from the local syntax for a path to the form used in - the path component of a URL. This does not produce a complete URL. The return - value will already be quoted using the :func:`~urllib.parse.quote` function. + Convert the given local path to a ``file:`` URL. This function uses + :func:`~urllib.parse.quote` function to encode the path. For historical + reasons, the return value omits the ``file:`` scheme prefix. This example + shows the function being used on Windows:: + + >>> from urllib.request import pathname2url + >>> path = 'C:\\Program Files' + >>> 'file:' + pathname2url(path) + 'file:///C:/Program%20Files' .. versionchanged:: 3.14 Windows drive letters are no longer converted to uppercase. @@ -161,11 +167,17 @@ The :mod:`urllib.request` module defines the following functions: found in any position other than the second character. -.. function:: url2pathname(path) +.. function:: url2pathname(url) + + Convert the given ``file:`` URL to a local path. This function uses + :func:`~urllib.parse.unquote` to decode the URL. For historical reasons, + the given value *must* omit the ``file:`` scheme prefix. This example shows + the function being used on Windows:: - Convert the path component *path* from a percent-encoded URL to the local syntax for a - path. This does not accept a complete URL. This function uses - :func:`~urllib.parse.unquote` to decode *path*. + >>> from urllib.request import url2pathname + >>> url = 'file:///C:/Program%20Files' + >>> url2pathname(url.removeprefix('file:')) + 'C:\\Program Files' .. versionchanged:: 3.14 Windows drive letters are no longer converted to uppercase. |