From 194e3ee97b79217ced3f5033c0bbe6ab9d939d7c Mon Sep 17 00:00:00 2001 From: Christoph Anton Mitterer Date: Wed, 13 Dec 2023 20:55:31 +0100 Subject: [PATCH] gh-107959: clarify Unix-availability of `os.lchmod()` (GH-107960) POSIX specifies that implementations are not required to support changing the file mode of symbolic links, but may do so. Consequently, `lchmod()` is not part of POSIX (but mentioned for implementations which do support the above). The current wording of the availability of `os.lchmod()` is rather vague and improved to clearly tell which POSIX/Unix/BSD-like support the function in general (those that support changing the file mode of symbolic links). Further, some examples of major implementations are added. Data for the BSDs taken from their online manpages. (cherry picked from commit f14e3d59c955fb3cf89e5241727ec566164dcf42) Co-authored-by: Christoph Anton Mitterer Signed-off-by: Christoph Anton Mitterer Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> --- Doc/library/os.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/Doc/library/os.rst b/Doc/library/os.rst index bf97dfd1f2f6b9..4507fbc8164dc8 100644 --- a/Doc/library/os.rst +++ b/Doc/library/os.rst @@ -2160,9 +2160,12 @@ features: for possible values of *mode*. As of Python 3.3, this is equivalent to ``os.chmod(path, mode, follow_symlinks=False)``. + ``lchmod()`` is not part of POSIX, but Unix implementations may have it if + changing the mode of symbolic links is supported. + .. audit-event:: os.chmod path,mode,dir_fd os.lchmod - .. availability:: Unix. + .. availability:: Unix, not Linux, FreeBSD >= 1.3, NetBSD >= 1.3, not OpenBSD .. versionchanged:: 3.6 Accepts a :term:`path-like object`.