mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-26 18:29:57 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 10

[3.12] GH-119054: Add "Permissions and ownership" section to pathlib docs. (GH-120505) (#120968)

Browse source 
Add dedicated subsection for `pathlib.owner()`, `group()`, `chmod()` and
`lchmod()`.

(cherry picked from commit e4a97a7fb1)
This commit is contained in:
Barney Gale 2024-06-24 20:32:24 +01:00 • committed by GitHub
parent 7a874b4ca6
commit 52bc99743c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 42 additions and 39 deletions
Download patch file Download diff file Expand all files Collapse all files

81
Doc/library/pathlib.rst
View file

@ -1380,6 +1380,48 @@ Renaming and deleting
Remove this directory. The directory must be empty. Remove this directory. The directory must be empty.
Ownership and permissions
^^^^^^^^^^^^^^^^^^^^^^^^^
.. method:: Path.owner()
Return the name of the user owning the file. :exc:`KeyError` is raised
if the file's user identifier (UID) isn't found in the system database.
.. method:: Path.group()
Return the name of the group owning the file. :exc:`KeyError` is raised
if the file's group identifier (GID) isn't found in the system database.
.. method:: Path.chmod(mode, *, follow_symlinks=True)
Change the file mode and permissions, like :func:`os.chmod`.
This method normally follows symlinks. Some Unix flavours support changing
permissions on the symlink itself; on these platforms you may add the
argument ``follow_symlinks=False``, or use :meth:`~Path.lchmod`.
::
>>> p = Path('setup.py')
>>> p.stat().st_mode
33277
>>> p.chmod(0o444)
>>> p.stat().st_mode
33060
.. versionchanged:: 3.10
The *follow_symlinks* parameter was added.
.. method:: Path.lchmod(mode)
Like :meth:`Path.chmod` but, if the path points to a symbolic link, the
symbolic link's mode is changed rather than its target's.
Other methods Other methods
^^^^^^^^^^^^^ ^^^^^^^^^^^^^
@ -1406,27 +1448,6 @@ Other methods
.. versionadded:: 3.5 .. versionadded:: 3.5
.. method:: Path.chmod(mode, *, follow_symlinks=True)
Change the file mode and permissions, like :func:`os.chmod`.
This method normally follows symlinks. Some Unix flavours support changing
permissions on the symlink itself; on these platforms you may add the
argument ``follow_symlinks=False``, or use :meth:`~Path.lchmod`.
::
>>> p = Path('setup.py')
>>> p.stat().st_mode
33277
>>> p.chmod(0o444)
>>> p.stat().st_mode
33060
.. versionchanged:: 3.10
The *follow_symlinks* parameter was added.
.. method:: Path.expanduser() .. method:: Path.expanduser()
Return a new path with expanded ``~`` and ``~user`` constructs, Return a new path with expanded ``~`` and ``~user`` constructs,
@ -1442,24 +1463,6 @@ Other methods
.. versionadded:: 3.5 .. versionadded:: 3.5
.. method:: Path.group()
Return the name of the group owning the file. :exc:`KeyError` is raised
if the file's gid isn't found in the system database.
.. method:: Path.lchmod(mode)
Like :meth:`Path.chmod` but, if the path points to a symbolic link, the
symbolic link's mode is changed rather than its target's.
.. method:: Path.owner()
Return the name of the user owning the file. :exc:`KeyError` is raised
if the file's uid isn't found in the system database.
.. method:: Path.readlink() .. method:: Path.readlink()
Return the path to which the symbolic link points (as returned by Return the path to which the symbolic link points (as returned by