Integrate with Starbase

rockcraft/application.py

@@ -19,7 +19,7 @@
 from typing import Any
 
 from craft_application import Application, AppMetadata, util
-from overrides import override
+from overrides import override  # type: ignore[reportUnknownVariableType]
 
 from rockcraft import models
 from rockcraft.models import project

rockcraft/commands/extensions.py

@@ -24,7 +24,7 @@
 import tabulate
 from craft_application.commands import AppCommand
 from craft_cli import emit
-from overrides import overrides
+from overrides import overrides  # type: ignore[reportUnknownVariableType]
 from pydantic import BaseModel
 
 from rockcraft import extensions

rockcraft/commands/init.py

@@ -21,7 +21,7 @@
 
 from craft_application.commands import AppCommand
 from craft_cli import emit
-from overrides import overrides
+from overrides import overrides  # type: ignore[reportUnknownVariableType]
 
 from rockcraft import errors
 

rockcraft/extensions/_utils.py

@@ -65,7 +65,7 @@ def _apply_extension(
     if "parts" not in yaml_data:
         yaml_data["parts"] = {}
 
-    parts = yaml_data["parts"]
+    parts: dict[str, Any] = yaml_data["parts"]
     for part_definition in parts.values():
         for property_name, property_value in part_extension.items():
             part_definition[property_name] = _apply_extension_property(

rockcraft/models/project.py

@@ -17,7 +17,7 @@
 """Project definition and helpers."""
 import re
 import shlex
-from collections.abc import Mapping, Sequence
+from collections.abc import Callable, Mapping, Sequence
 from pathlib import Path
 from typing import (
     TYPE_CHECKING,
@@ -59,7 +59,9 @@ class Config:  # pylint: disable=too-few-public-methods
         """Pydantic model configuration."""
 
         allow_population_by_field_name = True
-        alias_generator = lambda s: s.replace("_", "-")  # noqa: E731
+        alias_generator: Callable[[str], str] = lambda s: s.replace(  # noqa: E731
+            "_", "-"
+        )
 
     @pydantic.validator("build_for", pre=True)
     @classmethod
@@ -73,8 +75,8 @@ def _vectorise_build_for(cls, val: str | list[str]) -> list[str]:
     @classmethod
     def _validate_platform_set(cls, values: Mapping[str, Any]) -> Mapping[str, Any]:
         """Validate the build_on build_for combination."""
-        build_for = values["build_for"] if values.get("build_for") else []
-        build_on = values["build_on"] if values.get("build_on") else []
+        build_for: list[str] = values["build_for"] if values.get("build_for") else []
+        build_on: list[str] = values["build_on"] if values.get("build_on") else []
 
         # We can only build for 1 arch at the moment
         if len(build_for) > 1:
@@ -126,13 +128,16 @@ class Project(YamlModelMixin, BaseProject):
     name: NameStr  # type: ignore
     # summary is Optional[str] in BaseProject
     summary: str  # type: ignore
-    description: str
+    description: str  # type: ignore[reportIncompatibleVariableOverride]
     rock_license: str = pydantic.Field(alias="license")
     platforms: dict[str, Any]
     base: Literal["bare", "[email protected]", "[email protected]"]
     build_base: Literal["[email protected]", "[email protected]"] | None
     environment: dict[str, str] | None
-    run_user: Literal[tuple(SUPPORTED_GLOBAL_USERNAMES)] | None  # type: ignore
+    if TYPE_CHECKING:
+        run_user: str | None
+    else:
+        run_user: Literal[tuple(SUPPORTED_GLOBAL_USERNAMES)] | None  # type: ignore
     services: dict[str, Service] | None
     checks: dict[str, Check] | None
     entrypoint_service: str | None
@@ -148,7 +153,9 @@ class Config:  # pylint: disable=too-few-public-methods
         extra = "forbid"
         allow_mutation = False
         allow_population_by_field_name = True
-        alias_generator = lambda s: s.replace("_", "-")  # noqa: E731
+        alias_generator: Callable[[str], str] = lambda s: s.replace(  # noqa: E731
+            "_", "-"
+        )
         error_msg_templates = {
             "value_error.str.regex": INVALID_NAME_MESSAGE,
         }
@@ -185,12 +192,12 @@ def _validate_license(cls, rock_license: str) -> str:
             # This is the license name we use on our stores.
             return rock_license
 
-        lic: spdx_lookup.License | None = spdx_lookup.by_id(rock_license)
+        lic: spdx_lookup.License | None = spdx_lookup.by_id(rock_license)  # type: ignore[reportUnknownMemberType]
         if lic is None:
             raise ProjectValidationError(
                 f"License {rock_license} not valid. It must be valid and in SPDX format."
             )
-        return str(lic.id)
+        return str(lic.id)  # type: ignore[reportUnknownMemberType]
 
     @pydantic.validator("title", always=True)
     @classmethod
@@ -246,7 +253,9 @@ def _check_deprecated_base(base_value: str | None, field_name: str) -> str | Non
     def _validate_all_platforms(cls, platforms: dict[str, Any]) -> dict[str, Any]:
         """Make sure all provided platforms are tangible and sane."""
         for platform_label in platforms:
-            platform = platforms[platform_label] if platforms[platform_label] else {}
+            platform: dict[str, Any] = (
+                platforms[platform_label] if platforms[platform_label] else {}
+            )
             error_prefix = f"Error for platform entry '{platform_label}'"
 
             # Make sure the provided platform_set is valid
@@ -371,7 +380,7 @@ def _validate_package_repositories(
         if not package_repositories:
             return []
 
-        errors = []
+        errors: list[ErrorDict] = []
         for repository in package_repositories:
             try:
                 repo.validate_repository(repository)
@@ -412,11 +421,11 @@ def to_yaml(self) -> str:
         def _repr_str(dumper: yaml.SafeDumper, data: str) -> yaml.ScalarNode:
             """Multi-line string representer for the YAML dumper."""
             if "\n" in data:
-                return dumper.represent_scalar("tag:yaml.org,2002:str", data, style="|")
-            return dumper.represent_scalar("tag:yaml.org,2002:str", data)
+                return dumper.represent_scalar("tag:yaml.org,2002:str", data, style="|")  # type: ignore[reportUnknownMemberType]
+            return dumper.represent_scalar("tag:yaml.org,2002:str", data)  # type: ignore[reportUnknownMemberType]
 
         yaml.add_representer(str, _repr_str, Dumper=yaml.SafeDumper)
-        return super().yaml(
+        return super().yaml(  # type: ignore[reportUnknownMemberType]
             by_alias=True,
             exclude_none=True,
             allow_unicode=True,
@@ -427,9 +436,6 @@ def _repr_str(dumper: yaml.SafeDumper, data: str) -> yaml.ScalarNode:
     @classmethod
     def unmarshal(cls, data: dict[str, Any]) -> "Project":
         """Overridden to raise ProjectValidationError() for Pydantic errors."""
-        if not isinstance(data, dict):
-            raise TypeError("project data is not a dictionary")
-
         try:
             project = super().unmarshal(data)
         except pydantic.ValidationError as err:
@@ -538,18 +544,16 @@ def _format_pydantic_errors(
 
 def _format_pydantic_error_location(loc: Sequence[str | int]) -> str:
     """Format location."""
-    loc_parts = []
+    loc_parts: list[str] = []
     for loc_part in loc:
         if isinstance(loc_part, str):
             loc_parts.append(loc_part)
-        elif isinstance(loc_part, int):
+        else:
             # Integer indicates an index. Go
             # back and fix up previous part.
             previous_part = loc_parts.pop()
             previous_part += f"[{loc_part}]"
             loc_parts.append(previous_part)
-        else:
-            raise RuntimeError(f"unhandled loc: {loc_part}")
 
     new_loc = ".".join(loc_parts)
 

rockcraft/oci.py

@@ -442,8 +442,8 @@ def set_environment(self, env: dict[str, str]) -> None:
         """
         emit.progress("Configuring OCI environment...")
         image_path = self.path / self.image_name
-        params = []
-        env_list = []
+        params: list[str] = []
+        env_list: list[str] = []
 
         for name, value in env.items():
             env_item = f"{name}={value}"
@@ -491,7 +491,7 @@ def set_annotations(self, annotations: dict[str, Any]) -> None:
         label_params = ["--clear=config.labels"]
         annotation_params = ["--clear=manifest.annotations"]
 
-        labels_list = []
+        labels_list: list[str] = []
         for label_key, label_value in annotations.items():
             label_item = f"{label_key}={label_value}"
             labels_list.append(label_item)

rockcraft/pebble.py

@@ -17,7 +17,7 @@
 """Pebble metadata and configuration helpers."""
 
 import glob
-from collections.abc import Mapping
+from collections.abc import Callable, Mapping
 from pathlib import Path
 from typing import Any, Literal
 
@@ -70,7 +70,9 @@ class Config:  # pylint: disable=too-few-public-methods
         """Pydantic model configuration."""
 
         allow_population_by_field_name = True
-        alias_generator = lambda s: s.replace("_", "-")  # noqa: E731
+        alias_generator: Callable[[str], str] = lambda s: s.replace(  # noqa: E731
+            "_", "-"
+        )
         extra = "forbid"
 
 
@@ -116,7 +118,9 @@ class Config:  # pylint: disable=too-few-public-methods
         """Pydantic model configuration."""
 
         allow_population_by_field_name = True
-        alias_generator = lambda s: s.replace("_", "-")  # noqa: E731
+        alias_generator: Callable[[str], str] = lambda s: s.replace(  # noqa: E731
+            "_", "-"
+        )
         extra = "forbid"
 
 
@@ -153,7 +157,9 @@ class Config:  # pylint: disable=too-few-public-methods
         """Pydantic model configuration."""
 
         allow_population_by_field_name = True
-        alias_generator = lambda s: s.replace("_", "-")  # noqa: E731
+        alias_generator: Callable[[str], str] = lambda s: s.replace(  # noqa: E731
+            "_", "-"
+        )
         extra = "forbid"
 
 

rockcraft/plugins/python_plugin.py

@@ -20,7 +20,7 @@
 from textwrap import dedent
 
 from craft_parts.plugins import python_plugin
-from overrides import override
+from overrides import override  # type: ignore[reportUnknownVariableType]
 
 logger = logging.getLogger(__name__)
 
@@ -90,7 +90,7 @@ def _get_script_interpreter(self) -> str:
     @override
     def get_build_commands(self) -> list[str]:
         """Overridden to add a sitecustomize.py ."""
-        commands = []
+        commands: list[str] = []
 
         # Detect whether PARTS_PYTHON_INTERPRETER is a full path (not supported)
         commands.append(

rockcraft/services/lifecycle.py

@@ -26,7 +26,7 @@
 from craft_parts import Features, LifecycleManager, Step, callbacks
 from craft_parts.errors import CallbackRegistrationError
 from craft_parts.infos import ProjectInfo, StepInfo
-from overrides import override
+from overrides import override  # type: ignore[reportUnknownVariableType]
 
 from rockcraft import layers
 from rockcraft.models.project import Project

rockcraft/services/package.py

@@ -23,7 +23,7 @@
 
 from craft_application import AppMetadata, PackageService, models, util
 from craft_cli import emit
-from overrides import override
+from overrides import override  # type: ignore[reportUnknownVariableType]
 
 from rockcraft import errors, oci
 from rockcraft.models import Project
@@ -39,7 +39,7 @@ class RockcraftPackageService(PackageService):
     def __init__(
         self,
         app: AppMetadata,
-        services: RockcraftServiceFactory,
+        services: "RockcraftServiceFactory",
         *,
         project: models.Project,
         platform: str | None,

rockcraft/services/provider.py

@@ -17,7 +17,7 @@
 """Rockcraft Provider service."""
 
 from craft_application import ProviderService
-from overrides import override
+from overrides import override  # type: ignore[reportUnknownVariableType]
 
 
 class RockcraftProviderService(ProviderService):

rockcraft/services/service_factory.py

@@ -35,11 +35,11 @@ class RockcraftServiceFactory(ServiceFactory):
     ImageClass: type[services.RockcraftImageService] = services.RockcraftImageService
 
     # These are overrides of default ServiceFactory services
-    LifecycleClass: type[
+    LifecycleClass: type[  # type: ignore[reportIncompatibleVariableOverride]
         services.RockcraftLifecycleService
     ] = services.RockcraftLifecycleService
     PackageClass: type[base_services.PackageService] = services.RockcraftPackageService
-    ProviderClass: type[
+    ProviderClass: type[  # type: ignore[reportIncompatibleVariableOverride]
         services.RockcraftProviderService
     ] = services.RockcraftProviderService
 

rockcraft/utils.py

@@ -22,14 +22,20 @@
 import pathlib
 import shutil
 import sys
-from collections import namedtuple
 from distutils.util import strtobool  # pylint: disable=deprecated-module
+from typing import NamedTuple
 
 import rockcraft.errors
 
 logger = logging.getLogger(__name__)
 
-OSPlatform = namedtuple("OSPlatform", "system release machine")
+
+class OSPlatform(NamedTuple):
+    """Tuple containing the OS platform information."""
+
+    system: str
+    release: str
+    machine: str
 
 
 def is_managed_mode() -> bool: