Merge pull request #6 from InnoFang/dev

♻️ 🎨 refactor, optimize and format a lot

Author: InnoFang

code_counter/__main__.py

@@ -2,23 +2,22 @@
 # coding:utf8
 
 import time
-from code_counter.core.codecounter import CodeCounter
-from code_counter.core.argspaser import CodeCounterArgsParser
+from code_counter.core.counter import CodeCounter
+from code_counter.core.args import CodeCounterArgs
 from code_counter.conf.config import Config
 
 
 def main():
-    parser = CodeCounterArgsParser()
-    args = parser.args
+    args = CodeCounterArgs()
 
     config = Config()
-    if 'config' in parser.args:
-        config.invoke(args['config'])
+    if args.has_config_args():
+        config.invoke(args.config())
         return
 
     code_counter = CodeCounter(config)
 
-    search_args = args['search']
+    search_args = args.search()
     code_counter.setSearchArgs(search_args)
 
     time_start = time.time()

code_counter/core/argspaser.py code_counter/core/args.pycode_counter/core/argspaser.py renamed to code_counter/core/args.py

@@ -10,11 +10,16 @@ def split_args(args):
     return list(args.split(','))
 
 
-class CodeCounterArgsParser:
+class CodeCounterArgs:
+    __SEARCH__ = 'search'
+    __CONFIG__ = 'config'
+
     def __init__(self):
-        parser = argparse.ArgumentParser(prog="code-counter",
-                                         description="A command-line interface (CLI) utility that can help you easily count code and display detailed results.",
-                                         usage="""cocnt <command> [<args>]
+        parser = argparse.ArgumentParser(
+            prog="code-counter",
+            description="A command-line interface (CLI) utility "
+                        "that can help you easily count code and display detailed results.",
+            usage="""cocnt <command> [<args>]
 These are common Code-Counter commands used in various situations:
     search     Search code in the given path(s)
     config     Configure Code-Counter
@@ -27,13 +32,36 @@ def __init__(self):
             print("Unrecognized command")
             parser.print_help()
             exit(1)
-        self.args = {args.command: getattr(self, args.command)()}
+        self.__args = {args.command: argparse.Namespace()}
+        getattr(self, args.command)()
+
+    def has_search_args(self):
+        return self.__SEARCH__ in self.__args
+
+    def has_config_args(self):
+        return self.__CONFIG__ in self.__args
 
     def search(self):
+        if not self.has_search_args():
+            return None
+        if self.__args[self.__SEARCH__] == argparse.Namespace():
+            self.__args[self.__SEARCH__] = self.__search()
+        return self.__args[self.__SEARCH__]
+
+    def config(self):
+        if not self.has_config_args():
+            return None
+        if self.__args[self.__CONFIG__] == argparse.Namespace():
+            self.__args[self.__CONFIG__] = self.__config()
+        return self.__args[self.__CONFIG__]
+
+    def __search(self):
         parser = argparse.ArgumentParser(
-            description="Search code in the given path(s)")
+            description="Search code in the given path(s)",
+            usage="cocnt search input_path [-h] [-v] [-g] "
+                  "[-o OUTPUT_PATH] [--suffix SUFFIX] [--comment COMMENT] [--ignore IGNORE]")
         parser.add_argument('input_path', type=split_args,
-                            help="specify a file or directory path you want to count or use CONFIG placeholder to configure")
+                            help="counting the code lines according the given path(s)")
         parser.add_argument('-v', '--verbose', dest="verbose", action='store_true',
                             help="show verbose infomation")
         parser.add_argument('-g', '--graph', dest='graph', action='store_true',
@@ -43,14 +71,21 @@ def search(self):
         parser.add_argument('--suffix', dest='suffix', type=split_args,
                             help="what code files do you want to count, this parameter is disposable")
         parser.add_argument('--comment', dest='comment', type=split_args,
-                            help="the comment symbol, which can be judged whether the current line is a comment, this parameter is disposable")
+                            help="the comment symbol, which can be judged whether the current line is a comment, "
+                                 "this parameter is disposable")
         parser.add_argument('--ignore', dest='ignore', type=split_args,
-                            help="ignore some directories or files that you don't want to count, this parameter is disposable")
+                            help="ignore some directories or files that you don't want to count, "
+                                 "this parameter is disposable")
         return parser.parse_args(sys.argv[2:])
 
-    def config(self):
-        parser = argparse.ArgumentParser(prog="code-counter",
-                                         description="A command-line interface (CLI) utility that can help you easily count code and display detailed results.")
+    def __config(self):
+        parser = argparse.ArgumentParser(
+            prog="code-counter",
+            description="configure code-counter",
+            usage="cocnt config [-h] [--list] [--suffix-reset SUFFIX_RESET] "
+                  "[--suffix-add SUFFIX_ADD] [--comment-reset COMMENT_RESET] "
+                  "[--comment-add COMMENT_ADD] [--ignore-reset IGNORE_RESET] "
+                  "[--ignore-add IGNORE_ADD] [--restore] ")
         parser.add_argument('--list', dest='show_list', action='store_true',
                             help="list all variables set in config file, along with their values")
         parser.add_argument('--suffix-reset', dest='suffix_reset', type=split_args,
@@ -61,12 +96,15 @@ def config(self):
         parser.add_argument('--comment-reset', dest='comment_reset', type=split_args,
                             help="override 'comment' in config and count comment lines according to this value")
         parser.add_argument('--comment-add', dest='comment_add', type=split_args,
-                            help="append new value for 'comment' in config and count comment lines according to this value")
+                            help="append new value for 'comment' in config "
+                                 "and count comment lines according to this value")
 
         parser.add_argument('--ignore-reset', dest='ignore_reset', type=split_args,
-                            help="override 'ignore' in config and ignore some files or directory according to this value")
+                            help="override 'ignore' in config "
+                                 "and ignore some files or directory according to this value")
         parser.add_argument('--ignore-add', dest='ignore_add', type=split_args,
-                            help="append new value for 'ignore' in config and ignore some files or directory according to this value")
+                            help="append new value for 'ignore' in config "
+                                 "and ignore some files or directory according to this value")
 
         parser.add_argument('--restore', dest='restore', action='store_true',
                             help="restore default config")

code_counter/core/codecounter.py code_counter/core/counter.pycode_counter/core/codecounter.py renamed to code_counter/core/counter.py

@@ -5,7 +5,7 @@
 import os
 import unittest
 from unittest.mock import patch
-from code_counter.core.argspaser import CodeCounterArgsParser
+from code_counter.core.args import CodeCounterArgs
 from code_counter.conf.config import Config
 from code_counter.__main__ import main
 
@@ -27,23 +27,23 @@ def test_print_help(self):
         options = ('python', app_path, '--help')
         sys.argv[1:] = options[2:]
         try:
-            CodeCounterArgsParser()
+            CodeCounterArgs()
         except SystemExit:
             pass
 
     def test_print_search_help(self):
         options = ('python', app_path, 'search', '--help')
         sys.argv[1:] = options[2:]
         try:
-            CodeCounterArgsParser()
+            CodeCounterArgs()
         except SystemExit:
             pass
 
     def test_print_config_help(self):
         options = ('python', app_path, 'config', '--help')
         sys.argv[1:] = options[2:]
         try:
-            CodeCounterArgsParser()
+            CodeCounterArgs()
         except SystemExit:
             pass
 
@@ -58,11 +58,11 @@ def test_search_args(self):
                    '--comment=//,#,/*',
                    '--ignore=.vscode,.idea']
         sys.argv[1:] = options[2:]
-        parser = CodeCounterArgsParser()
-        self.assertTrue('config' not in parser.args, '"config" is in the "args"')
-        self.assertTrue('search' in parser.args, '"search" is not in the "args"')
-        search_args = parser.args['search']
-        self.assertEqual(search_args.path, '../code_counter/', "search path parsed error.")
+        args = CodeCounterArgs()
+        self.assertFalse(args.has_config_args(), '"config" is in the "args"')
+        self.assertTrue(args.has_search_args(), '"search" is not in the "args"')
+        search_args = args.search()
+        self.assertEqual(search_args.input_path, ['../code_counter/'], "search path parsed error.")
         self.assertTrue(search_args.verbose, '-v,--verbose flag parsed error.')
         self.assertTrue(search_args.graph, '-g,--graph flag parsed error.')
         self.assertEqual(search_args.output_path, 'output.txt', "output path parsed error.")
@@ -82,10 +82,10 @@ def test_config_args(self):
                    '--ignore-reset=target',
                    '--restore']
         sys.argv[1:] = options[2:]
-        parser = CodeCounterArgsParser()
-        self.assertTrue('config' in parser.args, '"config" is not in the "args"')
-        self.assertTrue('search' not in parser.args, '"search" is in the "args"')
-        config_args = parser.args['config']
+        args = CodeCounterArgs()
+        self.assertTrue(args.has_config_args(), '"config" is not in the "args"')
+        self.assertFalse(args.has_search_args(), '"search" is in the "args"')
+        config_args = args.config()
         self.assertTrue(config_args.show_list, '--list flag parsed error.')
         self.assertEqual(config_args.suffix_add, ['lisp'], "suffix_add flag and values parsed error.")
         self.assertEqual(config_args.suffix_reset, ['clj'], "suffix_reset flag and values parsed error.")
@@ -103,11 +103,12 @@ def test_Config_restore(self, mock_input):
                    'config',
                    '--restore']
         sys.argv[1:] = options[2:]
-        parser = CodeCounterArgsParser()
-        args = parser.args
+
+        args = CodeCounterArgs()
+        self.assertTrue(args.has_config_args())
+
         config = Config()
-        self.assertTrue('config' in args)
-        config.invoke(args['config'])
+        config.invoke(args.config())
 
         self.assertEqual(config.suffix, self.default_suffix, "the suffix doesn't equal")
         self.assertEqual(config.comment, self.default_comment, "the comment doesn't equal")
@@ -126,10 +127,10 @@ def test_Config_reset1(self, mock_input):
                    '--comment-reset=//,#,/**',
                    '--ignore-reset=target,build,node_modules,__pycache__']
         sys.argv[1:] = options[2:]
-        parser = CodeCounterArgsParser()
-        args = parser.args
-        self.assertTrue('config' in args)
-        config.invoke(args['config'])
+
+        args = CodeCounterArgs()
+        self.assertTrue(args.has_config_args())
+        config.invoke(args.config())
 
         suffix = ['java', 'cpp', 'go', 'js', 'py']
         comment = ['//', '#', '/**']
@@ -154,10 +155,10 @@ def test_Config_reset2(self, mock_input):
                    '--comment-reset=//,#,/**',
                    '--ignore-reset=target,build,node_modules,__pycache__']
         sys.argv[1:] = options[2:]
-        parser = CodeCounterArgsParser()
-        args = parser.args
-        self.assertTrue('config' in args)
-        config.invoke(args['config'])
+
+        args = CodeCounterArgs()
+        self.assertTrue(args.has_config_args())
+        config.invoke(args.config())
 
         suffix = ['java', 'cpp', 'go', 'js', 'py']
         comment = ['//', '#', '/**']
@@ -182,10 +183,10 @@ def test_Config_reset3(self, mock_input):
                    '--comment-reset=//,#,/**',
                    '--ignore-reset=target,build,node_modules,__pycache__']
         sys.argv[1:] = options[2:]
-        parser = CodeCounterArgsParser()
-        args = parser.args
-        self.assertTrue('config' in args)
-        config.invoke(args['config'])
+
+        args = CodeCounterArgs()
+        self.assertTrue(args.has_config_args())
+        config.invoke(args.config())
 
         suffix = ['java', 'cpp', 'go', 'js', 'py']
         comment = ['//', '#', '/**']
@@ -210,10 +211,10 @@ def test_Config_reset4(self, mock_input):
                    '--comment-reset=//,#,/**',
                    '--ignore-reset=target,build,node_modules,__pycache__']
         sys.argv[1:] = options[2:]
-        parser = CodeCounterArgsParser()
-        args = parser.args
-        self.assertTrue('config' in args)
-        config.invoke(args['config'])
+
+        args = CodeCounterArgs()
+        self.assertTrue(args.has_config_args())
+        config.invoke(args.config())
 
         suffix = ['java', 'cpp', 'go', 'js', 'py']
         comment = ['//', '#', '/**']
@@ -238,10 +239,10 @@ def test_Config_add1(self, mock_input):
                    '--comment-add=TEST_COMMENT',
                    '--ignore-add=TEST_IGNORE']
         sys.argv[1:] = options[2:]
-        parser = CodeCounterArgsParser()
-        args = parser.args
-        self.assertTrue('config' in args)
-        config.invoke(args['config'])
+
+        args = CodeCounterArgs()
+        self.assertTrue(args.has_config_args())
+        config.invoke(args.config())
 
         suffix = 'TEST_SUFFIX'
         comment = 'TEST_COMMENT'
@@ -266,10 +267,10 @@ def test_Config_add2(self, mock_input):
                    '--comment-add=TEST_COMMENT',
                    '--ignore-add=TEST_IGNORE']
         sys.argv[1:] = options[2:]
-        parser = CodeCounterArgsParser()
-        args = parser.args
-        self.assertTrue('config' in args)
-        config.invoke(args['config'])
+
+        args = CodeCounterArgs()
+        self.assertTrue(args.has_config_args())
+        config.invoke(args.config())
 
         suffix = 'TEST_SUFFIX'
         comment = 'TEST_COMMENT'
@@ -294,10 +295,10 @@ def test_Config_add3(self, mock_input):
                    '--comment-add=TEST_COMMENT',
                    '--ignore-add=TEST_IGNORE']
         sys.argv[1:] = options[2:]
-        parser = CodeCounterArgsParser()
-        args = parser.args
-        self.assertTrue('config' in args)
-        config.invoke(args['config'])
+
+        args = CodeCounterArgs()
+        self.assertTrue(args.has_config_args())
+        config.invoke(args.config())
 
         suffix = 'TEST_SUFFIX'
         comment = 'not TEST_COMMENT'
@@ -322,10 +323,10 @@ def test_Config_add4(self, mock_input):
                    '--comment-add=TEST_COMMENT',
                    '--ignore-add=TEST_IGNORE']
         sys.argv[1:] = options[2:]
-        parser = CodeCounterArgsParser()
-        args = parser.args
-        self.assertTrue('config' in args)
-        config.invoke(args['config'])
+
+        args = CodeCounterArgs()
+        self.assertTrue(args.has_config_args())
+        config.invoke(args.config())
 
         suffix = 'TEST_SUFFIX'
         comment = 'TEST_COMMENT'