Download Abstraction (#25)

Added download abstraction with interface printing

Author: Behemyth

cppython/plugins/generator/cmake.py

@@ -34,12 +34,14 @@ def data_type() -> Type[GeneratorData]:
         """
         return CMakeData
 
-    def install_generator(self) -> bool:
+    def downloaded(self) -> bool:
+        return True
+
+    def download(self) -> None:
         """
         Installs the external tooling required by the generator if necessary
         Returns whether anything was installed or not
         """
-        return False
 
     def install(self) -> None:
         raise NotImplementedError()

cppython/plugins/interface/console.py

@@ -109,4 +109,6 @@ def write_pyproject(self) -> None:
         """
         Write output
         """
-        pass
+
+    def print(self, string: str) -> None:
+        click.echo(string)

cppython/plugins/test/data.py

@@ -9,7 +9,6 @@
 default_pep621 = PEP621(name="test_name", version="1.0")
 
 # CMake is a default plugin
-# TODO: Provide dynamic default
-default_cppython_data = CPPythonData(generator="cmake", target=TargetEnum.EXE, install_path=Path())
+default_cppython_data = CPPythonData(**{"generator": "cmake", "target": TargetEnum.EXE, "install-path": Path()})
 
-default_pyproject = PyProject(pep_621=default_pep621, cppython_data=default_cppython_data)
+default_pyproject = PyProject(project=default_pep621, cppython=default_cppython_data)

cppython/project.py

@@ -16,6 +16,8 @@ class Project(API):
 
     def __init__(self, interface: Interface, pyproject: PyProject) -> None:
 
+        self.enabled = pyproject.cppython != None
+
         self._interface = interface
 
         PluginType = TypeVar("PluginType", bound=Type[Plugin])
@@ -35,22 +37,36 @@ def find_plugin_type(plugin_type: PluginType, condition: Callable[[str], bool])
 
             return None
 
-        plugin_type = find_plugin_type(Generator, lambda name: name == pyproject.cppython_data.generator)
+        plugin_type = find_plugin_type(Generator, lambda name: name == pyproject.cppython.generator)
 
         if plugin_type is None:
-            raise ConfigError(f"No generator plugin with the name '{pyproject.cppython_data.generator}' was found.")
+            raise ConfigError(f"No generator plugin with the name '{pyproject.cppython.generator}' was found.")
 
         generator_data = interface.read_generator_data(plugin_type.data_type())
         self._generator = plugin_type(pyproject, generator_data)
-        self._generator.install_generator()
+
+    def download(self):
+        """
+        Download the generator tooling if required
+        """
+        if not self._generator.downloaded():
+            self._interface.print(f"Downloading the {self._generator.name()} tool")
+
+            # TODO: Make async with progress bar
+            self._generator.download()
+            self._interface.print("Download complete")
 
     # API Contract
 
     def install(self) -> None:
-        self._generator.install()
+        if self.enabled:
+            self.download()
+            self._generator.install()
 
     def update(self) -> None:
-        self._generator.update()
+        if self.enabled:
+            self._generator.update()
 
     def build(self) -> None:
-        self._generator.build()
+        if self.enabled:
+            self._generator.build()

cppython/schema.py

@@ -5,9 +5,10 @@
 from abc import ABC, abstractmethod
 from enum import Enum
 from pathlib import Path
-from typing import Type, TypeVar
+from typing import Optional, Type, TypeVar
 
 from pydantic import BaseModel
+from pydantic.fields import Field
 
 
 class TargetEnum(Enum):
@@ -40,16 +41,16 @@ class CPPythonData(BaseModel):
     generator: str
     target: TargetEnum
     dependencies: dict[str, str] = {}
-    install_path: Path
+    install_path: Path = Field(alias="install-path")
 
 
 class PyProject(BaseModel):
     """
     pyproject.toml schema
     """
 
-    pep_621: PEP621
-    cppython_data: CPPythonData
+    project: PEP621
+    cppython: Optional[CPPythonData]
 
 
 class API(ABC):
@@ -131,6 +132,13 @@ def write_pyproject(self) -> None:
         """
         raise NotImplementedError()
 
+    @abstractmethod
+    def print(self, string: str) -> None:
+        """
+        Prints the given string into the Interface IO
+        """
+        raise NotImplementedError()
+
 
 class Generator(Plugin, API):
     """
@@ -165,9 +173,15 @@ def data_type() -> Type[GeneratorData]:
         raise NotImplementedError()
 
     @abstractmethod
-    def install_generator(self) -> bool:
+    def downloaded(self) -> bool:
+        """
+        Returns whether the generator needs to be downloaded
+        """
+        raise NotImplementedError()
+
+    @abstractmethod
+    def download(self) -> None:
         """
-        Installs the external tooling required by the generator if necessary
-        Returns whether anything was installed or not
+        Installs the external tooling required by the generator
         """
         raise NotImplementedError()