Skip to content

gh-137970: add st_mode_notice code_example #138532

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

gh-137970: add st_mode_notice code_example #138532

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ee75661
gh-137970:add st_mode_notice code_example
ian293382 Sep 5, 2025
fbaf288
Use a Sphinx
ian293382 Sep 5, 2025
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
17 changes: 17 additions & 0 deletions Doc/library/os.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3141,6 +3141,23 @@ features:

File mode: file type and file mode bits (permissions).

.. note::

``st_mode`` is an :class:`int` bitmask that combines the file type and the
permission bits. If you expect POSIX-style values like ``755`` or ``644``,
render the value in octal and/or mask out only the permission bits. For example:

.. code-block:: pycon

>>> import os, stat
>>> m = os.stat("somefile").st_mode
>>> oct(m) # includes the file-type bits (e.g. 0o100...)
'0o100755'
>>> oct(stat.S_IMODE(m)) # permissions only
'0o755'
>>> stat.filemode(m) # human-readable form
'-rwxr-xr-x'

.. attribute:: st_ino

Platform dependent, but if non-zero, uniquely identifies the
Expand Down
Loading