Skip to content

bpo-32557: allow shutil.disk_usage to take a file path on Windows also #9372

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
miss-islington merged 9 commits into from
Sep 25, 2018
Merged

bpo-32557: allow shutil.disk_usage to take a file path on Windows also #9372

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
0bf5be1
bpo-32557: allow shutil.disk_usage to take a file path on Windows also
jopamer Sep 17, 2018
85b6aae
Merge branch 'master' into bpo-32557
jopamer Sep 17, 2018
1963522
Remove accidentally committed `.bak` file
jopamer Sep 17, 2018
1dd454c
Replace expensive win32_stat call with GetFileAttributesW
jopamer Sep 18, 2018
5feca3b
Move directory truncation logic to the error case, and dynamically al…
jopamer Sep 18, 2018
ec5115b
Check for error on call to _dirnameW and eliminate recursive call to …
jopamer Sep 18, 2018
0f944ed
Respond to the latest round of code review feedback
jopamer Sep 24, 2018
3a260bb
Update shutil.rst
zooba Sep 25, 2018
5248f87
Add NEWS file
zooba Sep 25, 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
7 changes: 5 additions & 2 deletions Doc/library/shutil.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -343,11 +343,14 @@ Directory and files operations

Return disk usage statistics about the given path as a :term:`named tuple`
with the attributes *total*, *used* and *free*, which are the amount of
total, used and free space, in bytes. On Windows, *path* must be a
directory; on Unix, it can be a file or directory.
Copy link
Member

@berkerpeksag berkerpeksag Sep 20, 2018

Choose a reason for hiding this comment

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

Nit: I'd keep the "it can be a file or directory." part and add a versionchanged marker to explain that it now can accept file and directory on Windows. Example:

.. versionchanged:: 3.8
   Explain the behaivor change here.

Copy link
Contributor Author

@jopamer jopamer Sep 20, 2018

Choose a reason for hiding this comment

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

Ok - cool - I wasn't sure what the convention was. I'll update.

total, used and free space, in bytes. *path* may be a file or a
directory.

.. versionadded:: 3.3

.. versionchanged:: 3.8
On Windows, *path* can now be a file or directory.

Availability: Unix, Windows.

.. function:: chown(path, user=None, group=None)
Expand Down
1 change: 1 addition & 0 deletions Lib/test/test_shutil.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1363,6 +1363,7 @@ def _boo(filename, extract_dir, extra):
"disk_usage not available on this platform")
def test_disk_usage(self):
usage = shutil.disk_usage(os.path.dirname(__file__))
self.assertEqual(usage, shutil.disk_usage(__file__))
self.assertGreater(usage.total, 0)
self.assertGreater(usage.used, 0)
self.assertGreaterEqual(usage.free, 0)
Expand Down
1 change: 1 addition & 0 deletions Misc/NEWS.d/next/Windows/2018-09-25-10-39-27.bpo-32557.Rs1bf9.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Allow shutil.disk_usage to take a file path on Windows
29 changes: 27 additions & 2 deletions Modules/posixmodule.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10069,13 +10069,38 @@ os__getdiskusage_impl(PyObject *module, path_t *path)
{
BOOL retval;
ULARGE_INTEGER _, total, free;
DWORD err = 0;

Py_BEGIN_ALLOW_THREADS
retval = GetDiskFreeSpaceExW(path->wide, &_, &total, &free);
Py_END_ALLOW_THREADS
if (retval == 0)
return PyErr_SetFromWindowsErr(0);
if (retval == 0) {
if (GetLastError() == ERROR_DIRECTORY) {
wchar_t *dir_path = NULL;

dir_path = PyMem_New(wchar_t, path->length + 1);
if (dir_path == NULL) {
return PyErr_NoMemory();
}

wcscpy_s(dir_path, path->length + 1, path->wide);

if (_dirnameW(dir_path) != -1) {
Py_BEGIN_ALLOW_THREADS
retval = GetDiskFreeSpaceExW(dir_path, &_, &total, &free);
Py_END_ALLOW_THREADS
}
/* Record the last error in case it's modified by PyMem_Free. */
err = GetLastError();
PyMem_Free(dir_path);
if (retval) {
goto success;
}
}
return PyErr_SetFromWindowsErr(err);
}

success:
return Py_BuildValue("(LL)", total.QuadPart, free.QuadPart);
}
#endif /* MS_WINDOWS */
Expand Down