मुख्य सामग्री पर जाएं

उप-पैकेज

उपमॉड्यूल

मॉड्यूल की सामग्री

XDK Python SDK. X API के लिए एक Python SDK, जो टाइप सेफ्टी और ऑथेंटिकेशन सपोर्ट के साथ X API एंडपॉइंट्स तक सुविधाजनक पहुँच प्रदान करता है.

class xdk.Client

X API के साथ इंटरैक्ट करने के लिए Client।

पैरामीटर

path.base_url
str
डिफ़ॉल्ट:"'https://api.x.com'"
path.bearer_token
str or None
डिफ़ॉल्ट:"None"
path.access_token
str or None
डिफ़ॉल्ट:"None"
path.client_id
str or None
डिफ़ॉल्ट:"None"
path.client_secret
str or None
डिफ़ॉल्ट:"None"
path.redirect_uri
str or None
डिफ़ॉल्ट:"None"
path.token
Dict[str, Any] or None
डिफ़ॉल्ट:"None"
path.scope
str or List[str] or None
डिफ़ॉल्ट:"None"
path.authorization_base_url
str
डिफ़ॉल्ट:"'https://x.com/i'"
path.auth
OAuth1

__init__

X API क्लाइंट को प्रारंभ करता है।

पैरामीटर

path.base_url
str
डिफ़ॉल्ट:"'https://api.x.com'"
X API का बेस URL (https://api.x.com डिफ़ॉल्ट है)।
path.bearer_token
str or None
डिफ़ॉल्ट:"None"
X API के लिए बेयरर टोकन (केवल-ऐप प्रमाणीकरण)।
path.access_token
str or None
डिफ़ॉल्ट:"None"
उपयोगकर्ता संदर्भ के लिए OAuth2 access token (इसे सीधे bearer token के रूप में इस्तेमाल किया जा सकता है)।
path.client_id
str or None
डिफ़ॉल्ट:"None"
X API के लिए client ID (OAuth2 PKCE flow के लिए आवश्यक)।
path.client_secret
str or None
डिफ़ॉल्ट:"None"
X API के लिए client secret।
path.redirect_uri
str or None
डिफ़ॉल्ट:"None"
OAuth2 प्राधिकरण के लिए redirect URI।
path.token
Dict[str, Any] or None
डिफ़ॉल्ट:"None"
मौजूदा OAuth2 token dictionary (यदि उपलब्ध हो)। यदि यह दिया गया है, तो access_token निकाला जाएगा।
path.scope
str or List[str] or None
डिफ़ॉल्ट:"None"
OAuth2 प्राधिकरण scopes के लिए स्पेस से अलग की गई string या strings की सूची।
path.authorization_base_url
str
डिफ़ॉल्ट:"'https://x.com/i'"
OAuth2 प्राधिकरण का बेस URL (https://x.com/i डिफ़ॉल्ट है)।
path.auth
OAuth1
OAuth1.0a प्रमाणीकरण के लिए OAuth1 instance।

exchange_code

प्राधिकरण कोड के बदले टोकन प्राप्त करें (यह TypeScript API से मेल खाता है)।

पैरामीटर

path.code
Any
कॉलबैक से मिला प्राधिकरण कोड।
path.code_verifier
Any
डिफ़ॉल्ट:"None"
वैकल्पिक code verifier (अगर यह नहीं दिया गया है, तो संग्रहीत verifier का उपयोग किया जाता है)।

fetch_token

प्राधिकरण प्रतिक्रिया URL का उपयोग करके टोकन प्राप्त करें (लीगेसी विधि)।

पैरामीटर

path.authorization_response
Any
प्राधिकरण के बाद प्राप्त पूरा callback URL।

get_authorization_url

OAuth2 PKCE फ़्लो के लिए प्राधिकरण URL प्राप्त करता है।

पैरामीटर

path.state
Any
डिफ़ॉल्ट:"None"
सुरक्षा के लिए वैकल्पिक state पैरामीटर।

is_token_expired

जांचें कि OAuth2 टोकन की अवधि समाप्त हो गई है या नहीं।

refresh_token

OAuth2 टोकन को रीफ़्रेश करें।

class xdk.Cursor

[ResponseType]

पैरामीटर

path.method
PaginatableMethod

__init__

कर्सर को प्रारंभ करता है।

पैरामीटर

path.method
PaginatableMethod
हर पेज के लिए कॉल की जाने वाली API method (इसे pagination का समर्थन करना चाहिए)

items

पृष्ठांकित प्रतिक्रियाओं के अलग-अलग आइटमों पर इटरेट करें।

पैरामीटर

path.limit
int or None
डिफ़ॉल्ट:"None"
लौटाई जाने वाली आइटमों की अधिकतम संख्या (None का अर्थ असीमित है)

लौटाया गया मान

IteratorAny

pages

रिस्पॉन्स के पृष्ठों पर इटरेट करें।

पैरामीटर

path.limit
int or None
डिफ़ॉल्ट:"None"
वापस किए जाने वाले पृष्ठों की अधिकतम संख्या (None का अर्थ है असीमित)

लौटाया गया मान

IteratorResponseType

class xdk.StreamConfig

पुनः प्रयास व्यवहार के साथ स्ट्रीमिंग कनेक्शनों के लिए कॉन्फ़िगरेशन।

पैरामीटर

path.max_retries
int
डिफ़ॉल्ट:"10"
path.initial_backoff
float
डिफ़ॉल्ट:"1.0"
path.max_backoff
float
डिफ़ॉल्ट:"64.0"
path.backoff_multiplier
float
डिफ़ॉल्ट:"2.0"
path.jitter
bool
डिफ़ॉल्ट:"True"
path.timeout
float or None
डिफ़ॉल्ट:"None"
path.chunk_size
int
डिफ़ॉल्ट:"1024"
path.on_connect
Callable[[], None] or None
डिफ़ॉल्ट:"None"
path.on_disconnect
Callable[[Exception or None], None] or None
डिफ़ॉल्ट:"None"
path.on_reconnect
Callable[[int, float], None] or None
डिफ़ॉल्ट:"None"
path.on_error
Callable[[[StreamError

__init__

पैरामीटर

path.max_retries
int
डिफ़ॉल्ट:"10"
path.initial_backoff
float
डिफ़ॉल्ट:"1.0"
path.max_backoff
float
डिफ़ॉल्ट:"64.0"
path.backoff_multiplier
float
डिफ़ॉल्ट:"2.0"
path.jitter
bool
डिफ़ॉल्ट:"True"
path.timeout
float or None
डिफ़ॉल्ट:"None"
path.chunk_size
int
डिफ़ॉल्ट:"1024"
path.on_connect
Callable[[], None] or None
डिफ़ॉल्ट:"None"
path.on_disconnect
Callable[[Exception or None], None] or None
डिफ़ॉल्ट:"None"
path.on_reconnect
Callable[[int, float], None] or None
डिफ़ॉल्ट:"None"
path.on_error
Callable[[[StreamError

on_error : Callable[[[StreamError]

exception xdk.StreamError

वर्गीकरण के साथ स्ट्रीमिंग त्रुटियों के लिए उठाया गया अपवाद।

पैरामीटर

path.message
str
path.error_type
StreamErrorType

__init__

पैरामीटर

path.message
str
path.error_type
StreamErrorType

class xdk.StreamErrorType

पुनः प्रयास संबंधी निर्णयों के लिए स्ट्रीमिंग त्रुटियों का वर्गीकरण।

पैरामीटर

path.value
Any

class xdk.StreamState

स्ट्रीमिंग कनेक्शन की आंतरिक स्थिति।

पैरामीटर

path.retry_count
int
डिफ़ॉल्ट:"0"
path.current_backoff
float
डिफ़ॉल्ट:"1.0"
path.is_connected
bool
डिफ़ॉल्ट:"False"
path.total_items_received
int
डिफ़ॉल्ट:"0"
path.last_error
StreamError

__init__

पैरामीटर

path.retry_count
int
डिफ़ॉल्ट:"0"
path.current_backoff
float
डिफ़ॉल्ट:"1.0"
path.is_connected
bool
डिफ़ॉल्ट:"False"
path.total_items_received
int
डिफ़ॉल्ट:"0"
path.last_error
StreamError

last_error : [StreamError]

xdk.cursor

उचित type inference और validation के साथ एक कर्सर बनाएँ। यह factory function type inference में मदद करता है, ताकि आपको response type के लिए सही type hints मिलें, और यह भी सत्यापित करता है कि method static analysis और runtime, दोनों में pagination का समर्थन करता है।

पैरामीटर

path.method
PaginatableMethod
रैप की जाने वाली API method (इसे pagination का समर्थन करना चाहिए)