craft_parts.plugins.autotools_plugin module

The autotools plugin implementation.

class craft_parts.plugins.autotools_plugin.AutotoolsPlugin(*, properties, part_info)

Bases: Plugin

The autotools plugin is used for autotools-based parts.

Autotools-based projects are the ones that have the usual ./configure && make && make install instruction set.

This plugin will check for the existence of a ‘configure’ file, if one cannot be found, it will first try to run ‘autogen.sh’ or ‘bootstrap’ to generate one.

This plugin uses the common plugin keywords as well as those for “sources”. For more information check the ‘plugins’ topic for the former and the ‘sources’ topic for the latter.

In addition, this plugin uses the following plugin-specific keywords:

• autotools-bootstrap-parameters (list of strings) bootstrap flags to pass to the build if a bootstrap file is found in the project. These can in some cases be seen by running ‘./bootstrap –help’

• autotools-configure-parameters (list of strings) configure flags to pass to the build such as those shown by running ‘./configure –help’

Parameters:

• properties (PluginProperties)

• part_info (PartInfo)

get_build_commands()

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

Return type:

list[str]

get_build_environment()

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

Return type:

dict[str, str]

get_build_packages()

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

Return type:

set[str]

get_build_snaps()

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

Return type:

set[str]

properties_class

alias of AutotoolsPluginProperties

class craft_parts.plugins.autotools_plugin.AutotoolsPluginProperties(**data)

Bases: PluginProperties

The part properties used by the autotools plugin.

Parameters:

data (Any)

autotools_bootstrap_parameters: list[str]

autotools_configure_parameters: list[str]

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

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].

model_fields: ClassVar[Dict[str, FieldInfo]] = {'autotools_bootstrap_parameters': FieldInfo(annotation=list[str], required=False, default=[], alias='autotools-bootstrap-parameters', alias_priority=1), 'autotools_configure_parameters': FieldInfo(annotation=list[str], required=False, default=[], alias='autotools-configure-parameters', alias_priority=1), 'plugin': FieldInfo(annotation=Literal['autotools'], required=False, default='autotools', alias='plugin', alias_priority=1), 'source': FieldInfo(annotation=str, required=True, alias='source', alias_priority=1)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

plugin: Literal['autotools']

source: str