mirrors/cpython
0
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2024-12-29 19:55:17 +08:00
Code Issues Packages Projects Releases Wiki Activity

Issue #29092: Sync os.stat's doc and docstring on path type.

Browse Source
This commit is contained in:
Xiang Zhang 2017-01-22 13:04:17 +08:00
commit 4459e009ed
3 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Doc/library/os.rst
View File

@ -2213,7 +2213,7 @@ features:
Get the status of a file or a file descriptor. Perform the equivalent of a
:c:func:`stat` system call on the given path. *path* may be specified as
either a string -- directly or indirectly through the :class:`PathLike`
either a string or bytes -- directly or indirectly through the :class:`PathLike`
interface -- or as an open file descriptor. Return a :class:`stat_result`
object.

5
Modules/clinic/posixmodule.c.h
View File

@ -9,7 +9,8 @@ PyDoc_STRVAR(os_stat__doc__,
"Perform a stat system call on the given path.\n"
"\n"
" path\n"
" Path to be examined; can be string, bytes, or open-file-descriptor int.\n"
" Path to be examined; can be string, bytes, path-like object or\n"
" open-file-descriptor int.\n"
" dir_fd\n"
" If not None, it should be a file descriptor open to a directory,\n"
" and path should be a relative string; path will then be relative to\n"
@ -6149,4 +6150,4 @@ exit:
#ifndef OS_GETRANDOM_METHODDEF
#define OS_GETRANDOM_METHODDEF
#endif /* !defined(OS_GETRANDOM_METHODDEF) */
/*[clinic end generated code: output=50cfb7ebc44efb67 input=a9049054013a1b77]*/
/*[clinic end generated code: output=455def991740915a input=a9049054013a1b77]*/

5
Modules/posixmodule.c
View File

@ -2386,7 +2386,8 @@ class sched_param_converter(CConverter):
os.stat
path : path_t(allow_fd=True)
Path to be examined; can be string, bytes, or open-file-descriptor int.
Path to be examined; can be string, bytes, path-like object or
open-file-descriptor int.
*
@ -2413,7 +2414,7 @@ It's an error to use dir_fd or follow_symlinks when specifying path as
static PyObject *
os_stat_impl(PyObject *module, path_t *path, int dir_fd, int follow_symlinks)
/*[clinic end generated code: output=7d4976e6f18a59c5 input=099d356c306fa24a]*/
/*[clinic end generated code: output=7d4976e6f18a59c5 input=270bd64e7bb3c8f7]*/
{
return posix_do_stat("stat", path, dir_fd, follow_symlinks);
}