Python shutil.disk_usage() Function: Usage and Examples

This Python tutorial explains shutil.disk_usage() Function: Usage and Examples. Follow the example, inspect the output, and practise an input change so you understand the behavior rather than simply copying the syntax.

What This Feature Does

Inspect available and consumed storage using shutil.disk_usage().

shutil.disk_usage(path) returns a named tuple with total, used, and free storage in bytes for the filesystem containing the given path. The values describe filesystem capacity, not the cumulative size of one directory.

When to Use It

This technique belongs to file copying, temporary files and matching. It is useful when the input, operation and expected outcome are known. Start with a small controlled example before integrating it into a larger workflow.

Step-by-Step Python Example

Read the code once before running it. Notice which values are inputs, which function or method performs the work, and whether the result is returned or stored by changing an existing object.

from pathlib import Path
import shutil

storage_information = shutil.disk_usage(Path.cwd())
print(storage_information.total >= storage_information.used)
print(storage_information.free >= 0)

Understanding the Code

First, the imports make pathlib, shutil available. They provide the filesystem, data or standard-library functions used later.
Find the call shutil.disk_usage(Path.cwd()). Its parameters determine the specific operation demonstrated in the title.
Its purpose is to inspect available and consumed storage using shutil.disk_usage(). Compare this description against the result printed by the program.
The print() expressions display a checkable outcome. Print values and exception names are not substitutes for the program result itself.

Expected Output

True
True

Each printed line corresponds to a separate observation in the program. Use the lines to distinguish returned data, changes to existing objects, and status checks.

Important Details and Edge Cases

For directory contents size, traverse files and sum their st_size instead.

Before applying this to real documents, check whether the method reads data, creates a new file, moves it, or overwrites an existing file. Work in a disposable test directory first and handle OSError-related failures in applications.

Practice: Try It Yourself

Display available disk space in GiB for your current project location.

Begin by copying the example into a separate practice file. Change one input at a time, run it again, and describe why the result changed. If the exercise writes or deletes files, keep it inside a temporary test folder.

Official Python Documentation

For the complete reference, see the Python standard library documentation.

Common Beginner Mistakes

Treating free space as the total size of files in the chosen directory.
Assuming reported free space is guaranteed available to the current user on every filesystem.
Before applying this to real documents, check whether the method reads data, creates a new file, moves it, or overwrites an existing file. Work in a disposable test directory first and handle OSError-related failures in applications.

Key Takeaways

Inspect available and consumed storage using shutil.disk_usage().
shutil.disk_usage(path) returns a named tuple with total, used, and free storage in bytes for the filesystem containing the given path. The values describe filesystem capacity, not the cumulative size of one directory.
Avoid this common pitfall: Treating free space as the total size of files in the chosen directory.