-
-
Notifications
You must be signed in to change notification settings - Fork 4.6k
/
client.py
3806 lines (3175 loc) · 143 KB
/
client.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
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Tweepy
# Copyright 2009-2023 Joshua Roesslein
# See LICENSE for details.
from collections import namedtuple
import datetime
try:
from functools import cache
except ImportError: # Remove when support for Python 3.8 is dropped
from functools import lru_cache
cache = lru_cache(maxsize=None)
import logging
from platform import python_version
import time
import warnings
import requests
import tweepy
from tweepy.auth import OAuth1UserHandler
from tweepy.direct_message_event import DirectMessageEvent
from tweepy.errors import (
BadRequest, Forbidden, HTTPException, NotFound, TooManyRequests,
TwitterServerError, Unauthorized
)
from tweepy.list import List
from tweepy.media import Media
from tweepy.place import Place
from tweepy.poll import Poll
from tweepy.space import Space
from tweepy.tweet import Tweet
from tweepy.user import User
log = logging.getLogger(__name__)
Response = namedtuple("Response", ("data", "includes", "errors", "meta"))
class BaseClient:
def __init__(
self, bearer_token=None, consumer_key=None, consumer_secret=None,
access_token=None, access_token_secret=None, *, return_type=Response,
wait_on_rate_limit=False
):
self.bearer_token = bearer_token
self.consumer_key = consumer_key
self.consumer_secret = consumer_secret
self.access_token = access_token
self.access_token_secret = access_token_secret
self.return_type = return_type
self.wait_on_rate_limit = wait_on_rate_limit
self.session = requests.Session()
self.user_agent = (
f"Python/{python_version()} "
f"Requests/{requests.__version__} "
f"Tweepy/{tweepy.__version__}"
)
def request(self, method, route, params=None, json=None, user_auth=False):
host = "https://api.twitter.com"
headers = {"User-Agent": self.user_agent}
auth = None
if user_auth:
auth = OAuth1UserHandler(
self.consumer_key, self.consumer_secret,
self.access_token, self.access_token_secret
)
auth = auth.apply_auth()
else:
headers["Authorization"] = f"Bearer {self.bearer_token}"
log.debug(
f"Making API request: {method} {host + route}\n"
f"Parameters: {params}\n"
f"Headers: {headers}\n"
f"Body: {json}"
)
with self.session.request(
method, host + route, params=params, json=json, headers=headers,
auth=auth
) as response:
log.debug(
"Received API response: "
f"{response.status_code} {response.reason}\n"
f"Headers: {response.headers}\n"
f"Content: {response.content}"
)
if response.status_code == 400:
raise BadRequest(response)
if response.status_code == 401:
raise Unauthorized(response)
if response.status_code == 403:
raise Forbidden(response)
if response.status_code == 404:
raise NotFound(response)
if response.status_code == 429:
if self.wait_on_rate_limit:
reset_time = int(response.headers["x-rate-limit-reset"])
sleep_time = reset_time - int(time.time()) + 1
if sleep_time > 0:
log.warning(
"Rate limit exceeded. "
f"Sleeping for {sleep_time} seconds."
)
time.sleep(sleep_time)
return self.request(method, route, params, json, user_auth)
else:
raise TooManyRequests(response)
if response.status_code >= 500:
raise TwitterServerError(response)
if not 200 <= response.status_code < 300:
raise HTTPException(response)
return response
def _make_request(
self, method, route, params={}, endpoint_parameters=(), json=None,
data_type=None, user_auth=False
):
request_params = self._process_params(params, endpoint_parameters)
response = self.request(method, route, params=request_params,
json=json, user_auth=user_auth)
if self.return_type is requests.Response:
return response
response = response.json()
if self.return_type is dict:
return response
return self._construct_response(response, data_type=data_type)
def _construct_response(self, response, data_type=None):
data = response.get("data")
data = self._process_data(data, data_type=data_type)
includes = response.get("includes", {})
includes = self._process_includes(includes)
errors = response.get("errors", [])
meta = response.get("meta", {})
return Response(data, includes, errors, meta)
def _process_data(self, data, data_type=None):
if data_type is not None:
if isinstance(data, list):
data = [data_type(result) for result in data]
elif data is not None:
data = data_type(data)
return data
def _process_includes(self, includes):
if "media" in includes:
includes["media"] = [Media(media) for media in includes["media"]]
if "places" in includes:
includes["places"] = [Place(place) for place in includes["places"]]
if "polls" in includes:
includes["polls"] = [Poll(poll) for poll in includes["polls"]]
if "tweets" in includes:
includes["tweets"] = [Tweet(tweet) for tweet in includes["tweets"]]
if "users" in includes:
includes["users"] = [User(user) for user in includes["users"]]
return includes
def _process_params(self, params, endpoint_parameters):
endpoint_parameters = {
endpoint_parameter.replace('.', '_'): endpoint_parameter
for endpoint_parameter in endpoint_parameters
}
request_params = {}
for param_name, param_value in params.items():
try:
param_name = endpoint_parameters[param_name]
except KeyError:
log.warn(f"Unexpected parameter: {param_name}")
if isinstance(param_value, list):
request_params[param_name] = ','.join(map(str, param_value))
elif isinstance(param_value, datetime.datetime):
if param_value.tzinfo is not None:
param_value = param_value.astimezone(datetime.timezone.utc)
request_params[param_name] = param_value.strftime(
"%Y-%m-%dT%H:%M:%SZ"
)
# TODO: Constant datetime format string?
elif param_value is not None:
request_params[param_name] = param_value
return request_params
class Client(BaseClient):
"""Client( \
bearer_token=None, consumer_key=None, consumer_secret=None, \
access_token=None, access_token_secret=None, *, return_type=Response, \
wait_on_rate_limit=False \
)
Twitter API v2 Client
.. versionadded:: 4.0
.. versionchanged:: 4.15
Removed ``block`` and ``unblock`` methods, as the endpoints they use
have been removed
Parameters
----------
bearer_token : str | None
Twitter API OAuth 2.0 Bearer Token / Access Token
consumer_key : str | None
Twitter API OAuth 1.0a Consumer Key
consumer_secret : str | None
Twitter API OAuth 1.0a Consumer Secret
access_token : str | None
Twitter API OAuth 1.0a Access Token
access_token_secret : str | None
Twitter API OAuth 1.0a Access Token Secret
return_type : type[dict | requests.Response | Response]
Type to return from requests to the API
wait_on_rate_limit : bool
Whether to wait when rate limit is reached
Attributes
----------
session : requests.Session
Requests Session used to make requests to the API
user_agent : str
User agent used when making requests to the API
"""
def _get_authenticating_user_id(self, *, oauth_1=False):
if oauth_1:
if self.access_token is None:
raise TypeError(
"Access Token must be provided for OAuth 1.0a User Context"
)
else:
return self._get_oauth_1_authenticating_user_id(
self.access_token
)
else:
if self.bearer_token is None:
raise TypeError(
"Access Token must be provided for "
"OAuth 2.0 Authorization Code Flow with PKCE"
)
else:
return self._get_oauth_2_authenticating_user_id(
self.bearer_token
)
@cache
def _get_oauth_1_authenticating_user_id(self, access_token):
return access_token.partition('-')[0]
@cache
def _get_oauth_2_authenticating_user_id(self, access_token):
original_access_token = self.bearer_token
original_return_type = self.return_type
self.bearer_token = access_token
self.return_type = dict
user_id = self.get_me(user_auth=False)["data"]["id"]
self.bearer_token = original_access_token
self.return_type = original_return_type
return user_id
# Bookmarks
def remove_bookmark(self, tweet_id):
"""Allows a user or authenticated user ID to remove a Bookmark of a
Tweet.
.. note::
A request is made beforehand to Twitter's API to determine the
authenticating user's ID. This is cached and only done once per
:class:`Client` instance for each access token used.
.. versionadded:: 4.8
Parameters
----------
tweet_id : int | str
The ID of the Tweet that you would like the ``id`` to remove a
Bookmark of.
Raises
------
TypeError
If the access token isn't set
Returns
-------
dict | requests.Response | Response
References
----------
https://developer.twitter.com/en/docs/twitter-api/tweets/bookmarks/api-reference/delete-users-id-bookmarks-tweet_id
"""
id = self._get_authenticating_user_id()
route = f"/2/users/{id}/bookmarks/{tweet_id}"
return self._make_request(
"DELETE", route
)
def get_bookmarks(self, **params):
"""get_bookmarks( \
*, expansions=None, max_results=None, media_fields=None, \
pagination_token=None, place_fields=None, poll_fields=None, \
tweet_fields=None, user_fields=None \
)
Allows you to get an authenticated user's 800 most recent bookmarked
Tweets.
.. note::
A request is made beforehand to Twitter's API to determine the
authenticating user's ID. This is cached and only done once per
:class:`Client` instance for each access token used.
.. versionadded:: 4.8
Parameters
----------
expansions : list[str] | str | None
:ref:`expansions_parameter`
max_results : int | None
The maximum number of results to be returned per page. This can be
a number between 1 and 100. By default, each page will return 100
results.
media_fields : list[str] | str | None
:ref:`media_fields_parameter`
pagination_token : str | None
Used to request the next page of results if all results weren't
returned with the latest request, or to go back to the previous
page of results. To return the next page, pass the ``next_token``
returned in your previous response. To go back one page, pass the
``previous_token`` returned in your previous response.
place_fields : list[str] | str | None
:ref:`place_fields_parameter`
poll_fields : list[str] | str | None
:ref:`poll_fields_parameter`
tweet_fields : list[str] | str | None
:ref:`tweet_fields_parameter`
user_fields : list[str] | str | None
:ref:`user_fields_parameter`
Raises
------
TypeError
If the access token isn't set
Returns
-------
dict | requests.Response | Response
References
----------
https://developer.twitter.com/en/docs/twitter-api/tweets/bookmarks/api-reference/get-users-id-bookmarks
"""
id = self._get_authenticating_user_id()
route = f"/2/users/{id}/bookmarks"
return self._make_request(
"GET", route, params=params,
endpoint_parameters=(
"expansions", "max_results", "media.fields",
"pagination_token", "place.fields", "poll.fields",
"tweet.fields", "user.fields"
), data_type=Tweet
)
def bookmark(self, tweet_id):
"""Causes the authenticating user to Bookmark the target Tweet provided
in the request body.
.. note::
A request is made beforehand to Twitter's API to determine the
authenticating user's ID. This is cached and only done once per
:class:`Client` instance for each access token used.
.. versionadded:: 4.8
Parameters
----------
tweet_id : int | str
The ID of the Tweet that you would like the user ``id`` to
Bookmark.
Raises
------
TypeError
If the access token isn't set
Returns
-------
dict | requests.Response | Response
References
----------
https://developer.twitter.com/en/docs/twitter-api/tweets/bookmarks/api-reference/post-users-id-bookmarks
"""
id = self._get_authenticating_user_id()
route = f"/2/users/{id}/bookmarks"
return self._make_request(
"POST", route, json={"tweet_id": str(tweet_id)}
)
# Hide replies
def hide_reply(self, id, *, user_auth=True):
"""Hides a reply to a Tweet.
.. versionchanged:: 4.5
Added ``user_auth`` parameter
Parameters
----------
id : int | str
Unique identifier of the Tweet to hide. The Tweet must belong to a
conversation initiated by the authenticating user.
user_auth : bool
Whether or not to use OAuth 1.0a User Context to authenticate
Returns
-------
dict | requests.Response | Response
References
----------
https://developer.twitter.com/en/docs/twitter-api/tweets/hide-replies/api-reference/put-tweets-id-hidden
"""
return self._make_request(
"PUT", f"/2/tweets/{id}/hidden", json={"hidden": True},
user_auth=user_auth
)
def unhide_reply(self, id, *, user_auth=True):
"""Unhides a reply to a Tweet.
.. versionchanged:: 4.5
Added ``user_auth`` parameter
Parameters
----------
id : int | str
Unique identifier of the Tweet to unhide. The Tweet must belong to
a conversation initiated by the authenticating user.
user_auth : bool
Whether or not to use OAuth 1.0a User Context to authenticate
Returns
-------
dict | requests.Response | Response
References
----------
https://developer.twitter.com/en/docs/twitter-api/tweets/hide-replies/api-reference/put-tweets-id-hidden
"""
return self._make_request(
"PUT", f"/2/tweets/{id}/hidden", json={"hidden": False},
user_auth=user_auth
)
# Likes
def unlike(self, tweet_id, *, user_auth=True):
"""Unlike a Tweet.
The request succeeds with no action when the user sends a request to a
user they're not liking the Tweet or have already unliked the Tweet.
.. note::
When using OAuth 2.0 Authorization Code Flow with PKCE with
``user_auth=False``, a request is made beforehand to Twitter's API
to determine the authenticating user's ID. This is cached and only
done once per :class:`Client` instance for each access token used.
.. versionchanged:: 4.5
Added ``user_auth`` parameter
.. versionchanged:: 4.8
Added support for using OAuth 2.0 Authorization Code Flow with PKCE
.. versionchanged:: 4.8
Changed to raise :class:`TypeError` when the access token isn't set
Parameters
----------
tweet_id : int | str
The ID of the Tweet that you would like to unlike.
user_auth : bool
Whether or not to use OAuth 1.0a User Context to authenticate
Raises
------
TypeError
If the access token isn't set
Returns
-------
dict | requests.Response | Response
References
----------
https://developer.twitter.com/en/docs/twitter-api/tweets/likes/api-reference/delete-users-id-likes-tweet_id
"""
id = self._get_authenticating_user_id(oauth_1=user_auth)
route = f"/2/users/{id}/likes/{tweet_id}"
return self._make_request(
"DELETE", route, user_auth=user_auth
)
def get_liking_users(self, id, *, user_auth=False, **params):
"""get_liking_users( \
id, *, expansions=None, max_results=None, media_fields=None, \
pagination_token=None, place_fields=None, poll_fields=None, \
tweet_fields=None, user_fields=None, user_auth=False \
)
Allows you to get information about a Tweet’s liking users.
.. versionchanged:: 4.6
Added ``max_results`` and ``pagination_token`` parameters
Parameters
----------
id : int | str
Tweet ID of the Tweet to request liking users of.
expansions : list[str] | str | None
:ref:`expansions_parameter`
max_results : int | None
The maximum number of results to be returned per page. This can be
a number between 1 and 100. By default, each page will return 100
results.
media_fields : list[str] | str | None
:ref:`media_fields_parameter`
pagination_token : str | None
Used to request the next page of results if all results weren't
returned with the latest request, or to go back to the previous
page of results. To return the next page, pass the ``next_token``
returned in your previous response. To go back one page, pass the
``previous_token`` returned in your previous response.
place_fields : list[str] | str | None
:ref:`place_fields_parameter`
poll_fields : list[str] | str | None
:ref:`poll_fields_parameter`
tweet_fields : list[str] | str | None
:ref:`tweet_fields_parameter`
user_fields : list[str] | str | None
:ref:`user_fields_parameter`
user_auth : bool
Whether or not to use OAuth 1.0a User Context to authenticate
Returns
-------
dict | requests.Response | Response
References
----------
https://developer.twitter.com/en/docs/twitter-api/tweets/likes/api-reference/get-tweets-id-liking_users
"""
return self._make_request(
"GET", f"/2/tweets/{id}/liking_users", params=params,
endpoint_parameters=(
"expansions", "max_results", "media.fields",
"pagination_token", "place.fields", "poll.fields",
"tweet.fields", "user.fields"
), data_type=User, user_auth=user_auth
)
def get_liked_tweets(self, id, *, user_auth=False, **params):
"""get_liked_tweets( \
id, *, expansions=None, max_results=None, media_fields=None, \
pagination_token=None, place_fields=None, poll_fields=None, \
tweet_fields=None, user_fields=None, user_auth=False \
)
Allows you to get information about a user’s liked Tweets.
The Tweets returned by this endpoint count towards the Project-level
`Tweet cap`_.
Parameters
----------
id : int | str
User ID of the user to request liked Tweets for.
expansions : list[str] | str | None
:ref:`expansions_parameter`
max_results : int | None
The maximum number of results to be returned per page. This can be
a number between 5 and 100. By default, each page will return 100
results.
media_fields : list[str] | str | None
:ref:`media_fields_parameter`
pagination_token : str | None
Used to request the next page of results if all results weren't
returned with the latest request, or to go back to the previous
page of results. To return the next page, pass the ``next_token``
returned in your previous response. To go back one page, pass the
``previous_token`` returned in your previous response.
place_fields : list[str] | str | None
:ref:`place_fields_parameter`
poll_fields : list[str] | str | None
:ref:`poll_fields_parameter`
tweet_fields : list[str] | str | None
:ref:`tweet_fields_parameter`
user_fields : list[str] | str | None
:ref:`user_fields_parameter`
user_auth : bool
Whether or not to use OAuth 1.0a User Context to authenticate
Returns
-------
dict | requests.Response | Response
References
----------
https://developer.twitter.com/en/docs/twitter-api/tweets/likes/api-reference/get-users-id-liked_tweets
.. _Tweet cap: https://developer.twitter.com/en/docs/projects/overview#tweet-cap
"""
return self._make_request(
"GET", f"/2/users/{id}/liked_tweets", params=params,
endpoint_parameters=(
"expansions", "max_results", "media.fields",
"pagination_token", "place.fields", "poll.fields",
"tweet.fields", "user.fields"
), data_type=Tweet, user_auth=user_auth
)
def like(self, tweet_id, *, user_auth=True):
"""Like a Tweet.
.. note::
When using OAuth 2.0 Authorization Code Flow with PKCE with
``user_auth=False``, a request is made beforehand to Twitter's API
to determine the authenticating user's ID. This is cached and only
done once per :class:`Client` instance for each access token used.
.. versionchanged:: 4.5
Added ``user_auth`` parameter
.. versionchanged:: 4.8
Added support for using OAuth 2.0 Authorization Code Flow with PKCE
.. versionchanged:: 4.8
Changed to raise :class:`TypeError` when the access token isn't set
Parameters
----------
tweet_id : int | str
The ID of the Tweet that you would like to Like.
user_auth : bool
Whether or not to use OAuth 1.0a User Context to authenticate
Raises
------
TypeError
If the access token isn't set
Returns
-------
dict | requests.Response | Response
References
----------
https://developer.twitter.com/en/docs/twitter-api/tweets/likes/api-reference/post-users-id-likes
"""
id = self._get_authenticating_user_id(oauth_1=user_auth)
route = f"/2/users/{id}/likes"
return self._make_request(
"POST", route, json={"tweet_id": str(tweet_id)},
user_auth=user_auth
)
# Manage Tweets
def delete_tweet(self, id, *, user_auth=True):
"""Allows an authenticated user ID to delete a Tweet.
.. versionadded:: 4.3
.. versionchanged:: 4.5
Added ``user_auth`` parameter
Parameters
----------
id : int | str
The Tweet ID you are deleting.
user_auth : bool
Whether or not to use OAuth 1.0a User Context to authenticate
Returns
-------
dict | requests.Response | Response
References
----------
https://developer.twitter.com/en/docs/twitter-api/tweets/manage-tweets/api-reference/delete-tweets-id
"""
return self._make_request(
"DELETE", f"/2/tweets/{id}", user_auth=user_auth
)
def create_tweet(
self, *, direct_message_deep_link=None, for_super_followers_only=None,
place_id=None, media_ids=None, media_tagged_user_ids=None,
poll_duration_minutes=None, poll_options=None, quote_tweet_id=None,
exclude_reply_user_ids=None, in_reply_to_tweet_id=None,
reply_settings=None, text=None, user_auth=True
):
"""Creates a Tweet on behalf of an authenticated user.
.. versionadded:: 4.3
.. versionchanged:: 4.5
Added ``user_auth`` parameter
Parameters
----------
direct_message_deep_link : str | None
`Tweets a link directly to a Direct Message conversation`_ with an
account.
for_super_followers_only : bool | None
Allows you to Tweet exclusively for `Super Followers`_.
place_id : str | None
Place ID being attached to the Tweet for geo location.
media_ids : list[int | str] | None
A list of Media IDs being attached to the Tweet. This is only
required if the request includes the ``tagged_user_ids``.
media_tagged_user_ids : list[int | str] | None
A list of User IDs being tagged in the Tweet with Media. If the
user you're tagging doesn't have photo-tagging enabled, their names
won't show up in the list of tagged users even though the Tweet is
successfully created.
poll_duration_minutes : int | None
Duration of the poll in minutes for a Tweet with a poll. This is
only required if the request includes ``poll.options``.
poll_options : list[str] | None
A list of poll options for a Tweet with a poll.
quote_tweet_id : int | str | None
Link to the Tweet being quoted.
exclude_reply_user_ids : list[int | str] | None
A list of User IDs to be excluded from the reply Tweet thus
removing a user from a thread.
in_reply_to_tweet_id : int | str | None
Tweet ID of the Tweet being replied to. Please note that
``in_reply_to_tweet_id`` needs to be in the request if
``exclude_reply_user_ids`` is present.
reply_settings : str | None
`Settings`_ to indicate who can reply to the Tweet. Limited to
"mentionedUsers" and "following". If the field isn’t specified, it
will default to everyone.
text : str | None
Text of the Tweet being created. This field is required if
``media.media_ids`` is not present.
user_auth : bool
Whether or not to use OAuth 1.0a User Context to authenticate
Returns
-------
dict | requests.Response | Response
References
----------
https://developer.twitter.com/en/docs/twitter-api/tweets/manage-tweets/api-reference/post-tweets
.. _Tweets a link directly to a Direct Message conversation: https://business.twitter.com/en/help/campaign-editing-and-optimization/public-to-private-conversation.html
.. _Super Followers: https://help.twitter.com/en/using-twitter/super-follows
.. _Settings: https://blog.twitter.com/en_us/topics/product/2020/new-conversation-settings-coming-to-a-tweet-near-you
"""
json = {}
if direct_message_deep_link is not None:
json["direct_message_deep_link"] = direct_message_deep_link
if for_super_followers_only is not None:
json["for_super_followers_only"] = for_super_followers_only
if place_id is not None:
json["geo"] = {"place_id": place_id}
if media_ids is not None:
json["media"] = {
"media_ids": [str(media_id) for media_id in media_ids]
}
if media_tagged_user_ids is not None:
json["media"]["tagged_user_ids"] = [
str(media_tagged_user_id)
for media_tagged_user_id in media_tagged_user_ids
]
if poll_options is not None:
json["poll"] = {"options": poll_options}
if poll_duration_minutes is not None:
json["poll"]["duration_minutes"] = poll_duration_minutes
if quote_tweet_id is not None:
json["quote_tweet_id"] = str(quote_tweet_id)
if in_reply_to_tweet_id is not None:
json["reply"] = {"in_reply_to_tweet_id": str(in_reply_to_tweet_id)}
if exclude_reply_user_ids is not None:
json["reply"]["exclude_reply_user_ids"] = [
str(exclude_reply_user_id)
for exclude_reply_user_id in exclude_reply_user_ids
]
if reply_settings is not None:
json["reply_settings"] = reply_settings
if text is not None:
json["text"] = text
return self._make_request(
"POST", f"/2/tweets", json=json, user_auth=user_auth
)
# Quote Tweets
def get_quote_tweets(self, id, *, user_auth=False, **params):
"""get_quote_tweets( \
id, *, exclude=None, expansions=None, max_results=None, \
media_fields=None, pagination_token=None, place_fields=None, \
poll_fields=None, tweet_fields=None, user_fields=None, \
user_auth=False \
)
Returns Quote Tweets for a Tweet specified by the requested Tweet ID.
The Tweets returned by this endpoint count towards the Project-level
`Tweet cap`_.
.. versionadded:: 4.7
.. versionchanged:: 4.11
Added ``exclude`` parameter
Parameters
----------
id : int | str
Unique identifier of the Tweet to request.
exclude : list[str] | str | None
Comma-separated list of the types of Tweets to exclude from the
response.
expansions : list[str] | str | None
:ref:`expansions_parameter`
max_results : int | None
Specifies the number of Tweets to try and retrieve, up to a maximum
of 100 per distinct request. By default, 10 results are returned if
this parameter is not supplied. The minimum permitted value is 10.
It is possible to receive less than the ``max_results`` per request
throughout the pagination process.
media_fields : list[str] | str | None
:ref:`media_fields_parameter`
pagination_token : str | None
This parameter is used to move forwards through 'pages' of results,
based on the value of the ``next_token``. The value used with the
parameter is pulled directly from the response provided by the API,
and should not be modified.
place_fields : list[str] | str | None
:ref:`place_fields_parameter`
poll_fields : list[str] | str | None
:ref:`poll_fields_parameter`
tweet_fields : list[str] | str | None
:ref:`tweet_fields_parameter`
user_fields : list[str] | str | None
:ref:`user_fields_parameter`
user_auth : bool
Whether or not to use OAuth 1.0a User Context to authenticate
Returns
-------
dict | requests.Response | Response
References
----------
https://developer.twitter.com/en/docs/twitter-api/tweets/quote-tweets/api-reference/get-tweets-id-quote_tweets
.. _Tweet cap: https://developer.twitter.com/en/docs/projects/overview#tweet-cap
"""
return self._make_request(
"GET", f"/2/tweets/{id}/quote_tweets", params=params,
endpoint_parameters=(
"exclude", "expansions", "max_results", "media.fields",
"pagination_token", "place.fields", "poll.fields",
"tweet.fields", "user.fields"
), data_type=Tweet, user_auth=user_auth
)
# Retweets
def unretweet(self, source_tweet_id, *, user_auth=True):
"""Allows an authenticated user ID to remove the Retweet of a Tweet.
The request succeeds with no action when the user sends a request to a
user they're not Retweeting the Tweet or have already removed the
Retweet of.
.. note::
When using OAuth 2.0 Authorization Code Flow with PKCE with
``user_auth=False``, a request is made beforehand to Twitter's API
to determine the authenticating user's ID. This is cached and only
done once per :class:`Client` instance for each access token used.
.. versionchanged:: 4.5
Added ``user_auth`` parameter
.. versionchanged:: 4.8
Added support for using OAuth 2.0 Authorization Code Flow with PKCE
.. versionchanged:: 4.8
Changed to raise :class:`TypeError` when the access token isn't set
Parameters
----------
source_tweet_id : int | str
The ID of the Tweet that you would like to remove the Retweet of.
user_auth : bool
Whether or not to use OAuth 1.0a User Context to authenticate
Raises
------
TypeError
If the access token isn't set
Returns
-------
dict | requests.Response | Response
References
----------
https://developer.twitter.com/en/docs/twitter-api/tweets/retweets/api-reference/delete-users-id-retweets-tweet_id
"""
id = self._get_authenticating_user_id(oauth_1=user_auth)
route = f"/2/users/{id}/retweets/{source_tweet_id}"
return self._make_request(
"DELETE", route, user_auth=user_auth
)
def get_retweeters(self, id, *, user_auth=False, **params):
"""get_retweeters( \
id, *, expansions=None, max_results=None, media_fields=None, \
pagination_token=None, place_fields=None, poll_fields=None, \
tweet_fields=None, user_fields=None, user_auth=False \
)
Allows you to get information about who has Retweeted a Tweet.
.. versionchanged:: 4.6
Added ``max_results`` and ``pagination_token`` parameters
Parameters
----------
id : int | str
Tweet ID of the Tweet to request Retweeting users of.
expansions : list[str] | str | None
:ref:`expansions_parameter`
max_results : int | None
The maximum number of results to be returned per page. This can be
a number between 1 and 100. By default, each page will return 100
results.
media_fields : list[str] | str | None
:ref:`media_fields_parameter`
pagination_token : str | None
Used to request the next page of results if all results weren't
returned with the latest request, or to go back to the previous
page of results. To return the next page, pass the ``next_token``
returned in your previous response. To go back one page, pass the
``previous_token`` returned in your previous response.
place_fields : list[str] | str | None
:ref:`place_fields_parameter`
poll_fields : list[str] | str | None
:ref:`poll_fields_parameter`