paginator

X API SDK 向けのカーソルベースのページネーション用ユーティリティ。

このモジュールは、すべての API クライアントで洗練されたページネーションをサポートするための Cursor クラスを提供します。Cursor を使うことで、適切な型安全性を保ちながら、.pages() と .items() の両メソッドを用いて、ページネーションされた結果を簡単にイテレートできます。

​

class xdk.paginator.Cursor

[ResponseType]

​

パラメーター

path.method · PaginatableMethod

​

__init__

カーソルを初期化します。

​

パラメーター

path.method · PaginatableMethod

各ページごとに呼び出す API メソッド（ページネーションをサポートしている必要があります）

​

items

ページネーションされたレスポンスの各アイテムを反復処理します。

​

パラメーター

path.limit · int or None · デフォルト: "None"

返されるアイテム数の上限（制限なしの場合は None）

​

戻り値

IteratorAny

​

pages

レスポンスをページ単位で反復処理します。

​

パラメーター

path.limit · int or None · デフォルト: "None"

返すページ数の上限（無制限の場合は None）

​

戻り値

IteratorResponseType

​

class xdk.paginator.PaginatableMethod

[ResponseType]

​

__init__

​

xdk.paginator.cursor

適切な型推論とバリデーションを行うカーソルを作成します。 このファクトリ関数は、レスポンス型に対して適切な型ヒントが得られるよう型推論を支援し、 メソッドがページネーションをサポートしていることを静的解析時と実行時の両方で検証します。

​

パラメーター

path.method · PaginatableMethod

ラップする API メソッド（ページネーションをサポートしている必要があります）