Merge pull request #14 from InnoFang/dev

♻️ 🏗️ ✨ 🎨 Decoupling the CodeCounter and Visualization, and using searching progress bar to make the output more user-friendly

Author: InnoFang

code_counter/core/counter.py

@@ -5,11 +5,12 @@
 import asyncio
 from collections import defaultdict
 from code_counter.conf.config import Config
+from code_counter.core.visualization import GraphVisualization
 from code_counter.core.countable.iterator import CountableIterator, RemoteCountableIterator
+from code_counter.tools.progress import SearchingProgressBar
 
 
 class CodeCounter:
-
     def __init__(self):
         self.config = Config()
 
@@ -18,19 +19,9 @@ def __init__(self):
         self.total_blank_lines = 0
         self.total_comment_lines = 0
         self.files_of_language = defaultdict(int)
+        self.lines_of_language = defaultdict(int)
 
         self.args = None
-        self.lines_of_language = {}
-
-        self.result = {
-            'total': {
-                'code': 0,
-                'comment': 0,
-                'blank': 0,
-            },
-            'code': {},
-            'file': {}
-        }
 
     def setArgs(self, args):
         self.args = args
@@ -41,8 +32,6 @@ def setArgs(self, args):
         if args.ignore:
             self.config.ignore = set(args.ignore)
 
-        self.lines_of_language = {suffix: 0 for suffix in self.config.suffix}
-
     def search(self):
         if self.args is None:
             raise Exception('search_args is None, please invoke the `setArgs` function first.')
@@ -58,7 +47,11 @@ def search(self):
         if self.args.verbose:
             self.__print_searching_verbose_title(output_file)
 
+        progress_bar = SearchingProgressBar()
+        progress_bar.start()
         asyncio.run(self.__search(input_path, output_file))
+        progress_bar.stop()
+        progress_bar.join()
 
         self.__print_result_info(output_file)
 
@@ -118,73 +111,23 @@ def __print_result_info(self, output_file=None):
               file=output_file)
         print(file=output_file)
 
-        self.result['total']['code'] = self.total_code_lines
-        self.result['total']['blank'] = self.total_blank_lines
-        self.result['total']['comment'] = self.total_comment_lines
-
-        total_files = 0
-
-        for _, cnt in self.files_of_language.items():
-            total_files += cnt
+        total_files = sum(self.files_of_language.values())
 
         print("\t{:>10}  |{:>10}  |{:>10}  |{:>10}  |{:>10}"
               .format("Type", "Files", 'Ratio', 'Lines', 'Ratio'), file=output_file)
         print("\t{}".format('-' * 65), file=output_file)
 
-        for tp, cnt in self.files_of_language.items():
-            code_line = self.lines_of_language[tp]
-            self.result['code'][tp] = code_line
-            self.result['file'][tp] = cnt
+        for tp, file_count in self.files_of_language.items():
+            count_count = self.lines_of_language[tp]
             print("\t{:>10}  |{:>10}  |{:>10}  |{:>10}  |{:>10}".format(
-                tp, cnt, '%.2f%%' % (cnt / total_files * 100),
-                code_line, '%.2f%%' % (code_line / self.total_code_lines * 100)), file=output_file)
+                tp, file_count, '%.2f%%' % (file_count / total_files * 100),
+                count_count, '%.2f%%' % (count_count / self.total_code_lines * 100)), file=output_file)
 
     def visualize(self):
-        from matplotlib import pyplot as plt
-        from matplotlib import font_manager as fm
-        from matplotlib import cm
-        import numpy as np
-
-        plt.figure('Visualization of Statistical Results', figsize=(15, 6))
-
-        size = 0.3
-        wedgeprops = dict(width=0.3, edgecolor='w')
-        proptease = fm.FontProperties()
-
-        plt.subplot(121)
-        total_values = list(self.result['total'].values())
-        total_keys = list(self.result['total'].keys())
-        explode = np.array([0., 0., 0.])
-        explode[total_keys.index('code')] = 0.05
-        patches, l_text, p_text = plt.pie(total_values, labels=total_keys, autopct='%2.1f%%',
-                                          explode=explode, startangle=90)
-        proptease.set_size('x-large')
-        plt.setp(l_text, fontproperties=proptease)
-        plt.setp(p_text, fontproperties=proptease)
-        plt.axis('equal')
-        plt.title("Total Statistics")
-        plt.legend(title="Index", loc='best', bbox_to_anchor=(0, 1))
-
-        plt.subplot(122)
-        length = len(self.result['code'].values())
-        colors = cm.rainbow(np.arange(length) / length)
-        patches1, l_text1, p_text1 = plt.pie(list(self.result['code'].values()),
-                                             labels=list(self.result['code'].keys()), autopct='%2.1f%%', radius=1,
-                                             wedgeprops=wedgeprops, colors=colors, pctdistance=0.85, labeldistance=1.1)
-        patches2, l_text2, p_text2 = plt.pie(list(self.result['file'].values()),
-                                             labels=list(self.result['file'].keys()), autopct='%2.1f%%',
-                                             radius=1 - size,
-                                             wedgeprops=wedgeprops, colors=colors, pctdistance=0.8, labeldistance=0.4)
-        # font size include: ‘xx-small’,x-small’,'small’,'medium’,‘large’,‘x-large’,‘xx-large’ or number, e.g. '12'
-        proptease.set_size('x-large')
-        plt.setp(l_text1, fontproperties=proptease)
-        proptease.set_size('large')
-        plt.setp(p_text1, fontproperties=proptease)
-        proptease.set_size('medium')
-        plt.setp(p_text2, fontproperties=proptease)
-        proptease.set_size('small')
-        plt.setp(l_text2, fontproperties=proptease)
-        plt.axis('equal')
-        plt.title("Inner Pie: Code Files, Outer Pie: Code Lines")
-        plt.legend(list(self.result['code'].keys()), title="Abbreviation", loc='best', bbox_to_anchor=(1.05, 1))
-        plt.show()
+        gv = GraphVisualization(
+            total_code_lines=self.total_code_lines,
+            total_blank_lines=self.total_blank_lines,
+            total_comment_lines=self.total_comment_lines,
+            files_of_language=self.files_of_language,
+            lines_of_language=self.lines_of_language)
+        gv.visualize()

code_counter/core/visualization.py

@@ -0,0 +1,68 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8  -*-
+
+from matplotlib import pyplot as plt
+from matplotlib import font_manager as fm
+from matplotlib import cm
+import numpy as np
+from collections import defaultdict
+
+
+class GraphVisualization:
+    def __init__(self, total_code_lines=0, total_blank_lines=0, total_comment_lines=0,
+                 files_of_language=defaultdict(int), lines_of_language=defaultdict(int)):
+        self.total_code_lines = total_code_lines
+        self.total_blank_lines = total_blank_lines
+        self.total_comment_lines = total_comment_lines
+        self.code_type_count = defaultdict(int)
+        self.file_type_count = defaultdict(int)
+
+        for tp, file_count in files_of_language.items():
+            count_count = lines_of_language[tp]
+            self.code_type_count[tp] = count_count
+            self.file_type_count[tp] = file_count
+
+    def visualize(self):
+        plt.figure('Visualization of Statistical Results', figsize=(15, 6))
+
+        size = 0.3
+        wedgeprops = dict(width=0.3, edgecolor='w')
+        proptease = fm.FontProperties()
+
+        plt.subplot(121)
+        total_keys = ['Code', 'Blank', 'Comment']
+        total_values = [self.total_code_lines, self.total_blank_lines, self.total_comment_lines]
+        explode = np.array([0., 0., 0.])
+        explode[0] = 0.05  # Offset the label `Code` outward a little
+        patches, l_text, p_text = plt.pie(total_values, labels=total_keys, autopct='%2.1f%%',
+                                          explode=explode, startangle=90)
+        proptease.set_size('x-large')
+        plt.setp(l_text, fontproperties=proptease)
+        plt.setp(p_text, fontproperties=proptease)
+        plt.axis('equal')
+        plt.title("Total Statistics")
+        plt.legend(title="Index", loc='best', bbox_to_anchor=(0, 1))
+
+        plt.subplot(122)
+        length = len(self.code_type_count)
+        colors = cm.rainbow(np.arange(length) / length)
+        patches1, l_text1, p_text1 = plt.pie(list(self.code_type_count.values()),
+                                             labels=list(self.code_type_count.keys()), autopct='%2.1f%%', radius=1,
+                                             wedgeprops=wedgeprops, colors=colors, pctdistance=0.85, labeldistance=1.1)
+        patches2, l_text2, p_text2 = plt.pie(list(self.file_type_count.values()),
+                                             labels=list(self.file_type_count.keys()), autopct='%2.1f%%',
+                                             radius=1 - size,
+                                             wedgeprops=wedgeprops, colors=colors, pctdistance=0.8, labeldistance=0.4)
+        # font size include: ‘xx-small’,x-small’,'small’,'medium’,‘large’,‘x-large’,‘xx-large’ or number, e.g. '12'
+        proptease.set_size('x-large')
+        plt.setp(l_text1, fontproperties=proptease)
+        proptease.set_size('large')
+        plt.setp(p_text1, fontproperties=proptease)
+        proptease.set_size('medium')
+        plt.setp(p_text2, fontproperties=proptease)
+        proptease.set_size('small')
+        plt.setp(l_text2, fontproperties=proptease)
+        plt.axis('equal')
+        plt.title("Inner Pie: Code Files, Outer Pie: Code Lines")
+        plt.legend(list(self.code_type_count.keys()), title="Abbreviation", loc='best', bbox_to_anchor=(1.05, 1))
+        plt.show()

code_counter/tools/progress.py

@@ -0,0 +1,45 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8  -*-
+
+import threading
+import sys
+import time
+
+
+class SearchingProgressBar(threading.Thread):
+    __LEN__ = 10
+
+    def __init__(self):
+        super(SearchingProgressBar, self).__init__()
+        self.daemon = True
+        self._stop_event = threading.Event()
+
+    def stop(self):
+        self._stop_event.set()
+
+    def stopped(self):
+        return self._stop_event.is_set()
+
+    def __clear(self):
+        sys.stdout.write("\r")
+        sys.stdout.write("   " * self.__LEN__)
+        sys.stdout.write("\r")
+        sys.stdout.flush()
+
+    def run(self):
+        while True:
+            progress = "searching "
+            for i in range(self.__LEN__):
+                if self.stopped():
+                    self.__clear()
+                    return
+                time.sleep(0.1)
+                sys.stdout.write("\r")
+                progress += " ."
+                sys.stdout.write(progress)
+                sys.stdout.flush()
+                sys.stdout.write("\r")
+            sys.stdout.write("\r")
+            sys.stdout.write("searching " + "  " * self.__LEN__)
+            sys.stdout.write("\r")
+            sys.stdout.flush()