Added a class for media types that come back in the tweet stream. Updated api to use these

d2dcrc-wdp · d2dcrc-wdp · commit 4050a065e945 · 2015-11-10T13:50:45.000+10:30
diff --git a/twitter/__init__.py b/twitter/__init__.py
@@ -38,5 +38,6 @@
 from .status import Status
 from .user import User, UserStatus
 from .category import Category
+from .media import Media
 from .list import List
 from .api import Api
diff --git a/twitter/api.py b/twitter/api.py
@@ -592,7 +592,6 @@ def GetHomeTimeline(self,
             parameters['include_entities'] = 'false'
         json_data = self._RequestUrl(url, 'GET', data=parameters)
         data = self._ParseAndCheckTwitter(json_data.content)
-
         return [Status.NewFromJsonDict(x) for x in data]
 
     def GetUserTimeline(self,
diff --git a/twitter/media.py b/twitter/media.py
@@ -0,0 +1,75 @@
+#!/usr/bin/env python
+
+
+class Media(object):
+    """A class representing the Media component of a tweet.
+
+    The Media structure exposes the following properties:
+
+      media.expanded_url
+      media.display_url
+      media.url
+      media.media_url_https
+      media.media_url
+      media.type
+    """
+
+    def __init__(self, **kwargs):
+        """An object to the information for each Media entity for a tweet
+        This class is normally instantiated by the twitter.Api class and
+        returned in a sequence.
+        """
+        param_defaults = {
+            'expanded_url': None,
+            'display_url': None,
+            'url': None,
+            'media_url_https': None,
+            'media_url': None,
+            'type': None,
+        }
+
+        for (param, default) in param_defaults.iteritems():
+            setattr(self, param, kwargs.get(param, default))
+
+    @property
+    def Expanded_url(self):
+        return self.expanded_url or False
+
+    @property
+    def Url(self):
+        return self.url or False
+
+    @property
+    def Media_url_https(self):
+        return self.media_url_https or False
+
+    @property
+    def Media_url(self):
+        return self.media_url or False
+
+    @property
+    def Type(self):
+        return self.type or False
+
+    def __eq__(self, other):
+        return other.Media_url == self.Media_url and other.Type == self.Type
+
+    def __hash__(self):
+        return hash((self.Media_url, self.Type))
+
+    @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.Category instance
+        """
+        return Media(expanded_url=data.get('expanded_url', None),
+                     display_url=data.get('display_url', None),
+                     url=data.get('url', None),
+                     media_url_https=data.get('media_url_https', None),
+                     media_url=data.get('media_url', None),
+                     type=data.get('type', None),
+                     )
diff --git a/twitter/status.py b/twitter/status.py
@@ -3,8 +3,10 @@
 from calendar import timegm
 import rfc822
 import time
+from sets import Set
 
 from twitter import json, Hashtag, TwitterError, Url
+from twitter.media import Media
 
 
 class Status(object):
@@ -118,7 +120,8 @@ def __init__(self, **kwargs):
             'media': None,
             'withheld_copyright': None,
             'withheld_in_countries': None,
-            'withheld_scope': None}
+            'withheld_scope': None,
+        }
 
         for (param, default) in param_defaults.iteritems():
             setattr(self, param, kwargs.get(param, default))
@@ -400,19 +403,19 @@ def __str__(self):
         return self.AsJsonString()
 
     def __repr__(self):
-      """A string representation of this twitter.Status instance.
+        """A string representation of this twitter.Status instance.
       The return value is the ID of status, username and datetime.
       Returns:
         A string representation of this twitter.Status instance with 
         the ID of status, username and datetime.
       """
-      if self.user:
-        representation = "Status(ID=%s, screen_name='%s', created_at='%s')" % (
-        self.id, self.user.screen_name, self.created_at)
-      else:
-        representation = "Status(ID=%s,  created_at='%s')" % (
-        self.id, self.created_at)
-      return representation
+        if self.user:
+            representation = "Status(ID=%s, screen_name='%s', created_at='%s')" % (
+                self.id, self.user.screen_name, self.created_at)
+        else:
+            representation = "Status(ID=%s,  created_at='%s')" % (
+                self.id, self.created_at)
+        return representation
 
     def AsJsonString(self, allow_non_ascii=False):
         """A JSON string representation of this twitter.Status instance.
@@ -525,7 +528,7 @@ def NewFromJsonDict(data):
         urls = None
         user_mentions = None
         hashtags = None
-        media = None
+        media = Set()
         if 'entities' in data:
             if 'urls' in data['entities']:
                 urls = [Url.NewFromJsonDict(u) for u in data['entities']['urls']]
@@ -536,14 +539,14 @@ def NewFromJsonDict(data):
             if 'hashtags' in data['entities']:
                 hashtags = [Hashtag.NewFromJsonDict(h) for h in data['entities']['hashtags']]
             if 'media' in data['entities']:
-                media = data['entities']['media']
-            else:
-                media = []
+                for m in data['entities']['media']:
+                    media.add(Media.NewFromJsonDict(m))
 
         # the new extended entities
         if 'extended_entities' in data:
             if 'media' in data['extended_entities']:
-                media = [m for m in data['extended_entities']['media']]
+                for m in data['extended_entities']['media']:
+                    media.add(Media.NewFromJsonDict(m))
 
         return Status(created_at=data.get('created_at', None),
                       favorited=data.get('favorited', None),
@@ -574,4 +577,5 @@ def NewFromJsonDict(data):
                       scopes=data.get('scopes', None),
                       withheld_copyright=data.get('withheld_copyright', None),
                       withheld_in_countries=data.get('withheld_in_countries', None),
-                      withheld_scope=data.get('withheld_scope', None))
+                      withheld_scope=data.get('withheld_scope', None),
+                      )
