Skip to content
YosoiDocs

MapRequest

yosoi.map.MapRequest

class MapRequest(NativeAuthoringModel):

Authored seed intent with validation deferred to checking or sending.

Attributes: seed: Caller seed text; creating this model does not send network requests.

Source: python/yosoi/map.py:643

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

seed: str = Field(repr=False)
def model_post_init(self, context: object) -> None:

Retain authored seed intent natively without acquiring pages.

Source: python/yosoi/map.py:653

def check(self) -> None:

Validate seed and package-default policy without network I/O.

Raises: MapError: The seed, scope, policy, or acquisition setup is invalid.

Source: python/yosoi/map.py:657

def bind(self, policy: Policy) -> BoundMapRequest:

Snapshot a complete policy declaration for later discovery.

Args: policy: Complete declaration to serialize at binding time.

Returns: A binding unaffected by later edits to the caller policy.

Source: python/yosoi/map.py:665

async def send(self, *, cancellation: CancellationToken | None=None) -> MapOutcome:

Discover within package defaults while retaining typed evidence.

Args: cancellation: Optional cooperative token shared with other operations. Observed cancellation stops further work and retains existing outcomes.

Returns: Discovery evidence and acquisition owners. Inspect source states, frontier, omissions, and termination before claiming completeness.

Raises: MapError: Seed validation, policy resolution, or execution setup fails. pydantic.ValidationError: Native data cannot form a typed result.

Source: python/yosoi/map.py:676