Unify Printer, Logger and Console classes (#2124)

Refactors Printer, Log and Console into a single Console class. This providers a single point of entry for all user input/ouput handling.

Author: freakboy3742

changes/2114.feature.rst

@@ -1 +1 @@
-Project bootstraps now have access to the Briefcase logger, console, and the overrides specified with ``-Q`` options at the command line.
+Project bootstraps now have access to the Briefcase console and the overrides specified with ``-Q`` options at the command line.

changes/2114.removal.rst

@@ -1 +1 @@
-The API for project bootstraps has been slightly modified. The constructor for a bootstrap must now accept a logger and console argument; the ``extra_context()`` method must now accept a ``project_overrides`` argument.
+The API for project bootstraps has been slightly modified. The constructor for a bootstrap must now accept a console argument; the ``extra_context()`` method must now accept a ``project_overrides`` argument.

changes/2124.misc.rst

@@ -0,0 +1 @@
+The Printer, Logger and Console classes have been unified into a single Console class.

src/briefcase/__main__.py

@@ -3,7 +3,7 @@
 from pathlib import Path
 
 from briefcase.cmdline import parse_cmdline
-from briefcase.console import Console, Log, Printer
+from briefcase.console import Console
 from briefcase.exceptions import (
     BriefcaseError,
     BriefcaseTestSuiteFailure,
@@ -15,49 +15,47 @@
 def main():
     result = 0
     command = None
-    printer = Printer()
-    console = Console(printer=printer)
-    logger = Log(printer=printer)
+    console = Console()
     try:
         Command, extra_cmdline = parse_cmdline(sys.argv[1:], console=console)
-        command = Command(logger=logger, console=console)
+        command = Command(console=console)
         options, overrides = command.parse_options(extra=extra_cmdline)
         command.parse_config(
             Path.cwd() / "pyproject.toml",
             overrides=overrides,
         )
         command(**options)
     except HelpText as e:
-        logger.info()
-        logger.info(str(e))
+        console.info()
+        console.info(str(e))
         result = e.error_code
     except BriefcaseWarning as w:
         # The case of something that hasn't gone right, but in an
         # acceptable way.
-        logger.warning(str(w))
+        console.warning(str(w))
         result = w.error_code
     except BriefcaseTestSuiteFailure as e:
         # Test suite status is logged when the test is executed.
         # Set the return code, but don't log anything else.
         result = e.error_code
     except BriefcaseError as e:
-        logger.error()
-        logger.error(str(e))
+        console.error()
+        console.error(str(e))
         result = e.error_code
-        logger.capture_stacktrace()
+        console.capture_stacktrace()
     except Exception:
-        logger.capture_stacktrace()
+        console.capture_stacktrace()
         raise
     except KeyboardInterrupt:
-        logger.warning()
-        logger.warning("Aborted by user.")
-        logger.warning()
+        console.warning()
+        console.warning("Aborted by user.")
+        console.warning()
         result = -42
-        if logger.save_log:
-            logger.capture_stacktrace()
+        if console.save_log:
+            console.capture_stacktrace()
     finally:
         with suppress(KeyboardInterrupt):
-            logger.save_log_to_file(command)
+            console.save_log_to_file(command)
 
     return result
 

src/briefcase/bootstraps/base.py

@@ -4,7 +4,7 @@
 from pathlib import Path
 from typing import Any, TypedDict
 
-from briefcase.console import Console, Log
+from briefcase.console import Console
 
 
 class AppContext(TypedDict):
@@ -54,9 +54,8 @@ class BaseGuiBootstrap(ABC):
     # is presented with the options to create a new project.
     display_name_annotation: str = ""
 
-    def __init__(self, logger: Log, input: Console, context: AppContext):
-        self.logger = logger
-        self.input = input
+    def __init__(self, console: Console, context: AppContext):
+        self.console = console
 
         # context contains metadata about the app being created
         self.context = context

src/briefcase/commands/base.py

@@ -28,7 +28,7 @@
 import briefcase
 from briefcase import __version__
 from briefcase.config import AppConfig, GlobalConfig, parse_config
-from briefcase.console import MAX_TEXT_WIDTH, Console, Log
+from briefcase.console import MAX_TEXT_WIDTH, Console
 from briefcase.exceptions import (
     BriefcaseCommandError,
     BriefcaseConfigError,
@@ -140,7 +140,6 @@ class BaseCommand(ABC):
 
     def __init__(
         self,
-        logger: Log,
         console: Console,
         tools: ToolCache = None,
         apps: dict = None,
@@ -150,7 +149,6 @@ def __init__(
     ):
         """Base for all Commands.
 
-        :param logger: Logger for console and logfile.
         :param console: Facilitates console interaction and input solicitation.
         :param tools: Cache of tools populated by Commands as they are required.
         :param apps: Dictionary of project's Apps keyed by app name.
@@ -169,7 +167,6 @@ def __init__(
         self.is_clone = is_clone
 
         self.tools = tools or ToolCache(
-            logger=logger,
             console=console,
             base_path=self.data_path / "tools",
         )
@@ -185,12 +182,8 @@ def __init__(
         self._briefcase_toml: dict[AppConfig, dict[str, ...]] = {}
 
     @property
-    def logger(self):
-        return self.tools.logger
-
-    @property
-    def input(self):
-        return self.tools.input
+    def console(self):
+        return self.tools.console
 
     def validate_data_path(self, data_path):
         """Validate provided data path or determine OS-specific path.
@@ -275,7 +268,7 @@ def validate_data_path(self, data_path):
     def validate_locale(self):
         """Validate the system's locale is compatible."""
         if self.tools.host_os == "Linux" and self.tools.system_encoding != "UTF-8":
-            self.logger.warning(
+            self.console.warning(
                 f"""
 *************************************************************************
 ** WARNING: Default system encoding is not supported                   **
@@ -304,8 +297,7 @@ def _command_factory(self, command_name: str):
         command = getattr(format_module, command_name)(
             base_path=self.base_path,
             apps=self.apps,
-            logger=self.logger,
-            console=self.input,
+            console=self.console,
             tools=self.tools,
             is_clone=True,
         )
@@ -731,7 +723,7 @@ def parse_options(self, extra):
                 platform=self.platform,
                 output_format=self.output_format,
             ),
-            description=self.input.textwrap(
+            description=self.console.textwrap(
                 f"{self.description}\n\n{supported_formats_helptext}"
             ),
             formatter_class=(
@@ -765,9 +757,9 @@ def parse_options(self, extra):
             options["passthrough"] = passthrough
 
         # Extract the base default options onto the command
-        self.input.enabled = options.pop("input_enabled")
-        self.logger.verbosity = options.pop("verbosity")
-        self.logger.save_log = options.pop("save_log")
+        self.console.input_enabled = options.pop("input_enabled")
+        self.console.verbosity = options.pop("verbosity")
+        self.console.save_log = options.pop("save_log")
 
         # Parse the configuration overrides
         overrides = parse_config_overrides(options.pop("config_overrides"))
@@ -902,7 +894,7 @@ def parse_config(self, filename, overrides):
                     config_file,
                     platform=self.platform,
                     output_format=self.output_format,
-                    logger=self.logger,
+                    console=self.console,
                 )
 
                 # Create the global config
@@ -958,7 +950,7 @@ def update_cookiecutter_cache(self, template: str, branch="master"):
                     repo = self.tools.git.Repo(cached_template)
                 except self.tools.git.exc.GitError:
                     # Template repository is in a weird state. Delete it
-                    self.logger.warning(
+                    self.console.warning(
                         "Template cache is in a weird state. Getting a clean clone."
                     )
                     self.tools.shutil.rmtree(cached_template)
@@ -968,7 +960,7 @@ def update_cookiecutter_cache(self, template: str, branch="master"):
                 # the template, or the template was in a weird state. Perform a blobless
                 # clone.
                 try:
-                    self.logger.info(f"Cloning template {template!r}...")
+                    self.console.info(f"Cloning template {template!r}...")
                     cached_template.mkdir(exist_ok=True, parents=True)
                     repo = self.tools.git.Repo.clone_from(
                         url=template,
@@ -1022,8 +1014,8 @@ def update_cookiecutter_cache(self, template: str, branch="master"):
                     # We are offline, or otherwise unable to contact the origin git
                     # repo. It's OK to continue; but capture the error in the log and
                     # warn the user that the template may be stale.
-                    self.logger.debug(str(e))
-                    self.logger.warning(
+                    self.console.debug(str(e))
+                    self.console.warning(
                         """
 *************************************************************************
 ** WARNING: Unable to update template                                  **
@@ -1041,7 +1033,7 @@ def update_cookiecutter_cache(self, template: str, branch="master"):
                     # Check out the branch for the required version tag.
                     head = remote.refs[branch]
 
-                    self.logger.info(
+                    self.console.info(
                         f"Using existing template (sha {head.commit.hexsha}, "
                         f"updated {head.commit.committed_datetime.strftime('%c')})"
                     )
@@ -1082,7 +1074,7 @@ def _generate_template(self, template, branch, output_path, extra_context):
             branch=branch,
         )
 
-        self.logger.configure_stdlib_logging("cookiecutter")
+        self.console.configure_stdlib_logging("cookiecutter")
         try:
             # Unroll the template.
             self.tools.cookiecutter(
@@ -1136,7 +1128,7 @@ def generate_template(
         )
 
         try:
-            self.logger.info(
+            self.console.info(
                 f"Using app template: {template}, branch {template_branch}"
             )
             # Unroll the new app template
@@ -1153,7 +1145,7 @@ def generate_template(
                 raise
 
             # Development branches can use the main template.
-            self.logger.info(
+            self.console.info(
                 f"Template branch {template_branch} not found; falling back to development template"
             )
 

src/briefcase/commands/build.py

@@ -77,7 +77,7 @@ def _build_app(
         state = self.build_app(app, test_mode=test_mode, **full_options(state, options))
 
         qualifier = " (test mode)" if test_mode else ""
-        self.logger.info(
+        self.console.info(
             f"Built {self.binary_path(app).relative_to(self.base_path)}{qualifier}",
             prefix=app.app_name,
         )