Add fillGap

Author: thepushkarp

README.md

@@ -4,7 +4,7 @@
 
 ### Inspiration 💡
 
-Some of the programs in this repository are inspired from the projects given in [Automate the Boring Stuff with Python](https://automatetheboringstuff.com/) by [Al Sweigart](https://github.com/asweigart) and some other are born out of redundant curiosity of a boring mind during lazy afternoons.
+Many of the programs in this repository are inspired from the projects given in [Automate the Boring Stuff with Python](https://automatetheboringstuff.com/) by [Al Sweigart](https://github.com/asweigart) and some other are born out of redundant curiosity of a boring mind during lazy afternoons.
 
 This repository would contain python scripts, some of which might come of use occasionally. The purpose of creating this is to explore the various modules and implementations of the language through creating programs that are as much fun to use as they are to make.
 
@@ -42,7 +42,8 @@ pip install -r requirements.txt
 - Contents
 	- [Code Destroyer](#Code-Destroyer)
 	- [Phone Number and Email Extractor](#Phone-Number-and-Email-Extractor)
-	- [Search files based on Size](#Search-files-based-on-Size)
+	- [Search files based on size](#Search-files-based-on-size)
+	- [Fill gaps in naming](#Fill-gaps-in-naming)
 
 - [License](LICENSE)
 
@@ -74,7 +75,7 @@ python3 phoneAndEmail.py
 
 Two files, `emails.txt` and `phoneNumbers.txt` would be created in the same directory containing the emails and phone numbers from the copied text.
 
-### Search files based on Size
+### Search files based on size
 
 Lets you search through a folder based on file size. Asks user for folder path and size. Files and subfolders inside the folder, greater than or equal to the input size would be displayed.
 
@@ -86,6 +87,19 @@ python3 searchSize.py
 
 When prompted, enter the minimum size (in bytes) and the folder where files are to be searched. If the path entered is correct, the files, above and equal the size entered would be displayed.
 
+### Fill gaps in naming
+
+Finds all files with a given prefix, such as spam001.txt, spam002.txt, and so on, in a single folder and locates any gaps in the numbering (such as if there is a spam001.txt and spam003.txt but no spam002.txt) and reanames all the files to close this gap.
+
+#### Usage:
+
+```py3
+python3 fillGap.py
+```
+
+Enter the file prefix, extesion name and taret folder in the prompt that appears. The files would be named in
+order, closing gaps, if any.
+
 ---
 
 File Templates taken from [awesome-bashrc](https://github.com/aashutoshrathi/awesome-bashrc) and [HackerRank-Test-Case-Generator](https://github.com/aashutoshrathi/HackerRank-Test-Case-Generator/).

fillGap/fillGap.py

@@ -0,0 +1,66 @@
+"""
+fillGap.py - A program that finds all files with a given prefix,
+such as spam001.txt, spam002.txt, and so on, in a single folder
+and locates any gaps in the numbering (such as if there is a
+spam001.txt and spam003.txt but no spam002.txt) and reanames all the
+files to close this gap.
+
+Usage: run "python3 fillGap.py" and Enter the file prefix, estension
+and taret folder in the prompt that appears. The files would be named
+in order, closing gaps, if any.
+"""
+
+import os
+import sys
+import re
+from math import log
+import shutil
+
+# Input file/folder name and extension
+filename = input("Enter the name prefix for the files/folders\n")
+print("\nEnter the extension after the dot in filenames (like txt in spam01.txt)")
+print("Type \"folder\" (without the quotes) if the files are folders")
+ext = input()
+
+# Create filename regex
+if ext == 'folder':
+	nameSeq = re.compile(
+		r'^' + re.escape(filename) + r'\d*' + r'$'
+	)
+else:
+	nameSeq = re.compile(
+		r'^' + re.escape(filename) + r'\d*' +
+		r'[.]' + re.escape(ext) + r'$'
+	)
+
+# Put matching file/folder names in a list
+path = input("\nEnter the path of folder containing the file/folder\n")
+path = os.path.abspath(path)
+print(path)
+if not os.path.isdir(path):
+	print("The path entered is not a valid folder.")
+	sys.exit()
+else:
+	lst = []
+	for entry in os.listdir(path):
+		found = nameSeq.search(entry)
+		if found:
+			lst.append(found[0])
+
+# Sort list and take size of list as padding
+lst = sorted(lst)
+padding = int(log(len(lst))//log(10)) + 1
+
+# Rename files/folders
+for i in range(len(lst)):
+	if ext == 'folder':
+		newName = filename + str(i).rjust(padding, '0')
+		oldPath = os.path.join(path, lst[i])
+		newPath = os.path.join(path, newName)
+		shutil.move(oldPath, newPath)
+	else:
+		newName = filename + str(i).rjust(padding, '0') + '.' + ext
+		oldPath = os.path.join(path, lst[i])
+		newPath = os.path.join(path, newName)
+		shutil.move(oldPath, newPath)
+print("The files are renamed with gaps closed.")