Skip to content

bpo-29688: Document Path.absolute #384

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

Closed
wants to merge 6 commits into from
Closed

bpo-29688: Document Path.absolute #384

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8849cb4
Document Path.absolute
DimitrisJim Mar 1, 2017
3de66eb
Fix space
DimitrisJim Mar 1, 2017
9c2b3cd
Address comments, use ticks with '.' and '..'
DimitrisJim Mar 1, 2017
cf666fe
Address review: Reword first two sentences
DimitrisJim Mar 1, 2017
00c9b77
Missed last review comment
DimitrisJim Mar 1, 2017
e4cbc5c
Fix space, again.
DimitrisJim Mar 1, 2017
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
12 changes: 12 additions & 0 deletions Doc/library/pathlib.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -652,6 +652,18 @@ call fails (for example because the path doesn't exist):
.. versionadded:: 3.5


.. method:: Path.absolute()

Return an absolute version of this path based on the current working
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hum, maybe specify that only relative paths are resolved using the current working directory?

Return an absolute version of this path. Relative paths are resolved using the current working directory.

directory. This function works even if the path doesn't exist.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This function => This method

I dislike "works even if", maybe: "This method doesn't check if the path exists." ?


No normalization is done, i.e all ``'.'`` and ``'..'`` will not be
normalized. Use :meth:`Path.resolve` to get the canonical path to a file.

>>> p = Path('pathlib')
>>> p.absolute()
PosixPath('/home/antoine/pathlib')

.. method:: Path.stat()

Return information about this path (similarly to :func:`os.stat`).
Expand Down