Tuesday, November 19, 2024
Google search engine
HomeLanguagesPython | os.rmdir() method

Python | os.rmdir() 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.

All functions in os module raise OSError in the case of invalid or inaccessible file names and paths, or other arguments that have the correct type, but are not accepted by the operating system.

os.rmdir() method in Python is used to remove or delete a empty directory. OSError will be raised if the specified path is not an empty directory.

Syntax: os.rmdir(path, *, dir_fd = None)

Parameter:
path: A path-like object representing a file path. A path-like object is either a string or bytes object representing a path.
dir_fd (optional) : A file descriptor referring to a directory. The default value of this parameter is None.
If the specified path is absolute then dir_fd is ignored.

Note: The ‘*’ in parameter list indicates that all following parameters (Here in our case ‘dir_fd’) are keyword-only parameters and they can be provided using their name, not as positional parameter.

Return Type: This method does not return any value.

Code #1: Use of os.rmdir() method to remove an empty directory




# Python program to explain os.rmdir() method 
    
# importing os module 
import os
  
# Directory name
directory = "ihritik"
  
# Parent Directory
parent = "/home/User/Documents"
  
# Path
path = os.path.join(parent, directory)
  
# Remove the Directory
# "ihritik"
os.rmdir(path)
print("Directory '%s' has been removed successfully" %directory)


Output:

Directory 'ihritik' has been removed successfully
Code #2: Handling errors while using os.rmdir() method




# Python program to explain os.rmdir() method 
    
# importing os module 
import os
  
# Directory name
directory = "ihritik"
  
# Parent Directory
parent = "/home/User/Documents"
  
# Path
path = os.path.join(parent, directory)
  
  
# Remove the Directory
# "ihritik"
try:
    os.rmdir(path)
    print("Directory '%s' has been removed successfully" %directory)
except OSError as error:
    print(error)
    print("Directory '%s' can not be removed" %directory)
  
  
# if the specified path 
# is not an empty directory
# then permission error will
# be raised
  
# similarly if specified path
# is invalid or is not a 
# directory then corresponding
# OSError will be raised


Output:

[Errno 13] Permission denied: '/home/User/Documents/ihritik'
Directory 'ihritik' can not be removed

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

RELATED ARTICLES

Most Popular

Recent Comments