cli: Use logging library functions instead of print

This lets us remove a bunch of checks for verbose, which cleans up
the API and it also lets us configure the logging at one location,
such as by sending it to stderr.

Author: cassava

cli/cloe_launch/__init__.py

@@ -3,6 +3,7 @@
 """
 
 from typing import List, Optional
+import logging
 import os
 import shutil
 import subprocess
@@ -22,35 +23,32 @@ class Configuration:
     profiles_dir = os.path.join(config_dir, "profiles")
     runtime_dir = os.path.expanduser("~/.cache/cloe/launcher")
 
-    verbose = 0
     conf_version = "1"
     _conf = {
         "version": conf_version,
         "shell_path": "/bin/bash",
         "conan_path": "conan",
         "relay_anonymous_files": True,
-        "engine": {"pre_arguments": [], "post_arguments": [],},
+        "engine": {
+            "pre_arguments": [],
+            "post_arguments": [],
+        },
     }
 
     all_profiles: List[str] = []
     default_profile: Optional[str] = None
     current_profile = None
 
-    def __init__(self, profile: str = None, verbose: int = 0):
-        self.verbose = verbose
-
+    def __init__(self, profile: str = None):
         # Make configuration and runtime directories if needed:
         if not os.path.exists(self.config_dir):
-            if self.verbose > 0:
-                print("Create configuration directory:", self.config_dir)
+            logging.info("Create configuration directory:", self.config_dir)
             os.makedirs(self.config_dir)
         if not os.path.exists(self.profiles_dir):
-            if self.verbose > 0:
-                print("Create profile directory:", self.profiles_dir)
+            logging.info("Create profile directory:", self.profiles_dir)
             os.makedirs(self.profiles_dir)
         if not os.path.exists(self.runtime_dir):
-            if self.verbose > 0:
-                print("Create runtime directory:", self.runtime_dir)
+            logging.info("Create runtime directory:", self.runtime_dir)
             os.makedirs(self.runtime_dir)
 
         # Load configuration file:
@@ -95,17 +93,15 @@ def set_default(self, profile: str) -> None:
             raise ConfigurationError("profile {} does not exist".format(profile))
         self.default_profile = profile
         self._conf["default_profile"] = profile
-        if self.verbose > 0:
-            print(
-                "Write configuration to {}:\n  {}".format(self.config_file, self._conf)
-            )
+        logging.info(
+            "Write configuration to {}:\n  {}".format(self.config_file, self._conf)
+        )
         with open(self.config_file, "w") as file:
             toml.dump(self._conf, file)
 
     def read(self, profile: str) -> str:
         """Read the specified profile."""
-        if self.verbose > 0:
-            print("Open:", self.profile_path(profile))
+        logging.info("Open:", self.profile_path(profile))
         with open(self.profile_path(profile), "r") as file:
             return file.read()
 
@@ -117,8 +113,7 @@ def edit(self, profile: str, create: bool = False) -> None:
         if not create and not os.path.exists(self.profile_path(profile)):
             raise ConfigurationError("profile {} does not exist".format(profile))
         cmd = [editor, self.profile_path(profile)]
-        if self.verbose > 0:
-            print("Exec:", " ".join(cmd))
+        logging.info("Exec:", " ".join(cmd))
         subprocess.call(cmd)
 
     def add(self, profile: str, file: str, force: bool = False) -> None:
@@ -127,8 +122,7 @@ def add(self, profile: str, file: str, force: bool = False) -> None:
             raise ConfigurationError(
                 "cannot overwrite profile {} unless forced".format(profile)
             )
-        if self.verbose > 1:
-            print("Copy: {} -> {}".format(file, self.profile_path(profile)))
+        logging.debug("Copy: {} -> {}".format(file, self.profile_path(profile)))
         shutil.copyfile(file, self.profile_path(profile))
         if profile not in self.all_profiles:
             self.all_profiles.append(profile)
@@ -137,8 +131,7 @@ def remove(self, profile: str) -> None:
         """Remove the profile, if it exists."""
         file = os.path.join(self.profiles_dir, profile)
         if os.path.exists(file):
-            if self.verbose > 0:
-                print("Remove:", file)
+            logging.info("Remove:", file)
             os.remove(file)
         if self.default_profile == profile:
             self.set_default(None)

cli/cloe_launch/__main__.py

@@ -21,6 +21,7 @@
 import os
 import sys
 import click
+import logging
 
 from cloe_launch.exec import Engine
 from cloe_launch import Configuration, ConfigurationError
@@ -38,11 +39,19 @@
 def main(ctx, verbose: int):
     """Launch cloe-engine with profiles and manage launch profiles."""
 
+    if verbose == 0:
+        level = logging.WARNING
+    elif verbose == 1:
+        level = logging.INFO
+    else:
+        level = logging.DEBUG
+    logging.basicConfig(format="%(message)s", stream=sys.stderr, level=level)
+
     class Options:
         def __init__(self, verbose):
             self.verbose = verbose
 
-    ctx.obj = Options(verbose=verbose)
+    ctx.obj = Options(verbose > 0)
 
 
 # Common options among engine and profile commands:
@@ -130,7 +139,7 @@ def cli_exec(
     ENGINE_ARGS are passed on to cloe-engine.
     """
     deny_profile_and_path(profile, profile_path)
-    conf = Configuration(profile, opt.verbose)
+    conf = Configuration(profile)
     engine = Engine(conf, conanfile=profile_path)
     engine.preserve_env = preserve_env
     engine.conan_options = conan_option
@@ -178,7 +187,7 @@ def cli_shell(
 ) -> None:
     """Launch shell with the correct environment from a profile."""
     deny_profile_and_path(profile, profile_path)
-    conf = Configuration(profile, opt.verbose)
+    conf = Configuration(profile)
     engine = Engine(conf, conanfile=profile_path)
     engine.preserve_env = preserve_env
     engine.conan_options = conan_option
@@ -196,7 +205,7 @@ def cli_shell(
 def cli_clean(opt, profile: str, profile_path: str) -> None:
     """Clean launcher profile cache."""
     deny_profile_and_path(profile, profile_path)
-    conf = Configuration(profile, opt.verbose)
+    conf = Configuration(profile)
     engine = Engine(conf, conanfile=profile_path)
     engine.clean()
 
@@ -215,7 +224,7 @@ def cli_profile():
 @click.pass_obj
 def cli_profile_show(opt, profile: str) -> None:
     """Show a profile configuration."""
-    conf = Configuration(profile, opt.verbose)
+    conf = Configuration(profile)
     if conf.current_profile is None:
         raise ConfigurationError("no default profile is configured")
     data = conf.read(conf.current_profile)
@@ -228,9 +237,9 @@ def cli_profile_show(opt, profile: str) -> None:
 @click.pass_obj
 def cli_profile_list(opt) -> None:
     """List all available profiles."""
-    conf = Configuration(verbose=opt.verbose)
+    conf = Configuration()
     for profile in conf.all_profiles:
-        if opt.verbose > 0:
+        if opt.verbose:
             if profile == conf.default_profile:
                 print("*", profile)
             else:
@@ -253,7 +262,7 @@ def cli_profile_add(
     opt, profile: str, conanfile: str, force: bool = False, default: bool = False
 ) -> None:
     """Add a new profile."""
-    conf = Configuration(verbose=opt.verbose)
+    conf = Configuration()
     conf.add(profile, conanfile, force=force)
     if default:
         conf.set_default(profile)
@@ -279,7 +288,7 @@ def cli_profile_add(
 @click.pass_obj
 def cli_profile_edit(opt, profile: str, editor: str, create: bool) -> None:
     """Edit a profile."""
-    conf = Configuration(profile, verbose=opt.verbose)
+    conf = Configuration(profile)
     if conf.current_profile is None:
         raise ConfigurationError("no default profile is configured")
     conf.edit(conf.current_profile, create)
@@ -292,7 +301,7 @@ def cli_profile_edit(opt, profile: str, editor: str, create: bool) -> None:
 @click.pass_obj
 def cli_profile_remove(opt, profile: str) -> None:
     """Remove a profile."""
-    conf = Configuration(verbose=opt.verbose)
+    conf = Configuration()
     conf.remove(profile)
 
 
@@ -303,11 +312,11 @@ def cli_profile_remove(opt, profile: str) -> None:
 @click.pass_obj
 def cli_profile_default(opt, profile: str) -> None:
     """Show or set the default profile."""
-    conf = Configuration(profile, verbose=opt.verbose)
+    conf = Configuration(profile)
     if profile is None:
         if conf.default_profile is not None:
             print(conf.default_profile)
-        elif opt.verbose > 0:
+        elif opt.verbose:
             print("Note: no default profile is configured")
     else:
         # Set default to provided value, which must exist already