In this ultimate tutorial, we are going to discuss how to remove files from a directory based on a matching pattern or wildcard, or specific extensions.
- How to delete text files using different techniques?
- Remove files by pattern using glob.glob() & os.remove()
- Get the list of files using glob.glob()
- Recursively Remove files by matching pattern or wildcard
- Recursively Remove files by matching pattern or wildcard using os.walk()
How to delete text files using different techniques?
Let’s discuss how to delete text files using different techniques, Suppose we have a directory that contains some log files and some text files and we want to delete all .txt files from that directory.
Then, continue your read so that you can successfully learn to remove files by matching patterns or wildcards by the following methods and techniques.
Remove files by pattern using glob.glob() & os.remove()
First, we will get a list of all file paths that match the specified patterns using glob.glob() and then delete all text files.
import os import glob # Get a list of all the file paths that ends with .txt from in specified directory fileList = glob.glob('C://Users/HP/Desktop/A plus topper/*.txt') # Iterate over the list of filepaths & remove each file. for filePath in fileList: try: os.remove(filePath) except: print("Error while deleting file : ", filePath)
So you can see that it will remove all ‘.txt’ files in the directory ‘C:\\Users\HP\Desktop\A plus topper\*.txt’. It will remove all text files because we mention” *.txt “.
Get the list of files using glob.glob()
glob.glob() accepts path name and finds the path of all the files that match the specified pattern. By default recursive parameter is False, which means that it will find files in the main directory, not in a subdirectory.
glob.glob(pathname, *, recursive=False)
As we have seen by this approach we can not recursively delete files from subdirectories. For that, we will find another solution,
Read More:
- Python: How to convert a timestamp string to a datetime object using datetime.strptime()
- How to get first key in Dictionary – Python
Recursively Remove files by matching pattern or wildcard
It will search all the ‘txt’ files including files in subdirectories because we will use 'C://Users/HP/Desktop/A plus topper/**/*.txt'
‘ **Â ‘ in it.
Then we can iterate over the list and delete each file one by one using os.remove().
import os import glob # get a recursive list of file paths that matches pattern including sub directories fileList = glob.glob('C://Users/HP/Desktop/A plus topper/**/*.txt', recursive=True) # Iterate over the list of filepaths & remove each file. for filePath in fileList: try: os.remove(filePath) except OSError: print("Error while deleting file")
It will delete all the text files from the directory and its sub-directories.
Recursively Remove files by matching pattern or wildcard using os.walk()
In this, we are going to use os.walk(). It generates filename in the given directory by walking over the tree structure in a top-down or bottom-up approach.
os.walk(top, topdown=True, onerror=None, followlinks=False)
It will return a tuple consisting of the main directory, a list of all subdirectories, and a list of all file names in the main directory.
Let’s use this os.walk() to get a list of all files in a given directory that matches a pattern. Then delete those files,
import os import fnmatch # Get a list of all files in directory for rootDir, subdirs, filenames in os.walk('C://HP/Users/Desktop/A plus topper'): # Find the files that matches the given patterm for filename in fnmatch.filter(filenames, '*.txt'): try: os.remove(os.path.join(rootDir, filename)) except OSError: print("Error while deleting file")
It will delete all the text files from the directory and also from its subdirectories.
Now we are going to create a Generic function to delete all the files from a given directory based on a matching pattern and it will also return the names of the files that were not deleted due to some error.
import os import fnmatch ''' Generic function to delete all the files from a given directory based on matching pattern ''' def removeFilesByMatchingPattern(dirPath, pattern): listOfFilesWithError = [] for parentDir, dirnames, filenames in os.walk(dirPath): for filename in fnmatch.filter(filenames, pattern): try: os.remove(os.path.join(parentDir, filename)) except: print("Error while deleting file : ", os.path.join(parentDir, filename)) listOfFilesWithError.append(os.path.join(parentDir, filename)) return listOfFilesWithError listOfErrors = removeFilesByMatchingPattern('/home/varung/Documents/python/logs/', '*.txt') print('Files that can not be deleted : ') for filePath in listOfErrors: print(filePath)
So in the above code, you can see that it will also return file names that can not be deleted.
Conclusion:
In this article, we have seen how to remove files from a directory based on matching patterns or wildcards, or certain extensions.