The os.rename function in Python is used to rename files or directories. This function is part of the os module, which provides a way of using operating system-dependent functionality like reading or writing to the file system. In a macOS environment, renaming files using os.rename is straightforward and can be very useful for automating file management tasks. This article will guide you through the process of using os.rename on macOS, providing practical examples to illustrate its usage.

Examples:

1. Basic File Rename: To rename a file, you need to import the os module and then use the os.rename function. Here’s a simple example:

   import os
   
   # Define the original file name and the new file name
   original_file = 'old_filename.txt'
   new_file = 'new_filename.txt'
   
   # Use os.rename to rename the file
   os.rename(original_file, new_file)
   print(f"File renamed from {original_file} to {new_file}")

   Save this script as rename_file.py and run it via the terminal using the following command:

   python3 rename_file.py

2. Renaming a Directory: You can also rename directories using the same os.rename function. Here’s how:

   import os
   
   # Define the original directory name and the new directory name
   original_dir = 'old_directory'
   new_dir = 'new_directory'
   
   # Use os.rename to rename the directory
   os.rename(original_dir, new_dir)
   print(f"Directory renamed from {original_dir} to {new_dir}")

   Save this script as rename_directory.py and run it via the terminal:

   python3 rename_directory.py

3. Handling Errors: It's important to handle potential errors, such as the file or directory not existing. Here’s an example with error handling:

   import os
   
   original_file = 'old_filename.txt'
   new_file = 'new_filename.txt'
   
   try:
      os.rename(original_file, new_file)
      print(f"File renamed from {original_file} to {new_file}")
   except FileNotFoundError:
      print(f"Error: {original_file} does not exist")
   except PermissionError:
      print(f"Error: Permission denied to rename {original_file}")
   except Exception as e:
      print(f"An unexpected error occurred: {e}")

   Save this script as rename_with_error_handling.py and run it via the terminal:

   python3 rename_with_error_handling.py