Python | os.rename() method

OS module in Python provides functions for interacting with the operating system. OS comes under Python’s standard utility modules. This module provides a portable way of using operating system dependent functionality.

os.rename() method in Python is used to rename a file or directory.
This method renames a source file/ directory to specified destination file/directory.

Syntax: os.rename(source, destination, *, src_dir_fd = None, dst_dir_fd = None)

Parameters:
source: A path-like object representing the file system path. This is the source file path which is to renamed.
destination: A path-like object representing the file system path.
src_dir_fd (optional): A file descriptor referring to a directory.
dst_dir_fd (optional): A file descriptor referring to a directory.

Return Type: This method does not return any value.

Code #1: Use of os.rename() method

# Python program to explain os.rename() method

# importing os module
import os


# Source file path
source = 'GeeksforGeeks/file.txt'

# destination file path
dest = 'GeekforGeeks/newfile.txt'


# Now rename the source path
# to destination path
# using os.rename() method
os.rename(source, dest)
print("Source path renamed to destination path successfully.")

Output:

Source path renamed to destination path successfully.

Code #2: Handling possible errors

# Python program to explain os.rename() method

# importing os module
import os


# Source file path
source = './GeeksforGeeks/file.txt'

# destination file path
dest = './GeeksforGeeks/dir'


# try renaming the source path
# to destination path
# using os.rename() method

try :
    os.rename(source, dest)
    print("Source path renamed to destination path successfully.")

# If Source is a file
# but destination is a directory
except IsADirectoryError:
    print("Source is a file but destination is a directory.")

# If source is a directory
# but destination is a file
except NotADirectoryError:
    print("Source is a directory but destination is a file.")

# For permission related errors
except PermissionError:
    print("Operation not permitted.")

# For other errors
except OSError as error:
    print(error)

Output:

Source is a file but destination is a directory.

Reference: https://docs.python.org/3/library/os.html#os.rename