Python | shutil.disk_usage() method

Shutil module in Python provides many functions of high-level operations on files and collections of files. It comes under Python’s standard utility modules. This module helps in automating process of copying and removal of files and directories.

shutil.disk_usage() method in Python is to get disk usage statistics about the given path. This method returns a named tuple with attributes total, used and free. The total attribute represents the amount of total space, the used attribute represents the amount of used space and the free attribute represents the amount of available space, in bytes.

Note: On Windows, the given path must represent a directory but on Unix systems, it can be a file or directory.

Syntax: shutil.disk_usage(path)

Parameter:
path: A path-like object representing a file system path. A path-like object is either a string or bytes object representing a path.

Return Type: This method returns a named tuple with attributed total, used and free.

Code: Use of shutil.disk_usage() method

# Python program to explain shutil.disk_usage() method

# importing shutil module
import shutil

# Path
path = "/home/User/Documents"

# Get the disk usage statistics
# about the given path
stat = shutil.disk_usage(path)

# Print disk usage statistics
print("Disk usage statistics:")
print(stat)

Output:

Disk usage statistics:
usage(total=244934381568, used=13350301696, free=219070689280)

Reference: https://docs.python.org/3/library/shutil.html