Skip to content

gh-83714: Use statx on Linux 4.11 and later in os.stat #136334

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
jbosboom wants to merge 19 commits into from
Closed

gh-83714: Use statx on Linux 4.11 and later in os.stat #136334

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
99c9efd
bpo-39533: Use statx on Linux 4.11 and later in os.stat
jbosboom Jul 6, 2025
cebd5b7
Fix versionadded documentation syntax
jbosboom Jul 8, 2025
ffd7a89
Add blurb
jbosboom Jul 8, 2025
d53650a
Fix typo stx_subvol -> st_subvol in docs
jbosboom Jul 8, 2025
4e4e917
Allow statx to be explicitly configured out for old glibc
jbosboom Sep 4, 2025
bc3155b
Implement os.statx
jbosboom Sep 4, 2025
b0e8276
Use correct function name in os.statx argument validation errors
jbosboom Sep 4, 2025
1a8a6d6
Merge branch 'main' into statx
jbosboom Sep 10, 2025
f71315e
Move statx-specific members from os.stat_result to new os.statx_result
jbosboom Sep 10, 2025
1f1e959
make regen-configure
jbosboom Sep 10, 2025
7440397
Reimplement os.statx_result using PyMemberDef and PyGetSetDef; remove…
jbosboom Sep 13, 2025
534e33f
Remove statx-specific members from os.stat_result documentation
jbosboom Sep 13, 2025
7dc75d0
Simplify statx configure check
jbosboom Sep 13, 2025
894efb5
Document os.statx
jbosboom Sep 14, 2025
d5bc601
Prepare for review
jbosboom Sep 15, 2025
5b36cf0
Document st_birthtime fallback behavior
jbosboom Sep 15, 2025
6be85a3
Implement os.stat with statx only if the statx syscall works
jbosboom Sep 17, 2025
c32ee72
Test statx PathLike and dir_fd handling
jbosboom Sep 17, 2025
c84f783
statx docs fixes
jbosboom Sep 17, 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
Prev Previous commit
Next Next commit
Document st_birthtime fallback behavior
  • Loading branch information
@jbosboom
jbosboom committed Sep 15, 2025
commit 5b36cf0e6d93126cb25c7689c9a2513d2a463a81
6 changes: 4 additions & 2 deletions Doc/library/os.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3225,7 +3225,8 @@
.. versionchanged:: 3.12
``st_birthtime`` is now available on Windows.
.. versionchanged:: next
``st_birthtime`` is now available on Linux.
``st_birthtime`` is now present on Linux. The value will be ``0.0``
on kernel versions < 4.11 or if not supported by the filesystem.

.. attribute:: st_birthtime_ns

Expand All @@ -3235,7 +3236,8 @@

.. versionadded:: 3.12
.. versionchanged:: next
``st_birthtime_ns`` is now available on Linux.
``st_birthtime_ns`` is now present on Linux. The value will be ``0``
on kernel versions < 4.11 or if not supported by the filesystem.

.. note::

Expand Down Expand Up @@ -3375,7 +3377,7 @@

.. function:: statx(path, mask, *, dir_fd=None, follow_symlinks=True, sync=None)

Get the status of a file or file descriptor by performing a :c:func:`statx`

Check warning on line 3380 in Doc/library/os.rst

View workflow job for this annotation

GitHub Actions / Docs / Docs 

c:func reference target not found: statx [ref.func]

@cmaloney cmaloney Sep 16, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Should be able to make the missing c func / struct pieces stop erroring by adding to:

cpython/Doc/conf.py

Line 121 in 4e00e25

nitpick_ignore = [
(in general try with new things to not add new warnings; are people working on resolving existing sphinx warnings)

@StanFromIreland StanFromIreland Sep 16, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
Get the status of a file or file descriptor by performing a :c:func:`statx`
Get the status of a file or file descriptor by performing a :c:func:`!statx`

This will also work.

@jbosboom jbosboom Sep 16, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Running make html and make check as directed by the devguide, I don't see any warnings.

@cmaloney cmaloney Sep 17, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Getting all the warnings out of the docs build is difficult (there are many warnings in non-changed code which don't matter for PRs; but new ones do); the CI does check for new warnings and attaches them to PRs. I can see some here on the Github UI:

image

system call on the given path. *path* may be specified as either a string or
bytes -- directly or indirectly through the :class:`PathLike` interface --
or as an open file descriptor. *mask* is a combination of the module-level
Expand Down Expand Up @@ -3404,7 +3406,7 @@

.. class:: statx_result

Object whose attributes correspond roughly to the members of the

Check warning on line 3409 in Doc/library/os.rst

View workflow job for this annotation

GitHub Actions / Docs / Docs 

c:struct reference target not found: statx [ref.struct]
:c:struct:`statx` structure. It is used for the result of :func:`os.statx`.
:class:`!statx_result` has all of the attributes of :class:`stat_result`
available on Linux, but is not a subclass of :class:`stat_result` nor a
Expand Down
5 changes: 4 additions & 1 deletion Modules/posixmodule.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2816,7 +2816,10 @@ _pystat_fromstructstat(PyObject *module, STRUCT_STAT *st)
#elif defined(HAVE_STATX)
/* We were built with statx support, so stat_result.st_birthtime[_ns]
exists, but we fell back to stat because statx isn't available at
runtime. User programs assume st_birthtime is not None. */
runtime. structseq members are _Py_T_OBJECT (for which NULL means None,
not AttributeError), but user programs assume st_birthtime is not None.
When the statx syscall wrapper is available but the syscall itself is
not, we end up setting the birthtime to 0, so do that here too. */
SET_ITEM(ST_BIRTHTIME_IDX, PyFloat_FromDouble(0.0));
SET_ITEM(ST_BIRTHTIME_NS_IDX, _PyLong_GetZero());
#elif defined(MS_WINDOWS)
Expand Down
Loading