forked from bear/python-twitter
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathuser.py
More file actions
867 lines (691 loc) · 28.3 KB
/
user.py
File metadata and controls
867 lines (691 loc) · 28.3 KB
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
from builtins import object
#!/usr/bin/env python
from twitter import simplejson, TwitterError # TwitterError not used
class UserStatus(object):
"""A class representing the UserStatus structure used by the twitter API.
The UserStatus structure exposes the following properties:
userstatus.name
userstatus.id_str
userstatus.id
userstatus.screen_name
userstatus.following
userstatus.followed_by
"""
def __init__(self, **kwargs):
"""An object to hold a Twitter user status message.
This class is normally instantiated by the twitter.Api class and
returned in a sequence.
Args:
id:
The unique id of this status message. [Optional]
id_str:
The string version of the unique id of this status message. [Optional]
"""
param_defaults = {
'name': None,
'id': None,
'id_str': None,
'screen_name': None,
'following': None,
'followed_by': None}
for (param, default) in param_defaults.items():
setattr(self, param, kwargs.get(param, default))
def GetFollowedBy(self):
return self.followed_by or False
def GetFollowing(self):
return self.following or False
def GetScreenName(self):
return self.screen_name
def __ne__(self, other):
return not self.__eq__(other)
def __eq__(self, other):
try:
return other and \
self.name == other.name and \
self.id == other.id and \
self.id_str == other.id_str and \
self.screen_name == other.screen_name and \
self.following == other.following and \
self.followed_by == other.followed_by
except AttributeError:
return False
def __str__(self):
"""A string representation of this twitter.UserStatus instance.
The return value is the same as the JSON string representation.
Returns:
A string representation of this twitter.UserStatus instance.
"""
return self.AsJsonString()
def AsJsonString(self):
"""A JSON string representation of this twitter.UserStatus instance.
Returns:
A JSON string representation of this twitter.UserStatus instance
"""
return simplejson.dumps(self.AsDict(), sort_keys=True)
def AsDict(self):
"""A dict representation of this twitter.UserStatus instance.
The return value uses the same key names as the JSON representation.
Return:
A dict representing this twitter.UserStatus instance
"""
data = {}
if self.name:
data['name'] = self.name
if self.id:
data['id'] = self.id
if self.id_str:
data['id_str'] = self.id_str
if self.screen_name:
data['screen_name'] = self.screen_name
if self.following:
data['following'] = self.following
if self.followed_by:
data['followed_by'] = self.followed_by
return data
@staticmethod
def NewFromJsonDict(data):
"""Create a new instance based on a JSON dict.
Args:
data: A JSON dict, as converted from the JSON in the twitter API
Returns:
A twitter.UserStatus instance
"""
following = None
followed_by = None
if 'connections' in data:
if 'following' in data['connections']:
following = True
if 'followed_by' in data['connections']:
followed_by = True
return UserStatus(name=data.get('name', None),
id=data.get('id', None),
id_str=data.get('id_str', None),
screen_name=data.get('screen_name', None),
following=following,
followed_by=followed_by)
class User(object):
"""A class representing the User structure used by the twitter API.
The User structure exposes the following properties:
user.id
user.name
user.screen_name
user.location
user.description
user.default_profile
user.default_profile_image
user.profile_image_url
user.profile_background_tile
user.profile_background_image_url
user.profile_banner_url
user.profile_sidebar_fill_color
user.profile_background_color
user.profile_link_color
user.profile_text_color
user.protected
user.utc_offset
user.time_zone
user.url
user.status
user.statuses_count
user.followers_count
user.friends_count
user.favourites_count
user.geo_enabled
user.verified
user.lang
user.notifications
user.contributors_enabled
user.created_at
user.listed_count
"""
def __init__(self, **kwargs):
param_defaults = {
'id': None,
'name': None,
'screen_name': None,
'location': None,
'description': None,
'default_profile': None,
'default_profile_image': None,
'profile_image_url': None,
'profile_background_tile': None,
'profile_background_image_url': None,
'profile_banner_url': None,
'profile_sidebar_fill_color': None,
'profile_background_color': None,
'profile_link_color': None,
'profile_text_color': None,
'protected': None,
'utc_offset': None,
'time_zone': None,
'followers_count': None,
'friends_count': None,
'statuses_count': None,
'favourites_count': None,
'url': None,
'status': None,
'geo_enabled': None,
'verified': None,
'lang': None,
'notifications': None,
'contributors_enabled': None,
'created_at': None,
'listed_count': None}
for (param, default) in param_defaults.items():
setattr(self, param, kwargs.get(param, default))
def GetId(self):
"""Get the unique id of this user.
Returns:
The unique id of this user
"""
return self._id
def SetId(self, id):
"""Set the unique id of this user.
Args:
id: The unique id of this user.
"""
self._id = id
id = property(GetId, SetId,
doc='The unique id of this user.')
def GetName(self):
"""Get the real name of this user.
Returns:
The real name of this user
"""
return self._name
def SetName(self, name):
"""Set the real name of this user.
Args:
name: The real name of this user
"""
self._name = name
name = property(GetName, SetName,
doc='The real name of this user.')
def GetScreenName(self):
"""Get the short twitter name of this user.
Returns:
The short twitter name of this user
"""
return self._screen_name
def SetScreenName(self, screen_name):
"""Set the short twitter name of this user.
Args:
screen_name: the short twitter name of this user
"""
self._screen_name = screen_name
screen_name = property(GetScreenName, SetScreenName,
doc='The short twitter name of this user.')
def GetLocation(self):
"""Get the geographic location of this user.
Returns:
The geographic location of this user
"""
return self._location
def SetLocation(self, location):
"""Set the geographic location of this user.
Args:
location: The geographic location of this user
"""
self._location = location
location = property(GetLocation, SetLocation,
doc='The geographic location of this user.')
def GetDescription(self):
"""Get the short text description of this user.
Returns:
The short text description of this user
"""
return self._description
def SetDescription(self, description):
"""Set the short text description of this user.
Args:
description: The short text description of this user
"""
self._description = description
description = property(GetDescription, SetDescription,
doc='The short text description of this user.')
def GetUrl(self):
"""Get the homepage url of this user.
Returns:
The homepage url of this user
"""
return self._url
def SetUrl(self, url):
"""Set the homepage url of this user.
Args:
url: The homepage url of this user
"""
self._url = url
url = property(GetUrl, SetUrl,
doc='The homepage url of this user.')
def GetProfileImageUrl(self):
"""Get the url of the thumbnail of this user.
Returns:
The url of the thumbnail of this user
"""
return self._profile_image_url
def SetProfileImageUrl(self, profile_image_url):
"""Set the url of the thumbnail of this user.
Args:
profile_image_url: The url of the thumbnail of this user
"""
self._profile_image_url = profile_image_url
profile_image_url = property(GetProfileImageUrl, SetProfileImageUrl,
doc='The url of the thumbnail of this user.')
def GetProfileBackgroundTile(self):
"""Boolean for whether to tile the profile background image.
Returns:
True if the background is to be tiled, False if not, None if unset.
"""
return self._profile_background_tile
def SetProfileBackgroundTile(self, profile_background_tile):
"""Set the boolean flag for whether to tile the profile background image.
Args:
profile_background_tile: Boolean flag for whether to tile or not.
"""
self._profile_background_tile = profile_background_tile
profile_background_tile = property(GetProfileBackgroundTile, SetProfileBackgroundTile,
doc='Boolean for whether to tile the background image.')
def GetProfileBackgroundImageUrl(self):
return self._profile_background_image_url
def SetProfileBackgroundImageUrl(self, profile_background_image_url):
self._profile_background_image_url = profile_background_image_url
profile_background_image_url = property(GetProfileBackgroundImageUrl, SetProfileBackgroundImageUrl,
doc='The url of the profile background of this user.')
def GetProfileBannerUrl(self):
return self._profile_banner_url
def SetProfileBannerUrl(self, profile_banner_url):
self._profile_banner_url = profile_banner_url
profile_banner_url = property(GetProfileBannerUrl, SetProfileBannerUrl,
doc='The url of the profile banner of this user.')
def GetProfileSidebarFillColor(self):
return self._profile_sidebar_fill_color
def SetProfileSidebarFillColor(self, profile_sidebar_fill_color):
self._profile_sidebar_fill_color = profile_sidebar_fill_color
profile_sidebar_fill_color = property(GetProfileSidebarFillColor, SetProfileSidebarFillColor)
def GetProfileBackgroundColor(self):
return self._profile_background_color
def SetProfileBackgroundColor(self, profile_background_color):
self._profile_background_color = profile_background_color
profile_background_color = property(GetProfileBackgroundColor, SetProfileBackgroundColor)
def GetProfileLinkColor(self):
return self._profile_link_color
def SetProfileLinkColor(self, profile_link_color):
self._profile_link_color = profile_link_color
profile_link_color = property(GetProfileLinkColor, SetProfileLinkColor)
def GetProfileTextColor(self):
return self._profile_text_color
def SetProfileTextColor(self, profile_text_color):
self._profile_text_color = profile_text_color
profile_text_color = property(GetProfileTextColor, SetProfileTextColor)
def GetProtected(self):
return self._protected
def SetProtected(self, protected):
self._protected = protected
protected = property(GetProtected, SetProtected)
def GetUtcOffset(self):
return self._utc_offset
def SetUtcOffset(self, utc_offset):
self._utc_offset = utc_offset
utc_offset = property(GetUtcOffset, SetUtcOffset)
def GetTimeZone(self):
"""Returns the current time zone string for the user.
Returns:
The descriptive time zone string for the user.
"""
return self._time_zone
def SetTimeZone(self, time_zone):
"""Sets the user's time zone string.
Args:
time_zone:
The descriptive time zone to assign for the user.
"""
self._time_zone = time_zone
time_zone = property(GetTimeZone, SetTimeZone)
def GetStatus(self):
"""Get the latest twitter.Status of this user.
Returns:
The latest twitter.Status of this user
"""
return self._status
def SetStatus(self, status):
"""Set the latest twitter.Status of this user.
Args:
status:
The latest twitter.Status of this user
"""
self._status = status
status = property(GetStatus, SetStatus,
doc='The latest twitter.Status of this user.')
def GetFriendsCount(self):
"""Get the friend count for this user.
Returns:
The number of users this user has befriended.
"""
return self._friends_count
def SetFriendsCount(self, count):
"""Set the friend count for this user.
Args:
count:
The number of users this user has befriended.
"""
self._friends_count = count
friends_count = property(GetFriendsCount, SetFriendsCount,
doc='The number of friends for this user.')
def GetListedCount(self):
"""Get the listed count for this user.
Returns:
The number of lists this user belongs to.
"""
return self._listed_count
def SetListedCount(self, count):
"""Set the listed count for this user.
Args:
count:
The number of lists this user belongs to.
"""
self._listed_count = count
listed_count = property(GetListedCount, SetListedCount,
doc='The number of lists this user belongs to.')
def GetFollowersCount(self):
"""Get the follower count for this user.
Returns:
The number of users following this user.
"""
return self._followers_count
def SetFollowersCount(self, count):
"""Set the follower count for this user.
Args:
count:
The number of users following this user.
"""
self._followers_count = count
followers_count = property(GetFollowersCount, SetFollowersCount,
doc='The number of users following this user.')
def GetStatusesCount(self):
"""Get the number of status updates for this user.
Returns:
The number of status updates for this user.
"""
return self._statuses_count
def SetStatusesCount(self, count):
"""Set the status update count for this user.
Args:
count:
The number of updates for this user.
"""
self._statuses_count = count
statuses_count = property(GetStatusesCount, SetStatusesCount,
doc='The number of updates for this user.')
def GetFavouritesCount(self):
"""Get the number of favourites for this user.
Returns:
The number of favourites for this user.
"""
return self._favourites_count
def SetFavouritesCount(self, count):
"""Set the favourite count for this user.
Args:
count:
The number of favourites for this user.
"""
self._favourites_count = count
favourites_count = property(GetFavouritesCount, SetFavouritesCount,
doc='The number of favourites for this user.')
def GetGeoEnabled(self):
"""Get the setting of geo_enabled for this user.
Returns:
True/False if Geo tagging is enabled
"""
return self._geo_enabled
def SetGeoEnabled(self, geo_enabled):
"""Set the latest twitter.geo_enabled of this user.
Args:
geo_enabled:
True/False if Geo tagging is to be enabled
"""
self._geo_enabled = geo_enabled
geo_enabled = property(GetGeoEnabled, SetGeoEnabled,
doc='The value of twitter.geo_enabled for this user.')
def GetVerified(self):
"""Get the setting of verified for this user.
Returns:
True/False if user is a verified account
"""
return self._verified
def SetVerified(self, verified):
"""Set twitter.verified for this user.
Args:
verified:
True/False if user is a verified account
"""
self._verified = verified
verified = property(GetVerified, SetVerified,
doc='The value of twitter.verified for this user.')
def GetLang(self):
"""Get the setting of lang for this user.
Returns:
language code of the user
"""
return self._lang
def SetLang(self, lang):
"""Set twitter.lang for this user.
Args:
lang:
language code for the user
"""
self._lang = lang
lang = property(GetLang, SetLang,
doc='The value of twitter.lang for this user.')
def GetNotifications(self):
"""Get the setting of notifications for this user.
Returns:
True/False for the notifications setting of the user
"""
return self._notifications
def SetNotifications(self, notifications):
"""Set twitter.notifications for this user.
Args:
notifications:
True/False notifications setting for the user
"""
self._notifications = notifications
notifications = property(GetNotifications, SetNotifications,
doc='The value of twitter.notifications for this user.')
def GetContributorsEnabled(self):
"""Get the setting of contributors_enabled for this user.
Returns:
True/False contributors_enabled of the user
"""
return self._contributors_enabled
def SetContributorsEnabled(self, contributors_enabled):
"""Set twitter.contributors_enabled for this user.
Args:
contributors_enabled:
True/False contributors_enabled setting for the user
"""
self._contributors_enabled = contributors_enabled
contributors_enabled = property(GetContributorsEnabled, SetContributorsEnabled,
doc='The value of twitter.contributors_enabled for this user.')
def GetCreatedAt(self):
"""Get the setting of created_at for this user.
Returns:
created_at value of the user
"""
return self._created_at
def SetCreatedAt(self, created_at):
"""Set twitter.created_at for this user.
Args:
created_at:
created_at value for the user
"""
self._created_at = created_at
created_at = property(GetCreatedAt, SetCreatedAt,
doc='The value of twitter.created_at for this user.')
def __ne__(self, other):
return not self.__eq__(other)
def __eq__(self, other):
try:
return other and \
self.id == other.id and \
self.name == other.name and \
self.screen_name == other.screen_name and \
self.location == other.location and \
self.description == other.description and \
self.default_profile == other.default_profile and \
self.default_profile_image == other.default_profile_image and \
self.profile_image_url == other.profile_image_url and \
self.profile_background_tile == other.profile_background_tile and \
self.profile_background_image_url == other.profile_background_image_url and \
self.profile_banner_url == other.profile_banner_url and \
self.profile_sidebar_fill_color == other.profile_sidebar_fill_color and \
self.profile_background_color == other.profile_background_color and \
self.profile_link_color == other.profile_link_color and \
self.profile_text_color == other.profile_text_color and \
self.protected == other.protected and \
self.utc_offset == other.utc_offset and \
self.time_zone == other.time_zone and \
self.url == other.url and \
self.statuses_count == other.statuses_count and \
self.followers_count == other.followers_count and \
self.favourites_count == other.favourites_count and \
self.friends_count == other.friends_count and \
self.status == other.status and \
self.geo_enabled == other.geo_enabled and \
self.verified == other.verified and \
self.lang == other.lang and \
self.notifications == other.notifications and \
self.contributors_enabled == other.contributors_enabled and \
self.created_at == other.created_at and \
self.listed_count == other.listed_count
except AttributeError:
return False
def __str__(self):
"""A string representation of this twitter.User instance.
The return value is the same as the JSON string representation.
Returns:
A string representation of this twitter.User instance.
"""
return self.AsJsonString()
def AsJsonString(self):
"""A JSON string representation of this twitter.User instance.
Returns:
A JSON string representation of this twitter.User instance
"""
return simplejson.dumps(self.AsDict(), sort_keys=True)
def AsDict(self):
"""A dict representation of this twitter.User instance.
The return value uses the same key names as the JSON representation.
Return:
A dict representing this twitter.User instance
"""
data = {}
if self.id:
data['id'] = self.id
if self.name:
data['name'] = self.name
if self.screen_name:
data['screen_name'] = self.screen_name
if self.location:
data['location'] = self.location
if self.description:
data['description'] = self.description
if self.default_profile:
data['default_profile'] = self.default_profile
if self.default_profile_image:
data['default_profile_image'] = self.default_profile_image
if self.profile_image_url:
data['profile_image_url'] = self.profile_image_url
if self.profile_background_tile is not None:
data['profile_background_tile'] = self.profile_background_tile
if self.profile_background_image_url:
data['profile_background_image_url'] = self.profile_background_image_url
if self.profile_banner_url:
data['profile_banner_url'] = self.profile_banner_url
if self.profile_sidebar_fill_color:
data['profile_sidebar_fill_color'] = self.profile_sidebar_fill_color
if self.profile_background_color:
data['profile_background_color'] = self.profile_background_color
if self.profile_link_color:
data['profile_link_color'] = self.profile_link_color
if self.profile_text_color:
data['profile_text_color'] = self.profile_text_color
if self.protected is not None:
data['protected'] = self.protected
if self.utc_offset:
data['utc_offset'] = self.utc_offset
if self.time_zone:
data['time_zone'] = self.time_zone
if self.url:
data['url'] = self.url
if self.status:
data['status'] = self.status.AsDict()
if self.friends_count:
data['friends_count'] = self.friends_count
if self.followers_count:
data['followers_count'] = self.followers_count
if self.statuses_count:
data['statuses_count'] = self.statuses_count
if self.favourites_count:
data['favourites_count'] = self.favourites_count
if self.geo_enabled:
data['geo_enabled'] = self.geo_enabled
if self.verified:
data['verified'] = self.verified
if self.lang:
data['lang'] = self.lang
if self.notifications:
data['notifications'] = self.notifications
if self.contributors_enabled:
data['contributors_enabled'] = self.contributors_enabled
if self.created_at:
data['created_at'] = self.created_at
if self.listed_count:
data['listed_count'] = self.listed_count
return data
@staticmethod
def NewFromJsonDict(data):
"""Create a new instance based on a JSON dict.
Args:
data:
A JSON dict, as converted from the JSON in the twitter API
Returns:
A twitter.User instance
"""
if 'status' in data:
from twitter import Status
# Have to do the import here to prevent cyclic imports in the __init__.py
# file
status = Status.NewFromJsonDict(data['status'])
else:
status = None
return User(id=data.get('id', None),
name=data.get('name', None),
screen_name=data.get('screen_name', None),
location=data.get('location', None),
description=data.get('description', None),
statuses_count=data.get('statuses_count', None),
followers_count=data.get('followers_count', None),
favourites_count=data.get('favourites_count', None),
default_profile=data.get('default_profile', None),
default_profile_image=data.get('default_profile_image', None),
friends_count=data.get('friends_count', None),
profile_image_url=data.get('profile_image_url_https', data.get('profile_image_url', None)),
profile_background_tile=data.get('profile_background_tile', None),
profile_background_image_url=data.get('profile_background_image_url', None),
profile_banner_url=data.get('profile_banner_url', None),
profile_sidebar_fill_color=data.get('profile_sidebar_fill_color', None),
profile_background_color=data.get('profile_background_color', None),
profile_link_color=data.get('profile_link_color', None),
profile_text_color=data.get('profile_text_color', None),
protected=data.get('protected', None),
utc_offset=data.get('utc_offset', None),
time_zone=data.get('time_zone', None),
url=data.get('url', None),
status=status,
geo_enabled=data.get('geo_enabled', None),
verified=data.get('verified', None),
lang=data.get('lang', None),
notifications=data.get('notifications', None),
contributors_enabled=data.get('contributors_enabled', None),
created_at=data.get('created_at', None),
listed_count=data.get('listed_count', None))