@@ -2175,7 +2175,7 @@ features:
2175
2175
Accepts a :term: `path-like object `.
2176
2176
2177
2177
2178
- .. function :: lstat(path, *, dir_fd=None, full=True )
2178
+ .. function :: lstat(path, *, dir_fd=None, fast=False )
2179
2179
2180
2180
Perform the equivalent of an :c:func: `lstat ` system call on the given path.
2181
2181
Similar to :func: `~os.stat `, but does not follow symbolic links. Return a
@@ -2184,15 +2184,15 @@ features:
2184
2184
On platforms that do not support symbolic links, this is an alias for
2185
2185
:func: `~os.stat `.
2186
2186
2187
- Passing *full * as ``False `` may omit some information on some platforms
2187
+ Passing *fast * as ``True `` may omit some information on some platforms
2188
2188
for the sake of performance. These omissions are not guaranteed (that is,
2189
2189
the information may be returned anyway), and may change between Python
2190
2190
releases without a deprecation period or due to operating system updates
2191
2191
without warning. See :class: `stat_result ` documentation for the fields
2192
2192
that are guaranteed to be present under this option.
2193
2193
2194
2194
As of Python 3.3, this is equivalent to ``os.stat(path, dir_fd=dir_fd,
2195
- follow_symlinks=False, full=full ) ``.
2195
+ follow_symlinks=False, fast=fast ) ``.
2196
2196
2197
2197
This function can also support :ref: `paths relative to directory descriptors
2198
2198
<dir_fd>`.
@@ -2217,7 +2217,7 @@ features:
2217
2217
for :func: `~os.stat `.
2218
2218
2219
2219
.. versionchanged :: 3.12
2220
- Added the *full * parameter.
2220
+ Added the *fast * parameter.
2221
2221
2222
2222
2223
2223
.. function :: mkdir(path, mode=0o777, *, dir_fd=None)
@@ -2791,7 +2791,7 @@ features:
2791
2791
for :class: `bytes ` paths on Windows.
2792
2792
2793
2793
2794
- .. function :: stat(path, *, dir_fd=None, follow_symlinks=True, full=True )
2794
+ .. function :: stat(path, *, dir_fd=None, follow_symlinks=True, fast=False )
2795
2795
2796
2796
Get the status of a file or a file descriptor. Perform the equivalent of a
2797
2797
:c:func: `stat ` system call on the given path. *path * may be specified as
@@ -2816,7 +2816,7 @@ features:
2816
2816
possible and call :func: `lstat ` on the result. This does not apply to
2817
2817
dangling symlinks or junction points, which will raise the usual exceptions.
2818
2818
2819
- Passing *full * as ``False `` may omit some information on some platforms
2819
+ Passing *fast * as ``True `` may omit some information on some platforms
2820
2820
for the sake of performance. These omissions are not guaranteed (that is,
2821
2821
the information may be returned anyway), and may change between Python
2822
2822
releases without a deprecation period or due to operating system updates
@@ -2856,7 +2856,7 @@ features:
2856
2856
``follow_symlinks=False `` had been specified instead of raising an error.
2857
2857
2858
2858
.. versionchanged :: 3.12
2859
- Added the *full * parameter.
2859
+ Added the *fast * parameter.
2860
2860
2861
2861
2862
2862
.. class :: stat_result
@@ -2865,19 +2865,20 @@ features:
2865
2865
:c:type: `stat ` structure. It is used for the result of :func: `os.stat `,
2866
2866
:func: `os.fstat ` and :func: `os.lstat `.
2867
2867
2868
- When the *full * argument to these functions is passed ``False ``, some
2868
+ When the *fast * argument to these functions is passed ``True ``, some
2869
2869
information may be reduced or omitted. Those attributes that are
2870
2870
guaranteed to be valid, and those currently known to be omitted, are
2871
2871
marked in the documentation below. If not specified and you depend on
2872
- that field, pass *full * as ``True `` to ensure it is calculated.
2872
+ that field, explicitly pass *fast * as ``False `` to ensure it is
2873
+ calculated.
2873
2874
2874
2875
Attributes:
2875
2876
2876
2877
.. attribute :: st_mode
2877
2878
2878
2879
File mode: file type and file mode bits (permissions).
2879
2880
2880
- When *full * is ``False ``, only the file type bits are guaranteed
2881
+ When *fast * is ``True ``, only the file type bits are guaranteed
2881
2882
to be valid (the mode bits may be zero).
2882
2883
2883
2884
.. attribute :: st_ino
@@ -2894,7 +2895,7 @@ features:
2894
2895
2895
2896
Identifier of the device on which this file resides.
2896
2897
2897
- On Windows, when *full * is ``False ``, this may be zero.
2898
+ On Windows, when *fast * is ``True ``, this may be zero.
2898
2899
2899
2900
.. attribute :: st_nlink
2900
2901
@@ -2914,7 +2915,7 @@ features:
2914
2915
The size of a symbolic link is the length of the pathname it contains,
2915
2916
without a terminating null byte.
2916
2917
2917
- This field is guaranteed to be filled without specifying *full *.
2918
+ This field is guaranteed to be filled when specifying *fast *.
2918
2919
2919
2920
Timestamps:
2920
2921
@@ -2926,7 +2927,7 @@ features:
2926
2927
2927
2928
Time of most recent content modification expressed in seconds.
2928
2929
2929
- This field is guaranteed to be filled without specifying *full *.
2930
+ This field is guaranteed to be filled when specifying *fast *.
2930
2931
2931
2932
.. attribute :: st_ctime
2932
2933
@@ -2944,7 +2945,7 @@ features:
2944
2945
Time of most recent content modification expressed in nanoseconds as an
2945
2946
integer.
2946
2947
2947
- This field is guaranteed to be filled without specifying *full *, subject
2948
+ This field is guaranteed to be filled when specifying *fast *, subject
2948
2949
to the note below.
2949
2950
2950
2951
.. attribute :: st_ctime_ns
@@ -3036,15 +3037,15 @@ features:
3036
3037
:c:func: `GetFileInformationByHandle `. See the ``FILE_ATTRIBUTE_* ``
3037
3038
constants in the :mod: `stat ` module.
3038
3039
3039
- This field is guaranteed to be filled without specifying *full *.
3040
+ This field is guaranteed to be filled when specifying *fast *.
3040
3041
3041
3042
.. attribute :: st_reparse_tag
3042
3043
3043
3044
When :attr: `st_file_attributes ` has the ``FILE_ATTRIBUTE_REPARSE_POINT ``
3044
3045
set, this field contains the tag identifying the type of reparse point.
3045
3046
See the ``IO_REPARSE_TAG_* `` constants in the :mod: `stat ` module.
3046
3047
3047
- This field is guaranteed to be filled without specifynig * full *.
3048
+ This field is guaranteed to be filled when specifying * fast *.
3048
3049
3049
3050
The standard module :mod: `stat ` defines functions and constants that are
3050
3051
useful for extracting information from a :c:type: `stat ` structure. (On
@@ -3082,7 +3083,8 @@ features:
3082
3083
as appropriate.
3083
3084
3084
3085
.. versionchanged :: 3.12
3085
- Added the *full * argument and defined the minimum
3086
+ Added the *fast * argument and defined the minimum set of returned
3087
+ fields.
3086
3088
3087
3089
.. function :: statvfs(path)
3088
3090
0 commit comments