Skip to main content

उप-पैकेज

उपमॉड्यूल

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

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

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 क्लाइंट को प्रारंभ करता है।

पैरामीटर

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

exchange_code

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

पैरामीटर

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

fetch_token

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

पैरामीटर

Any
प्राधिकरण के बाद प्राप्त पूरा callback 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 (इसे pagination का समर्थन करना चाहिए)

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

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

पैरामीटर

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