`welkin.pagination`

Module Contents

Classes

`PageIterator`
`PageableIterator`	Most common paging class.
`FormationIterator`	Specifically for paginating formations responses.
`PageNumberIterator`	PageableIterator with a different key used for the page count.
`MetaInfoIterator`	Functionally identical to PageableIterator with various renamed keys.
`MetaIterator`	Paging class for token based paging.
`CursorIterator`

Attributes

DEFAULT_PAGE_SIZE

welkin.pagination.DEFAULT_PAGE_SIZE = 20

class welkin.pagination.PageIterator(collection, resource, method, size=DEFAULT_PAGE_SIZE, *args, **kwargs)

property resources

class welkin.pagination.PageableIterator(*args, **kwargs)

Bases: PageIterator

Most common paging class.

class welkin.pagination.FormationIterator(*args, **kwargs)

Bases: PageIterator

Specifically for paginating formations responses.

Similar to PageableIterator but includes special behavior for single item formations, e.g. encounter disposition

class welkin.pagination.PageNumberIterator(*args, **kwargs)

Bases: PageableIterator

PageableIterator with a different key used for the page count.

class welkin.pagination.MetaInfoIterator(*args, **kwargs)

Bases: PageIterator

Functionally identical to PageableIterator with various renamed keys.

class welkin.pagination.MetaIterator(*args, **kwargs)

Bases: PageIterator

Paging class for token based paging.

class welkin.pagination.CursorIterator(*args, **kwargs): Bases: PageIterator