paginator

Utilidades de paginación basada en cursores para el SDK de X API.

Este módulo proporciona una clase Cursor para ofrecer paginación de forma elegante en todos los clientes de la API. Cursor permite iterar fácilmente sobre resultados paginados utilizando tanto los métodos .pages() como .items(), con la seguridad de tipos adecuada.

​

class xdk.paginator.Cursor

[ResponseType]

​

Parámetros

path.method · PaginatableMethod

​

__init__

Inicializa el cursor.

​

Parámetros

path.method · PaginatableMethod

El método de la API que se llamará para cada página (debe admitir paginación)

​

items

Itera sobre elementos individuales de las respuestas paginadas.

​

Parámetros

path.limit · int or None · predeterminado: "None"

Número máximo de elementos que se devolverán (None para sin límite)

​

Devuelve

IteratorAny

​

pages

Itera sobre páginas de respuestas.

​

Parámetros

path.limit · int or None · predeterminado: "None"

Número máximo de páginas que se devolverán (None para sin límite)

​

Devuelve

IteratorResponseType

​

class xdk.paginator.PaginatableMethod

[ResponseType]

​

__init__

​

xdk.paginator.cursor

Crea un cursor con la inferencia y validación de tipos adecuadas. Esta función de fábrica ayuda con la inferencia de tipos para que obtengas sugerencias de tipo correctas para la respuesta y valida que el método admita paginación tanto en el análisis estático como en tiempo de ejecución.

​

Parámetros

path.method · PaginatableMethod

El método de la API que se va a encapsular (debe admitir paginación)