gh-83006: Document behavior of shutil.disk_usage for non-mounted fi…

…lesystems on Unix (#107031)
python · Jul 22, 2023 · 6e5f223 · 6e5f223
1 parent 149748e
commit 6e5f223
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/Doc/library/shutil.rst b/Doc/library/shutil.rst
@@ -399,6 +399,12 @@ Directory and files operations
    total, used and free space, in bytes. *path* may be a file or a
    directory.
 
+   .. note::
+
+      On Unix filesystems, *path* must point to a path within a **mounted**
+      filesystem partition. On those platforms, CPython doesn't attempt to
+      retrieve disk usage information from non-mounted filesystems.
+
    .. versionadded:: 3.3
 
    .. versionchanged:: 3.8

diff --git a/Misc/NEWS.d/next/Library/2023-07-22-15-51-33.gh-issue-83006.21zaCz.rst b/Misc/NEWS.d/next/Library/2023-07-22-15-51-33.gh-issue-83006.21zaCz.rst
@@ -0,0 +1,2 @@
+Document behavior of :func:`shutil.disk_usage` for non-mounted filesystems
+on Unix.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		Document behavior of :func:`shutil.disk_usage` for non-mounted filesystems
		on Unix.