Delete a directory or file using Python
In this article, we will cover how to delete (remove) files and directories in Python. Python provides different methods and functions for removing files and directories. One can remove the file according to their need.
Table of Content
Various methods provided by Python are:
Deleting file/dir using the os.remove() Method
OS module in Python provides functions for interacting with the operating system. All functions in the 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.remove() method in Python removes or deletes a file path. This method can not remove or delete a directory. If the specified path is a directory then OSError will be raised by the method.
Example 1: Delete a File in Python
Suppose the file contained in the folder are:
We want to delete file1 from the above folder. Below is the implementation.
# importing os module
import os
# File name
file = 'file1.txt'
# File location
location = "D:/Pycharm projects/GeeksforGeeks/Authors/Nikhil/"
# Path
path = os.path.join(location, file)
# Remove the file
# 'file.txt'
os.remove(path)
Output:
Example 2: Remove file with absolute path
If the specified path is a directory.
# Python program to explain os.remove() method
# importing os module
import os
# Directory name
dir = "Nikhil"
# Path
location = "D:/Pycharm projects/GeeksforGeeks/Authors/"
path = os.path.join(location, dir)
# Remove the specified
# file path
os.remove(path)
print("% s has been removed successfully" % dir)
# if the specified path
# is a directory then
# 'IsADirectoryError' error
# will raised
# Similarly if the specified
# file path does not exists or
# is invalid then corresponding
# OSError will be raised
Output:
Traceback (most recent call last):
File "osremove.py", line 11, in
os.remove(path)
IsADirectoryError: [Errno 21] Is a directory: 'D:/Pycharm projects/GeeksforGeeks/Authors/Nikhil'
Example 3: Check if File Exists Before Deleting
Handling error while using os.remove() method.
# importing os module
import os
# path
path = 'D:/Pycharm projects/GeeksforGeeks/Authors/Nikhil'
# Remove the specified
# file path
try:
os.remove(path)
print("% s removed successfully" % path)
except OSError as error:
print(error)
print("File path can not be removed")
Output:
[Errno 21] Is a directory: 'D:/Pycharm projects/GeeksforGeeks/Authors/Nikhil'
File path can not be removed
Note: To know more about os.remove() click here.
Deleting file/dir using the os.rmdir() method
os.rmdir() method in Python is used to remove or delete an empty directory. OSError will be raised if the specified path is not an empty directory.
Example 1: Delete all directories from a Directory
Suppose the directories are –
We want to remove the directory Geeks. Below is the implementation.
# importing os module
import os
# Directory name
directory = "Geeks"
# Parent Directory
parent = "D:/Pycharm projects/"
# Path
path = os.path.join(parent, directory)
# Remove the Directory
# "Geeks"
os.rmdir(path)
Output:
Example 2: Error Handling while deleting a directory
Handling errors while using os.rmdir() method,
# Python program to explain os.rmdir() method
# importing os module
import os
# Directory name
directory = "GeeksforGeeks"
# Parent Directory
parent = "D:/Pycharm projects/"
# Path
path = os.path.join(parent, directory)
# Remove the Directory
# "GeeksforGeeks"
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:
[WinError 145] The directory is not empty: 'D:/Pycharm projects/GeeksforGeeks'
Directory 'GeeksforGeeks' can not be removed
Note: To know more about os.rmdir() click here.
Deleting file/dir using the shutil.rmtree()
shutil.rmtree() Method is used to delete an entire directory tree, a path must point to a directory (but not a symbolic link to a directory).
Example 1: Delete a directory and the files contained in it
Suppose the directory and sub-directories are as follow.
# Parent directory:
# Directory inside parent directory:
# File inside the sub-directory:
Example 2: Delete all Files from a Directory
We want to remove the directory Authors. Below is the implementation.
import os
# Directory path
dir_path = r"/content/sample_data"
# List all files in the directory
for filename in os.listdir(dir_path):
file_path = os.path.join(dir_path, filename)
# Check if it is a file (not a subdirectory)
if os.path.isfile(file_path):
os.remove(file_path) # Remove the file
print(f"Deleted file: {filename}")
Output:
Output
Example 3: Ignore error while deleting a directory
By passing ignore_errors = True.
import shutil
import os
# location
location = "D:/Pycharm projects/GeeksforGeeks/"
# directory
dir = "Authors"
# path
path = os.path.join(location, dir)
# removing directory
shutil.rmtree(path, ignore_errors=False)
# making ignore_errors = True will not raise
# a FileNotFoundError
Output:
Traceback (most recent call last): File “D:/Pycharm projects/gfg/gfg.py”, line 16, in shutil.rmtree(path, ignore_errors=False) File “C:\Users\Nikhil Aggarwal\AppData\Local\Programs\Python\Python38-32\lib\shutil.py”, line 730, in rmtree return _rmtree_unsafe(path, onerror) File “C:\Users\Nikhil Aggarwal\AppData\Local\Programs\Python\Python38-32\lib\shutil.py”, line 589, in _rmtree_unsafe onerror(os.scandir, path, sys.exc_info()) File “C:\Users\Nikhil Aggarwal\AppData\Local\Programs\Python\Python38-32\lib\shutil.py”, line 586, in _rmtree_unsafe with os.scandir(path) as scandir_it: FileNotFoundError: [WinError 3] The system cannot find the path specified: ‘D:/Pycharm projects/GeeksforGeeks/Authors’
Example 4: Exception handler
In onerror a function should be passed which must contain three parameters.
- function – function which raised the exception.
- path – path name passed which raised the exception while removal
- excinfo – exception info raised by sys.exc_info()
import shutil
import os
# exception handler
def handler(func, path, exc_info):
print("Inside handler")
print(exc_info)
# location
location = "D:/Pycharm projects/GeeksforGeeks/"
# directory
dir = "Authors"
# path
path = os.path.join(location, dir)
# removing directory
shutil.rmtree(path, onerror=handler)
Output:
Inside handler (, FileNotFoundError(2, ‘The system cannot find the path specified’), ) Inside handler (, FileNotFoundError(2, ‘The system cannot find the file specified’), )
Deleting file/dir using the pathlib.Path(empty_dir_path).rmdir()
An empty directory can also be removed or deleted using the pathlib.path module method. First, we have to set the path for the directory, and then we call the rmdir() method on that path
Example: Delete an Empty Directory using rmdir()
In this example, we will delete an empty folder, we just need to specify the folder name if it is in the root Directory
import pathlib
# Deleting an empty folder
# Put your file address
empty_dir = r"Untitled Folder"
path = pathlib.Path(empty_dir).rmdir()
print("Deleted '%s' successfully" % empty_dir)
Output:
Deleted 'Untitled Folder' successfully
