Python reference
Use import yosoi as ys. Browse modules, then Types, Functions, Aliases, or Constants. Each symbol has its own page.
This reference is generated from public Python source declarations without importing or executing the native extension. Signatures preserve Python annotations, defaults, and async declarations. Class pages show declared fields and methods; inherited or dynamically generated members are not expanded.
Package exports
Section titled “Package exports”| Name | Summary |
|---|---|
ys.Archive |
Local Unix Archive handle with no open files between operations. |
ys.AutomationRecord |
Bounded observations and receipts validated by the Rust record contract. |
ys.BoundFlow |
Retain an immutable Flow with a validated policy snapshot. |
ys.BrowserCleanupError |
Retain cleanup failures alongside the original operation exception. |
ys.BrowserError |
Native browser acquisition, execution, policy, or cleanup exception. |
ys.BrowserSurface |
An isolated live browser with source-specific actions and archive support. |
ys.CancellationToken |
Share a caller-controlled cancellation signal with SDK operations. |
ys.Continuation |
Tagged Continue or Stop behavior for known failures and observed cancellations. Retaining a result does not imply successful business effects. |
ys.Continue |
Retain an unsuccessful result and attempt the next safe step. |
ys.Contract |
Mutable Pydantic record model with native candidate extraction. |
ys.DecodedFrame |
Immutable Rust-owned PNG evidence, restored without a decoder when archived. |
ys.Document |
Immutable document bytes with retained native parse ownership. |
ys.ExecutionError |
Shared runtime preparation, execution, retention or cleanup failure. |
ys.ExtractionPolicy |
Immutable acceptance and native-work limits for Python Contract extraction. |
ys.Field |
Describe a Contract field using a genuine Pydantic FieldInfo. |
ys.Flow |
Declare ordered browser steps without acquiring a Session. |
ys.FlowExecutionError |
Raise strict completion failure while preserving the Flow outcome. |
ys.FlowInvocationError |
Retain native invocation failure and any partial execution evidence. |
ys.FlowOutcome |
Retain executed, skipped, and cleanup facts for a Flow invocation. |
ys.FlowPolicy |
Independent fallback continuation for failures and cancellations. |
ys.PixelRect |
Crop in full decoded-frame pixels; source-video dimensions may differ. |
ys.Plan |
Compiled immutable outputs and repeated-region declarations. |
ys.Policy |
Editable complete declaration with Rust-owned defaults and validation. |
ys.Session |
An acquired Rust Session, released by async context exit. |
ys.SessionPolicy |
Configure Rust-owned limits and capabilities for a retained Session. |
ys.Stop |
Stop a selected Flow scope after failure or cancellation. |
ys.StopScope |
current_flow stops its remaining leaves; invocation stops all remaining invocation work. Unknown effects can still force a hard safety stop. |
ys.Surface |
Reusable immutable index of any supported Document class. |
ys.SurfaceBudget |
Bounds on the complete Rust JSON result, before a transport envelope. |
ys.SurfaceConnection |
Shared lifecycle for a source-specific browser or video connection. |
ys.SurfaceError |
Rust preparation, reference, budget or authority failure with Rust metadata. |
ys.SurfaceLimits |
Task-independent document preparation bounds, enforced by Rust. |
ys.SurfacePolicy |
Evidence retention and output bounds shared across source connections. |
ys.SurfaceSession |
In-memory evidence session for an external live adapter. |
ys.SurfaceSessionPolicy |
Bounds for in-memory readers, subscriptions, history and one hot owner. |
ys.VideoError |
Native video I/O, decoder, timeout, bounds or missing-frame failure. |
ys.VideoPolicy |
Snapshot and decoder limits. Rust validates the supported combinations. |
ys.VideoSession |
Read-only stateful exploration around a frozen VideoSurface. |
ys.VideoSurface |
Frozen local video with a lazy timeline and read-only frame capabilities. |
ys.View |
One bounded page of captured DOM evidence, independent of a live browser. |
ys.WebSurface |
Shared read protocol over an immutable HTML or rendered-DOM index. |
ys.Work |
An explicit browser control lease owned by one Session. |
ys.__version__ |
Installed distribution version |
ys.accessibility_state |
Declare a boolean accessibility-state query without browser I/O. |
ys.accessibility_text |
Author accessibility node text query intent without document I/O. |
ys.accessible_name |
Author accessible node name query intent without document I/O. |
ys.all_of |
Combine expectations so every child must be satisfied. |
ys.archive |
Module |
ys.assert_all |
Check one typed Contract observation using synchronous local predicates. |
ys.assert_that |
Declare an immediate check of a DOM condition. |
ys.ax |
Declare an accessibility expectation for Until. |
ys.browser |
Module |
ys.check |
Author one named synchronous Contract predicate. |
ys.click |
Declare one click without dispatching it. |
ys.contracts |
Module |
ys.count_at_least |
Declare a minimum DOM match count for Until. |
ys.css |
Author CSS tree-node query intent without document I/O. |
ys.documents |
Module |
ys.enter_text |
Declare a text input action without executing it. |
ys.evaluate |
Declare JavaScript evaluation without executing the source. |
ys.evaluate_file |
Take a bounded, Rust-validated snapshot of one UTF-8 JavaScript file. |
ys.exists |
Declare an element-existence expectation for Until. |
ys.extract |
Return validated Pydantic models extracted from a document. |
ys.extract_report |
Return a report with accepted models, rejected candidates, and evidence. |
ys.flow |
Build an immutable Flow, retaining Rust defaults unless configured. |
ys.json_path |
Author supported Rust JSONPath value query intent without document I/O. |
ys.json_pointer |
Author JSON Pointer value query intent without document I/O. |
ys.locators |
Module |
ys.map |
Module |
ys.navigate |
Declare navigation without acquiring or changing a browser. |
ys.output |
Name one explicit query and projection declaration. |
ys.policy |
Module |
ys.regex |
Author decoded-text regular-expression range query intent without document I/O. |
ys.request |
Module |
ys.response |
Declare a matching network-response expectation for Until. |
ys.role |
Author accessibility role query intent without document I/O. |
ys.run_module |
Snapshot a bounded relative JavaScript module graph from disk. |
ys.run_module_with_export |
Snapshot a JavaScript module graph and read one named export as JSON. |
ys.screenshot |
Declare screenshot capture without executing it. |
ys.search |
Module |
ys.session |
Create an async context manager for an explicitly owned browser Session. |
ys.surface |
Module |
ys.text_literal |
Author decoded-text literal range query intent without document I/O. |
ys.timed |
Apply a positive, explicit millisecond timeout to one action. |
ys.tree_text_contains |
Author tree descendant-text substring query intent without document I/O. |
ys.until |
Declare an expectation wait around an optional one-shot trigger. |
ys.view |
Module |
ys.visible |
Declare a browser visibility expectation for Until. |
ys.wait |
Declare an explicit duration rather than a readiness condition. |
ys.wait_until |
Declare a bounded DOM-condition wait. |
ys.xpath |
Author XPath tree-node query intent without document I/O. |