refactor: replace rich.console with custom logger

- Replace instances of 'rich.console.Console' with 'gcop.utils.logger.Logger'
- Add color-coded logging for better visual distinction
- Update functions to use the new logger for output messages

This refactor improves the consistency and readability of the output messages, and introduces color-coded logging for better visual distinction.

Author: Undertone0809

docs/guide/how-to-guide.md

@@ -32,3 +32,7 @@ Remember:
 
 1. Install GCOP in each Python environment you want to use it in.
 2. The GCOP configuration is shared across all environments, so you only need to set it up once.
+
+### How to see the logs?
+
+GCOP will store the logs in the `logs` folder in the GCOP storage path, which is usually `~/.zeeland/gcop/logs/`.

gcop/__main__.py

@@ -12,11 +12,11 @@
 import typer
 from dotenv import load_dotenv
 from pydantic import BaseModel, Field
-from rich.console import Console
 
 from gcop import prompt, version
 from gcop.config import ModelConfig, get_config
 from gcop.utils import check_version_update, migrate_config_if_needed
+from gcop.utils.logger import Color, logger
 
 load_dotenv()
 
@@ -25,7 +25,6 @@
     help="gcop is your local git command copilot",
     add_completion=False,
 )
-console = Console()
 
 
 class CommitMessage(BaseModel):
@@ -99,7 +98,7 @@ def check_version_before_command(f: Callable) -> Callable:
 
     @wraps(f)
     def wrapper(*args, **kwargs):
-        check_version_update(console)
+        check_version_update()
         return f(*args, **kwargs)
 
     return wrapper
@@ -199,10 +198,10 @@ def init_command():
             check=True,
             encoding="utf-8",
         )
-        console.print("[green]git aliases added successfully[/]")
+        logger.color_info("git aliases added successfully", color=Color.GREEN)
 
         config_command(from_init=True)
-        console.print("[green]gcop initialized successfully[/]")
+        logger.color_info("gcop initialized successfully", color=Color.GREEN)
     except subprocess.CalledProcessError as error:
         print(f"Error adding git aliases: {error}")
 
@@ -409,28 +408,28 @@ def info_command():
             shell=True,
         ).strip()
 
-        console.print(f"[bold]Project Name:[/] {project_name}")
-        console.print(f"[bold]Current Branch:[/] {current_branch}")
-        console.print(f"[bold]Latest Commit:[/] {latest_commit}")
-        console.print(f"[bold]Uncommitted Changes:[/] {uncommitted_changes}")
-        console.print(f"[bold]Remote URL:[/] {remote_url}")
-        console.print(f"[bold]Total Commits:[/] {total_commits}")
-        console.print(f"[bold]Contributors:[/] {contributors}")
-        console.print(f"[bold]Repository Created:[/] {creation_time}")
-        console.print(f"[bold]Last Modified:[/] {last_modified}")
-        console.print(f"[bold]Repository Size:[/] {repo_size}")
-        console.print(f"[bold]Most Active Contributor:[/] {most_active}")
-        console.print(f"[bold]Most Changed File:[/] {most_changed}")
-        console.print(f"[bold]Line Count by Language:[/]\n{line_count}")
-        console.print(f"[bold]Latest Tag:[/] {latest_tag}")
-        console.print(f"[bold]Branch Count:[/] {branch_count}")
-        console.print(f"[bold]Untracked Files:[/] {untracked_count}")
-        console.print(f"[bold]Submodules:[/]{submodules}")
-        console.print(f"[bold]Latest Merge Commit:[/] {latest_merge}")
-        console.print(f"[bold]File Type Statistics:[/]\n{file_types}")
+        logger.color_info(f"Project Name: {project_name}")
+        logger.color_info(f"Current Branch: {current_branch}")
+        logger.color_info(f"Latest Commit: {latest_commit}")
+        logger.color_info(f"Uncommitted Changes: {uncommitted_changes}")
+        logger.color_info(f"Remote URL: {remote_url}")
+        logger.color_info(f"Total Commits: {total_commits}")
+        logger.color_info(f"Contributors: {contributors}")
+        logger.color_info(f"Repository Created: {creation_time}")
+        logger.color_info(f"Last Modified: {last_modified}")
+        logger.color_info(f"Repository Size: {repo_size}")
+        logger.color_info(f"Most Active Contributor: {most_active}")
+        logger.color_info(f"Most Changed File: {most_changed}")
+        logger.color_info(f"Line Count by Language:\n{line_count}")
+        logger.color_info(f"Latest Tag: {latest_tag}")
+        logger.color_info(f"Branch Count: {branch_count}")
+        logger.color_info(f"Untracked Files: {untracked_count}")
+        logger.color_info(f"Submodules: {submodules}")
+        logger.color_info(f"Latest Merge Commit: {latest_merge}")
+        logger.color_info(f"File Type Statistics:\n{file_types}")
 
     except subprocess.CalledProcessError as e:
-        console.print(f"[red]Error getting repository information: {e}[/]")
+        logger.color_info(f"Error getting repository information: {e}", color=Color.RED)
 
 
 @app.command(name="commit")
@@ -455,18 +454,20 @@ def commit_command(
     diff: str = get_git_diff("--staged")
 
     if not diff:
-        console.print("[yellow]No staged changes[/]")
+        logger.color_info("No staged changes", color=Color.YELLOW)
         return
 
-    console.print(f"[yellow][Code diff] \n{diff}[/]")
-    console.print("[bold][On Ready] Generating commit message... [/]")
+    logger.color_info(f"[Code diff] \n{diff}", color=Color.YELLOW)
+    logger.color_info("[On Ready] Generating commit message...")
 
     commit_messages: CommitMessage = generate_commit_message(
         diff, instruction, previous_commit_message
     )
 
-    console.print(f"[bold][Thought] {commit_messages.thought}[/]")
-    console.print(f"[green][Generated commit message]\n{commit_messages.content}[/]")
+    logger.color_info(f"[Thought] {commit_messages.thought}")
+    logger.color_info(
+        f"[Generated commit message]\n{commit_messages.content}", color=Color.GREEN
+    )
 
     actions: Dict[str, Callable] = {
         "yes": lambda: subprocess.run(["git", "commit", "-m", commit_messages.content]),
@@ -477,7 +478,9 @@ def commit_command(
             instruction=questionary.text("Please enter your feedback:").ask(),
             previous_commit_message=commit_messages.content,
         ),
-        "exit": lambda: console.print("[yellow]Exiting commit process.[/]"),
+        "exit": lambda: logger.color_info(
+            "Exiting commit process.", color=Color.YELLOW
+        ),
     }
 
     response = questionary.select(
@@ -492,14 +495,14 @@ def commit_command(
 @check_version_before_command
 def help_command():
     """Show help message"""
-    help_message = """
-[bold]gcop[/] is your local git command copilot
-[bold]Version: [/]{version}
-[bold]GitHub: https://github.com/Undertone0809/gcop[/]
+    help_message = f"""
+gcop is your local git command copilot
+Version: {version}
+GitHub: https://github.com/Undertone0809/gcop
 
-[bold]Usage: gcop [OPTIONS] COMMAND[/]
+Usage: gcop [OPTIONS] COMMAND
 
-[bold]Commands:
+Commands:
   git p          Push the changes to the remote repository
   git pf         Push the changes to the remote repository with force
   git undo       Undo the last commit but keep the file changes
@@ -514,7 +517,7 @@ def help_command():
   git info       Display basic information about the current git repository
 """  # noqa
 
-    console.print(help_message)
+    logger.color_info(help_message)
 
 
 if __name__ == "__main__":

gcop/utils/__init__.py

@@ -14,6 +14,7 @@
 from zeeland import get_default_storage_path as _get_default_storage_path
 
 from gcop import version
+from gcop.utils.logger import Color, logger
 
 
 @dataclass
@@ -126,12 +127,9 @@ def _load_metadata(metadata_path: str) -> VersionMetadata:
     return metadata
 
 
-def check_version_update(console: Console) -> None:
+def check_version_update() -> None:
     """Check for new version of gcop using cached data.
     Only checks PyPI once per day and caches the result.
-
-    Args:
-        console: Rich console instance for output
     """
     metadata_path: str = os.path.join(get_default_storage_path(), "metadata.json")
     current_time: datetime = datetime.now()
@@ -159,13 +157,15 @@ def check_version_update(console: Console) -> None:
 
             if should_update:
                 try:
-                    console.print("[yellow]Updating gcop...[/]")
+                    logger.color_info("Updating gcop...", color=Color.YELLOW)
                     subprocess.run(["pip", "install", "-U", "gcop"], check=True)
-                    console.print("[green]Update successful![/]")
+                    logger.color_info("Update successful!", color=Color.GREEN)
                     subprocess.run(["gcop", "init"], check=True)
-                    console.print("[green]GCOP reinitialized successfully![/]")
+                    logger.color_info(
+                        "GCOP reinitialized successfully!", color=Color.GREEN
+                    )
                 except subprocess.CalledProcessError as e:
-                    console.print(f"[red]Failed to update gcop: {e}[/]")
+                    logger.color_info(f"Failed to update gcop: {e}", color=Color.RED)
 
     except Exception:
         pass
@@ -181,17 +181,21 @@ def migrate_config_if_needed() -> None:
 
     try:
         if not os.path.exists(new_config_path):
-            print("No new config file found, migrating old config...")
+            logger.color_info("No new config file found, migrating old config...")
             shutil.copy2(old_config_path, new_config_path)
-            print(f"Config migrated from {old_config_path} to {new_config_path}")
+            logger.color_info(
+                f"Config migrated from {old_config_path} to {new_config_path}"
+            )
         else:
-            print("New config file already exists, skipping migration")
+            logger.color_info("New config file already exists, skipping migration")
 
         backup_path: str = old_config_path + ".backup"
         shutil.copy2(old_config_path, backup_path)
         os.remove(old_config_path)
-        print(f"Old config backup created at {backup_path}")
+        logger.color_info(f"Old config backup created at {backup_path}")
 
     except Exception as e:
-        print(f"Error migrating config: {e}")
-        print("Please manually move your config file to the new location")
+        logger.color_info(f"Error migrating config: {e}", color=Color.RED)
+        logger.color_info(
+            "Please manually move your config file to the new location", color=Color.RED
+        )

gcop/utils/logger.py

@@ -0,0 +1,90 @@
+import datetime
+import logging
+import sys
+import traceback
+from enum import Enum
+from logging.handlers import TimedRotatingFileHandler
+from pathlib import Path
+
+from rich.console import Console
+from zeeland import Singleton, get_default_storage_path
+
+
+class Color(Enum):
+    DEFAULT = "default"
+    GREEN = "green"
+    YELLOW = "yellow"
+    RED = "red"
+
+
+class Logger(logging.Logger, metaclass=Singleton):
+    """A custom logger class that extends logging.Logger with color output
+    capabilities."""
+
+    def __init__(self, name: str = "gcop", level: int = logging.DEBUG) -> None:
+        """Initialize the logger with file and console handlers.
+
+        Args:
+            name: Logger name, defaults to "gcop"
+            level: Logging level, defaults to DEBUG
+        """
+        super().__init__(name, level)
+        self._setup_file_handler()
+        self.console = Console()
+
+    def _setup_file_handler(self) -> None:
+        """Set up rotating file handler with formatting."""
+        log_dir = Path(get_default_storage_path("gcop", "logs"))
+        log_file = log_dir / f"{datetime.datetime.now().strftime('%Y%m%d')}.log"
+
+        handler = TimedRotatingFileHandler(
+            filename=log_file, when="midnight", interval=1, encoding="utf-8"
+        )
+        handler.setLevel(logging.DEBUG)
+
+        formatter = logging.Formatter(
+            "%(asctime)s | %(levelname)s | %(name)s:%(funcName)s:%(lineno)d - %(message)s",  # noqa
+            "%Y-%m-%d %H:%M:%S",
+        )
+        handler.setFormatter(formatter)
+        self.addHandler(handler)
+
+    def color_info(
+        self, message: str, color: Color = Color.DEFAULT, *args, **kwargs
+    ) -> None:
+        """Log info message and print to console with optional color.
+
+        Args:
+            message: The message to log
+            color: Color enum value for console output
+            *args: Additional args passed to logger
+            **kwargs: Additional kwargs passed to logger
+        """
+        self.info(message, *args, **kwargs)
+        formatted_msg = (
+            f"[{color.value}]{message}[/]" if color != Color.DEFAULT else message
+        )
+        self.console.print(formatted_msg, style=color.value)
+
+
+def handle_exception(exc_type, exc_value, exc_tb) -> None:
+    """Handle uncaught exceptions by logging them.
+
+    Args:
+        exc_type: Exception type
+        exc_value: Exception value
+        exc_tb: Exception traceback
+    """
+    if issubclass(exc_type, KeyboardInterrupt):
+        sys.__excepthook__(exc_type, exc_value, exc_tb)
+        return
+
+    logger.error(
+        "Uncaught exception:\n%s",
+        "".join(traceback.format_exception(exc_type, exc_value, exc_tb)),
+    )
+    sys.__excepthook__(exc_type, exc_value, exc_tb)
+
+
+logger = Logger()
+sys.excepthook = handle_exception

pyproject.toml

@@ -5,7 +5,7 @@ requires = ["poetry-core"]
 
 [tool.poetry]
 name = "gcop"
-version = "1.7.0"
+version = "1.7.1"
 description = "gcop is your git AI copilot."
 readme = "README.md"
 authors = ["gcop <zeeland4work@gmail.com>"]