Python Pathlib stat() Explained

The stat() method in Python's pathlib module is a powerful tool for retrieving file metadata. It provides details like file size, creation time, and permissions.

This method is essential for file management tasks. It helps you understand the properties of files and directories in your system.

What is pathlib.stat()?

The stat() method returns a os.stat_result object. This object contains various attributes related to the file or directory.

These attributes include file size, last access time, and modification time. You can use this information to make decisions in your code.

How to Use pathlib.stat()

To use stat(), you first need to create a Path object. This object represents the file or directory you want to inspect.

Here’s a simple example:

from pathlib import Path

# Create a Path object
file_path = Path('example.txt')

# Get file metadata
file_stats = file_path.stat()

# Print file size
print(f"File size: {file_stats.st_size} bytes")
    

File size: 1024 bytes
    

In this example, we retrieve the size of a file named example.txt. The st_size attribute gives the file size in bytes.

Common Attributes of os.stat_result

The os.stat_result object has several useful attributes. Here are some of the most commonly used ones:

• st_size: File size in bytes.
• st_atime: Last access time.
• st_mtime: Last modification time.
• st_ctime: Creation time on Windows, or last metadata change on Unix.

These attributes help you understand the file's history and usage. They are crucial for tasks like backup scripts or file monitoring.

Example: Checking File Modification Time

Let’s see how to check the last modification time of a file. This is useful for tracking changes.

from pathlib import Path
import datetime

# Create a Path object
file_path = Path('example.txt')

# Get file metadata
file_stats = file_path.stat()

# Convert modification time to a readable format
mod_time = datetime.datetime.fromtimestamp(file_stats.st_mtime)

print(f"Last modified: {mod_time}")
    

Last modified: 2023-10-01 12:34:56
    

This code converts the modification time to a human-readable format. It uses Python’s datetime module for the conversion.

Handling Errors with pathlib.stat()

When using stat(), you might encounter errors. For example, the file might not exist.

To handle such cases, use a try-except block. This ensures your program doesn’t crash unexpectedly.

from pathlib import Path

# Create a Path object
file_path = Path('nonexistent.txt')

try:
    file_stats = file_path.stat()
    print(f"File size: {file_stats.st_size} bytes")
except FileNotFoundError:
    print("File not found.")
    

File not found.
    

This example shows how to handle a FileNotFoundError. It’s a good practice to handle such errors gracefully.

Conclusion

The stat() method in Python’s pathlib module is a versatile tool. It provides detailed metadata about files and directories.

By understanding how to use stat(), you can enhance your file management scripts. It’s a must-know for any Python developer working with files.

For more on file handling, check out our guides on read_bytes() and write_text().