craft_parts.plugins.colcon_plugin module

The colcon plugin implementation.

class craft_parts.plugins.colcon_plugin.ColconPlugin(*, properties, part_info)[source]

Bases: Plugin

A plugin useful for building colcon-based parts.

Parameters:
get_build_commands()[source]

Return a list of commands to run during the build step.

Return type:

list[str]

get_build_environment()[source]

Return a dictionary with the environment to use in the build step.

Return type:

dict[str, str]

get_build_packages()[source]

Return a set of required packages to install in the build environment.

Return type:

set[str]

get_build_snaps()[source]

Return a set of required snaps to install in the build environment.

Return type:

set[str]

properties_class

alias of ColconPluginProperties

class craft_parts.plugins.colcon_plugin.ColconPluginProperties(**data)[source]

Bases: PluginProperties

The part properties used by the colcon plugin.

Parameters:

data (Any)

colcon_cmake_args: list[str]
colcon_packages: list[str]
colcon_packages_ignore: list[str]
model_config: ClassVar[ConfigDict] = {'alias_generator': <function PluginProperties.<lambda>>, 'extra': 'forbid', 'frozen': True, 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

plugin: Literal['colcon']
source: str