moved client function docstrings from pusher.py to *_client.py

Author: callum-oakley

pusher/http.py

@@ -6,6 +6,7 @@
     absolute_import,
     division)
 
+from pusher.util import doc_string
 from pusher.errors import *
 from pusher.signature import sign
 from pusher.version import VERSION
@@ -34,14 +35,6 @@ def make_request(self, *args, **kwargs):
         return self.f(self.client, *args, **kwargs)
 
 
-def doc_string(doc):
-    def decorator(f):
-        f.__doc__ = doc
-        return f
-
-    return decorator
-
-
 def request_method(f):
     @property
     @doc_string(f.__doc__)

pusher/notification_client.py

@@ -37,6 +37,10 @@ def __init__(
 
     @request_method
     def notify(self, interests, notification):
+        """Send push notifications, see:
+
+        https://github.com/pusher/pusher-http-python#push-notifications-beta
+        """
         if not isinstance(interests, list) and not isinstance(interests, set):
             raise TypeError("Interests must be a list or a set")
 

pusher/pusher.py

@@ -11,7 +11,8 @@
     validate_channel,
     validate_socket_id,
     pusher_url_re,
-    channel_name_re)
+    channel_name_re,
+    doc_string)
 
 from pusher.signature import sign, verify
 from pusher.pusher_client import PusherClient
@@ -110,52 +111,32 @@ def from_env(cls, env='PUSHER_URL', **options):
         return cls.from_url(val, **options)
 
 
+    @doc_string(PusherClient.trigger.__doc__)
     def trigger(self, channels, event_name, data, socket_id=None):
-        '''
-        Trigger an event on one or more channels, see:
-
-        http://pusher.com/docs/rest_api#method-post-event
-        '''
         return self._pusher_client.trigger(
             channels, event_name, data, socket_id)
 
 
+    @doc_string(PusherClient.trigger_batch.__doc__)
     def trigger_batch(self, batch=[], already_encoded=False):
-        '''
-        Trigger multiple events with a single HTTP call.
-
-        http://pusher.com/docs/rest_api#method-post-batch-events
-        '''
         return self._pusher_client.trigger_batch(batch, already_encoded)
 
-
+    @doc_string(PusherClient.channels_info.__doc__)
     def channels_info(self, prefix_filter=None, attributes=[]):
-        '''
-        Get information on multiple channels, see:
-
-        http://pusher.com/docs/rest_api#method-get-channels
-        '''
         return self._pusher_client.channels_info(prefix_filter, attributes)
 
 
+    @doc_string(PusherClient.channel_info.__doc__)
     def channel_info(self, channel, attributes=[]):
-        '''
-        Get information on a specific channel, see:
-
-        http://pusher.com/docs/rest_api#method-get-channel
-        '''
         return self._pusher_client.channel_info(channel, attributes)
 
 
+    @doc_string(PusherClient.users_info.__doc__)
     def users_info(self, channel):
-        '''
-        Fetch user ids currently subscribed to a presence channel
-
-        http://pusher.com/docs/rest_api#method-get-users
-        '''
         return self._pusher_client.users_info(channel)
 
 
+    @doc_string(NotificationClient.notify.__doc__)
     def notify(self, interest, notification):
         return self._notification_client.notify(interest, notification)
 

pusher/pusher_client.py

@@ -48,6 +48,10 @@ def __init__(
 
     @request_method
     def trigger(self, channels, event_name, data, socket_id=None):
+        """Trigger an event on one or more channels, see:
+
+        http://pusher.com/docs/rest_api#method-post-event
+        """
         if isinstance(channels, six.string_types):
             channels = [channels]
 
@@ -83,12 +87,10 @@ def trigger(self, channels, event_name, data, socket_id=None):
 
     @request_method
     def trigger_batch(self, batch=[], already_encoded=False):
-        '''
-        Trigger multiple events with a single HTTP call.
+        """Trigger multiple events with a single HTTP call.
 
         http://pusher.com/docs/rest_api#method-post-batch-events
-        '''
-
+        """
         if not already_encoded:
             for event in batch:
                 event['data'] = data_to_string(event['data'],
@@ -103,11 +105,10 @@ def trigger_batch(self, batch=[], already_encoded=False):
 
     @request_method
     def channels_info(self, prefix_filter=None, attributes=[]):
-        '''
-        Get information on multiple channels, see:
+        """Get information on multiple channels, see:
 
         http://pusher.com/docs/rest_api#method-get-channels
-        '''
+        """
         params = {}
         if attributes:
             params['info'] = join_attributes(attributes)
@@ -122,11 +123,10 @@ def channels_info(self, prefix_filter=None, attributes=[]):
 
     @request_method
     def channel_info(self, channel, attributes=[]):
-        '''
-        Get information on a specific channel, see:
+        """Get information on a specific channel, see:
 
         http://pusher.com/docs/rest_api#method-get-channel
-        '''
+        """
         validate_channel(channel)
 
         params = {}
@@ -139,11 +139,10 @@ def channel_info(self, channel, attributes=[]):
 
     @request_method
     def users_info(self, channel):
-        '''
-        Fetch user ids currently subscribed to a presence channel
+        """Fetch user ids currently subscribed to a presence channel
 
         http://pusher.com/docs/rest_api#method-get-users
-        '''
+        """
         validate_channel(channel)
 
         return Request(

pusher/util.py

@@ -64,3 +64,11 @@ def data_to_string(data, json_encoder):
 
     else:
         return json.dumps(data, cls=json_encoder)
+
+
+def doc_string(doc):
+    def decorator(f):
+        f.__doc__ = doc
+        return f
+
+    return decorator