swf_typed

Python interface to SWF.

Common

Common models and methods.

_common.PageConsumer

Paged SWF API response iterator.

class swf_typed._common.PageConsumer(...)[source]

Bases: Generator, Generic[T]

Paged SWF API response iterator.

get_page(page_token: str | None = None, start_getting_next_page: bool = True) Tuple[List[T], str | None][source]

Get a full page of results from SWF.

Uses pre-fetched results if available.

Parameters:
  • page_token – page token

  • start_getting_next_page – start fetching the next page in another thread

Returns:

page of results (structured), and next page’s token

model: Callable[[Dict[str, Any]], T]

swf_typed model (constructor) for list result items.

response: Dict[str, Any]

Current list API response.