etlplus.api.pagination

etlplus.api.pagination package.

Pagination configuration and runtime helpers for REST API responses.

This package groups configuration shapes, paginator utilities, and a client-facing driver for traversing page-, offset-, and cursor-based JSON responses.

Notes

  • Pagination defaults are centralized on EndpointClient (page,

    per_page, cursor, limit; start page 1; page size 100).

  • Prefer JSONRecords (list of JSONDict) for paginated

    responses; scalar/record aliases are exported for convenience.

  • The underlying Paginator is exported for advanced scenarios that

    need to stream pages manually.

Classes

PaginationClient(*, pagination, fetch[, ...])

Drive Paginator instances with shared guardrails.

Paginator(*[, type, page_size, start_page, ...])

REST API endpoint response pagination manager.

PaginationConfig(*[, type, page_param, ...])

Configuration container for API request pagination settings.

PaginationType(*values)

Enumeration of supported pagination types for REST API responses.

CursorPaginationConfigDict

Configuration mapping for cursor-based REST API response pagination.

PagePaginationConfigDict

Configuration mapping for page-based and offset-based REST API pagination.