new param, refactored

Author: LordAmit

tex_writing_issues/argument_handler.py

@@ -1,50 +1,45 @@
 import argparse
 import custom_log as l
 
+_dir_path: str = None
 _file_path: str = None
-_keyword: str = None
-
-def get_path() -> str:
-    global _file_path
-    if _file_path:
-        return _file_path
-    else:
-        _get_arguments()
-        return _file_path
 
 
-def get_keyword() -> str:
-    global _keyword
-    if _keyword:
-        return _keyword
+def get_dir_path() -> str:
+    global _dir_path
+    if _dir_path:
+        return _dir_path
     else:
         _get_arguments()
-        return _keyword
+        return _dir_path
 
 
-def get_print_line() -> bool:
-    global _print_line
-    if _print_line:
-        return _print_line
+def get_file_path() -> str:
+    global _file_path
+    if _file_path:
+        return _file_path
     else:
         _get_arguments()
-        return _print_line
+        return _file_path
 
 
 def _get_arguments():
     l.log("parsing arguments")
+    global _dir_path
     global _file_path
-    global _keyword
-    global _ext
-    global _print_line
-
     parser = argparse.ArgumentParser()
 
     parser.add_argument('--path',
-                        type=str, help='address from where tex files will be scanned',
-                        required=True)
+                        type=str, help='address from where tex files will be scanned')
+    parser.add_argument('--file',
+                        type=str, help='address of tex file')
 
     args = parser.parse_args()
+    if args.path:
+        _dir_path = args.path
+        l.log("dir path: " + _dir_path)
+    if args.file:
+        _file_path = args.file
+        l.log("file path: " + _file_path)
+
 
-    _file_path = args.path
-    l.log("path: "+_file_path)

tex_writing_issues/folder_walk.py

@@ -12,7 +12,7 @@ def walk() -> List:
     :return: List of string path of images
     """
     file_paths = []
-    path: str = argh.get_path()
+    path: str = argh.get_dir_path()
     l.log(path)
     l.log("checking path integrity")
     extension: str = ".tex"

tex_writing_issues/line_checker.py

@@ -20,9 +20,8 @@ def check_line(line: str, rules_packs: List):
             regex = re.compile(r"\b{}\b".format(keyword))
             if len(regex.findall(line)) != 0:
                 print("""
-                issue found: {}
+                issue type: {}, issue: {} 
                 line: {}
-                issue: {}
-                replace with: {}""".format(rule_name, line, keyword, rule[1:]))
-                count_issues+=1
+                replace with: {}""".format(rule_name, keyword, line, rule[1:]))
+                count_issues += 1
     return count_issues

tex_writing_issues/main.py

@@ -14,26 +14,34 @@ def will_i_process_line(line: str) -> bool:
         return True
 
 
+def process_file(file_path: str, all_rules: List):
+    count_issues: int = 0
+    print("at file: " + file_path)
+    lines: List[str] = open(file_path).readlines()
+    for line in lines:
+        if will_i_process_line(line):
+            line_issues = line_checker.check_line(line, all_rules)
+            count_issues += line_issues
+    print("done with: " + file_path)
+    print("total issues found: " + str(count_issues))
+
+
 if __name__ == '__main__':
     import folder_walk as walk
     import argument_handler as argh
     from typing import List
 
     l.disable()
-
-    keyword = argh.get_keyword()
-    l.log("started parsing directories")
-    file_paths: List[str] = walk.walk()
-    l.log("will start scanning files now.")
     all_rules = rule_builder.get_rules()
-
-    for file_path in file_paths:
-        count_issues: int = 0
-        print("at file: " + file_path)
-        lines: List[str] = open(file_path).readlines()
-        for line in lines:
-            if will_i_process_line(line):
-                line_issues = line_checker.check_line(line, all_rules)
-                count_issues += line_issues
-        print("done with: " + file_path)
-        print("total issues found: " + str(count_issues))
+    if argh.get_file_path() is not None:
+        print("single file given : "+argh.get_file_path())
+        l.log("single file input")
+        process_file(argh.get_file_path(), all_rules)
+    elif argh.get_dir_path() is not None:
+        l.log("directory is given. scanning files from directory")
+        file_paths: List[str] = walk.walk()
+        for file_path in file_paths:
+            process_file(file_path, all_rules)
+            print()
+    else:
+        print("neither path nor file was declared. Run with -h switch for help")

tex_writing_issues/rule_builder.py

@@ -13,7 +13,6 @@ def _build_rules(rule_names: List) -> List:
     path_rules = "/home/amit/git/automating-boring-tasks-using-python/tex_writing_issues/"
     all_rules: List = []
     for rule_name in rule_names:
-
         l.log("working with rule: " + rule_name)
         f_rule = path_rules + "words_" + rule_name
         l.log("rule file name: " + f_rule)