craft_parts.plugins.dump_plugin module

The dump plugin.

This plugin just dumps the content from a specified part source.

class craft_parts.plugins.dump_plugin.DumpPlugin(*, properties, part_info)

Bases: Plugin

Copy the content from the part source.

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]

get_pull_commands()

Return a list commands to retrieve dependencies during the pull step.

Return type:

list[str]

properties_class

alias of DumpPluginProperties

supports_strict_mode = True

Plugins that can run in ‘strict’ mode must set this classvar to True.

class craft_parts.plugins.dump_plugin.DumpPluginProperties(**data)

Bases: PluginProperties

The part properties used by the dump plugin.

Parameters:

data (Any)

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]] = {'plugin': FieldInfo(annotation=Literal['dump'], required=False, default='dump', 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['dump']

source: str