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)[source]¶
Bases:
Plugin
Copy the content from the part source.
- Parameters:
properties (
PluginProperties
) –part_info (
PartInfo
) –
- 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
]
- get_pull_commands()[source]¶
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)[source]¶
Bases:
PluginProperties
The part properties used by the dump plugin.
- Parameters:
data (
Any
) –
- classmethod unmarshal(data)[source]¶
Populate dump properties from the part specification.
‘source’ is a required part property.
- Parameters:
data (
Dict
[str
,Any
]) – A dictionary containing part properties.- Return type:
- Returns:
The populated plugin properties data object.
- Raises:
ValueError – If a required property is not found.