Skip to content

gh-91317: Document that Path does not collapse initial // #32193

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 10 commits into from
Jun 10, 2022
Merged

gh-91317: Document that Path does not collapse initial // #32193

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
fb49937
Document that Path does not collapse initial `//`
arhadthedev Mar 30, 2022
0cf996b
Add a NEWS entry
arhadthedev Mar 30, 2022
ad0de01
Update Misc/NEWS.d/next/Documentation/2022-03-30-17-56-01.bpo-47161.g…
arhadthedev Mar 31, 2022
1ed30e6
Merge branch 'main' into bpo-47161
arhadthedev Jun 8, 2022
ab2f285
Address the review of Bratt Cannon
arhadthedev Jun 8, 2022
31dc415
Address the review of Barney Gale
arhadthedev Jun 8, 2022
207b2d6
Do not use spaces inside links
arhadthedev Jun 8, 2022
519078a
Address "Unknown target name: unc"
arhadthedev Jun 8, 2022
a307bd3
Fix the link
arhadthedev Jun 8, 2022
6d76a31
Remove my provenance from NEWS because it's a community effort now.
arhadthedev Jun 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Address the review of Barney Gale 
Co-authored-by: Barney Gale <barney.gale@gmail.com>
  • Loading branch information
@arhadthedev @barneygale
arhadthedev and barneygale committed Jun 8, 2022
commit 31dc415136c4c4d9d3a2c46b64d0a1c48cece60a
27 changes: 26 additions & 1 deletion Doc/library/pathlib.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,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 @@ -311,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