Retrieving Directory Paths

To determine the current working directory or navigate relative paths, the os module provides essential functions. While os.getcwd() returns the path of the current script execution context, absolute paths for parent directories can be constructed using path manipulation.

import os

# Current working directory
current_path = os.getcwd()

# Absolute path of the directory containing the active file
script_dir = os.path.dirname(os.path.abspath(__file__))

# Path of the parent directory
parent_dir = os.path.abspath(os.path.join(current_path, os.pardir))

print(f"Current: {current_path}")
print(f"Parent: {parent_dir}")

Creating Directories Recursively

The os.makedirs() function allows for the creation of nested directory structures in a single call. If intermediate directories do not exist, they will be created automatically. The exist_ok parameter prevents errors if the directory already exists.

import os

# Define a nested structure
directory_structure = "storage/app/uploads"

# Create the structure, ignoring if it already exists
os.makedirs(directory_structure, exist_ok=True)

Deleting Files and Directory Trees

Removing individual files is handled by os.remove(). However, deleting a directory that may contain files or subdirectories requires the shutil.rmtree() method to perform a recursive deletion.

import os
import shutil

file_path = "temporary.log"
if os.path.exists(file_path):
    os.remove(file_path)

# Recursively remove a directory and all its contents
target_folder = "old_data"
shutil.rmtree(target_folder, ignore_errors=True)

Copying and Moving Data

For file operations, the shutil module is preferred. shutil.copy2() copies a file to a destination, preserving metadata. To clone an entire directory structure, shutil.copytree() is utilized.

import shutil

# Copy a single file
source_file = "config."
dest_file = "config_backup."
shutil.copy2(source_file, dest_file)

# Copy a directory tree
src_dir = "project_source"
dst_dir = "project_backup"
shutil.copytree(src_dir, dst_dir)

Renaming Resources

The os.rename() function serves to rename both files and directories. It effectively moves a file if the destination path differs from the source path.

import os

# Rename a directory
os.rename("legacy_data", "archived_data")

# Rename a specific file
old_filename = "report_v1.txt"
new_filename = "report_final.txt"
os.rename(old_filename, new_filename)

Path Manipulation Utilities

Path decomposition and construction are handled via os.path. This submodule provides tools to extract file extensions, directory names, and join paths safely across operating systems.

import os

raw_path = "/var/www/site/index.html"

# Extract the filename
filename = os.path.basename(raw_path)

# Extract the directory path
dir_path = os.path.dirname(raw_path)

# Construct a new path
new_location = os.path.join(dir_path, "backups", filename)

Verifying Path Existence and Type

Before performing operations, it is prudent to check if a path exists and whether it points to a file or a directory using os.path.exists(), os.path.isfile(), and os.path.isdir().

import os

check_path = "/usr/local/bin"

if os.path.exists(check_path):
    if os.path.isfile(check_path):
        print("Target is a file.")
    elif os.path.isdir(check_path):
        print("Target is a directory.")

Recursive Directory Traversal

To iterate through a file system tree, os.walk() generates a tuple of values for each directory it visits, including the root path, subdirectories, and filenames.

import os

root_dir = "/home/user/documents"

for dirpath, subdirs, files in os.walk(root_dir):
    # Process files found in the current directory
    for fname in files:
        full_path = os.path.join(dirpath, fname)
        print(f"Discovered file: {full_path}")

Listing Directory Contents

To retrieve a non-recursive list of entries in a specific folder, os.listdir() is used. This can be combined with list comprehensions to filter for files or directories explicitly.

import os

target = "/etc"

all_entries = os.listdir(target)

# Filter for only directories
only_dirs = [d for d in all_entries if os.path.isdir(os.path.join(target, d))]

# Filter for only files
only_files = [f for f in all_entries if os.path.isfile(os.path.join(target, f))]

print(f"Directories: {only_dirs}")

Modifying the Working Directory

Changing the current working directory of the running process is accomplished with os.chdir(). This affects relative path resolution for subsequent file operations.

import os

print(f"Before: {os.getcwd()}")

# Change to the parent directory
os.chdir(os.pardir)

print(f"After: {os.getcwd()}")