Skip to content
YosoiDocs

Plan

yosoi.locators.Plan

class Plan(ImmutableModel):

Compiled immutable outputs and repeated-region declarations.

Attributes: outputs: Ordered named output declarations. Native compilation checks IDs, projection compatibility, and region structure without acquiring documents.

Source: python/yosoi/locators.py:544

Members below are declared on this class. Inherited Pydantic methods and generated constructor signatures are not expanded.

outputs: tuple[Output, ...]
def model_post_init(self, context: object) -> None:

Retain an existing native plan or compile declared outputs through Rust.

Source: python/yosoi/locators.py:555

@classmethod
def from_compiled(cls, value: str | Mapping[str, Any]) -> Self:

Import a portable Rust Plan; Rust validates all compiled invariants.

Source: python/yosoi/locators.py:566

def compiled(self) -> dict[str, object]:

Inspect the portable plan compiled by Rust.

Source: python/yosoi/locators.py:608

def model_copy(self, *, update: Mapping[str, Any] | None=None, deep: bool=False) -> Self:

Copy immutable authoring intent and revalidate changed inputs.

Args: update: Optional authoring replacements to validate in Rust. deep: Reconstruct the declaration when True.

Returns: A validated copy. Unchanged shallow copies retain compiled ownership.

Raises: LocatorError: Changed declarations fail native semantic validation. pydantic.ValidationError: Updated authoring fields are invalid.

Source: python/yosoi/locators.py:612