craft_parts.state_manager.overlay_state module¶
State definitions for the overlay step.
- class craft_parts.state_manager.overlay_state.OverlayState(**data)[source]¶
Bases:
StepState
Context information for the overlay step.
- Parameters:
data (
Any
) –
- part_properties: Dict[str, Any]¶
- project_options: Dict[str, Any]¶
- project_options_of_interest(project_options)[source]¶
Return relevant project options concerning this step.
- Parameters:
project_options (
Dict
[str
,Any
]) – A dictionary containing all project options.- Return type:
Dict
[str
,Any
]- Returns:
A dictionary containing project options of interest.
- properties_of_interest(part_properties, *, extra_properties=None)[source]¶
Return relevant properties concerning this step.
- Parameters:
part_properties (
Dict
[str
,Any
]) – A dictionary containing all part properties.extra_properties (
Optional
[List
[str
]]) – Additional relevant properties to return.
- Return type:
Dict
[str
,Any
]- Returns:
A dictionary containing properties of interest.
- classmethod unmarshal(data)[source]¶
Create and populate a new
OverlayState
object from dictionary data.The unmarshal method validates entries in the input dictionary, populating the corresponding fields in the state object.
- Parameters:
data (
Dict
[str
,Any
]) – The dictionary data to unmarshal.- Return type:
- Returns:
The newly created object.
- Raises:
TypeError – If data is not a dictionary.