Skip to content

bpo-33140: skip defining shutil.chown() on windows #26973

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
akulakov wants to merge 6 commits into from
Closed

bpo-33140: skip defining shutil.chown() on windows #26973

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f9df788
Skip definition of chown() on windows
akulakov Jun 30, 2021
29ab75d
update __all__
akulakov Jun 30, 2021
4f8ca64
formatting
akulakov Jun 30, 2021
50e443b
more formatting
akulakov Jun 30, 2021
1ba11a9
Fix test
akulakov Jun 30, 2021
1e8f84d
fix test comparison
akulakov Jun 30, 2021
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
67 changes: 35 additions & 32 deletions Lib/shutil.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,10 +54,12 @@
"register_archive_format", "unregister_archive_format",
"get_unpack_formats", "register_unpack_format",
"unregister_unpack_format", "unpack_archive",
"ignore_patterns", "chown", "which", "get_terminal_size",
"SameFileError"]
"ignore_patterns", "which", "get_terminal_size", "SameFileError"]
# disk_usage is added later, if available on the platform

if not _WINDOWS:
__all__.append("chown")

class Error(OSError):
pass

Expand Down Expand Up @@ -1292,37 +1294,38 @@ def disk_usage(path):
return _ntuple_diskusage(total, used, free)


def chown(path, user=None, group=None):
"""Change owner user and group of the given path.
if not _WINDOWS:
def chown(path, user=None, group=None):
"""Change owner user and group of the given path.

user and group can be the uid/gid or the user/group names, and in that case,
they are converted to their respective uid/gid.
"""
sys.audit('shutil.chown', path, user, group)

if user is None and group is None:
raise ValueError("user and/or group must be set")

_user = user
_group = group

# -1 means don't change it
if user is None:
_user = -1
# user can either be an int (the uid) or a string (the system username)
elif isinstance(user, str):
_user = _get_uid(user)
if _user is None:
raise LookupError("no such user: {!r}".format(user))

if group is None:
_group = -1
elif not isinstance(group, int):
_group = _get_gid(group)
if _group is None:
raise LookupError("no such group: {!r}".format(group))

os.chown(path, _user, _group)
user and group can be the uid/gid or the user/group names, and in that
case, they are converted to their respective uid/gid.
"""
sys.audit('shutil.chown', path, user, group)

if user is None and group is None:
raise ValueError("user and/or group must be set")

_user = user
_group = group

# -1 means don't change it
if user is None:
_user = -1
# user can either be an int (the uid) or a string (the system username)
elif isinstance(user, str):
_user = _get_uid(user)
if _user is None:
raise LookupError("no such user: {!r}".format(user))

if group is None:
_group = -1
elif not isinstance(group, int):
_group = _get_gid(group)
if _group is None:
raise LookupError("no such group: {!r}".format(group))

os.chown(path, _user, _group)

def get_terminal_size(fallback=(80, 24)):
"""Get the size of the terminal window.
Expand Down
4 changes: 3 additions & 1 deletion Lib/test/test_shutil.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2608,10 +2608,12 @@ def test_module_all_attribute(self):
'get_archive_formats', 'register_archive_format',
'unregister_archive_format', 'get_unpack_formats',
'register_unpack_format', 'unregister_unpack_format',
'unpack_archive', 'ignore_patterns', 'chown', 'which',
'unpack_archive', 'ignore_patterns', 'which',
'get_terminal_size', 'SameFileError']
if hasattr(os, 'statvfs') or os.name == 'nt':
target_api.append('disk_usage')
if os.name != 'nt':
target_api.append('chown')
self.assertEqual(set(shutil.__all__), set(target_api))


Expand Down