Pagination instance

The Pagination instance passed to the decorated functions as the argument pagination contains the following attributes:

page (int, read-only)

The index of the current page.

offset (int, read-only)

The index of the first item of the current page.

context

Arbitrary data. Used to pass data from one page to the other, or for stop conditions.

is_last_page (bool)

Setting this attribute to True indicates that the current page is the last one, so that the iteration is stopped and the next page is never called.