Python os remove permission error

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. 

Output: 

Example 2: Remove file with absolute path

If the specified path is a directory. 

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.

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.

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. 

Output: 

Example 2: Error Handling while deleting a directory

Handling errors while using os.rmdir() method, 

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. 

Output: 

Example 2: Ignore error while deleting a directory

By passing ignore_errors = True. 

Output:

Traceback (most recent call last): File “D:/Pycharm projects/gfg/gfg.py”, line 16, in shutil.rmtree(path, ignore_errors=False) File “C:UsersNikhil AggarwalAppDataLocalProgramsPythonPython38-32libshutil.py”, line 730, in rmtree return _rmtree_unsafe(path, onerror) File “C:UsersNikhil AggarwalAppDataLocalProgramsPythonPython38-32libshutil.py”, line 589, in _rmtree_unsafe onerror(os.scandir, path, sys.exc_info()) File “C:UsersNikhil AggarwalAppDataLocalProgramsPythonPython38-32libshutil.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 

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 to set the path for the directory, and then we call 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

Output:

Deleted 'Untitled Folder' successfully

You can delete files from your computer using Python. The os.remove() method deletes single Python files. os.rmdir() removes a file or a directory. The shutil.rmtree() method will delete a directory and the files contained in it.

Developers use files in Python programs for a wide array of purposes. When you’re working with files, one of the most crucial functions you need to know about is how to delete a file.

For instance, let’s say you’re creating a program that analyzes the performance of the S&P 500 index and stores the results in a file. You may want to delete any existing analysis files to make room for the new file.

In Python, you can use the os.remove() method to remove files, and the os.rmdir() method to delete an empty folder. If you want to delete a folder with all of its files, you can use the shutil.rmtree() method.

This tutorial will discuss how to remove Python files and folders using os.remove(), os.rmdir(), and shutil.rmtree(). We’ll also go through an example of each of these methods being used to delete a file or folder.

Python Delete File Tutorial

You can delete files using the Python os.remove(), os.rmdir(), and shutil.rmtree() method. These methods remove a file, a directory, and a folder with all of its files, respectively.

How to Delete a File in Python Using os.remove()

The Python os.remove() method deletes a file from your operating system. os.remove() only deletes a single file. It cannot delete a directory.

The os module allows developers to interface with the operating and file systems of a computer. os.remove() is a method included in the Python os module that allows you to delete an individual file.

Before we start working with these methods, we need to import the os library using a Python import statement.

The os library facilitates interactions with the operating system in Python. We can do so using the following code:

Now we’re ready to start removing files in Python the os.remove() module in Python. Let’s look at the syntax for the os.remove() path method:

import os

os.remove(file_location)

The os.remove() method takes one parameter: the location of the file you want to delete.

Let’s say we are creating a program that analyzes the grades earned by students in a math class over the course of a year.

We want to create a file called /home/school/math/final_analysis.csv with our analyzed data. But, before our program creates that file, we first need to make sure it does not already exist.

We could use the following code to remove this file:

import os

path = "/home/school/math/final_analysis.csv"

os.remove(path)

print("final_analysis.csv has been deleted.")

Our file has been removed. We printed the following message has been printed to the console using a Python print() statement:

final_analysis.csv has been deleted.

On the first line, we import the os module, which contains the os.remove() method that we want to reference in our program. Then, we define a Python variable called path. This variable stores the file path for the file we want to remove.

We then use os.remove() and specify our path variable as the file path, which will remove our file.

Delete Empty Directory Using Python os.rmdir()

The os.remove() method cannot be used to delete a folder. Instead, we can use the os.rmdir() method. The os.rmdir() method is used to delete an empty file or directory.

os.rmdir() accepts one parameter: the path of the file you want to delete. Here’s the syntax for the os.rmdir() method:

import os

os.rmdir(file_path)

Let’s say that we have decided to store our processed data in a folder called final within our /home/school/math directory. Every time we run our program, we want to remove the final folder directory. This is because our program will create a new one with the processed data.

We could use the following code to remove the final folder:

import os

path = "/home/school/math/final"

os.rmdir(path)

print("/home/school/math/final has been deleted.")

Our code deletes the directory /home/school/math/final and returns the following message to the console:

/home/school/math/final has been deleted.

The os.rmdir() method can only be used to delete an empty directory. If you specify a folder that contains files, the following error will be returned:

[Errno 13] Permission denied: '/home/school/math/final' Directory 'final' can not be removed

Python os Error Handling

In the above examples, we have stated that, in some cases, a permission error can be returned by an argument. If we use os.remove() to remove a directory, an error will be returned. If we use os.rmdir() to remove a directory that contains files, an error will be returned.

When you’re deleting files in a program, you may want to have a function that handles your errors gracefully if an error arises. We can do this using a try except block.

Here’s our example of the os.rmdir() method above, but with an error-handling mechanism that will print a predefined message if exceptions are raised:

import os

path = "/home/school/math/final"

try:
	os.rmdir(path)
	print("/home/school/math/final has been deleted.")
except OSError as error:
	print("There was an error.")

Now, if we run our code and no error is returned, our directory will be removed and the following message will be returned:

/home/school/math/final has been deleted.

However, if we run our code and try to remove a directory that contains files, for example, the following message will be returned:

In our code, we used a try except block. This procedure first runs the lines of code within the try block. If an error is encountered, it will run the code within the except block. In this case, the except block will only be executed if an OSError is raised.

If you want to learn more about error handling using try except blocks in Python, read our tutorial on Python try except.

Delete File Python with Directories

The shutil library includes a method called shutil.rmtree() that can be used to remove a directory that contains files.

The shutil library offers a number of functions related to file operations. In our case, we want to focus on the shutil.rmtree() method, which removes an entire directory tree.

Here’s the syntax for the shutil.rmtree() method:

import shutil

shutil.rmtree(file_path)

Notice that we have imported the shutil module in our code. That is because shutil.rmtree() is part of an external library, like os.remove(), so we need to import the library before we can use it.

Let’s walk through an example to show how this method can be used. Say that our grade analysis program needs to remove the directory final, but that directory already includes files with our processed data. To remove the directory and all of its files, we could use the following code:

import shutil

path = "/home/school/math/final"

shutil.rmtree(path)

print("/home/school/math/final has been removed.")

Our code removes the folder final and all its contents, then prints the following message to the console:

/home/school/math/final has been removed.

Conclusion

Removing files is a common operation in Python. The os.remove() method can be used to delete a specific file, and the os.rmdir() method can be used to remove an empty directory. In addition, you can use the shutil.rmtree() method to delete a folder that contains one or more files.

To learn more about coding in Python, read our complete guide on How to Learn Python.