Python os rmdir()

The os.rmdir function in Python's os module removes (deletes) an empty directory. This function is useful for cleaning up empty directories from the filesystem.

Table of Contents

1. Introduction
2. os.rmdir Function Syntax
3. Examples
   • Basic Usage
   • Handling Errors
4. Real-World Use Case
5. Conclusion

Introduction

The os.rmdir function in Python's os module deletes an empty directory specified by the path. If the directory contains any files or subdirectories, an OSError will be raised. This function is useful for removing empty directories as part of directory management tasks.

os.rmdir Function Syntax

Here is how you use the os.rmdir function:

import os

os.rmdir(path)

Parameters:

• path: The path to the directory to be removed.

Returns:

• None. This function deletes the specified empty directory.

Examples

Basic Usage

Here is an example of how to use the os.rmdir function to delete an empty directory.

Example

import os

# Creating an empty directory
directory_path = 'empty_directory'
os.mkdir(directory_path)
print(f"Directory '{directory_path}' created.")

# Deleting the empty directory
os.rmdir(directory_path)
print(f"Directory '{directory_path}' has been deleted.")

Output:

Directory 'empty_directory' created.
Directory 'empty_directory' has been deleted.

Handling Errors

This example demonstrates how to handle errors when trying to delete a directory that is not empty or does not exist.

Example

import os

# Trying to delete a non-existing directory
directory_path = 'non_existing_directory'
try:
    os.rmdir(directory_path)
except FileNotFoundError:
    print(f"Directory '{directory_path}' does not exist.")
except OSError as e:
    print(f"Error: {e}")

# Creating a non-empty directory
non_empty_directory_path = 'non_empty_directory'
os.mkdir(non_empty_directory_path)
with open(os.path.join(non_empty_directory_path, 'file.txt'), 'w') as file:
    file.write("This is a test file.")

# Trying to delete the non-empty directory
try:
    os.rmdir(non_empty_directory_path)
except OSError as e:
    print(f"Error: {e}")

Output:

Directory 'non_existing_directory' does not exist.
Error: [Errno 39] Directory not empty: 'non_empty_directory'

Real-World Use Case

Cleaning Up Temporary Directories

In real-world applications, the os.rmdir function can be used to remove empty directories that were used temporarily during the execution of a program.

Example

import os
import tempfile

def create_temp_directory():
    temp_dir = tempfile.mkdtemp()
    print(f"Temporary directory created at: {temp_dir}")
    return temp_dir

def delete_temp_directory(directory_path):
    try:
        os.rmdir(directory_path)
        print(f"Temporary directory '{directory_path}' has been deleted.")
    except OSError as e:
        print(f"Error: {e}")

# Example usage
temp_directory_path = create_temp_directory()
# Ensure the directory is empty before deleting
delete_temp_directory(temp_directory_path)

Output:

Temporary directory created at: /tmp/tmpabc123
Temporary directory '/tmp/tmpabc123' has been deleted.

Conclusion

The os.rmdir function in Python's os module deletes an empty directory specified by the path. This function is useful for cleaning up empty directories as part of directory management tasks. Proper error handling should be implemented to manage cases where the directory does not exist or is not empty. For removing non-empty directories, consider using shutil.rmtree instead.