WebSocket events handling in Flask - Interactive Code Practice

Practice - 5 Tasks

1fill in blank

easy

Complete the code to import the Flask-SocketIO class.

Flask

from flask_socketio import [1]

Drag options to blanks, or click blank then click option'

AFlaskSocket

BFlaskIO

CSocket

DSocketIO

Attempts:

3 left

💡 Hint

Common Mistakes

Using 'FlaskSocket' instead of 'SocketIO'.

Trying to import from 'flask_socket' instead of 'flask_socketio'.

The SocketIO class is imported from flask_socketio to enable WebSocket support in Flask.

2fill in blank

medium

Complete the code to create a SocketIO instance with the Flask app.

Flask

socketio = [1](app)

Drag options to blanks, or click blank then click option'

ASocket

BSocketIO

CFlaskSocketIO

DFlaskSocket

Attempts:

3 left

💡 Hint

Common Mistakes

Using a class name that does not exist like 'Socket' or 'FlaskSocket'.

Forgetting to pass the Flask app instance.

The SocketIO instance wraps the Flask app to enable WebSocket event handling.

3fill in blank

hard

Fix the error in the event handler decorator to listen for 'message' events.

Flask

@socketio.on('[1]')
def handle_message(msg):
    print('Received:', msg)

Drag options to blanks, or click blank then click option'

Amessage

Bdisconnect

Cconnect

Dsend

Attempts:

3 left

💡 Hint

Common Mistakes

Using 'connect' or 'disconnect' which are for connection events, not messages.

Using 'send' which is a method, not an event name.

The event name for receiving messages is 'message'. Using this decorator listens for incoming messages.

4fill in blank

hard

Fill both blanks to emit a 'response' event with data back to the client.

Flask

socketio.[1]('[2]', {'data': 'Hello client!'})

Drag options to blanks, or click blank then click option'

Aemit

Bsend

Cresponse

Dmessage

Attempts:

3 left

💡 Hint

Common Mistakes

Using send instead of emit for custom events.

Using 'message' as event name instead of 'response'.

Use emit to send a custom event named 'response' with data to the client.

5fill in blank

hard

Fill all three blanks to define a handler for client connection and send a welcome message.

Flask

@socketio.on('[1]')
def [2]():
    socketio.[3]('welcome', {'msg': 'Welcome!'})

Drag options to blanks, or click blank then click option'

Aconnect

Bhandle_connect

Cemit

Dmessage

Attempts:

3 left

💡 Hint

Common Mistakes

Using 'message' instead of 'connect' for the decorator.

Naming the handler function incorrectly or forgetting it.

Using 'send' instead of 'emit' to send the welcome message.

The @socketio.on('connect') decorator listens for client connections. The handler function handle_connect sends a 'welcome' event using emit.

Practice

1. What does the decorator @socketio.on('message') do in a Flask app using WebSocket?

easy

A. It closes the WebSocket connection.

B. It sends a WebSocket message to all connected clients.

C. It listens for incoming WebSocket messages with the event name 'message'.

D. It initializes the Flask app.

Solution

1. Step 1: Understand the decorator role

   The @socketio.on('message') decorator registers a function to handle incoming WebSocket events named 'message'.

2. Step 2: Differentiate from other actions

   Sending messages or closing connections are done by other functions, not by this decorator.

3. Final Answer:

   It listens for incoming WebSocket messages with the event name 'message'. -> Option C

4. Quick Check:

   Decorator for event handling = C [OK]

Hint: Remember: @socketio.on listens, send() sends [OK]

Common Mistakes:

• Confusing event handler with sending messages
• Thinking it closes connections
• Assuming it initializes the app

2. Which of the following is the correct syntax to send a message back to the client inside a WebSocket event handler in Flask-SocketIO?

easy

A. socketio.send('Hello client!')

B. send('Hello client!')

C. emit('Hello client!')

D. socket.emit('Hello client!')

Solution

1. Step 1: Identify the correct function call

   In Flask-SocketIO, use the imported send() function inside handlers to reply to the sender client.

2. Step 2: Check syntax correctness

   A: send('Hello client!') correctly sends to sender. B: socketio.send() sends to all clients. C: emit('Hello client!') uses message as event name without data. D: socket undefined.

3. Final Answer:

   send('Hello client!') -> Option B

4. Quick Check:

   Use send() to reply to sender [OK]

Hint: send() replies to sender, socketio.send() to all [OK]

Common Mistakes:

• Using socketio.send() which sends to all clients
• Malformed emit() call without data
• Using undefined socket object

3. Given this Flask-SocketIO event handler code:

@socketio.on('chat')
def handle_chat(msg):
    print('Received:', msg)
    send('Echo: ' + msg)

What will be printed and sent if the client sends the message 'Hi'?

medium

A. Causes a runtime error because send() needs an event name.

B. Prints 'Echo: Hi' and sends 'Received: Hi' back to the client.

C. Prints nothing and sends 'Hi' back to the client.

D. Prints 'Received: Hi' and sends 'Echo: Hi' back to the client.

Solution

1. Step 1: Analyze the print statement

   The function prints 'Received: ' plus the message, so it prints 'Received: Hi'.

2. Step 2: Analyze the send() call

   The send() function sends the string 'Echo: ' plus the message back to the client, so it sends 'Echo: Hi'.

3. Final Answer:

   Prints 'Received: Hi' and sends 'Echo: Hi' back to the client. -> Option D

4. Quick Check:

   Print then send echo message = D [OK]

Hint: Print shows received, send echoes message [OK]

Common Mistakes:

• Mixing print output with sent message
• Assuming send() needs event name
• Confusing order of print and send

4. Identify the error in this Flask-SocketIO event handler:

@socketio.on('update')
def handle_update():
    data = request.json
    send(data)

medium

A. Using request.json inside WebSocket handler causes an error.

B. Missing event name in @socketio.on decorator.

C. send() cannot send JSON data.

D. Function must have a parameter to receive message data.

Solution

1. Step 1: Understand request context in WebSocket

   WebSocket handlers do not have HTTP request context, so request.json is not available and causes an error.

2. Step 2: Check other parts

   The decorator has event name, send() can send JSON, and function can have zero parameters if no message expected.

3. Final Answer:

   Using request.json inside WebSocket handler causes an error. -> Option A

4. Quick Check:

   request.json not available in WebSocket handlers [OK]

Hint: Don't use request.json in WebSocket handlers [OK]

Common Mistakes:

• Assuming HTTP request context exists in WebSocket
• Thinking send() can't send JSON
• Believing function must have parameters always

5. You want to broadcast a message to all connected clients except the sender in Flask-SocketIO. Which code snippet correctly does this inside an event handler?

hard

A. emit('broadcast', data, broadcast=true, include_self=false)

B. send(data, broadcast=true, include_self=true)

C. emit('broadcast', data, broadcast=true, include_self=true)

D. send(data, include_self=false)

Solution

1. Step 1: Understand broadcasting options

   To send to all except sender, use emit() with broadcast=true and include_self=false.

2. Step 2: Check each option

   B: send(data, broadcast=true, include_self=true) includes sender. C: emit('broadcast', data, broadcast=true, include_self=true) includes sender. D: send(data, include_self=false) lacks broadcast flag. A correctly excludes sender.

3. Final Answer:

   emit('broadcast', data, broadcast=true, include_self=false) -> Option A

4. Quick Check:

   Broadcast exclude sender = emit with include_self=false [OK]

Hint: Use emit with broadcast=true and include_self=false [OK]

Common Mistakes:

• Using send() incorrectly for targeted broadcast
• Setting include_self=true which includes sender
• Missing broadcast=true flag