Skip to content

bpo-29341: Added path.like object to docstring in posixmodule.c and posixmodule.c.h #10101

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

Merged
pablogsal merged 11 commits into from
Nov 2, 2018
Merged

bpo-29341: Added path.like object to docstring in posixmodule.c and posixmodule.c.h #10101

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
b7a0287
Added path.like object to docstring in posixmodule.c and posixmodule.c.h
BNMetrics Oct 25, 2018
975a0f8
added blurb news
BNMetrics Oct 25, 2018
e4b72c2
Merge branch 'master' into os_docstring
BNMetrics Oct 25, 2018
e0d86de
fixed some typo
BNMetrics Oct 25, 2018
ff8b2ce
removed changed to posixmodule.c
BNMetrics Oct 25, 2018
ab4cf0c
clinic input cleanup
BNMetrics Oct 25, 2018
ff2f999
added "a" in front of path-like object in the headers
BNMetrics Nov 2, 2018
b90402c
updated clinic input in posixmodule.c and updated news
BNMetrics Nov 2, 2018
1e62204
minor change, adding . at the end of the sentence
BNMetrics Nov 2, 2018
e74d94c
adding comma in front of 'or' for consistency purpose
pablogsal Nov 2, 2018
522f9de
updated clinic input
BNMetrics Nov 2, 2018
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
2 changes: 2 additions & 0 deletions Misc/NEWS.d/next/Core and Builtins/2018-10-25-20-53-32.bpo-29341.jH-AMF.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Clarify in the docstrings of :mod:`os` methods that path-like objects are also accepted
as input parameters.
22 changes: 11 additions & 11 deletions Modules/clinic/posixmodule.c.h
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

40 changes: 20 additions & 20 deletions Modules/posixmodule.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2480,7 +2480,7 @@ class sched_param_converter(CConverter):
os.stat

path : path_t(allow_fd=True)
Path to be examined; can be string, bytes, path-like object or
Path to be examined; can be string, bytes, a path-like object or
open-file-descriptor int.

*
Expand Down Expand Up @@ -2508,7 +2508,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=270bd64e7bb3c8f7]*/
/*[clinic end generated code: output=7d4976e6f18a59c5 input=01d362ebcc06996b]*/
{
return posix_do_stat("stat", path, dir_fd, follow_symlinks);
}
Expand Down Expand Up @@ -2542,7 +2542,7 @@ os_lstat_impl(PyObject *module, path_t *path, int dir_fd)
os.access -> bool

path: path_t
Path to be tested; can be string or bytes

@pablogsal pablogsal Nov 2, 2018 •
edited
Loading

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.

Could you add a . at the end of this sentence? :)

Path to be tested; can be string, bytes, or a path-like object.

@BNMetrics BNMetrics Nov 2, 2018

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.

Sure! :)

Path to be tested; can be string, bytes, or a path-like object.

mode: int
Operating-system mode bitfield. Can be F_OK to test existence,
Expand Down Expand Up @@ -2580,7 +2580,7 @@ Note that most operations will use the effective uid/gid, therefore this
static int
os_access_impl(PyObject *module, path_t *path, int mode, int dir_fd,
int effective_ids, int follow_symlinks)
/*[clinic end generated code: output=cf84158bc90b1a77 input=8e8c3a6ba791fee3]*/
/*[clinic end generated code: output=cf84158bc90b1a77 input=3ffe4e650ee3bf20]*/
{
int return_value;

Expand Down Expand Up @@ -2772,7 +2772,7 @@ os_fchdir_impl(PyObject *module, int fd)
os.chmod

path: path_t(allow_fd='PATH_HAVE_FCHMOD')
Path to be modified. May always be specified as a str or bytes.
Path to be modified. May always be specified as a str, bytes, or a path-like object.
On some platforms, path may also be specified as an open file descriptor.
If this functionality is unavailable, using it raises an exception.

Expand Down Expand Up @@ -2803,7 +2803,7 @@ dir_fd and follow_symlinks may not be implemented on your platform.
static PyObject *
os_chmod_impl(PyObject *module, path_t *path, int mode, int dir_fd,
int follow_symlinks)
/*[clinic end generated code: output=5cf6a94915cc7bff input=7f1618e5e15cc196]*/
/*[clinic end generated code: output=5cf6a94915cc7bff input=989081551c00293b]*/
{
int result;

Expand Down Expand Up @@ -3123,7 +3123,7 @@ os_fdatasync_impl(PyObject *module, int fd)
os.chown

path : path_t(allow_fd='PATH_HAVE_FCHOWN')
Path to be examined; can be string, bytes, or open-file-descriptor int.
Path to be examined; can be string, bytes, a path-like object, or open-file-descriptor int.

uid: uid_t

Expand Down Expand Up @@ -3161,7 +3161,7 @@ dir_fd and follow_symlinks may not be implemented on your platform.
static PyObject *
os_chown_impl(PyObject *module, path_t *path, uid_t uid, gid_t gid,
int dir_fd, int follow_symlinks)
/*[clinic end generated code: output=4beadab0db5f70cd input=a61cc35574814d5d]*/
/*[clinic end generated code: output=4beadab0db5f70cd input=b08c5ec67996a97d]*/
{
int result;

Expand Down Expand Up @@ -3688,7 +3688,7 @@ os.listdir

Return a list containing the names of the files in the directory.

path can be specified as either str or bytes. If path is bytes,
path can be specified as either str, bytes, or a path-like object. If path is bytes,
the filenames returned will also be bytes; in all other circumstances
the filenames returned will be str.
If path is None, uses the path='.'.
Expand All @@ -3704,7 +3704,7 @@ entries '.' and '..' even if they are present in the directory.

static PyObject *
os_listdir_impl(PyObject *module, path_t *path)
/*[clinic end generated code: output=293045673fcd1a75 input=09e300416e3cd729]*/
/*[clinic end generated code: output=293045673fcd1a75 input=e3f58030f538295d]*/
{
#if defined(MS_WINDOWS) && !defined(HAVE_OPENDIR)
return _listdir_windows_no_opendir(path, NULL);
Expand Down Expand Up @@ -11415,7 +11415,7 @@ os.getxattr

Return the value of extended attribute attribute on path.

path may be either a string or an open file descriptor.
path may be either a string, a path-like object, or an open file descriptor.
If follow_symlinks is False, and the last element of the path is a symbolic
link, getxattr will examine the symbolic link itself instead of the file
the link points to.
Expand All @@ -11425,7 +11425,7 @@ If follow_symlinks is False, and the last element of the path is a symbolic
static PyObject *
os_getxattr_impl(PyObject *module, path_t *path, path_t *attribute,
int follow_symlinks)
/*[clinic end generated code: output=5f2f44200a43cff2 input=8c8ea3bab78d89c2]*/
/*[clinic end generated code: output=5f2f44200a43cff2 input=025789491708f7eb]*/
{
Py_ssize_t i;
PyObject *buffer = NULL;
Expand Down Expand Up @@ -11487,7 +11487,7 @@ os.setxattr

Set extended attribute attribute on path to value.

path may be either a string or an open file descriptor.
path may be either a string, a path-like object, or an open file descriptor.
If follow_symlinks is False, and the last element of the path is a symbolic
link, setxattr will modify the symbolic link itself instead of the file
the link points to.
Expand All @@ -11497,7 +11497,7 @@ If follow_symlinks is False, and the last element of the path is a symbolic
static PyObject *
os_setxattr_impl(PyObject *module, path_t *path, path_t *attribute,
Py_buffer *value, int flags, int follow_symlinks)
/*[clinic end generated code: output=98b83f63fdde26bb input=f0d26833992015c2]*/
/*[clinic end generated code: output=98b83f63fdde26bb input=c17c0103009042f0]*/
{
ssize_t result;

Expand Down Expand Up @@ -11535,7 +11535,7 @@ os.removexattr

Remove extended attribute attribute on path.

path may be either a string or an open file descriptor.
path may be either a string, a path-like object, or an open file descriptor.
If follow_symlinks is False, and the last element of the path is a symbolic
link, removexattr will modify the symbolic link itself instead of the file
the link points to.
Expand All @@ -11545,7 +11545,7 @@ If follow_symlinks is False, and the last element of the path is a symbolic
static PyObject *
os_removexattr_impl(PyObject *module, path_t *path, path_t *attribute,
int follow_symlinks)
/*[clinic end generated code: output=521a51817980cda6 input=cdb54834161e3329]*/
/*[clinic end generated code: output=521a51817980cda6 input=3d9a7d36fe2f7c4e]*/
{
ssize_t result;

Expand Down Expand Up @@ -11578,7 +11578,7 @@ os.listxattr

Return a list of extended attributes on path.

path may be either None, a string, or an open file descriptor.
path may be either None, a string, a path-like object, or an open file descriptor.
if path is None, listxattr will examine the current directory.
If follow_symlinks is False, and the last element of the path is a symbolic
link, listxattr will examine the symbolic link itself instead of the file
Expand All @@ -11587,7 +11587,7 @@ If follow_symlinks is False, and the last element of the path is a symbolic

static PyObject *
os_listxattr_impl(PyObject *module, path_t *path, int follow_symlinks)
/*[clinic end generated code: output=bebdb4e2ad0ce435 input=08cca53ac0b07c13]*/
/*[clinic end generated code: output=bebdb4e2ad0ce435 input=9826edf9fdb90869]*/
{
Py_ssize_t i;
PyObject *result = NULL;
Expand Down Expand Up @@ -12836,7 +12836,7 @@ os.scandir

Return an iterator of DirEntry objects for given path.

path can be specified as either str, bytes or path-like object. If path
path can be specified as either str, bytes, or a path-like object. If path
is bytes, the names of yielded DirEntry objects will also be bytes; in
all other circumstances they will be str.

Expand All @@ -12845,7 +12845,7 @@ If path is None, uses the path='.'.

static PyObject *
os_scandir_impl(PyObject *module, path_t *path)
/*[clinic end generated code: output=6eb2668b675ca89e input=b139dc1c57f60846]*/
/*[clinic end generated code: output=6eb2668b675ca89e input=6bdd312708fc3bb0]*/
{
ScandirIterator *iterator;
#ifdef MS_WINDOWS
Expand Down