Project Root

Author: Behemyth

cppython/builder.py

@@ -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.pyproject_file.parent).repository:
+            if scm_type.features(project_data.project_root).repository:
                 return scm_type
 
         self._logger.info('No SCM plugin was found that supports the given path')

cppython/console/entry.py

@@ -49,9 +49,8 @@ def main(
         debug: Debug mode
     """
     path = _find_pyproject_file()
-    file_path = path / 'pyproject.toml'
 
-    project_configuration = ProjectConfiguration(verbosity=verbose, debug=debug, pyproject_file=file_path, version=None)
+    project_configuration = ProjectConfiguration(verbosity=verbose, debug=debug, project_root=path, version=None)
 
     interface = ConsoleInterface()
     context.obj = ConsoleConfiguration(project_configuration=project_configuration, interface=interface)
@@ -79,7 +78,7 @@ def install(
     if (configuration := context.find_object(ConsoleConfiguration)) is None:
         raise ValueError('The configuration object is missing')
 
-    path = configuration.project_configuration.pyproject_file
+    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)
@@ -101,7 +100,7 @@ def update(
     if (configuration := context.find_object(ConsoleConfiguration)) is None:
         raise ValueError('The configuration object is missing')
 
-    path = configuration.project_configuration.pyproject_file
+    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)

cppython/core/resolution.py

@@ -33,7 +33,7 @@ def resolve_project_configuration(project_configuration: ProjectConfiguration) -
     Returns:
         The resolved data
     """
-    return ProjectData(pyproject_file=project_configuration.pyproject_file, verbosity=project_configuration.verbosity)
+    return ProjectData(project_root=project_configuration.project_root, verbosity=project_configuration.verbosity)
 
 
 def resolve_pep621(
@@ -58,7 +58,7 @@ def resolve_pep621(
         if project_configuration.version is not None:
             modified_version = project_configuration.version
         elif scm is not None:
-            modified_version = scm.version(project_configuration.pyproject_file.parent)
+            modified_version = scm.version(project_configuration.project_root)
         else:
             raise ValueError("Version can't be resolved. No SCM")
 
@@ -110,7 +110,7 @@ def resolve_cppython(
     Returns:
         An instance of the resolved type
     """
-    root_directory = project_data.pyproject_file.parent.absolute()
+    root_directory = project_data.project_root.absolute()
 
     # Add the base path to all relative paths
     modified_install_path = local_configuration.install_path
@@ -128,11 +128,6 @@ def resolve_cppython(
     if not modified_build_path.is_absolute():
         modified_build_path = root_directory / modified_build_path
 
-    # Create directories if they do not exist
-    modified_install_path.mkdir(parents=True, exist_ok=True)
-    modified_tool_path.mkdir(parents=True, exist_ok=True)
-    modified_build_path.mkdir(parents=True, exist_ok=True)
-
     modified_provider_name = local_configuration.provider_name
     modified_generator_name = local_configuration.generator_name
 
@@ -168,7 +163,6 @@ def resolve_cppython_plugin(cppython_data: CPPythonData, plugin_type: type[Plugi
     """
     # Add plugin specific paths to the base path
     modified_install_path = cppython_data.install_path / plugin_type.name()
-    modified_install_path.mkdir(parents=True, exist_ok=True)
 
     plugin_data = CPPythonData(
         install_path=modified_install_path,
@@ -194,7 +188,6 @@ def _write_tool_directory(cppython_data: CPPythonData, directory: Path) -> Direc
         The written path
     """
     plugin_directory = cppython_data.tool_path / 'cppython' / directory
-    plugin_directory.mkdir(parents=True, exist_ok=True)
 
     return plugin_directory
 
@@ -209,7 +202,7 @@ def resolve_generator(project_data: ProjectData, cppython_data: CPPythonPluginDa
     Returns:
         The plugin specific configuration
     """
-    root_directory = project_data.pyproject_file.parent
+    root_directory = project_data.project_root
     tool_directory = _write_tool_directory(cppython_data, Path('generators') / cppython_data.generator_name)
     configuration = GeneratorPluginGroupData(root_directory=root_directory, tool_directory=tool_directory)
     return configuration
@@ -225,7 +218,7 @@ def resolve_provider(project_data: ProjectData, cppython_data: CPPythonPluginDat
     Returns:
         The plugin specific configuration
     """
-    root_directory = project_data.pyproject_file.parent
+    root_directory = project_data.project_root
     tool_directory = _write_tool_directory(cppython_data, Path('providers') / cppython_data.provider_name)
     configuration = ProviderPluginGroupData(root_directory=root_directory, tool_directory=tool_directory)
     return configuration
@@ -241,7 +234,7 @@ def resolve_scm(project_data: ProjectData, cppython_data: CPPythonPluginData) ->
     Returns:
         The plugin specific configuration
     """
-    root_directory = project_data.pyproject_file.parent
+    root_directory = project_data.project_root
     tool_directory = _write_tool_directory(cppython_data, Path('managers') / cppython_data.scm_name)
     configuration = SCMPluginGroupData(root_directory=root_directory, tool_directory=tool_directory)
     return configuration

cppython/core/schema.py

@@ -5,7 +5,7 @@
 from typing import Annotated, Any, NewType, Protocol, runtime_checkable
 
 from pydantic import BaseModel, Field, field_validator, model_validator
-from pydantic.types import DirectoryPath, FilePath
+from pydantic.types import DirectoryPath
 
 from cppython.utility.plugin import Plugin as SynodicPlugin
 from cppython.utility.utility import TypeName
@@ -20,14 +20,14 @@ class CPPythonModel(BaseModel):
 class ProjectData(CPPythonModel, extra='forbid'):
     """Resolved data of 'ProjectConfiguration'"""
 
-    pyproject_file: Annotated[FilePath, Field(description='The path where the pyproject.toml exists')]
+    project_root: Annotated[Path, Field(description='The path where the pyproject.toml exists')]
     verbosity: Annotated[int, Field(description='The verbosity level as an integer [0,2]')] = 0
 
 
 class ProjectConfiguration(CPPythonModel, extra='forbid'):
     """Project-wide configuration"""
 
-    pyproject_file: Annotated[FilePath, Field(description='The path where the pyproject.toml exists')]
+    project_root: Annotated[Path, Field(description='The path where the pyproject.toml exists')]
     version: Annotated[
         str | None,
         Field(
@@ -56,25 +56,6 @@ def min_max(cls, value: int) -> int:
         """
         return min(max(value, 0), 2)
 
-    @field_validator('pyproject_file')
-    @classmethod
-    def pyproject_name(cls, value: FilePath) -> FilePath:
-        """Validator that verifies the name of the file
-
-        Args:
-            value: Input to validate
-
-        Raises:
-            ValueError: The given filepath is not named "pyproject.toml"
-
-        Returns:
-            The file path
-        """
-        if value.name != 'pyproject.toml':
-            raise ValueError('The given file is not named "pyproject.toml"')
-
-        return value
-
 
 class PEP621Data(CPPythonModel):
     """Resolved PEP621Configuration data"""
@@ -130,17 +111,17 @@ def _default_install_location() -> Path:
 class CPPythonData(CPPythonModel, extra='forbid'):
     """Resolved CPPython data with local and global configuration"""
 
-    install_path: DirectoryPath
-    tool_path: DirectoryPath
-    build_path: DirectoryPath
+    install_path: Path
+    tool_path: Path
+    build_path: Path
     current_check: bool
     provider_name: TypeName
     generator_name: TypeName
     scm_name: TypeName
 
     @field_validator('install_path', 'tool_path', 'build_path')
     @classmethod
-    def validate_absolute_path(cls, value: DirectoryPath) -> DirectoryPath:
+    def validate_absolute_path(cls, value: Path) -> Path:
         """Enforce the input is an absolute path
 
         Args:
@@ -184,7 +165,7 @@ class PluginGroupData(CPPythonModel, extra='forbid'):
 
     root_directory: Annotated[DirectoryPath, Field(description='The directory of the project')]
     tool_directory: Annotated[
-        DirectoryPath,
+        Path,
         Field(
             description=(
                 'Points to the project plugin directory within the tool directory. '

cppython/plugins/cmake/resolution.py

@@ -18,7 +18,7 @@ def resolve_cmake_data(data: dict[str, Any], core_data: CorePluginData) -> CMake
     """
     parsed_data = CMakeConfiguration(**data)
 
-    root_directory = core_data.project_data.pyproject_file.parent.absolute()
+    root_directory = core_data.project_data.project_root.absolute()
 
     modified_preset = parsed_data.preset_file
     if not modified_preset.is_absolute():

cppython/plugins/conan/plugin.py

@@ -19,6 +19,8 @@
 class ConanProvider(Provider):
     """Conan Provider"""
 
+    _provider_url = 'https://raw.githubusercontent.com/conan-io/cmake-conan/refs/heads/develop2/conan_provider.cmake'
+
     def __init__(
         self, group_data: ProviderPluginGroupData, core_data: CorePluginData, configuration_data: dict[str, Any]
     ) -> None:
@@ -27,11 +29,6 @@ def __init__(
         self.core_data: CorePluginData = core_data
         self.data: ConanData = resolve_conan_data(configuration_data, core_data)
 
-        self._provider_file = self.core_data.cppython_data.tool_path / 'conan' / 'conan_provider.cmake'
-        self._provider_url = (
-            'https://raw.githubusercontent.com/conan-io/cmake-conan/refs/heads/develop2/conan_provider.cmake'
-        )
-
     @staticmethod
     def _download_file(url: str, file: Path) -> None:
         """Replaces the given file with the contents of the url"""
@@ -64,17 +61,9 @@ def information() -> Information:
 
     def install(self) -> None:
         """Installs the provider"""
-        self._download_file(
-            self._provider_url,
-            self._provider_file,
-        )
 
     def update(self) -> None:
         """Updates the provider"""
-        self._download_file(
-            self._provider_url,
-            self._provider_file,
-        )
 
     @staticmethod
     def supported_sync_type(sync_type: type[SyncData]) -> bool:
@@ -99,6 +88,14 @@ def sync_data(self, consumer: SyncConsumer) -> SyncData:
         """
         for sync_type in consumer.sync_types():
             if sync_type == CMakeSyncData:
-                return CMakeSyncData(provider_name=TypeName('conan'), top_level_includes=self._provider_file)
+                return CMakeSyncData(
+                    provider_name=TypeName('conan'),
+                    top_level_includes=self.core_data.cppython_data.tool_path / 'conan' / 'conan_provider.cmake',
+                )
 
         raise NotSupportedError('OOF')
+
+    @classmethod
+    async def download_tooling(cls, directory: Path) -> None:
+        """Downloads the conan provider file"""
+        cls._download_file(cls._provider_url, directory / 'conan_provider.cmake')

cppython/plugins/pdm/plugin.py

@@ -33,15 +33,13 @@ def on_post_install(self, project: Project, dry_run: bool, **_kwargs: Any) -> No
             dry_run: If true, won't perform any actions
             _kwargs: Sink for unknown arguments
         """
-        pyproject_file = project.root.absolute() / project.PYPROJECT_FILENAME
+        root = project.root.absolute()
 
         # Attach configuration for CPPythonPlugin callbacks
         version = project.pyproject.metadata.get('version')
         verbosity = project.core.ui.verbosity
 
-        project_configuration = ProjectConfiguration(
-            pyproject_file=pyproject_file, verbosity=verbosity, version=version
-        )
+        project_configuration = ProjectConfiguration(project_root=root, verbosity=verbosity, version=version)
 
         self.logger.info("CPPython: Entered 'on_post_install'")
 

cppython/plugins/vcpkg/plugin.py

@@ -184,7 +184,7 @@ def install(self) -> None:
         Raises:
             ProcessError: Failed vcpkg calls
         """
-        manifest_directory = self.core_data.project_data.pyproject_file.parent
+        manifest_directory = self.core_data.project_data.project_root
         manifest = generate_manifest(self.core_data, self.data)
 
         # Write out the manifest
@@ -214,7 +214,8 @@ def update(self) -> None:
         Raises:
             ProcessError: Failed vcpkg calls
         """
-        manifest_directory = self.core_data.project_data.pyproject_file.parent
+        manifest_directory = self.core_data.project_data.project_root
+
         manifest = generate_manifest(self.core_data, self.data)
 
         # Write out the manifest

cppython/plugins/vcpkg/resolution.py

@@ -42,7 +42,7 @@ def resolve_vcpkg_data(data: dict[str, Any], core_data: CorePluginData) -> Vcpkg
     """
     parsed_data = VcpkgConfiguration(**data)
 
-    root_directory = core_data.project_data.pyproject_file.parent.absolute()
+    root_directory = core_data.project_data.project_root.absolute()
 
     modified_install_directory = parsed_data.install_directory
 

cppython/plugins/vcpkg/schema.py

@@ -4,7 +4,6 @@
 from typing import Annotated
 
 from pydantic import Field, HttpUrl
-from pydantic.types import DirectoryPath
 
 from cppython.core.schema import CPPythonModel
 
@@ -18,7 +17,7 @@ class VcpkgDependency(CPPythonModel):
 class VcpkgData(CPPythonModel):
     """Resolved vcpkg data"""
 
-    install_directory: DirectoryPath
+    install_directory: Path
     dependencies: list[VcpkgDependency]