paginator

Outils de pagination à base de curseur pour le SDK X API.

Ce module fournit une classe Cursor pour une gestion élégante de la pagination sur l’ensemble des clients API. Cursor permet d’itérer facilement sur les résultats paginés en utilisant les méthodes .pages() et .items() avec une sécurité de typage appropriée.

​

class xdk.paginator.Cursor

[ResponseType]

​

Paramètres

path.method · PaginatableMethod

​

__init__

Initialiser le curseur.

​

Paramètres

path.method · PaginatableMethod

La méthode d’API à appeler pour chaque page (doit prendre en charge la pagination)

​

items

Itérer sur chaque élément des réponses paginées.

​

Paramètres

path.limit · int or None · défaut: "None"

Nombre maximal d’éléments à renvoyer (None pour ne pas fixer de limite)

​

Renvoie

IteratorAny

​

pages

Parcourt les pages de réponses.

​

Paramètres

path.limit · int or None · défaut: "None"

Nombre maximal de pages à retourner (None pour un nombre illimité)

​

Renvoie

IteratorResponseType

​

class xdk.paginator.PaginatableMethod

[ResponseType]

​

__init__

​

xdk.paginator.cursor

Crée un curseur avec une inférence de types et une validation appropriées. Cette fonction de fabrique facilite l’inférence de types afin que vous obteniez des annotations de type correctes pour le type de réponse, et elle valide que la méthode prend en charge la pagination aussi bien à l’analyse statique qu’à l’exécution.

​

Paramètres

path.method · PaginatableMethod

La méthode d’API à encapsuler (doit être compatible avec la pagination)