add @socketio.event convenience decorator

example/app.py

@@ -32,22 +32,22 @@ def index():
     return render_template('index.html', async_mode=socketio.async_mode)
 
 
-@socketio.on('my_event')
-def test_message(message):
+@socketio.event
+def my_event(message):
     session['receive_count'] = session.get('receive_count', 0) + 1
     emit('my_response',
          {'data': message['data'], 'count': session['receive_count']})
 
 
-@socketio.on('my_broadcast_event')
-def test_broadcast_message(message):
+@socketio.event
+def my_broadcast_event(message):
     session['receive_count'] = session.get('receive_count', 0) + 1
     emit('my_response',
          {'data': message['data'], 'count': session['receive_count']},
          broadcast=True)
 
 
-@socketio.on('join')
+@socketio.event
 def join(message):
     join_room(message['room'])
     session['receive_count'] = session.get('receive_count', 0) + 1
@@ -56,7 +56,7 @@ def join(message):
           'count': session['receive_count']})
 
 
-@socketio.on('leave')
+@socketio.event
 def leave(message):
     leave_room(message['room'])
     session['receive_count'] = session.get('receive_count', 0) + 1
@@ -65,24 +65,24 @@ def leave(message):
           'count': session['receive_count']})
 
 
-@socketio.on('close_room')
-def close(message):
+@socketio.event
+def close_room(message):
     session['receive_count'] = session.get('receive_count', 0) + 1
     emit('my_response', {'data': 'Room ' + message['room'] + ' is closing.',
                          'count': session['receive_count']},
          room=message['room'])
     close_room(message['room'])
 
 
-@socketio.on('my_room_event')
-def send_room_message(message):
+@socketio.event
+def my_room_event(message):
     session['receive_count'] = session.get('receive_count', 0) + 1
     emit('my_response',
          {'data': message['data'], 'count': session['receive_count']},
          room=message['room'])
 
 
-@socketio.on('disconnect_request')
+@socketio.event
 def disconnect_request():
     @copy_current_request_context
     def can_disconnect():
@@ -97,13 +97,13 @@ def can_disconnect():
          callback=can_disconnect)
 
 
-@socketio.on('my_ping')
-def ping_pong():
+@socketio.event
+def my_ping():
     emit('my_pong')
 
 
-@socketio.on('connect')
-def test_connect():
+@socketio.event
+def connect():
     global thread
     with thread_lock:
         if thread is None:

flask_socketio/__init__.py

@@ -355,6 +355,41 @@ def on_foo_event(json):
         """
         self.on(message, namespace=namespace)(handler)
 
+    def event(self, *args, **kwargs):
+        """Decorator to register an event handler.
+
+        This is a simplified version of the ``on()`` method that takes the
+        event name from the decorated function.
+
+        Example usage::
+
+            @socketio.event
+            def my_event(data):
+                print('Received data: ', data)
+
+        The above example is equivalent to::
+
+            @socketio.on('my_event')
+            def my_event(data):
+                print('Received data: ', data)
+
+        A custom namespace can be given as an argument to the decorator::
+
+            @socketio.event(namespace='/test')
+            def my_event(data):
+                print('Received data: ', data)
+        """
+        if len(args) == 1 and len(kwargs) == 0 and callable(args[0]):
+            # the decorator was invoked without arguments
+            # args[0] is the decorated function
+            return self.on(args[0].__name__)(args[0])
+        else:
+            # the decorator was invoked with arguments
+            def set_handler(handler):
+                return self.on(handler.__name__, *args, **kwargs)(handler)
+
+            return set_handler
+
     def on_namespace(self, namespace_handler):
         if not isinstance(namespace_handler, Namespace):
             raise ValueError('Not a namespace instance.')

test_socketio.py

@@ -31,8 +31,8 @@ def on_disconnect():
     disconnected = '/'
 
 
-@socketio.on('connect', namespace='/test')
-def on_connect_test():
+@socketio.event(namespace='/test')
+def connect():
     send('connected-test')
     send(json.dumps(request.args.to_dict(flat=False)))
     send(json.dumps({h: request.headers[h] for h in request.headers.keys()
@@ -45,8 +45,8 @@ def on_disconnect_test():
     disconnected = '/test'
 
 
-@socketio.on('message')
-def on_message(message):
+@socketio.event
+def message(message):
     send(message)
     if message == 'test session':
         session['a'] = 'b'