Add logging to base file

woojiahao · woojiahao · commit 244d21534053 · 2025-07-18T19:02:09.000+08:00
diff --git a/app/cli.py b/app/cli.py
@@ -1,14 +1,24 @@
+import logging
+import sys
+
 import click
 import requests
 
 from app.commands import check, download, progress, setup, verify
 from app.commands.version import version
-from app.utils.click_utils import warn
-from app.utils.version_utils import Version
+from app.utils.click import warn
+from app.utils.version import Version
 from app.version import __version__
 
 
-@click.group()
+class LoggingGroup(click.Group):
+    def invoke(self, ctx: click.Context) -> None:
+        logger = logging.getLogger(__name__)
+        logger.info("Running command %s with arguments %s", ctx.command_path, sys.argv)
+        return super().invoke(ctx)
+
+
+@click.group(cls=LoggingGroup)
 @click.option("--verbose", "-v", is_flag=True, help="Enable verbose output")
 @click.pass_context
 def cli(ctx, verbose) -> None:
diff --git a/app/commands/check/git.py b/app/commands/check/git.py
@@ -1,9 +1,9 @@
 import click
 
 from app.commands.check.github import github
-from app.utils.click_utils import error, info, success
-from app.utils.gh_cli_utils import is_authenticated, is_github_cli_installed
-from app.utils.git_cli_utils import get_git_config, is_git_installed
+from app.utils.click import error, info, success
+from app.utils.gh_cli import is_authenticated, is_github_cli_installed
+from app.utils.git_cli import get_git_config, is_git_installed
 
 
 @click.command()
diff --git a/app/commands/check/github.py b/app/commands/check/github.py
@@ -1,8 +1,8 @@
 import click
 
-from app.utils.click_utils import error, info, success
-from app.utils.gh_cli_utils import is_authenticated, is_github_cli_installed
-from app.utils.git_cli_utils import get_git_config, is_git_installed
+from app.utils.click import error, info, success
+from app.utils.gh_cli import is_authenticated, is_github_cli_installed
+from app.utils.git_cli import get_git_config, is_git_installed
 
 
 @click.command()
diff --git a/app/commands/progress/reset.py b/app/commands/progress/reset.py
@@ -11,9 +11,9 @@
 from app.commands.check.github import github
 from app.commands.download import setup_exercise_folder
 from app.commands.progress.constants import STUDENT_PROGRESS_FORK_NAME
-from app.utils.click_utils import error, info, success, warn
-from app.utils.gh_cli_utils import delete_repo, get_username
-from app.utils.gitmastery_utils import (
+from app.utils.click import error, info, success, warn
+from app.utils.gh_cli import delete_repo, get_username
+from app.utils.gitmastery import (
     generate_cds_string,
     require_gitmastery_exercise_root,
     require_gitmastery_root,
diff --git a/app/commands/progress/sync/off.py b/app/commands/progress/sync/off.py
@@ -6,9 +6,9 @@
 from app.commands.check.git import git
 from app.commands.check.github import github
 from app.commands.progress.constants import STUDENT_PROGRESS_FORK_NAME
-from app.utils.click_utils import confirm, error, info
-from app.utils.gh_cli_utils import delete_repo, get_username
-from app.utils.gitmastery_utils import generate_cds_string, require_gitmastery_root
+from app.utils.click import confirm, error, info
+from app.utils.gh_cli import delete_repo, get_username
+from app.utils.gitmastery import generate_cds_string, require_gitmastery_root
 
 
 @click.command()
diff --git a/app/commands/progress/sync/on.py b/app/commands/progress/sync/on.py
@@ -11,17 +11,17 @@
     PROGRESS_REPOSITORY_NAME,
     STUDENT_PROGRESS_FORK_NAME,
 )
-from app.utils.click_utils import error, info, success, warn
-from app.utils.gh_cli_utils import (
+from app.utils.click import error, info, success, warn
+from app.utils.gh_cli import (
     clone_with_custom_name,
     fork,
     get_prs,
     get_username,
     has_fork,
     pull_request,
 )
-from app.utils.git_cli_utils import add_all, add_remote, commit, push
-from app.utils.gitmastery_utils import (
+from app.utils.git_cli import add_all, add_remote, commit, push
+from app.utils.gitmastery import (
     GITMASTERY_CONFIG_NAME,
     generate_cds_string,
     require_gitmastery_root,
diff --git a/app/commands/setup.py b/app/commands/setup.py
@@ -5,9 +5,9 @@
 
 from app.commands.check.git import git
 from app.commands.progress.constants import PROGRESS_REPOSITORY_NAME
-from app.utils.click_utils import error, info, prompt
-from app.utils.gh_cli_utils import clone
-from app.utils.git_cli_utils import remove_remote
+from app.utils.click import error, info, prompt
+from app.utils.gh_cli import clone
+from app.utils.git_cli import remove_remote
 
 
 @click.command()
diff --git a/app/commands/verify.py b/app/commands/verify.py
@@ -17,10 +17,10 @@
     LOCAL_FOLDER_NAME,
     PROGRESS_REPOSITORY_NAME,
 )
-from app.utils.click_utils import error, info, warn
-from app.utils.gh_cli_utils import get_prs, get_username, pull_request
-from app.utils.git_cli_utils import add_all, commit, push
-from app.utils.gitmastery_utils import (
+from app.utils.click import error, info, warn
+from app.utils.gh_cli import get_prs, get_username, pull_request
+from app.utils.git_cli import add_all, commit, push
+from app.utils.gitmastery import (
     execute_py_file_function_from_url,
     require_gitmastery_exercise_root,
     require_gitmastery_root,
diff --git a/app/commands/version.py b/app/commands/version.py
@@ -1,7 +1,7 @@
 import click
 
-from app.utils.click_utils import info
-from app.utils.version_utils import Version
+from app.utils.click import info
+from app.utils.version import Version
 from app.version import __version__
 
 
diff --git a/app/logging/__init__.py b/app/logging/__init__.py
diff --git a/app/logging/setup_logging.py b/app/logging/setup_logging.py
@@ -0,0 +1,47 @@
+import logging
+import re
+
+from app.utils.gitmastery import find_gitmastery_root
+
+
+class GitMasteryFileHandler(logging.Handler):
+    def __init__(self) -> None:
+        super().__init__()
+
+    def emit(self, record: logging.LogRecord) -> None:
+        gitmastery_root = find_gitmastery_root()
+        if gitmastery_root is None:
+            return
+
+        log_path = gitmastery_root[0] / ".gitmastery.log"
+        handler = logging.FileHandler(log_path, mode="a")
+        # TODO: This feels inefficient for logging but I can't think of a good
+        # alternative
+        handler.setFormatter(self.formatter)
+        handler.emit(record)
+        handler.close()
+
+    def close(self) -> None:
+        super().close()
+
+
+class RemoveAnsiFilter(logging.Filter):
+    ansi_escape = re.compile(r"\x1B[@-_][0-?]*[ -/]*[@-~]")
+
+    def filter(self, record):
+        if isinstance(record.msg, str):
+            record.msg = self.ansi_escape.sub("", record.msg)
+        return True
+
+
+def setup_logging() -> None:
+    root_logger = logging.getLogger()
+    root_logger.setLevel(logging.DEBUG)
+    root_logger.handlers.clear()
+
+    formatter = logging.Formatter("[%(asctime)s] [%(levelname)s] %(message)s")
+
+    file_handler = GitMasteryFileHandler()
+    file_handler.setFormatter(formatter)
+    file_handler.addFilter(RemoveAnsiFilter())
+    root_logger.addHandler(file_handler)
diff --git a/app/utils/click.py b/app/utils/click.py
@@ -1,33 +1,41 @@
+import logging
 from sys import exit
 from typing import Any, Optional
 
 import click
 
+logger = logging.getLogger(__name__)
+
 
 def error(message: str) -> None:
+    logger.error(message)
     click.echo(
         f"{click.style(' ERROR ', fg='black', bg='bright_red', bold=True)} {message}"
     )
     exit(1)
 
 
 def info(message: str) -> None:
+    logger.info(message)
     click.echo(
         f"{click.style(' INFO ', fg='black', bg='bright_blue', bold=True)} {message}"
     )
 
 
 def debug(message: str) -> None:
+    logger.debug(message)
     click.echo(f"{click.style(' DEBUG ', fg='white', bg='black', bold=True)} {message}")
 
 
 def warn(message: str) -> None:
+    logger.warn(message)
     click.echo(
         f"{click.style(' WARN ', fg='black', bg='bright_yellow', bold=True)} {message}"
     )
 
 
 def success(message: str) -> None:
+    logger.info(message)
     click.echo(
         f"{click.style(' SUCCESS ', fg='black', bg='bright_green', bold=True)} {message}"
     )
diff --git a/app/utils/command.py b/app/utils/command.py
@@ -1,3 +1,4 @@
+import logging
 import os
 import subprocess
 from dataclasses import dataclass
@@ -22,12 +23,18 @@ def stdout(self) -> str:
 
 
 def run(command: List[str], verbose: bool, env: Dict[str, str] = {}) -> CommandResult:
+    logger = logging.getLogger(__name__)
     result = subprocess.run(
         command, capture_output=True, text=True, env=dict(os.environ, **env)
     )
+    logger.info("Ran command: %s", command)
+    if env:
+        logger.info("Env: %s", env)
     if verbose:
         if result.returncode == 0:
-            print(result.stdout)
+            logger.info(result.stdout)
+            print("\t" + result.stdout)
         else:
-            print(result.stderr)
+            logger.error(result.stderr)
+            print("\t" + result.stderr)
     return CommandResult(result=result)
diff --git a/main.py b/main.py
@@ -1,4 +1,6 @@
 from app.cli import start
+from app.logging.setup_logging import setup_logging
 
 if __name__ == "__main__":
+    setup_logging()
     start()
