Merge pull request #22 from InnoFang/dev

✨ 🎨 pref: merge dev

Author: InnoFang

code_counter/__main__.py

@@ -1,40 +1,54 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8  -*-
-
-import time
+import os
+from code_counter.conf.config import Config
 from code_counter.core.counter import CodeCounter
 from code_counter.core.args import CodeCounterArgs
-from code_counter.conf.config import Config
+
+
+def handle_config_command(config, args):
+    # Handle configuration command
+    config.invoke(args.config())
+
+
+def handle_remote_args(config, cocnt_args):
+    # Handle remote repository-related arguments
+    args = cocnt_args.remote()
+    if cocnt_args.is_gitee_repo() and not config.access_tokens.gitee:
+        config.request_gitee_access_token()
+    elif cocnt_args.is_github_repo() and not config.access_tokens.github:
+        config.request_github_access_token()
+    return args
+
+
+def handle_search_args(config, cocnt_args):
+    # Handle search-related arguments
+    args = cocnt_args.search()
+    return args
 
 
 def main():
     cocnt_args = CodeCounterArgs()
-
     config = Config()
+
+    # If configuration command is present, invoke and return
     if cocnt_args.has_config_args():
-        config.invoke(cocnt_args.config())
+        handle_config_command(config, cocnt_args)
         return
 
-    code_counter = CodeCounter()
-
-    if cocnt_args.has_search_args():
-        args = cocnt_args.search()
-    elif cocnt_args.has_remote_args():
-        args = cocnt_args.remote()
-        if cocnt_args.is_gitee_repo() and not config.access_tokens.gitee:
-            config.request_gitee_access_token()
-        elif cocnt_args.is_github_repo() and not config.access_tokens.github:
-            config.request_github_access_token()
+    # If searching or processing a remote repository, check and request access tokens
+    if cocnt_args.has_remote_args():
+        args = handle_remote_args(config, cocnt_args)
+    elif cocnt_args.has_search_args():
+        args = handle_search_args(config, cocnt_args)
     else:
-        raise Exception('wrong command')
-
-    code_counter.setArgs(args)
+        raise Exception('Wrong command')
 
-    time_start = time.time()
+    code_counter = CodeCounter(args)
     code_counter.search()
-    time_end = time.time()
 
-    print('\n\tTotally cost {} s.'.format(time_end - time_start))
+    if args.output_path:
+        print(f'Output saved to: {os.path.abspath(args.output_path)}')
 
     if args.graph:
         code_counter.visualize()

code_counter/core/args.py

@@ -1,17 +1,76 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8  -*-
+"""
+Command-line interface (CLI) utility for counting code lines and displaying detailed results.
+"""
 
 import re
 import sys
 import argparse
+from typing import List, Optional
 from code_counter import __version__
 
 
-def split_args(args):
+def split_args(args: str) -> List[str]:
+    """
+    Split input arguments separated by commas.
+
+    Parameters
+    ----------
+    args: str
+        Input arguments as a comma-separated string.
+
+    Returns
+    -------
+    List[str]
+        List of split arguments.
+    """
     return list(args.split(','))
 
 
-def remote_repo_parse(repo):
+def parse_remote_repo(repo: str) -> str:
+    """
+    Parse the input repository link to extract information and construct API URL.
+
+    Parameters
+    ----------
+    repo: str
+        Input repository link.
+
+    Returns
+    -------
+    str
+        Constructed API URL for the repository.
+    """
+    # Check both HTTPS and SSH links for GitHub or Gitee repositories
+    res = re.search(r"^(https|git)@(github|gitee).com:([^/]+)/([^\.]+)\.git$", repo, re.I)
+    if not res:
+        print('Remote repository link parse error! Please enter a valid HTTPS or SSH link:')
+        print('\tcocnt remote', repo)
+        exit(1)
+
+    # Construct API URL based on the matched repository
+    api_url = f'https://{res.group(2)}.com/api/v5/repos/{res.group(3)}/{res.group(4)}/contents/'
+    return api_url
+
+
+@PendingDeprecationWarning
+def remote_repo_parse(repo: str) -> str:
+    """
+    Parse the input repository link and return the corresponding API URL.
+
+    This function is deprecated in favor of `parse_remote_repo`.
+
+    Parameters
+    ----------
+    repo: str
+        Input repository link.
+
+    Returns
+    -------
+    str
+        Constructed API URL for the repository.
+    """
     # check HTTPS link first
     res = re.search(r"^https://(github|gitee).com/([^/]+)/([^\.]+)\.git$", repo, re.I)
     # if got none, then check SSH link
@@ -34,15 +93,17 @@ def remote_repo_parse(repo):
 
 
 class CodeCounterArgs:
-    __SEARCH__ = 'search'
-    __CONFIG__ = 'config'
-    __REMOTE__ = 'remote'
+    SEARCH = 'search'
+    CONFIG = 'config'
+    REMOTE = 'remote'
 
     def __init__(self):
+        """
+        Initialize CodeCounterArgs instance.
+        """
         parser = argparse.ArgumentParser(
             prog="code-counter",
-            description="A command-line interface (CLI) utility "
-                        "that can help you easily count code and display detailed results.",
+            description="A command-line interface (CLI) utility that counts code lines and displays detailed results.",
             usage="""cocnt <command> [<args>]
 These are common Code-Counter commands used in various situations:
     search     Search and count code lines for the given path(s)
@@ -53,54 +114,126 @@ def __init__(self):
                             version='%(prog)s {}'.format(__version__))
         parser.add_argument("command", help="Subcommand to run, `search` or `config`")
         args = parser.parse_args(sys.argv[1:2])
+
         if not hasattr(self, args.command):
             print("Unrecognized command")
             parser.print_help()
             exit(1)
+
         self.__args = {args.command: argparse.Namespace()}
         getattr(self, args.command)()
 
-    def has_search_args(self):
-        return self.__SEARCH__ in self.__args
+    def has_search_args(self) -> bool:
+        """
+        Check if the instance has search-related arguments.
 
-    def has_remote_args(self):
-        return self.__REMOTE__ in self.__args
+        Returns
+        -------
+        bool
+            True if search-related arguments are present, False otherwise.
+        """
+        return self.SEARCH in self.__args
 
-    def has_config_args(self):
-        return self.__CONFIG__ in self.__args
+    def has_remote_args(self) -> bool:
+        """
+        Check if the instance has remote-related arguments.
 
-    def is_github_repo(self):
-        if not self.has_remote_args():
-            return False
-        return self.__args[self.__REMOTE__].input_path.startswith('https://api.github.com/repos/')
+        Returns
+        -------
+        bool
+            True if remote-related arguments are present, False otherwise.
+        """
+        return self.REMOTE in self.__args
 
-    def is_gitee_repo(self):
-        if not self.has_remote_args():
-            return False
-        return self.__args[self.__REMOTE__].input_path.startswith('https://gitee.com/api/v5/repos/')
+    def has_config_args(self) -> bool:
+        """
+        Check if the instance has config-related arguments.
+
+        Returns
+        -------
+        bool
+            True if config-related arguments are present, False otherwise.
+        """
+        return self.CONFIG in self.__args
+
+    def is_github_repo(self) -> bool:
+        """
+        Check if the provided input is a GitHub repository.
+
+        Returns
+        -------
+            bool
+            True if the input is a GitHub repository, False otherwise.
+        """
+        return self.has_remote_args() \
+            and self.__args[self.REMOTE].input_path.startswith('https://api.github.com/repos/')
+
+    def is_gitee_repo(self) -> bool:
+        """
+        Check if the provided input is a Gitee repository.
 
-    def search(self):
+        Returns
+        -------
+        bool
+            True if the input is a Gitee repository, False otherwise.
+        """
+        return self.has_remote_args() \
+            and self.__args[self.REMOTE].input_path.startswith('https://gitee.com/api/v5/repos/')
+
+    def search(self) -> Optional[argparse.Namespace]:
+        """
+        Get search-related arguments.
+
+        Returns
+        -------
+        Optional[argparse.Namespace]
+            Search-related arguments if present, None otherwise.
+        """
         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__]
+        if self.__args[self.SEARCH] == argparse.Namespace():
+            self.__args[self.SEARCH] = self.__search()
+        return self.__args[self.SEARCH]
 
-    def remote(self):
+    def remote(self) -> Optional[argparse.Namespace]:
+        """
+        Get remote-related arguments.
+
+        Returns
+        -------
+        Optional[argparse.Namespace]
+            Remote-related arguments if present, None otherwise.
+        """
         if not self.has_remote_args():
             return None
-        if self.__args[self.__REMOTE__] == argparse.Namespace():
-            self.__args[self.__REMOTE__] = self.__remote()
-        return self.__args[self.__REMOTE__]
+        if self.__args[self.REMOTE] == argparse.Namespace():
+            self.__args[self.REMOTE] = self.__remote()
+        return self.__args[self.REMOTE]
+
+    def config(self) -> Optional[argparse.Namespace]:
+        """
+        Get config-related arguments.
 
-    def config(self):
+        Returns
+        -------
+        Optional[argparse.Namespace]
+            Config-related arguments if present, None otherwise.
+        """
         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__]
+        if self.__args[self.CONFIG] == argparse.Namespace():
+            self.__args[self.CONFIG] = self.__config()
+        return self.__args[self.CONFIG]
 
-    def __search(self):
+    def __search(self) -> argparse.Namespace:
+        """
+        Parse search-related arguments.
+
+        Returns
+        -------
+        argparse.Namespace
+            Search-related arguments.
+        """
         parser = argparse.ArgumentParser(
             description="Search and count code lines for the given path(s)",
             usage="cocnt search input_path [-h] [-v] [-g] "
@@ -110,7 +243,7 @@ def __search(self):
         parser.add_argument('-v', '--verbose', dest="verbose", action='store_true',
                             help="show verbose information")
         parser.add_argument('-g', '--graph', dest='graph', action='store_true',
-                            help="choose to whether to visualize the result")
+                            help="choose whether to visualize the result")
         parser.add_argument('-o', '--output', dest='output_path',
                             help="specify an output path if you want to store the result")
         parser.add_argument('--suffix', dest='suffix', type=split_args,
@@ -121,17 +254,25 @@ def __search(self):
                             help="ignore some directories or files that you don't want to count")
         return parser.parse_args(sys.argv[2:])
 
-    def __remote(self):
+    def __remote(self) -> argparse.Namespace:
+        """
+        Parse remote-related arguments.
+
+        Returns
+        -------
+        argparse.Namespace
+            Remote-related arguments.
+        """
         parser = argparse.ArgumentParser(
-            description="Search and count the remote repository with a given Github or Gitee HTTP link",
+            description="Search and count the remote repository with a given GitHub or Gitee HTTP link",
             usage="cocnt remote <repository> [-h] [-v] [-g] "
                   "[-o OUTPUT_PATH] [--suffix SUFFIX] [--comment COMMENT] [--ignore IGNORE]")
-        parser.add_argument('input_path', metavar="repository", type=remote_repo_parse,
+        parser.add_argument('input_path', metavar="repository", type=parse_remote_repo,
                             help="search and count a remote repository")
         parser.add_argument('-v', '--verbose', dest="verbose", action='store_true',
                             help="show verbose information")
         parser.add_argument('-g', '--graph', dest='graph', action='store_true',
-                            help="choose to whether to visualize the result")
+                            help="choose whether to visualize the result")
         parser.add_argument('-o', '--output', dest='output_path',
                             help="specify an output path if you want to store the result")
         parser.add_argument('--suffix', dest='suffix', type=split_args,
@@ -142,7 +283,15 @@ def __remote(self):
                             help="ignore some directories or files that you don't want to count")
         return parser.parse_args(sys.argv[2:])
 
-    def __config(self):
+    def __config(self) -> argparse.Namespace:
+        """
+        Parse config-related arguments.
+
+        Returns
+        -------
+        argparse.Namespace
+            Config-related arguments.
+        """
         parser = argparse.ArgumentParser(
             prog="code-counter",
             description="configure code-counter",
@@ -178,7 +327,7 @@ def __config(self):
                             help="delete some values of the 'ignore' in the config")
 
         parser.add_argument('--github-token', dest='github_token',
-                            help="update the Github access token")
+                            help="update the GitHub access token")
         parser.add_argument('--gitee-token', dest='gitee_token',
                             help="update the Gitee access token")