Add progress bar

The dumps I'm looking at take close to a minute to process, so I think
a progress bar is nice here. Disable with -q.

Sem-Ver: feature

Signed-off-by: Zack Cerza <[email protected]>

Author: zmc

must_triage/cmd.py

@@ -4,11 +4,13 @@
 
 from must_triage import formatters
 from must_triage import inspectors
+from must_triage.progress import ProgressBar
 
 
 def parse_args():
     parser = argparse.ArgumentParser()
     parser.add_argument('path', type=dir_or_file)
+    parser.add_argument('-q', '--quiet', action='store_true')
     return parser.parse_args()
 
 
@@ -23,7 +25,10 @@ def main():
     args = parse_args()
     interests = dict()
     for inspector_cls in inspectors.all():
-        inspector = inspector_cls(root=args.path)
+        inspector_args = dict(root=args.path)
+        if not args.quiet:
+            inspector_args['progress_class'] = ProgressBar
+        inspector = inspector_cls(**inspector_args)
         inspectors.merge_interests(interests, inspector.inspect())
 
     print(json.dumps(interests, indent=2, default=formatters.json_serialize))

must_triage/inspectors/base.py

@@ -0,0 +1,10 @@
+from must_triage.progress import NoProgress
+
+
+class Inspector:
+    def __init__(self, root, progress_class=NoProgress):
+        self.root = root
+        self._progress_class = progress_class
+
+    def inspect(self):
+        raise NotImplementedError

must_triage/inspectors/ocp.py

@@ -3,20 +3,21 @@
 import must_triage.fs as fs
 import must_triage.inspectors as inspectors
 
+from must_triage.inspectors.base import Inspector
 
-class OCP:
-    def __init__(self, root):
-        self.root = root
 
+class OCP(Inspector):
     def inspect(self):
         self.interests = dict()
         yamls = fs.find(self.root, lambda p: fs.has_ext(p, ['.yaml', '.yml']))
         inspectors.merge_interests(self.interests, self.inspect_yamls(yamls))
         return self.interests
 
     def inspect_yamls(self, paths):
+        if not paths:
+            return dict()
         interests = dict()
-        for path in paths:
+        for path in self._progress_class("Reading OCP files").iter(paths):
             interests[path] = list()
             with open(path) as fd:
                 try:

must_triage/inspectors/ocs.py

@@ -5,11 +5,10 @@
 import must_triage.fs as fs
 import must_triage.inspectors as inspectors
 
+from must_triage.inspectors.base import Inspector
 
-class OCS:
-    def __init__(self, root):
-        self.root = root
 
+class OCS(Inspector):
     def inspect(self):
         self.interests = dict()
         jsons = fs.find(
@@ -20,8 +19,10 @@ def inspect(self):
         return self.interests
 
     def inspect_jsons(self, paths):
+        if not paths:
+            return dict()
         interests = dict()
-        for path in paths:
+        for path in self._progress_class("Reading OCS files").iter(paths):
             interests[path] = list()
             if os.stat(path).st_size == 0:
                 interests[path].append("File is empty")

must_triage/progress.py

@@ -0,0 +1,26 @@
+import progress.bar
+
+
+class NoProgress:
+    def __init__(self, *args, **kwargs):
+        pass
+
+    def __enter__(self):
+        return self
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        pass
+
+    def next(self):
+        pass
+
+    def iter(self, it):
+        for x in it:
+            yield x
+
+    def finish(self):
+        pass
+
+
+class ProgressBar(progress.bar.IncrementalBar):
+    suffix = "%(index)d/%(max)d %(elapsed_td)s"

requirements.txt

@@ -1 +1,2 @@
 PyYAML
+progress