publish Command + Test Organization (#115)

Author: Behemyth

.gitignore

@@ -10,10 +10,18 @@ TestResults/
 *.pyc
 dist/
 .vs/
+.venv/
+
+#Pytest
+.pytest_cache/
 
 #PDM
 .pdm-python
 __pypackages__/
+.pdm-build/
+
+#ruff
+.ruff_cache/
 
 #Coverage
 .coverage

.vscode/extensions.json

@@ -1,8 +1,8 @@
 {
     "recommendations": [
-        "ms-python.mypy-type-checker",
         "asciidoctor.asciidoctor-vscode",
         "charliermarsh.ruff",
-        "tamasfe.even-better-toml"
+        "tamasfe.even-better-toml",
+        "meta.pyrefly"
     ]
 }

.vscode/settings.json

@@ -5,10 +5,14 @@
     "python.testing.unittestEnabled": false,
     "python.testing.pytestEnabled": true,
     "editor.formatOnSave": true,
-    "editor.codeActionsOnSave": {
-        "source.organizeImports": "explicit"
-    },
     "mypy-type-checker.reportingScope": "workspace",
     "mypy-type-checker.preferDaemon": true,
     "mypy-type-checker.importStrategy": "fromEnvironment",
+    "[python]": {
+        "editor.codeActionsOnSave": {
+            "source.fixAll": "explicit",
+            "source.organizeImports": "explicit"
+        },
+        "editor.defaultFormatter": "charliermarsh.ruff"
+    }
 }

cppython/builder.py

@@ -4,11 +4,11 @@
 from importlib.metadata import entry_points
 from inspect import getmodule
 from logging import Logger
-from typing import Any
+from typing import Any, cast
 
 from cppython.core.plugin_schema.generator import Generator
 from cppython.core.plugin_schema.provider import Provider
-from cppython.core.plugin_schema.scm import SCM
+from cppython.core.plugin_schema.scm import SCM, SupportedSCMFeatures
 from cppython.core.resolution import (
     PluginBuildData,
     PluginCPPythonData,
@@ -262,7 +262,7 @@ def select_scm(self, scm_plugins: list[type[SCM]], project_data: ProjectData) ->
             The selected SCM plugin type
         """
         for scm_type in scm_plugins:
-            if scm_type.features(project_data.project_root).repository:
+            if cast(SupportedSCMFeatures, scm_type.features(project_data.project_root)).repository:
                 return scm_type
 
         self._logger.info('No SCM plugin was found that supports the given path')
@@ -317,7 +317,7 @@ def create_scm(
         cppython_plugin_data = resolve_cppython_plugin(core_data.cppython_data, scm_type)
         scm_data = resolve_scm(core_data.project_data, cppython_plugin_data)
 
-        plugin = scm_type(scm_data)
+        plugin = cast(SCM, scm_type(scm_data))
 
         return plugin
 
@@ -354,7 +354,7 @@ def create_generator(
             cppython_data=cppython_plugin_data,
         )
 
-        return generator_type(generator_data, core_plugin_data, generator_configuration)
+        return cast(Generator, generator_type(generator_data, core_plugin_data, generator_configuration))
 
     def create_provider(
         self,
@@ -389,7 +389,7 @@ def create_provider(
             cppython_data=cppython_plugin_data,
         )
 
-        return provider_type(provider_data, core_plugin_data, provider_configuration)
+        return cast(Provider, provider_type(provider_data, core_plugin_data, provider_configuration))
 
 
 class Builder:

cppython/console/entry.py

@@ -5,12 +5,29 @@
 from typing import Annotated
 
 import typer
+from rich import print
 
 from cppython.console.schema import ConsoleConfiguration, ConsoleInterface
 from cppython.core.schema import ProjectConfiguration
 from cppython.project import Project
 
-app = typer.Typer()
+app = typer.Typer(no_args_is_help=True)
+
+
+def get_enabled_project(context: typer.Context) -> Project:
+    """Helper to load and validate an enabled Project from CLI context."""
+    configuration = context.find_object(ConsoleConfiguration)
+    if configuration is None:
+        raise ValueError('The configuration object is missing')
+
+    path = configuration.project_configuration.project_root / 'pyproject.toml'
+    pyproject_data = loads(path.read_text(encoding='utf-8'))
+
+    project = Project(configuration.project_configuration, configuration.interface, pyproject_data)
+    if not project.enabled:
+        print('[bold red]Error[/bold red]: Project is not enabled. Please check your pyproject.toml configuration.')
+        raise typer.Exit(code=1)
+    return project
 
 
 def _find_pyproject_file() -> Path:
@@ -75,13 +92,7 @@ def install(
     Raises:
         ValueError: If the configuration object is missing
     """
-    if (configuration := context.find_object(ConsoleConfiguration)) is None:
-        raise ValueError('The configuration object is missing')
-
-    path = configuration.project_configuration.project_root / 'pyproject.toml'
-    pyproject_data = loads(path.read_text(encoding='utf-8'))
-
-    project = Project(configuration.project_configuration, configuration.interface, pyproject_data)
+    project = get_enabled_project(context)
     project.install()
 
 
@@ -97,13 +108,7 @@ def update(
     Raises:
         ValueError: If the configuration object is missing
     """
-    if (configuration := context.find_object(ConsoleConfiguration)) is None:
-        raise ValueError('The configuration object is missing')
-
-    path = configuration.project_configuration.project_root / 'pyproject.toml'
-    pyproject_data = loads(path.read_text(encoding='utf-8'))
-
-    project = Project(configuration.project_configuration, configuration.interface, pyproject_data)
+    project = get_enabled_project(context)
     project.update()
 
 
@@ -112,3 +117,19 @@ def list_command(
     _: typer.Context,
 ) -> None:
     """Prints project information"""
+
+
+@app.command()
+def publish(
+    context: typer.Context,
+) -> None:
+    """Publish API call
+
+    Args:
+        context: The CLI configuration object
+
+    Raises:
+        ValueError: If the configuration object is missing
+    """
+    project = get_enabled_project(context)
+    project.publish()

cppython/core/plugin_schema/generator.py

@@ -10,6 +10,7 @@
     DataPlugin,
     DataPluginGroupData,
     SupportedDataFeatures,
+    SupportedFeatures,
     SyncData,
 )
 
@@ -58,13 +59,13 @@ def __init__(
 
     @staticmethod
     @abstractmethod
-    def features(directory: DirectoryPath) -> SupportedGeneratorFeatures:
+    def features(directory: DirectoryPath) -> SupportedFeatures:
         """Broadcasts the shared features of the generator plugin to CPPython
 
         Args:
             directory: The root directory where features are evaluated
 
         Returns:
-            The supported features
+            The supported features - `SupportedGeneratorFeatures`. Cast to this type to help us avoid generic typing
         """
         raise NotImplementedError

cppython/core/plugin_schema/provider.py

@@ -11,6 +11,7 @@
     DataPlugin,
     DataPluginGroupData,
     SupportedDataFeatures,
+    SupportedFeatures,
     SyncData,
 )
 
@@ -67,14 +68,14 @@ def __init__(
 
     @staticmethod
     @abstractmethod
-    def features(directory: DirectoryPath) -> SupportedProviderFeatures:
+    def features(directory: DirectoryPath) -> SupportedFeatures:
         """Broadcasts the shared features of the Provider plugin to CPPython
 
         Args:
             directory: The root directory where features are evaluated
 
         Returns:
-            The supported features
+            The supported features - `SupportedProviderFeatures`. Cast to this type to help us avoid generic typing
         """
         raise NotImplementedError
 
@@ -87,3 +88,8 @@ def install(self) -> None:
     def update(self) -> None:
         """Called when dependencies need to be updated and written to the lock file."""
         raise NotImplementedError
+
+    @abstractmethod
+    def publish(self) -> None:
+        """Called when the project needs to be published."""
+        raise NotImplementedError

cppython/core/plugin_schema/scm.py

@@ -31,14 +31,14 @@ def __init__(self, group_data: SCMPluginGroupData) -> None:
 
     @staticmethod
     @abstractmethod
-    def features(directory: DirectoryPath) -> SupportedSCMFeatures:
+    def features(directory: DirectoryPath) -> SupportedFeatures:
         """Broadcasts the shared features of the SCM plugin to CPPython
 
         Args:
             directory: The root directory where features are evaluated
 
         Returns:
-            The supported features
+            The supported features - `SupportedSCMFeatures`. Cast to this type to help us avoid generic typing
         """
         raise NotImplementedError
 

cppython/core/schema.py

@@ -44,7 +44,7 @@ class ProjectConfiguration(CPPythonModel, extra='forbid'):
         bool, Field(description='Debug mode. Additional processing will happen to expose more debug information')
     ] = False
 
-    @field_validator('verbosity')
+    @field_validator('verbosity')  # type: ignore
     @classmethod
     def min_max(cls, value: int) -> int:
         """Validator that clamps the input value
@@ -118,7 +118,7 @@ class CPPythonData(CPPythonModel, extra='forbid'):
     scm_name: TypeName
     dependencies: list[Requirement]
 
-    @field_validator('configuration_path', 'install_path', 'tool_path', 'build_path')
+    @field_validator('configuration_path', 'install_path', 'tool_path', 'build_path')  # type: ignore
     @classmethod
     def validate_absolute_path(cls, value: Path) -> Path:
         """Enforce the input is an absolute path
@@ -234,14 +234,14 @@ def __init__(
 
     @staticmethod
     @abstractmethod
-    def features(directory: DirectoryPath) -> SupportedDataFeatures:
+    def features(directory: DirectoryPath) -> SupportedFeatures:
         """Broadcasts the shared features of the data plugin to CPPython
 
         Args:
             directory: The root directory where features are evaluated
 
         Returns:
-            The supported features
+            The supported features - `SupportedDataFeatures`. Cast to this type to help us avoid generic typing
         """
         raise NotImplementedError
 

cppython/defaults.py

@@ -7,7 +7,7 @@
     SCMPluginGroupData,
     SupportedSCMFeatures,
 )
-from cppython.core.schema import Information
+from cppython.core.schema import Information, SupportedFeatures
 
 
 class DefaultSCM(SCM):
@@ -18,11 +18,11 @@ def __init__(self, group_data: SCMPluginGroupData) -> None:
         self.group_data = group_data
 
     @staticmethod
-    def features(_: DirectoryPath) -> SupportedSCMFeatures:
+    def features(directory: DirectoryPath) -> SupportedFeatures:
         """Broadcasts the shared features of the SCM plugin to CPPython
 
         Returns:
-            The supported features
+            The supported features - `SupportedGeneratorFeatures`. Cast to this type to help us avoid generic typing
         """
         return SupportedSCMFeatures(repository=True)
 
@@ -36,7 +36,7 @@ def information() -> Information:
         return Information()
 
     @staticmethod
-    def version(_: DirectoryPath) -> str:
+    def version(directory: DirectoryPath) -> str:
         """Extracts the system's version metadata
 
         Returns: