Verbosity (#31)

Author: Behemyth

cppython/console.py

@@ -4,12 +4,13 @@
 
 from pathlib import Path
 from typing import Type
+from xmlrpc.client import Boolean
 
 import click
 import tomlkit
 from cppython_core.schema import GeneratorDataType, Interface, PyProject
 
-from cppython.project import Project
+from cppython.project import Project, ProjectConfiguration
 
 
 def _create_pyproject():
@@ -38,60 +39,67 @@ class Config:
     """
 
     def __init__(self):
-        pyproject = _create_pyproject()
+        self.pyproject = _create_pyproject()
+        self.interface = ConsoleInterface()
+        self.configuration = ProjectConfiguration()
 
-        # Initialize the object hook into CPPython
-        interface = ConsoleInterface()
-
-        # Initialize the CPPython context
-        self.project = Project(interface, pyproject)
+    def create_project(self) -> Project:
+        """
+        TODO
+        """
+        return Project(self.configuration, self.interface, self.pyproject)
 
 
-pass_config = click.make_pass_decorator(Config)
+pass_config = click.make_pass_decorator(Config, ensure=True)
 
 
 @click.group()
-@click.pass_context
-def cli(context):
+@click.option("-v", "--verbose", is_flag=True, help="Print additional output")
+@pass_config
+def cli(config, verbose: Boolean):
     """
     entry_point group for the CLI commands
     """
-    context.ensure_object(Config)
+    config.configuration.verbose = verbose
 
 
 @cli.command()
 @pass_config
-def install(config):
+def info(config):
     """
-    Fulfills the 'install' API requirement
+    TODO
     """
-    config.project.install()
+    project = config.create_project()
 
 
 @cli.command()
 @pass_config
-def update(config):
+def install(config):
     """
-    Fulfills the 'update' API requirement
+    TODO
     """
-    config.project.update()
+    project = config.create_project()
+    project.install()
 
 
 @cli.command()
 @pass_config
-def build(config):
+def update(config):
     """
-    Fulfills the 'build' API requirement
+    TODO
     """
-    config.project.build()
+    project = config.create_project()
+    project.update()
 
 
-@cli.result_callback()
+@cli.command()
 @pass_config
-def cleanup(config, result):
+def build(config):
     """
-    Post-command cleanup
+    TODO
     """
+    project = config.create_project()
+    project.build()
 
 
 class ConsoleInterface(Interface):

cppython/plugins/__init__.py

@@ -2,26 +2,45 @@
 The central delegation of the CPPython project
 """
 
+from dataclasses import dataclass
 from importlib import metadata
 from typing import Callable, Optional, Type, TypeVar
+from xmlrpc.client import Boolean
 
 from cppython_core.exceptions import ConfigError
 from cppython_core.schema import API, Generator, Interface, Plugin, PyProject
 
 
+@dataclass
+class ProjectConfiguration:
+    """
+    TODO
+    """
+
+    verbose: Boolean = False
+
+
 class Project(API):
     """
     The object constructed at each entry_point
     """
 
-    def __init__(self, interface: Interface, pyproject: PyProject) -> None:
+    def __init__(self, configuration: ProjectConfiguration, interface: Interface, pyproject: PyProject) -> None:
 
         self.enabled = False
+        self.verbose = configuration.verbose
+
+        if self.verbose:
+            interface.print("Starting CPPython project initialization")
 
         if pyproject.tool is None:
+            if self.verbose:
+                interface.print("Table [tool] is not defined")
             return
 
         if pyproject.tool.cppython is None:
+            if self.verbose:
+                interface.print("Table [tool.cppython] is not defined")
             return
 
         self.enabled = True
@@ -53,6 +72,9 @@ def find_plugin_type(plugin_type: PluginType, condition: Callable[[str], bool])
         generator_data = interface.read_generator_data(plugin_type.data_type())
         self._generator = plugin_type(pyproject, generator_data)
 
+        if self.verbose:
+            interface.print("CPPython project initialized")
+
     def download(self):
         """
         Download the generator tooling if required
@@ -68,13 +90,19 @@ def download(self):
 
     def install(self) -> None:
         if self.enabled:
+            if self.verbose:
+                self._interface.print("CPPython: Installing...")
             self.download()
             self._generator.install()
 
     def update(self) -> None:
         if self.enabled:
+            if self.verbose:
+                self._interface.print("CPPython: Updating...")
             self._generator.update()
 
     def build(self) -> None:
         if self.enabled:
+            if self.verbose:
+                self._interface.print("CPPython: Building...")
             self._generator.build()

cppython/project.py

@@ -16,7 +16,7 @@ requires-python = ">=3.10"
 dependencies = [
   "click>=8.0.3",
   "tomlkit>=0.10.0",
-  "cppython-core>=0.1.0",
+  "cppython-core>=0.1.1",
 ]
 
 [project.license-files]

pdm.lock

@@ -10,6 +10,7 @@
 
 from cppython.console import Config, ConsoleInterface, cli
 from cppython.data import default_pyproject
+from cppython.project import ProjectConfiguration
 
 
 class TestCLIInterface(InterfaceUnitTests):
@@ -55,3 +56,24 @@ def test_command(self, command: str, mocker: MockerFixture):
 
         assert result.exit_code == 0
         mocked_command.assert_called_once()
+
+    def test_config(self):
+        """
+        TODO
+        """
+
+        Config()
+
+    def test_verbosity(self):
+        """
+        TODO
+        """
+
+        config = Config()
+
+        runner = CliRunner()
+        result = runner.invoke(cli, "-v info", obj=config, catch_exceptions=False)
+
+        assert result.exit_code == 0
+
+        assert config.configuration.verbose