Merge ~brad-figg/+git/kteam-tools:cranky-checkout-no-color into ~brad-figg/+git/kteam-tools:master

[Brad Figg]

While working on some tools for cranking kernels, one of which is post-processing the output from cranky checkout I found that it would be nice to disable the colorization.

Unmerged commits

4281efb... by Brad Figg on 2022-11-23

cranky/cmds.d/checkout: Add a command line option which allows the output colorization to be disabled. This is useful (disabling colorization) when the output is being post processed by another tool.

Signed-off-by: Brad Figg <email address hidden>

b6eda67... by Brad Figg on 2022-11-23

ktl/log.py: If Clog.color is set to False, none of the log output should be colored.

Signed-off-by: Brad Figg <email address hidden>

diff --git a/cranky/cmds.d/checkout b/cranky/cmds.d/checkout
index 042daa1..716f746 100755
--- a/cranky/cmds.d/checkout
+++ b/cranky/cmds.d/checkout
@@ -12,13 +12,15 @@ import datetime
 from crl.git import GitHandleSet, GitError
 from crl.config import Config
 from crl.handle import HandleError
-from ktl.log import cerror, cnotice
+from ktl.log import cerror, cnotice, Clog
 
 
-def checkout_repos(handle, reference=None, dissociate=False, depth=None, crd=None):
+def checkout_repos(handle, reference=None, dissociate=False, depth=None, crd=None, nc=False):
     """
     Clone the repos that make up the set of kernel packages
     """
+    Clog.color = not nc
+
     # Cycle through the trees and clone/update the package specific
     # repositories.
     ghs = GitHandleSet(handle)
@@ -162,6 +164,9 @@ otherwise the cranky checkout'd repo will get corrupted.
 Borrow the objects from the referenced local repository only to reduce network
 traffic. This is a git clone option, check 'git help clone' for more details.
 """
+    help_nc = '''No Colour. By default the debug output that is printed comes out in
+multiple colours to help with the debugging. This option disables that.
+'''
 
     help_crd = """
 Checks out branches as CRD-{DATE}+{BRANCH} and sets upstream to 'security'.
@@ -186,6 +191,10 @@ Checks out branches as CRD-{DATE}+{BRANCH} and sets upstream to 'security'.
                         default=None,
                         type=datetime.date.fromisoformat,
                         help=help_crd)
+    parser.add_argument('--nc',
+                        action='store_true',
+                        default=False,
+                        help=help_nc)
 
     try:
         checkout_repos(**vars(parser.parse_args()))
diff --git a/ktl/log.py b/ktl/log.py
index a3f3074..27c320c 100644
--- a/ktl/log.py
+++ b/ktl/log.py
@@ -45,15 +45,24 @@ class Clog:
 
     @classmethod
     def debug(c, msg, color='magenta'):
-        debug(colored(msg, color))
+        if c.color:
+            debug(colored(msg, color))
+        else:
+            debug(msg)
 
     @classmethod
     def warn(c, msg, color='red'):
-        warning(colored(msg, color))
+        if c.color:
+            warning(colored(msg, color))
+        else:
+            warning(msg)
 
     @classmethod
     def notice(c, msg, color='yellow'):
-        c.info(colored(msg, color))
+        if c.color:
+            c.info(colored(msg, color))
+        else:
+            info(msg)
 
     @classmethod
     def enter(c, msg):