Types

Generated from yosoi v0.0.2a19. Only symbols in __all__ are listed.

Author

Author(description: str = ..., kwargs: Any = {}) -> Any

BodyText

BodyText(description: str = ..., kwargs: Any = {}) -> Any

Datetime

Datetime(description: str = ..., assume_utc: bool = ..., past_only: bool = ..., as_iso: bool = ..., kwargs: Any = {}) -> Any

Field

Field(frozen: bool = False, selector: str | None = None, delimiter: str | None = None, kwargs: Any = {}) -> Any

Yosoi-aware Field wrapper that stores selector metadata in json_schema_extra.

Per-field guidance for the LLM is supplied via the standard pydantic description= argument — there is no separate hint knob. Args:

• frozen bool — If True, marks the field as frozen (selector won’t be re-discovered).
• selector str | None — Optional CSS selector override. When set, AI discovery is skipped for this field and the provided selector is used directly.
• delimiter str | None — Optional regex pattern for splitting delimited strings in list fields. Defaults to comma/semicolon/and splitting when not set.
• **kwargs Any — Additional arguments forwarded to pydantic.Field (e.g. description).

Returns: Any — A pydantic FieldInfo with Yosoi-specific metadata in json_schema_extra.

Raises:

• TypeError — If the removed hint argument is passed. Use description.

Price

Price(description: str = ..., currency_symbol: str | None = ..., require_decimals: bool = ..., kwargs: Any = {}) -> Any

Rating

Rating(description: str = ..., as_float: bool = ..., scale: int = ..., kwargs: Any = {}) -> Any

Title

Title(description: str = ..., kwargs: Any = {}) -> Any

Url

Url(description: str = ..., require_https: bool = ..., strip_tracking: bool = ..., kwargs: Any = {}) -> Any