Merge pull request #1 from bear/master

Pull origin repositories

Author: nxexox

AUTHORS.rst

@@ -21,6 +21,7 @@ Now it's a full-on open source project with many contributors over time:
 * Pradeep Nayak,
 * Ian Ozsvald,
 * Nicolas Perriault,
+* Trevor Prater,
 * Glen Tregoning,
 * Lars Weiler,
 * Sebastian Wiesinger,

CHANGES

@@ -6,6 +6,7 @@
   See the messy details at https://github.com/bear/python-twitter/pull/251
 
   Pull Requests
+      #525 Adds support for 280 character limit for tweets by trevorprater
       #267 initialize Api.__auth fixes #119 by rbpasker
       #266 Add full_text and page options in GetDirectMessages function by mistersalmon
       #264 Updates Media object with new methods, adds id param, adds tests by jeremylow
@@ -24,6 +25,9 @@
 
   Probably a whole lot that I missed - ugh!
 
+2017-11-11
+  Added support for 280 character limit
+
 2015-10-05
   Added who to api.GetSearch
 

doc/changelog.rst

@@ -1,5 +1,10 @@
 Changelog
 ---------
+Version 3.3.1
+=============
+
+* Adds support for 280 character limit.
+
 
 Version 3.3
 =============

doc/conf.py

@@ -57,9 +57,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '3.2'
+version = '3.3'
 # The full version, including alpha/beta/rc tags.
-release = '3.2.1'
+release = '3.3.1'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

examples/tweet.py

@@ -4,6 +4,8 @@
 
 __author__ = '[email protected]'
 
+from __future__ import print_function
+
 try:
     import configparser
 except ImportError as _:
@@ -15,6 +17,7 @@
 import twitter
 
 
+
 USAGE = '''Usage: tweet [options] message
 
   This script posts a message to Twitter.
@@ -52,7 +55,7 @@
 
 
 def PrintUsageAndExit():
-    print USAGE
+    print(USAGE)
     sys.exit(2)
 
 
@@ -143,11 +146,11 @@ def main():
     try:
         status = api.PostUpdate(message)
     except UnicodeDecodeError:
-        print "Your message could not be encoded.  Perhaps it contains non-ASCII characters? "
-        print "Try explicitly specifying the encoding with the --encoding flag"
+        print("Your message could not be encoded.  Perhaps it contains non-ASCII characters? ")
+        print("Try explicitly specifying the encoding with the --encoding flag")
         sys.exit(2)
-    print "%s just posted: %s" % (status.user.name, status.text)
 
+    print("{0} just posted: {1}".format(status.user.name, status.text))
 
 if __name__ == "__main__":
     main()

tests/test_models.py

@@ -190,3 +190,7 @@ def test_user_status(self):
             self.fail(e)
         self.assertTrue(user_status.AsJsonString())
         self.assertTrue(user_status.AsDict())
+
+        self.assertTrue(user_status.connections['blocking'])
+        self.assertTrue(user_status.connections['muting'])
+        self.assertFalse(user_status.connections['followed_by'])

tests/test_tweet_length.py

@@ -63,15 +63,12 @@ def test_split_tweets(self):
         tweets = self.api._TweetTextWrap(test_tweet)
         self.assertEqual(
             tweets[0],
-            "Anatole went out of the room and returned a few minutes later wearing a fur coat girt with a silver belt, and a sable cap jauntily set on")
+            "Anatole went out of the room and returned a few minutes later wearing a fur coat girt with a silver belt, and a sable cap jauntily set on one side and very becoming to his handsome face. Having looked in a mirror, and standing before Dolokhov in the same pose he had assumed")
         self.assertEqual(
             tweets[1],
-            "one side and very becoming to his handsome face. Having looked in a mirror, and standing before Dolokhov in the same pose he had assumed")
-        self.assertEqual(
-            tweets[2],
             "before it, he lifted a glass of wine.")
 
-        test_tweet = "t.co went t.co of t.co room t.co returned t.co few minutes later"
+        test_tweet = "t.co went t.co of t.co room t.co returned t.co few minutes later and then t.co went to t.co restroom and t.co was sad because t.co did not have any t.co toilet paper"
         tweets = self.api._TweetTextWrap(test_tweet)
-        self.assertEqual(tweets[0], 't.co went t.co of t.co room t.co returned')
-        self.assertEqual(tweets[1], 't.co few minutes later')
+        self.assertEqual(tweets[0], 't.co went t.co of t.co room t.co returned t.co few minutes later and then t.co went to t.co restroom and t.co was sad because')
+        self.assertEqual(tweets[1], 't.co did not have any t.co toilet paper')

twitter/__init__.py

@@ -23,7 +23,7 @@
 __email__        = '[email protected]'
 __copyright__    = 'Copyright (c) 2007-2016 The Python-Twitter Developers'
 __license__      = 'Apache License 2.0'
-__version__      = '3.3'
+__version__      = '3.3.1'
 __url__          = 'https://github.com/bear/python-twitter'
 __download_url__ = 'https://pypi.python.org/pypi/python-twitter'
 __description__  = 'A Python wrapper around the Twitter API'

twitter/api.py

@@ -72,7 +72,7 @@
 if sys.version_info > (3,):
     long = int
 
-CHARACTER_LIMIT = 140
+CHARACTER_LIMIT = 280
 
 # A singleton representing a lazily instantiated FileCache.
 DEFAULT_CACHE = object()
@@ -229,6 +229,8 @@ def __init__(self,
         self._use_gzip = use_gzip_compression
         self._debugHTTP = debugHTTP
         self._shortlink_size = 19
+        if timeout and timeout < 30:
+            warn("Warning: The Twitter streaming API sends 30s keepalives, the given timeout is shorter!")
         self._timeout = timeout
         self.__auth = None
 
@@ -274,9 +276,12 @@ def __init__(self,
 
         if debugHTTP:
             import logging
-            import http.client
+            try:
+                import http.client as http_client  # python3
+            except ImportError:
+                import httplib as http_client  # python2
 
-            http.client.HTTPConnection.debuglevel = 1
+            http_client.HTTPConnection.debuglevel = 1
 
             logging.basicConfig()  # you need to initialize logging, otherwise you will not see anything from requests
             logging.getLogger().setLevel(logging.DEBUG)
@@ -976,8 +981,8 @@ def PostUpdate(self,
 
         Args:
             status (str):
-                The message text to be posted. Must be less than or equal to 140
-                characters.
+                The message text to be posted. Must be less than or equal to
+                CHARACTER_LIMIT characters.
             media (int, str, fp, optional):
                 A URL, a local file, or a file-like object (something with a
                 read() method), or a list of any combination of the above.
@@ -1029,8 +1034,8 @@ def PostUpdate(self,
                 otherwise the payload will contain the full user data item.
             verify_status_length (bool, optional):
                 If True, api throws a hard error that the status is over
-                140 characters. If False, Api will attempt to post the
-                status.
+                CHARACTER_LIMIT characters. If False, Api will attempt to post
+                the status.
         Returns:
             (twitter.Status) A twitter.Status instance representing the
             message posted.
@@ -1042,8 +1047,8 @@ def PostUpdate(self,
         else:
             u_status = str(status, self._input_encoding)
 
-        if verify_status_length and calc_expected_status_length(u_status) > 140:
-            raise TwitterError("Text must be less than or equal to 140 characters.")
+        if verify_status_length and calc_expected_status_length(u_status) > CHARACTER_LIMIT:
+            raise TwitterError("Text must be less than or equal to CHARACTER_LIMIT characters.")
 
         if auto_populate_reply_metadata and not in_reply_to_status_id:
             raise TwitterError("If auto_populate_reply_metadata is True, you must set in_reply_to_status_id")
@@ -1514,7 +1519,7 @@ def PostMultipleMedia(self, status, media, possibly_sensitive=None,
 
     def _TweetTextWrap(self,
                        status,
-                       char_lim=140):
+                       char_lim=CHARACTER_LIMIT):
 
         if not self._config:
             self.GetHelpConfiguration()
@@ -1525,7 +1530,7 @@ def _TweetTextWrap(self,
         words = re.split(r'\s', status)
 
         if len(words) == 1 and not is_url(words[0]):
-            if len(words[0]) > 140:
+            if len(words[0]) > CHARACTER_LIMIT:
                 raise TwitterError({"message": "Unable to split status into tweetable parts. Word was: {0}/{1}".format(len(words[0]), char_lim)})
             else:
                 tweets.append(words[0])
@@ -1541,7 +1546,7 @@ def _TweetTextWrap(self,
             else:
                 new_len += len(word) + 1
 
-            if new_len > 140:
+            if new_len > CHARACTER_LIMIT:
                 tweets.append(' '.join(line))
                 line = [word]
                 line_length = new_len - line_length
@@ -1559,12 +1564,12 @@ def PostUpdates(self,
         """Post one or more twitter status messages from the authenticated user.
 
         Unlike api.PostUpdate, this method will post multiple status updates
-        if the message is longer than 140 characters.
+        if the message is longer than CHARACTER_LIMIT characters.
 
         Args:
           status:
             The message text to be posted.
-            May be longer than 140 characters.
+            May be longer than CHARACTER_LIMIT characters.
           continuation:
             The character string, if any, to be appended to all but the
             last message.  Note that Twitter strips trailing '...' strings
@@ -2978,7 +2983,7 @@ def GetDirectMessages(self,
             objects. [Optional]
           full_text:
             When set to True full message will be included in the returned message
-            object if message length is bigger than 140 characters. [Optional]
+            object if message length is bigger than CHARACTER_LIMIT characters. [Optional]
           page:
             If you want more than 200 messages, you can use this and get 20 messages
             each time. You must recall it and increment the page value until it
@@ -4692,7 +4697,9 @@ def GetUserStream(self,
                       delimited=None,
                       stall_warnings=None,
                       stringify_friend_ids=False,
-                      filter_level=None):
+                      filter_level=None,
+                      session=None,
+                      include_keepalive=False):
         """Returns the data from the user stream.
 
         Args:
@@ -4740,11 +4747,20 @@ def GetUserStream(self,
         if filter_level is not None:
             data['filter_level'] = filter_level
 
-        resp = self._RequestStream(url, 'POST', data=data)
+        resp = self._RequestStream(url, 'POST', data=data, session=session)
+        # The Twitter streaming API sends keep-alive newlines every 30s if there has not been other
+        # traffic, and specifies that streams should only be reset after three keep-alive ticks.
+        #
+        # The original implementation of this API didn't expose keep-alive signals to the user,
+        # making it difficult to determine whether the connection should be hung up or not.
+        #
+        # https://dev.twitter.com/streaming/overview/connecting
         for line in resp.iter_lines():
             if line:
                 data = self._ParseAndCheckTwitter(line.decode('utf-8'))
                 yield data
+            elif include_keepalive:
+              yield None
 
     def VerifyCredentials(self, include_entities=None, skip_status=None, include_email=None):
         """Returns a twitter.User instance if the authenticating user is valid.
@@ -5073,7 +5089,7 @@ def _RequestUrl(self, url, verb, data=None, json=None, enforce_auth=True):
 
         return resp
 
-    def _RequestStream(self, url, verb, data=None):
+    def _RequestStream(self, url, verb, data=None, session=None):
         """Request a stream of data.
 
            Args:
@@ -5087,19 +5103,21 @@ def _RequestStream(self, url, verb, data=None):
            Returns:
              A twitter stream.
         """
+        session = session or requests.Session()
+
         if verb == 'POST':
             try:
-                return requests.post(url, data=data, stream=True,
-                                     auth=self.__auth,
-                                     timeout=self._timeout,
-                                     proxies=self.proxies)
+                return session.post(url, data=data, stream=True,
+                                    auth=self.__auth,
+                                    timeout=self._timeout,
+                                    proxies=self.proxies)
             except requests.RequestException as e:
                 raise TwitterError(str(e))
         if verb == 'GET':
             url = self._BuildUrl(url, extra_params=data)
             try:
-                return requests.get(url, stream=True, auth=self.__auth,
-                                    timeout=self._timeout, proxies=self.proxies)
+                return session.get(url, stream=True, auth=self.__auth,
+                                   timeout=self._timeout, proxies=self.proxies)
             except requests.RequestException as e:
                 raise TwitterError(str(e))
         return 0  # if not a POST or GET request

twitter/models.py

@@ -282,12 +282,12 @@ class UserStatus(TwitterModel):
     """ A class representing the UserStatus structure. This is an abbreviated
     form of the twitter.User object. """
 
-    connections = {'following': False,
-                   'followed_by': False,
-                   'following_received': False,
-                   'following_requested': False,
-                   'blocking': False,
-                   'muting': False}
+    _connections = {'following': False,
+                    'followed_by': False,
+                    'following_received': False,
+                    'following_requested': False,
+                    'blocking': False,
+                    'muting': False}
 
     def __init__(self, **kwargs):
         self.param_defaults = {
@@ -307,10 +307,19 @@ def __init__(self, **kwargs):
             setattr(self, param, kwargs.get(param, default))
 
         if 'connections' in kwargs:
-            for param in self.connections:
+            for param in self._connections:
                 if param in kwargs['connections']:
                     setattr(self, param, True)
 
+    @property
+    def connections(self):
+        return {'following': self.following,
+                'followed_by': self.followed_by,
+                'following_received': self.following_received,
+                'following_requested': self.following_requested,
+                'blocking': self.blocking,
+                'muting': self.muting}
+
     def __repr__(self):
         connections = [param for param in self.connections if getattr(self, param)]
         return "UserStatus(ID={uid}, ScreenName={sn}, Connections=[{conn}])".format(
@@ -337,19 +346,24 @@ def __init__(self, **kwargs):
             'friends_count': None,
             'geo_enabled': None,
             'id': None,
+            'id_str': None,
             'lang': None,
             'listed_count': None,
             'location': None,
             'name': None,
             'notifications': None,
             'profile_background_color': None,
             'profile_background_image_url': None,
+            'profile_background_image_url_https': None,
             'profile_background_tile': None,
             'profile_banner_url': None,
             'profile_image_url': None,
+            'profile_image_url_https': None,
             'profile_link_color': None,
+            'profile_sidebar_border_color': None,
             'profile_sidebar_fill_color': None,
             'profile_text_color': None,
+            'profile_use_background_image': None,
             'protected': None,
             'screen_name': None,
             'status': None,
@@ -358,6 +372,8 @@ def __init__(self, **kwargs):
             'url': None,
             'utc_offset': None,
             'verified': None,
+            'withheld_in_countries': None,
+            'withheld_scope': None,
         }
 
         for (param, default) in self.param_defaults.items():