Merge pull request #77 from smkent/status-output

Print status output in manage-cookie commands using loguru

Author: smkent

cookie_python/manage/main.py

@@ -1,9 +1,13 @@
 from __future__ import annotations
 
 import argparse
+import sys
 from enum import Enum
+from pathlib import Path
 from typing import Callable, Optional
 
+from loguru import logger
+
 from .release import release_action
 from .update import update_action
 
@@ -33,7 +37,22 @@ def __new__(
         return obj
 
 
+def configure_logging() -> None:
+    logger.remove()
+    logger.add(
+        sys.stderr,
+        colorize=True,
+        format=(
+            f"<b>[{Path(sys.argv[0]).name}]</b>"
+            " <light-blue>{time:YYYY-MM-DD HH:mm:ss}</light-blue>"
+            " <light-magenta>{extra[repo]}</light-magenta>"
+            " <level>{message}</level>"
+        ),
+    )
+
+
 def main() -> None:
+    configure_logging()
     ap = argparse.ArgumentParser()
     ap.add_argument(
         "action",

cookie_python/manage/release.py

@@ -22,7 +22,7 @@ def release_patch_version(repo: RepoSandbox) -> None:
             latest_tag = tag
             break
     if not latest_tag:
-        print("Unable to find latest version")
+        repo.logger.warning("Unable to find latest version")
         return None
     check_refs = ["origin/main", latest_tag]
     refs = []
@@ -33,15 +33,16 @@ def release_patch_version(repo: RepoSandbox) -> None:
             .strip()
         )
     if len(refs) == len(check_refs) and len(set(refs)) == 1:
-        print(f"No new changes since latest release {latest_tag}")
+        repo.logger.info(f"No new changes since latest release {latest_tag}")
         return None
     sv = semver.VersionInfo.parse(latest_tag.lstrip("v"))
     next_patch_ver = sv.bump_patch()
     new_tag = f"v{next_patch_ver}"
     if repo.dry_run:
-        print(f"Would release new version {new_tag}")
+        repo.logger.success(f"Would release new version {new_tag}")
         return None
     repo.run(["gh", "release", "create", new_tag, "--generate-notes"])
+    repo.logger.success(f"Releasing new version {new_tag}")
     return None
 
 

cookie_python/manage/repo.py

@@ -11,6 +11,8 @@
 from types import TracebackType
 from typing import Any, Optional
 
+import loguru
+
 
 class RepoSandbox:
     def __init__(self, repo: str, dry_run: bool = False) -> None:
@@ -30,6 +32,10 @@ def __exit__(
     ) -> None:
         self._stack.close()
 
+    @cached_property
+    def logger(self) -> "loguru.Logger":
+        return loguru.logger.bind(repo=self.repo)
+
     @cached_property
     def tempdir(self) -> Path:
         return Path(
@@ -73,7 +79,7 @@ def run(
 
     def shell(self) -> None:
         if sys.__stdin__.isatty():
-            print('Starting shell. Run "exit 1" to abort.')
+            self.logger.info('Starting shell. Run "exit 1" to abort.')
             self.run([os.environ.get("SHELL", "/bin/bash")])
 
     def commit_changes(self, message: str) -> None:
@@ -104,12 +110,13 @@ def lint_test(self) -> None:
         try:
             self.run(["poetry", "run", "poe", "test"])
         except subprocess.CalledProcessError as e:
-            print(e)
-            print("Resolve errors and exit shell to continue")
+            self.logger.error(str(e))
+            self.logger.error("Resolve errors and exit shell to continue")
             self.shell()
 
     def open_pr(self, message: str) -> None:
         if self.dry_run:
+            self.logger.success("Would open PR")
             return
         self.run(["git", "push", "origin", self.branch])
         commit_title, _, *commit_body = message.splitlines()
@@ -129,3 +136,4 @@ def open_pr(self, message: str) -> None:
             ],
             input=os.linesep.join(commit_body).encode("utf-8"),
         )
+        self.logger.success("Opened PR")

cookie_python/manage/update.py

@@ -38,8 +38,10 @@ def update_cruft(repo: RepoSandbox) -> Optional[str]:
         )
         if rej_files or conflicts:
             if try_count == 0:
-                print(f">>> Conflicts found: {rej_files}")
-                print("Resolve conflicts and exit shell to continue")
+                repo.logger.error(f"Conflicts found: {rej_files}")
+                repo.logger.error(
+                    "Resolve conflicts and exit shell to continue"
+                )
                 repo.shell()
                 continue
             raise Exception(f"Unresolved conflicts: {rej_files}")
@@ -102,6 +104,7 @@ def update_dependencies(repo: RepoSandbox) -> Optional[str]:
 def update_action(args: Namespace) -> None:
     for repo_url in args.repo:
         with RepoSandbox(repo_url, args.dry_run) as repo:
+            repo.logger.info("Starting update")
             actions = []
             msg_body = ""
             cruft_msg = update_cruft(repo)
@@ -113,7 +116,10 @@ def update_action(args: Namespace) -> None:
                 msg_body += deps_msg
                 actions.append("dependencies")
             if not msg_body:
-                return None
-            message = f"Update {', '.join(actions)}\n\n{msg_body}"
+                repo.logger.info("Already up to date")
+                continue
+            actions_str = ", ".join(actions)
+            message = f"Update {actions_str}\n\n{msg_body}"
+            repo.logger.info(f"Updated {actions_str}")
             repo.commit_changes(message)
             repo.open_pr(message)

poetry.lock

@@ -23,6 +23,7 @@ packages = [
 
 [tool.poetry.dependencies]
 python = "^3.8"
+loguru = "*"
 poetry-dynamic-versioning = "*"
 pyyaml = "*"
 semver = "*"