Delete a directory or file using Python - GeeksforGeeks (2024)

Table of Contents

Deleting file/dir using the os.remove() method Syntax of os.remove() Python3 Python3 Python3 Deleting file/dir using the os.rmdir() method Syntax of os.rmdir() Python3 Python3 Deleting file/dir using the shutil.rmtree() Syntax of shutil.rmtree() Delete a directory and the files contained in it. Python3 Python3 Python3 Deleting file/dir using the pathlib.Path(empty_dir_path).rmdir() Syntax of pathlib.Path Python3 Please Login to comment... FAQs References

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.

Various methods provided by Python are –

Using os.remove()
Using os.rmdir()
Using shutil.rmtree()
Using pathlib.Path(empty_dir_path).rmdir()

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 is used to remove or delete 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.

Syntax of os.remove()

Syntax: os.remove(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.

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.

Python3

# Python program to explain os.remove() method

# 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.

Python3

# 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.

Python3

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.

Syntax of os.rmdir()

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.

Example 1: Delete all directories from a Directory

Suppose the directories are –

We want to remove the directory Geeks. Below is the implementation.

Python3

# 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,

Python3

# 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() is used to delete an entire directory tree, a path must point to a directory (but not a symbolic link to a directory).

Syntax of shutil.rmtree()

Syntax: shutil.rmtree(path, ignore_errors=False, onerror=None)
Parameters:
path: A path-like object representing a file path. A path-like object is either a string or bytes object representing a path.
ignore_errors: If ignore_errors is true, errors resulting from failed removals will be ignored.
onerror: If ignore_errors is false or omitted, such errors are handled by calling a handler specified by onerror.

Delete a directory and the files contained in it.

Example 1:

Suppose the directory and sub-directories are as follow.

# Parent directory:

# Directory inside parent directory:

# File inside the sub-directory:

Example: Delete all Files from a Directory

We want to remove the directory Authors. Below is the implementation.

Python3

# Python program to demonstrate

# shutil.rmtree()

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)

Output:

Example 2: Ignore error while deleting a directory

By passing ignore_errors = True.

Python3

# Python program to demonstrate

# shutil.rmtree()

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 3: 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()

Below is the implementation

Python3

# Python program to demonstrate

# shutil.rmtree()

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 module’s rmdir() method. First, we have toset the path for the directory, and then wecall the rmdir() method on that path

Syntax of pathlib.Path

Syntax: pathlib.Path(empty_dir_path).rmdir()
Parameter:
empty_dir_path: A path-like object representing a empty directory path. A path-like object is either a string or bytes object representing a path.
Return Type: This method does not return any value.

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

Python3

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

nikhilaggarwal3

Improve

How to Change the Owner of a Directory Using Python

Please Login to comment...

FAQs

Delete a directory or file using Python - GeeksforGeeks? ›

Deleting file/dir using the os.

How do you delete a file directory in Python? ›

to delete a directory:

import shutil.
# Specify the path of the directory to be deleted.
directory_path = '/path/to/directory'
# Check if the directory exists before attempting to delete it.
if os.path. exists(directory_path):
shutil. rmtree(directory_path)
print(f"The directory {directory_path} has been deleted.")
else:

More items...

Nov 22, 2023

Keep Reading ›

How do you remove a directory if it exists in Python? ›

rmdir() The Python . rmdir() method allows the user to delete a folder if it exists in the system or computer and does not contain other folders or files. Note: A FileNotFoundError is raised if the directory is not found.

How do I remove a directory structure in Python? ›

Delete an entire directory tree using Python | shutil. rmtree() method

Syntax: shutil.rmtree(path, ignore_errors=False, onerror=None)
Parameters:
path: A path-like object representing a file path. ...
ignore_errors: If ignore_errors is true, errors resulting from failed removals will be ignored.

More items...

Jul 5, 2021

Discover More ›

How do you delete a folder and subfolders in Python? ›

To delete a folder that has subfolders and files in it, you have to delete all the files first, then call os. rmdir() or path. rmdir() on the now empty folder.

View Details ›

How do I delete a directory file? ›

Deleting or removing directories (rmdir command)

To empty and remove a directory, type the following: rm mydir/* mydir/.* rmdir mydir. ...
To remove the /tmp/jones/demo/mydir directory and all the directories beneath it, type the following: cd /tmp rmdir -p jones/demo/mydir.

Get More Info ›

What is the fastest way to delete directory Python? ›

We can use functions from Python's built-in os module to delete files and empty folders.

os. remove() will delete a file.
os. rmdir() will delete an empty folder.

Apr 15, 2023

View Details ›

Which method will remove the directory path in Python? ›

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.

Get More Info ›

How to use delete in Python? ›

Python del Keyword

ExampleGet your own Python Server. Delete an object: class MyClass: name = "John" del MyClass. print(MyClass) ...
Example. Delete a variable: x = "hello" del x. print(x) Try it Yourself »
Example. Delete the first item in a list: x = ["apple", "banana", "cherry"] del x[0] print(x) Try it Yourself »

Get More Info Here ›

How do you check if a directory exists or not Python? ›

How to check if a file or directory exists in Python

try: f = open("filename.txt") except FileNotFoundError: # doesn't exist else: # exists.
import os if os. path. ...
from pathlib import Path my_file = Path("/path/to/file")
if my_file. is_file(): # file exists if my_file.

What is the difference between a file and a folder? ›

A file is the common storage unit in a computer, and all programs and data are "written" into a file and "read" from a file. A folder holds one or more files, and a folder can be empty until it is filled. A folder can also contain other folders, and there can be many levels of folders within folders.

See Details ›

How do you delete a non-empty directory in Python? ›

How to Delete a Non-Empty Directory in Python Using the “shutil” Module. The shutil. rmtree() function is used to delete a non-empty directory and all its contents recursively.

Discover More Details ›

How to check if a file exists in Python? ›

We use the is_file() function, which is part of the Path class from the pathlib module, or exists() function, which is part of the os. path module, in order to check if a file exists or not in Python.

Keep Reading ›

How do I delete a file in Python? ›

One of the most straightforward ways to delete a file in Python is by using the os module's remove() function. This method is concise and well-suited for simple file deletion tasks.