Python Pathlib mkdir() Explained

Python's pathlib module simplifies file and directory operations. One of its key methods is mkdir(), which creates directories. This article explains how to use it effectively.

What is pathlib.mkdir()?

The mkdir() method in the pathlib module creates a new directory. It is part of the Path class, which represents file system paths. This method is both simple and powerful.

Basic Usage of mkdir()

To create a directory, first import the Path class from pathlib. Then, call mkdir() on a Path object. Here's an example:

    from pathlib import Path

    # Create a directory
    new_dir = Path("example_directory")
    new_dir.mkdir()
    

This code creates a directory named example_directory in the current working directory. If the directory already exists, it raises a FileExistsError.

Handling Existing Directories

To avoid errors when a directory exists, use the exist_ok parameter. Set it to True to ignore the error. Here's how:

    new_dir.mkdir(exist_ok=True)
    

This ensures the code runs smoothly, even if the directory already exists. It's a useful feature for scripts that may run multiple times.

Creating Parent Directories

Sometimes, you need to create parent directories. Use the parents parameter. Set it to True to create all necessary parent directories. Example:

    nested_dir = Path("parent/child/grandchild")
    nested_dir.mkdir(parents=True)
    

This creates the parent, child, and grandchild directories. Without parents=True, it would raise a FileNotFoundError.

Combining mkdir() with Other Methods

You can combine mkdir() with other pathlib methods. For example, use is_dir() to check if a directory exists before creating it. Here's an example:

    if not new_dir.is_dir():
        new_dir.mkdir()
    

This ensures the directory is only created if it doesn't already exist. It's a good practice to avoid unnecessary operations.

Practical Example

Let's create a script that organizes files into directories. The script checks if a directory exists and creates it if necessary. Here's the code:

    from pathlib import Path

    # Define directories
    directories = ["docs", "images", "videos"]

    # Create directories if they don't exist
    for dir_name in directories:
        dir_path = Path(dir_name)
        if not dir_path.exists():
            dir_path.mkdir()
            print(f"Created directory: {dir_name}")
        else:
            print(f"Directory already exists: {dir_name}")
    

This script creates docs, images, and videos directories. It uses exists() to check if they exist before creating them.

Conclusion

The pathlib.mkdir() method is a powerful tool for creating directories in Python. It is simple to use and integrates well with other pathlib methods. By using parameters like exist_ok and parents, you can handle various scenarios efficiently.

For more advanced file path operations, explore joinpath() and resolve(). These methods can further simplify your file management tasks.