Skip to main content

하위 패키지

하위 모듈

모듈 내용

XDK Python SDK입니다. X API 엔드포인트에 편리하게 접근할 수 있도록, 타입 안정성과 인증 기능을 지원하는 X API용 Python SDK입니다.

class xdk.Client

X API와 상호작용하기 위한 Client 클래스입니다.

매개변수

str
기본값:"'https://api.x.com'"
str or None
기본값:"None"
str or None
기본값:"None"
str or None
기본값:"None"
str or None
기본값:"None"
str or None
기본값:"None"
Dict[str, Any] or None
기본값:"None"
str or List[str] or None
기본값:"None"
str
기본값:"'https://x.com/i'"
OAuth1

__init__

X API Client 인스턴스를 초기화합니다.

매개변수

str
기본값:"'https://api.x.com'"
X API의 기본 URL입니다(기본값은 https://api.x.com입니다).
str or None
기본값:"None"
X API용 Bearer 토큰입니다(앱 전용 인증).
str or None
기본값:"None"
사용자 컨텍스트용 OAuth2 액세스 토큰입니다(Bearer 토큰으로 직접 사용할 수 있습니다).
str or None
기본값:"None"
X API용 client ID입니다(OAuth2 PKCE 플로에 필요).
str or None
기본값:"None"
X API용 client secret입니다.
str or None
기본값:"None"
OAuth2 인가에 사용되는 redirect URI입니다.
Dict[str, Any] or None
기본값:"None"
기존 OAuth2 토큰 딕셔너리입니다(있는 경우). 제공된 경우 access_token이 추출됩니다.
str or List[str] or None
기본값:"None"
OAuth2 인가 스코프를 위한 공백으로 구분된 문자열 또는 문자열 리스트입니다.
str
기본값:"'https://x.com/i'"
OAuth2 인가용 기본 URL입니다(기본값은 https://x.com/i입니다).
OAuth1
OAuth1.0a 인증용 OAuth1 인스턴스입니다.

exchange_code

인가 코드를 토큰으로 교환합니다(TypeScript API와 동일합니다).

매개변수

Any
콜백에 포함된 authorization code입니다.
Any
기본값:"None"
선택적인 code verifier입니다 (지정하지 않으면 저장된 verifier를 사용합니다).

fetch_token

인가 응답 URL을 사용하여 토큰을 가져옵니다(레거시 메서드).

매개변수

Any
인가 후 반환된 전체 콜백 URL입니다.

get_authorization_url

OAuth2 PKCE 플로우용 인가 URL을 가져옵니다.

매개변수

Any
기본값:"None"
보안 강화를 위한 선택적 state 매개변수입니다.

is_token_expired

OAuth2 토큰이 만료되었는지 확인합니다.

refresh_token

OAuth2 토큰을 갱신합니다.

class xdk.Cursor

[ResponseType]

매개변수

PaginatableMethod

__init__

커서를 초기화합니다.

매개변수

PaginatableMethod
각 페이지에 대해 호출할 API method입니다 (페이지네이션을 지원해야 합니다)

items

페이지네이션 응답의 개별 항목을 반복 처리합니다.

매개변수

int or None
기본값:"None"
반환할 항목의 최대 개수 (None이면 제한 없음)

반환값

IteratorAny

pages

응답 페이지들을 순회합니다.

매개변수

int or None
기본값:"None"
반환할 페이지의 최대 수 (None이면 무제한)

반환값

IteratorResponseType

class xdk.StreamConfig

재시도 동작이 포함된 스트리밍 연결 구성입니다.

매개변수

int
기본값:"10"
float
기본값:"1.0"
float
기본값:"64.0"
float
기본값:"2.0"
bool
기본값:"True"
float or None
기본값:"None"
int
기본값:"1024"
Callable[[], None] or None
기본값:"None"
Callable[[Exception or None], None] or None
기본값:"None"
Callable[[int, float], None] or None
기본값:"None"
Callable[[[StreamError

__init__

매개변수

int
기본값:"10"
float
기본값:"1.0"
float
기본값:"64.0"
float
기본값:"2.0"
bool
기본값:"True"
float or None
기본값:"None"
int
기본값:"1024"
Callable[[], None] or None
기본값:"None"
Callable[[Exception or None], None] or None
기본값:"None"
Callable[[int, float], None] or None
기본값:"None"
Callable[[[StreamError

on_error : Callable[[[StreamError]

exception xdk.StreamError

분류 정보가 포함된 스트리밍 오류에 대해 발생하는 예외입니다.

매개변수

str
StreamErrorType

__init__

매개변수

str
StreamErrorType

class xdk.StreamErrorType

재시도 여부를 결정할 때 사용하는 스트리밍 오류 분류.

매개변수

Any

class xdk.StreamState

스트리밍 연결의 내부 상태를 나타냅니다.

매개변수

int
기본값:"0"
float
기본값:"1.0"
bool
기본값:"False"
int
기본값:"0"
StreamError

__init__

매개변수

int
기본값:"0"
float
기본값:"1.0"
bool
기본값:"False"
int
기본값:"0"
StreamError

last_error : [StreamError]

xdk.cursor

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

매개변수

PaginatableMethod
래핑할 API method (페이지네이션을 지원해야 함)