Skip to content
YosoiDocs

Field

yosoi.contracts.Field

def Field(description: str | None=None, *, id: str | FieldId | None=None, locator: Locator | Query | None=None, default: Any=PydanticUndefined, **kwargs: Any) -> Any:

Describe a Contract field using a genuine Pydantic FieldInfo.

A bare query uses text projection. Pydantic constraints, aliases, defaults, and other FieldInfo options are forwarded. Only the locator and field ID participate in native candidate extraction; Pydantic validates each raw projected value.

Source: python/yosoi/contracts.py:89