When it comes to renaming or moving files and directories, two commonly used methods are os. rename and shutil. move. While both can serve the purpose of renaming and moving, they have distinct differences in terms of functionality and use cases. In this article, we will explore these differences and when to use each of them.
Difference Between os. rename and shutil. move in Python
Both os. rename and shutil. move are valuable tool in Python for renaming and moving files and directories. The choice between them depends on the complexity of your task and the specific requirements of your file manipulation operation.
When to Use os. rename and shutil.move:
Use of os.rename when:
- You need to perform a basic rename operation within the same directory.
- Atomicity is crucial for your operation.
Use of shutil.move when:
- You need to move files or directories across different filesystems or devices.
- You want to ensure destination directories are automatically created.
- You need to handle the overwriting of existing files.
- You want to preserve file metadata and attributes.
Examples for os.rename
Renaming a File
It will rename the file ‘old_file.txt’ to ‘new_file.txt’ and display a message indicating that the renaming process was successful.
Python3
import os# Current file nameold_name = 'old_file.txt'# New file namenew_name = 'new_file.txt'# Rename the fileos.rename(old_name, new_name)print(f"File '{old_name}' has been renamed to '{new_name}'.") |
Output:
File is renamed as GFG
Rename a Directory
It will rename the directory ‘old_directory’ to ‘new_directory’ and display a message indicating that the renaming process was successful.
Python3
import os# Current directory nameold_dir = 'old_directory'# New directory namenew_dir = 'new_directory'# Rename the directoryos.rename(old_dir, new_dir)print(f"Directory '{old_dir}' has been renamed to '{new_dir}'.") |
Output:
Rename a Directory
Examples for shutil.move
Moving a File to a Different Directory
This code uses the shutil module to move a file from a source location to a destination directory. It first specifies the paths to the source file and the destination directory. Then, it calls shutil.move() with these paths to perform the move operation.
Python3
import shutil# Source file pathsource_file = 'source_directory/source_file.txt'# Destination directory pathdestination_directory = 'destination_directory/'# Move the file to the destination directoryshutil.move(source_file, destination_directory)print(f"File '{source_file}' has been moved to '{destination_directory}'.") |
Output:
Moving a file to different directory
Handling Overwriting with shutil.move
This code uses the shutil library in Python to move a file from a source directory to a destination directory, potentially overwriting a file with the same name in the destination directory.
Python3
import shutil# Source file pathsource_file = 'source_directory/file.txt'# Destination directory pathdestination_directory = 'destination_directory/'# Destination file path (same name as the source)destination_file = 'destination_directory/file.txt'# Move the file to the destination directory (overwrites if exists)shutil.move(source_file, destination_file)print(f"File '{source_file}' has been moved to '{destination_file }' (overwriting if necessary).") |
Output:
Handling Overwriting with shutil.move
