FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

[3.11] gh-91317: Document that Path does not collapse initial `//` (GH-32193) by miss-islington · Pull Request #93702 · python/cpython · GitHub

/ cpython Public

[3.11] gh-91317: Document that Path does not collapse initial // (GH-32193) #93702

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.

Sign up for GitHub

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

Merged
miss-islington merged 1 commit into from
Jun 10, 2022
Conversation 3 Commits 1 Checks 0 Files changed
Merged

[3.11] gh-91317: Document that Path does not collapse initial // (GH-32193) #93702

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension .rst  (2) All 1 file type selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
33 changes: 30 additions & 3 deletions Doc/library/pathlib.rst
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -133,11 +133,13 @@ we also call *flavours*:
PureWindowsPath('c:/Program Files')

Spurious slashes and single dots are collapsed, but double dots (``'..'``)
are not, since this would change the meaning of a path in the face of
symbolic links::
and leading double slashes (``'//'``) are not, since this would change the
meaning of a path for various reasons (e.g. symbolic links, UNC paths)::

>>> PurePath('foo//bar')
PurePosixPath('foo/bar')
>>> PurePath('//foo/bar')
PurePosixPath('//foo/bar')
>>> PurePath('foo/./bar')
PurePosixPath('foo/bar')
>>> PurePath('foo/../bar')
Expand Down Expand Up @@ -166,13 +168,17 @@ we also call *flavours*:
.. class:: PureWindowsPath(*pathsegments)

A subclass of :class:`PurePath`, this path flavour represents Windows
filesystem paths::
filesystem paths, including `UNC paths`_::

>>> PureWindowsPath('c:/Program Files/')
PureWindowsPath('c:/Program Files')
>>> PureWindowsPath('//server/share/file')
PureWindowsPath('//server/share/file')

*pathsegments* is specified similarly to :class:`PurePath`.

.. _unc paths: https://en.wikipedia.org/wiki/Path_(computing)#UNC

Regardless of the system you're running on, you can instantiate all of
these classes, since they don't provide any operation that does system calls.

Expand Down Expand Up @@ -309,6 +315,27 @@ Pure paths provide the following methods and properties:
>>> PureWindowsPath('//host/share').root
'\\'

If the path starts with more than two successive slashes,
:class:`~pathlib.PurePosixPath` collapses them::

>>> PurePosixPath('//etc').root
'//'
>>> PurePosixPath('///etc').root
'/'
>>> PurePosixPath('////etc').root
'/'

.. note::

This behavior conforms to *The Open Group Base Specifications Issue 6*,
paragraph `4.11 *Pathname Resolution* <xbd_path_resolution>`_:

*"A pathname that begins with two successive slashes may be interpreted in
an implementation-defined manner, although more than two leading slashes
shall be treated as a single slash."*

.. xbd_path_resolution: https://pubs.opengroup.org/onlinepubs/009695399/basedefs/xbd_chap04.html#tag_04_11

.. data:: PurePath.anchor

The concatenation of the drive and root::
Expand Down
2 changes: 2 additions & 0 deletions Misc/NEWS.d/next/Documentation/2022-03-30-17-56-01.bpo-47161.gesHfS.rst
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Document that :class:`pathlib.PurePath` does not collapse
initial double slashes because they denote UNC paths.
Back | FazBrowse Home | New Git URL