Merge pull request #859 from visheshdvivedi/filesearch-branch

Add script to search files in the folder

Author: pawangeek

file_search/README.md

@@ -0,0 +1,32 @@
+# File Search
+
+Automation script to search any file/folder inside any directory within your computer
+
+Just run the following command to search
+```
+python filesearch.py "search_term" "path/to/folder"
+```
+
+To go through all the available options, type
+```
+python filesearch.py -h
+```
+
+You will get options like this:
+```
+usage: filesearch.py [-h] [-dc] [-f] [-nb] term dir      
+
+Search files within your computer
+
+positional arguments:
+  term                 Filename/Word to search for       
+  dir                  Directory where you want to search
+
+options:
+  -h, --help           show this help message and exit   
+  -dc, --disable-case  Perform case insensitive search   
+  -f, --folder         Search only folders (default: searches files)
+  -nb, --no-bar        Not show progress bar
+```
+
+##### Contributed By: [visheshdvivedi](https://github.com/visheshdvivedi)

file_search/filesearch.py

@@ -0,0 +1,145 @@
+import os
+import datetime
+import argparse
+from progress.bar import Bar
+
+
+class FileSearch:
+    def __init__(self):
+        self.file_count = 0
+        self.progress_bar = Bar('Searching', suffix='%(eta)ds')
+
+    def get_file_count(self, path, is_folder):
+
+        if not is_folder:
+            print("[INFO] Reading files ...")
+        else:
+            print("[INFO] Reading folders ...")
+
+        self.file_count = 0
+        for root, dirs, files in os.walk(path):
+            if is_folder:
+                self.file_count += len(dirs)
+            else:
+                self.file_count += len(files)
+
+    def __perform_search(
+        self,
+        search_term,
+        start_dir,
+        is_folder,
+        disable_case,
+        show_bar
+    ):
+        results = []
+        for root, dirs, files in os.walk(start_dir):
+            if is_folder:
+                for dir in dirs:
+
+                    if show_bar:
+                        self.progress_bar.next()
+
+                    if disable_case and search_term in dir:
+                        results.append(os.path.join(root, dir))
+                    elif not disable_case and search_term.lower() in dir.lower():
+                        results.append(os.path.join(root, dir))
+            else:
+                for file in files:
+
+                    if show_bar:
+                        self.progress_bar.next()
+
+                    if disable_case and search_term in file:
+                        results.append(os.path.join(root, file))
+                    elif not disable_case and search_term.lower() in file.lower():
+                        results.append(os.path.join(root, file))
+
+        return results
+
+    def search(
+        self,
+        search_term,
+        start_dir,
+        is_folder=False,
+        disable_case=False,
+        show_bar=True
+    ):
+        self.file_count = 0
+        self.get_file_count(start_dir, is_folder)
+        self.progress_bar.max = self.file_count
+
+        if not os.path.exists(start_dir):
+            raise Exception(f"Path {start_dir} does not exist.")
+
+        start_time = datetime.datetime.now()
+        result = self.__perform_search(
+            search_term,
+            start_dir,
+            is_folder,
+            disable_case,
+            show_bar
+        )
+        end_time = datetime.datetime.now()
+
+        if not is_folder:
+            print(
+                f"\n\n[INFO] Searched {self.file_count:,} files in {(end_time-start_time).total_seconds()} seconds")
+        else:
+            print(
+                f"\n\n[INFO] Searched {self.file_count:,} folders in {(end_time-start_time).total_seconds()} seconds")
+
+        return result
+
+
+if __name__ == "__main__":
+
+    parser = argparse.ArgumentParser(
+        description="Search files within your computer")
+
+    parser.add_argument(
+        "search-term",
+        metavar="term",
+        type=str,
+        help="Filename/Word to search for"
+    )
+    parser.add_argument(
+        "start-dir",
+        metavar="dir",
+        type=str,
+        help="Directory where you want to search"
+    )
+
+    parser.add_argument(
+        "-dc",
+        "--disable-case",
+        action="store_true",
+        help="Perform case insensitive search"
+    )
+    parser.add_argument(
+        "-f",
+        "--folder",
+        action="store_true",
+        help="Search only folders (default: searches files)"
+    )
+    parser.add_argument(
+        "-nb",
+        "--no-bar",
+        action="store_false",
+        help="Not show progress bar"
+    )
+
+    args = parser.parse_args().__dict__
+
+    searcher = FileSearch()
+    results = searcher.search(
+        args['search-term'],
+        args['start-dir'],
+        args['folder'],
+        args['disable_case'],
+        args['no_bar']
+    )
+
+    print("[INFO] Results: \n")
+    for path in results:
+        print("Path:", path)
+    print("")