welkin.pagination

Attributes

DEFAULT_PAGE_SIZE

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

Module Contents

welkin.pagination.DEFAULT_PAGE_SIZE = 20

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

collection

resource

method

size = 20

meta_key = None

meta_dict

args = ()

kwargs

property resources

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

Bases: PageIterator

Most common paging class.

meta_key = 'pageable'

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

meta_key = 'pageable'

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.

meta_key = 'metaInfo'

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

Bases: PageIterator

Paging class for token based paging.

meta_key = 'meta'

meta_dict

class welkin.pagination.CursorIterator(*args, **kwargs)

Bases: PageIterator

meta_key = 'cursor'

meta_dict