craft_parts.steps module¶

Definitions and helpers to handle lifecycle steps.

class craft_parts.steps.Step(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: IntEnum

All the steps needed to fully process a part.

Steps correspond to the tasks that must be fulfilled in order to process each of the parts in the project specification. In the PULL step sources for a part are retrieved and unpacked. The OVERLAY step is used to change the underlying filesystem. In the BUILD step artifacts are built and installed. In the STAGE step installed build artifacts from all parts and overlay contents are added to a staging area. These files are further processed in the PRIME step to obtain the final tree with the final payload for deployment.

BUILD = 3¶

OVERLAY = 2¶

PRIME = 5¶

PULL = 1¶

STAGE = 4¶

next_steps()[source]¶

List the steps that should happen after the current step.

Return type:: list[Step]
Returns:: The list of next steps.

previous_steps()[source]¶

List the steps that should happen before the current step.

Return type:: list[Step]
Returns:: The list of previous steps.

craft_parts.steps.dependency_prerequisite_step(step)[source]¶

Obtain the step a given step may depend on.

Return type:: Step | None
Returns:: The prerequisite step.
Parameters:: step (Step)