-
Notifications
You must be signed in to change notification settings - Fork 697
/
api.py
587 lines (477 loc) · 19.8 KB
/
api.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
# encoding: utf-8
from __future__ import unicode_literals, print_function
from .util import PY_3_OR_HIGHER, actually_bytes
try:
import urllib.request as urllib_request
import urllib.error as urllib_error
except ImportError:
import urllib2 as urllib_request
import urllib2 as urllib_error
try:
from cStringIO import StringIO
except ImportError:
from io import BytesIO as StringIO
from .twitter_globals import POST_ACTIONS
from .auth import NoAuth
import re
import sys
import gzip
from time import sleep, time
try:
import http.client as http_client
except ImportError:
import httplib as http_client
try:
import json
except ImportError:
import simplejson as json
class _DEFAULT(object):
pass
class TwitterError(Exception):
"""
Base Exception thrown by the Twitter object when there is a
general error interacting with the API.
"""
pass
class TwitterHTTPError(TwitterError):
"""
Exception thrown by the Twitter object when there is an
HTTP error interacting with twitter.com.
"""
def __init__(self, e, uri, format, uriparts):
self.e = e
self.uri = uri
self.format = format
self.uriparts = uriparts
try:
data = self.e.fp.read()
except http_client.IncompleteRead as e:
# can't read the error text
# let's try some of it
data = e.partial
if self.e.headers.get('Content-Encoding') == 'gzip':
buf = StringIO(data)
f = gzip.GzipFile(fileobj=buf)
data = f.read()
if len(data) == 0:
data = {}
else:
data = data.decode('utf8')
if "json" == self.format:
try:
data = json.loads(data)
except ValueError:
# We try to load the response as json as a nicety; if it fails, carry on.
pass
self.response_data = data
super(TwitterHTTPError, self).__init__(str(self))
def __str__(self):
fmt = ("." + self.format) if self.format else ""
return (
"Twitter sent status %i for URL: %s%s using parameters: "
"(%s)\ndetails: %s" % (
self.e.code, self.uri, fmt, self.uriparts,
self.response_data))
class TwitterResponse(object):
"""
Response from a twitter request. Behaves like a list or a string
(depending on requested format) but it has a few other interesting
attributes.
`headers` gives you access to the response headers as an
httplib.HTTPHeaders instance. You can do
`response.headers.get('h')` to retrieve a header.
"""
@property
def rate_limit_remaining(self):
"""
Remaining requests in the current rate-limit.
"""
return int(self.headers.get('X-Rate-Limit-Remaining', "0"))
@property
def rate_limit_limit(self):
"""
The rate limit ceiling for that given request.
"""
return int(self.headers.get('X-Rate-Limit-Limit', "0"))
@property
def rate_limit_reset(self):
"""
Time in UTC epoch seconds when the rate limit will reset.
"""
return int(self.headers.get('X-Rate-Limit-Reset', "0"))
class TwitterDictResponse(dict, TwitterResponse):
pass
class TwitterListResponse(list, TwitterResponse):
pass
def wrap_response(response, headers):
response_typ = type(response)
if response_typ is dict:
res = TwitterDictResponse(response)
res.headers = headers
elif response_typ is list:
res = TwitterListResponse(response)
res.headers = headers
else:
res = response
return res
POST_ACTIONS_RE = re.compile('(' + '|'.join(POST_ACTIONS) + r')(/\d+)?$')
def method_for_uri(uri):
if POST_ACTIONS_RE.search(uri):
return "POST"
return "GET"
def build_uri(orig_uriparts, kwargs):
"""
Build the URI from the original uriparts and kwargs. Modifies kwargs.
"""
uriparts = []
for uripart in orig_uriparts:
# If this part matches a keyword argument (starting with _), use
# the supplied value. Otherwise, just use the part.
if uripart.startswith("_"):
part = (str(kwargs.pop(uripart, uripart)))
else:
part = uripart
uriparts.append(part)
uri = '/'.join(uriparts)
# If an id kwarg is present and there is no id to fill in in
# the list of uriparts, assume the id goes at the end.
id = kwargs.pop('id', None)
if id:
uri += "/%s" % (id)
return uri
class TwitterCall(object):
TWITTER_UNAVAILABLE_WAIT = 30 # delay after HTTP codes 502, 503 or 504
def __init__(
self, auth, format, domain, callable_cls, uri="",
uriparts=None, secure=True, timeout=None, gzip=False, retry=False):
self.auth = auth
self.format = format
self.domain = domain
self.callable_cls = callable_cls
self.uri = uri
self.uriparts = uriparts
self.secure = secure
self.timeout = timeout
self.gzip = gzip
self.retry = retry
def __getattr__(self, k):
# NOTE: we test this to avoid doing dangerous things when actually
# attempting to get magic methods this object does not have (such as
# __getstate__, for instance, which is important to pickling).
# NOTE: when this code is run, the desired magic method cannot exist
# on this object because we are using __getattr__ and not
# __getattribute__, hence if it existed, it would be accessed normally.
if k.startswith('__'):
raise AttributeError
def extend_call(arg):
return self.callable_cls(
auth=self.auth, format=self.format, domain=self.domain,
callable_cls=self.callable_cls, timeout=self.timeout,
secure=self.secure, gzip=self.gzip, retry=self.retry,
uriparts=self.uriparts + (arg,))
if k == "_":
return extend_call
else:
return extend_call(k)
def __call__(self, **kwargs):
kwargs = dict(kwargs)
uri = build_uri(self.uriparts, kwargs)
# Shortcut call arguments for special json arguments case
if "media/metadata/create" in uri:
media_id = kwargs.pop('media_id', None)
alt_text = kwargs.pop('alt_text', kwargs.pop('text', None))
if media_id and alt_text:
jsondata = {
"media_id": media_id,
"alt_text": {"text": alt_text}
}
return self.__call__(_json=jsondata, **kwargs)
method = kwargs.pop('_method', None) or method_for_uri(uri)
domain = self.domain
# If an _id kwarg is present, this is treated as id as a CGI
# param.
_id = kwargs.pop('_id', None)
if _id:
kwargs['id'] = _id
# If an _timeout is specified in kwargs, use it
_timeout = kwargs.pop('_timeout', None)
secure_str = ''
if self.secure:
secure_str = 's'
dot = ""
if self.format:
dot = "."
url_base = "http%s://%s/%s%s%s" % (
secure_str, domain, uri, dot, self.format)
# Check if argument tells whether img is already base64 encoded
b64_convert = not kwargs.pop("_base64", False)
if b64_convert:
import base64
# Catch media arguments to handle oauth query differently for multipart
media = None
if 'media' in kwargs:
mediafield = 'media'
media = kwargs.pop('media')
media_raw = True
elif 'media[]' in kwargs:
mediafield = 'media[]'
media = kwargs.pop('media[]')
if b64_convert:
media = base64.b64encode(media)
media_raw = False
# Catch media arguments that are not accepted through multipart
# and are not yet base64 encoded
if b64_convert:
for arg in ['banner', 'image']:
if arg in kwargs:
kwargs[arg] = base64.b64encode(kwargs[arg])
headers = {'Accept-Encoding': 'gzip'} if self.gzip else dict()
body = None
arg_data = None
# Catch _json special argument to handle special endpoints which
# require args as a json string within the request's body
# for instance media/metadata/create on upload.twitter.com
# https://dev.twitter.com/rest/reference/post/media/metadata/create
jsondata = kwargs.pop('_json', None)
if jsondata:
body = actually_bytes(json.dumps(jsondata))
headers['Content-Type'] = 'application/json; charset=UTF-8'
if self.auth:
headers.update(self.auth.generate_headers())
# Use urlencoded oauth args with no params when sending media
# via multipart and send it directly via uri even for post
url_args = {} if media or jsondata else kwargs
if method == "PUT" and _id:
# the two PUT method APIs both require uri id parameter
url_args['id'] = _id
arg_data = self.auth.encode_params(
url_base, method, url_args)
if method == 'GET' or media or jsondata:
url_base += '?' + arg_data
else:
body = arg_data.encode('utf-8')
# Handle query as multipart when sending media
if media:
BOUNDARY = b"###Python-Twitter###"
bod = []
bod.append(b'--' + BOUNDARY)
bod.append(
b'Content-Disposition: form-data; name="'
+ actually_bytes(mediafield)
+ b'"')
bod.append(b'Content-Type: application/octet-stream')
if not media_raw:
bod.append(b'Content-Transfer-Encoding: base64')
bod.append(b'')
bod.append(actually_bytes(media))
for k, v in kwargs.items():
k = actually_bytes(k)
v = actually_bytes(v)
bod.append(b'--' + BOUNDARY)
bod.append(b'Content-Disposition: form-data; name="' + k + b'"')
bod.append(b'Content-Type: text/plain;charset=utf-8')
bod.append(b'')
bod.append(v)
bod.append(b'--' + BOUNDARY + b'--')
bod.append(b'')
bod.append(b'')
body = b'\r\n'.join(bod)
# print(body.decode('utf-8', errors='ignore'))
headers['Content-Type'] = \
b'multipart/form-data; boundary=' + BOUNDARY
if not PY_3_OR_HIGHER:
url_base = url_base.encode("utf-8")
for k in headers:
headers[actually_bytes(k)] = actually_bytes(headers.pop(k))
req = urllib_request.Request(url_base, data=body, headers=headers)
# Horrible hack, the python2/urllib2 version of request doesn't
# take a method parameter, but we can overwrite the class
# get_method() function to a lambda function that always returns
# the method we want...
# https://stackoverflow.com/questions/111945/is-there-any-way-to-do-http-put-in-python/111988#111988
if not PY_3_OR_HIGHER:
method = method.encode('utf-8')
req.get_method = lambda: method
if self.retry:
return self._handle_response_with_retry(req, uri, arg_data, _timeout)
else:
return self._handle_response(req, uri, arg_data, _timeout)
def _handle_response(self, req, uri, arg_data, _timeout=None):
kwargs = {}
if _timeout:
kwargs['timeout'] = _timeout
try:
handle = urllib_request.urlopen(req, **kwargs)
if handle.headers['Content-Type'] in ['image/jpeg', 'image/png']:
return handle
try:
data = handle.read()
except http_client.IncompleteRead as e:
# Even if we don't get all the bytes we should have there
# may be a complete response in e.partial
data = e.partial
if handle.info().get('Content-Encoding') == 'gzip':
# Handle gzip decompression
buf = StringIO(data)
f = gzip.GzipFile(fileobj=buf)
data = f.read()
if len(data) == 0:
return wrap_response({}, handle.headers)
elif "json" == self.format:
res = json.loads(data.decode('utf8'))
return wrap_response(res, handle.headers)
else:
return wrap_response(
data.decode('utf8'), handle.headers)
except urllib_error.HTTPError as e:
if (e.code == 304):
return []
else:
raise TwitterHTTPError(e, uri, self.format, arg_data)
def _handle_response_with_retry(self, req, uri, arg_data, _timeout=None):
retry = self.retry
while retry:
try:
return self._handle_response(req, uri, arg_data, _timeout)
except TwitterHTTPError as e:
if e.e.code == 429:
# API rate limit reached
reset = int(e.e.headers.get('X-Rate-Limit-Reset', time() + 30))
delay = int(reset - time() + 2) # add some extra margin
if delay <= 0:
delay = self.TWITTER_UNAVAILABLE_WAIT
print("API rate limit reached; waiting for %ds..." % delay, file=sys.stderr)
elif e.e.code in (502, 503, 504):
delay = self.TWITTER_UNAVAILABLE_WAIT
print("Service unavailable; waiting for %ds..." % delay, file=sys.stderr)
else:
raise
if isinstance(retry, int) and not isinstance(retry, bool):
if retry <= 0:
raise
retry -= 1
sleep(delay)
class Twitter(TwitterCall):
"""
The minimalist yet fully featured Twitter API class.
Get RESTful data by accessing members of this class. The result
is decoded python objects (lists and dicts).
The Twitter API is documented at:
https://dev.twitter.com/overview/documentation
The list of most accessible functions is listed at:
https://dev.twitter.com/rest/public
Examples::
from twitter import *
t = Twitter(
auth=OAuth(token, token_secret, consumer_key, consumer_secret))
# Get your "home" timeline
t.statuses.home_timeline()
# Get a particular friend's timeline
t.statuses.user_timeline(screen_name="billybob")
# to pass in GET/POST parameters, such as `count`
t.statuses.home_timeline(count=5)
# to pass in the GET/POST parameter `id` you need to use `_id`
t.statuses.oembed(_id=1234567890)
# Update your status
t.statuses.update(
status="Using @sixohsix's sweet Python Twitter Tools.")
# Send a direct message
t.direct_messages.new(
user="billybob",
text="I think yer swell!")
# Get the members of tamtar's list "Things That Are Rad"
t.lists.members(owner_screen_name="tamtar", slug="things-that-are-rad")
# An *optional* `_timeout` parameter can also be used for API
# calls which take much more time than normal or twitter stops
# responding for some reason:
t.users.lookup(
screen_name=','.join(A_LIST_OF_100_SCREEN_NAMES), \
_timeout=1)
# Overriding Method: GET/POST
# you should not need to use this method as this library properly
# detects whether GET or POST should be used, Nevertheless
# to force a particular method, use `_method`
t.statuses.oembed(_id=1234567890, _method='GET')
# Send images along with your tweets:
# - first just read images from the web or from files the regular way:
with open("example.png", "rb") as imagefile:
imagedata = imagefile.read()
# - then upload medias one by one on Twitter's dedicated server
# and collect each one's id:
t_upload = Twitter(domain='upload.twitter.com',
auth=OAuth(token, token_secret, consumer_key, consumer_secret))
id_img1 = t_upload.media.upload(media=imagedata)["media_id_string"]
id_img2 = t_upload.media.upload(media=imagedata)["media_id_string"]
# - finally send your tweet with the list of media ids:
t.statuses.update(status="PTT ★", media_ids=",".join([id_img1, id_img2]))
# Or send a tweet with an image (or set a logo/banner similarily)
# using the old deprecated method that will probably disappear some day
params = {"media[]": imagedata, "status": "PTT ★"}
# Or for an image encoded as base64:
params = {"media[]": base64_image, "status": "PTT ★", "_base64": True}
t.statuses.update_with_media(**params)
# Attach text metadata to medias sent, using the upload.twitter.com route
# using the _json workaround to send json arguments as POST body
# (warning: to be done before attaching the media to a tweet)
t_upload.media.metadata.create(_json={
"media_id": id_img1,
"alt_text": { "text": "metadata generated via PTT!" }
})
# or with the shortcut arguments ("alt_text" and "text" work):
t_upload.media.metadata.create(media_id=id_img1, text="metadata generated via PTT!")
Searching Twitter::
# Search for the latest tweets about #pycon
t.search.tweets(q="#pycon")
Using the data returned
-----------------------
Twitter API calls return decoded JSON. This is converted into
a bunch of Python lists, dicts, ints, and strings. For example::
x = twitter.statuses.home_timeline()
# The first 'tweet' in the timeline
x[0]
# The screen name of the user who wrote the first 'tweet'
x[0]['user']['screen_name']
Getting raw XML data
--------------------
If you prefer to get your Twitter data in XML format, pass
format="xml" to the Twitter object when you instantiate it::
twitter = Twitter(format="xml")
The output will not be parsed in any way. It will be a raw string
of XML.
"""
def __init__(
self, format="json",
domain="api.twitter.com", secure=True, auth=None,
api_version=_DEFAULT, retry=False):
"""
Create a new twitter API connector.
Pass an `auth` parameter to use the credentials of a specific
user. Generally you'll want to pass an `OAuth`
instance::
twitter = Twitter(auth=OAuth(
token, token_secret, consumer_key, consumer_secret))
`domain` lets you change the domain you are connecting. By
default it's `api.twitter.com`.
If `secure` is False you will connect with HTTP instead of
HTTPS.
`api_version` is used to set the base uri. By default it's
'1.1'.
If `retry` is True, API rate limits will automatically be
handled by waiting until the next reset, as indicated by
the X-Rate-Limit-Reset HTTP header. If retry is an integer,
it defines the number of retries attempted.
"""
if not auth:
auth = NoAuth()
if (format not in ("json", "xml", "")):
raise ValueError("Unknown data format '%s'" % (format))
if api_version is _DEFAULT:
api_version = '1.1'
uriparts = ()
if api_version:
uriparts += (str(api_version),)
TwitterCall.__init__(
self, auth=auth, format=format, domain=domain,
callable_cls=TwitterCall,
secure=secure, uriparts=uriparts, retry=retry)
__all__ = ["Twitter", "TwitterError", "TwitterHTTPError", "TwitterResponse"]