paginator

X API SDK를 위한 커서 기반 페이지네이션 유틸리티입니다.

이 모듈은 모든 API Client에서 편리하게 페이지네이션을 지원하는 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

올바른 type 추론과 검증을 위한 커서를 생성합니다. 이 팩토리 함수는 type 추론을 도와 응답 type에 대한 적절한 힌트를 제공하고, 해당 메서드가 정적 분석과 런타임 모두에서 페이지네이션을 지원하는지 검증합니다.

​

매개변수

path.method · PaginatableMethod

페이지네이션을 지원하는 래핑 대상 API 메서드