1 files changed, 24 insertions, 35 deletions

diff --git a/mastodon/Mastodon.py b/mastodon/Mastodon.py
index d2d634e..88f4906 100644
--- a/mastodon/Mastodon.py
+++ b/mastodon/Mastodon.py
@@ -17,10 +17,11 @@ import re
 import copy
 import threading
 import sys
+
 try:
     from urllib.parse import urlparse
 except ImportError:
-     from urlparse import urlparse
+    from urlparse import urlparse
 
 
 class Mastodon:
@@ -1009,57 +1010,34 @@ class Mastodon:
     ###
     # Streaming
     ###
-    def user_stream(self, listener, async=False):
+    def stream_user(self, listener, async=False):
         """
         Streams events that are relevant to the authorized user, i.e. home
         timeline and notifications. 'listener' should be a subclass of
         StreamListener which will receive callbacks for incoming events.
-
-        If async is False, this method blocks forever.
-
-        If async is True, 'listener' will listen on another thread and this method
-        will return a handle corresponding to the open connection. The
-        connection may be closed at any time by calling its close() method.
         """
         return self.__stream('/api/v1/streaming/user', listener, async=async)
 
-    def public_stream(self, listener, async=False):
+    def stream_public(self, listener, async=False):
         """
         Streams public events. 'listener' should be a subclass of StreamListener
         which will receive callbacks for incoming events.
-
-        If async is False, this method blocks forever.
-
-        If async is True, 'listener' will listen on another thread and this method
-        will return a handle corresponding to the open connection. The
-        connection may be closed at any time by calling its close() method.
         """
         return self.__stream('/api/v1/streaming/public', listener, async=async)
 
-    def local_stream(self, listener, async=False):
+    def stream_local(self, listener, async=False):
         """
         Streams local events. 'listener' should be a subclass of StreamListener
         which will receive callbacks for incoming events.
 
-        If async is False, this method blocks forever.
-
-        If async is True, 'listener' will listen on another thread and this method
-        will return a handle corresponding to the open connection. The
-        connection may be closed at any time by calling its close() method.
         """
         return self.__stream('/api/v1/streaming/public/local', listener, async=async)
 
-    def hashtag_stream(self, tag, listener, async=False):
+    def stream_hashtag(self, tag, listener, async=False):
         """
         Returns all public statuses for the hashtag 'tag'. 'listener' should be
         a subclass of StreamListener which will receive callbacks for incoming
         events.
-
-        If async is False, this method blocks forever.
-
-        If async is True, 'listener' will listen on another thread and this method
-        will return a handle corresponding to the open connection. The
-        connection may be closed at any time by calling its close() method.
         """
         return self.__stream("/api/v1/streaming/hashtag?tag={}".format(tag), listener)
 
@@ -1083,8 +1061,8 @@ class Mastodon:
 
         return (date_time_utc - epoch_utc).total_seconds()
 
-
-    def __json_date_parse(self, json_object):
+    @staticmethod
+    def __json_date_parse(json_object):
         """
         Parse dates in certain known json fields, if possible.
         """
@@ -1100,7 +1078,8 @@ class Mastodon:
                     raise MastodonAPIError('Encountered invalid date.')
         return json_object
 
-    def __json_id_to_bignum(self, json_object):
+    @staticmethod
+    def __json_id_to_bignum(json_object):
         """
         Converts json string IDs to native python bignums.
         """
@@ -1117,10 +1096,11 @@ class Mastodon:
                 pass
 
         return json_object
-
-    def __json_hooks(self, json_object):
-        json_object = self.__json_date_parse(json_object)
-        json_object = self.__json_id_to_bignum(json_object)
+    
+    @staticmethod
+    def __json_hooks(json_object):
+        json_object = Mastodon.__json_date_parse(json_object)
+        json_object = Mastodon.__json_id_to_bignum(json_object)
         return json_object
 
     def __api_request(self, method, endpoint, params={}, files={}, do_ratelimiting=True):
@@ -1424,6 +1404,7 @@ class MastodonError(Exception):
 
 
 class MastodonIllegalArgumentError(ValueError, MastodonError):
+    """Raised when an incorrect parameter is passed to a function"""
     pass
 
 
@@ -1432,16 +1413,24 @@ class MastodonIOError(IOError, MastodonError):
 
 
 class MastodonFileNotFoundError(MastodonIOError):
+    """Raised when a file requested to be loaded can not be opened"""
     pass
 
 
 class MastodonNetworkError(MastodonIOError):
+    """Raised when network communication with the server fails"""
     pass
 
 
 class MastodonAPIError(MastodonError):
+    """Raised when the mastodon API generates a response that cannot be handled"""
     pass
 
 
 class MastodonRatelimitError(MastodonError):
+    """Raised when rate limiting is set to manual mode and the rate limit is exceeded"""
+    pass
+
+class MastodonMalformedEventError(MastodonError):
+    """Raised when the server-sent event stream is malformed"""
     pass