Room-based messaging in Flask - Interactive Code Practice

Practice - 5 Tasks

1fill in blank

easy

Complete the code to import the Flask-SocketIO extension.

Flask

from flask_socketio import [1]

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

ASocket

BSocketIO

CFlaskSocket

DFlaskIO

Attempts:

3 left

💡 Hint

Common Mistakes

Using incorrect class names like FlaskSocket or FlaskIO.

Trying to import from the wrong module.

The Flask-SocketIO extension is imported using SocketIO.

2fill in blank

medium

Complete the code to initialize SocketIO with the Flask app.

Flask

app = Flask(__name__)
socketio = [1](app)

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

ASocketIO

BSocket

CFlaskSocketIO

DSocketApp

Attempts:

3 left

💡 Hint

Common Mistakes

Using incorrect class names like Socket or SocketApp.

Not passing the Flask app instance.

We initialize SocketIO by calling SocketIO(app) to bind it to the Flask app.

3fill in blank

hard

Fix the error in the event handler to join a room.

Flask

@socketio.on('join')
def on_join(data):
    username = data['username']
    room = data['room']
    [1](room)
    send(f"{username} has entered the room.", room=room)

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

Ajoinroom()

BjoinRoom

Cjoinroom

Djoin_room

Attempts:

3 left

💡 Hint

Common Mistakes

Using camelCase or incorrect casing like joinRoom.

Calling a non-existent function joinroom.

The correct function to join a room is join_room(room) from Flask-SocketIO.

4fill in blank

hard

Fill both blanks to send a message to a specific room and leave it.

Flask

@socketio.on('leave')
def on_leave(data):
    username = data['username']
    room = data['room']
    send(f"{username} has left the room.", [1]=room)
    [2](room)

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

Aroom

Bleave_room

Cbroadcast

Dsend_room

Attempts:

3 left

💡 Hint

Common Mistakes

Using incorrect keyword arguments like broadcast instead of room.

Calling a non-existent function like send_room.

To send a message to a room, use send(..., room=room). To leave a room, call leave_room(room).

5fill in blank

hard

Fill all three blanks to emit a message event to a room with JSON data.

Flask

@socketio.on('message')
def handle_message(data):
    room = data['room']
    message = data['msg']
    [1]('new_message', {'msg': message}, [2]=room, [3]=False)

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

Aemit

Broom

Cbroadcast

Dsend

Attempts:

3 left

💡 Hint

Common Mistakes

Using send instead of emit for custom events.

Setting broadcast to True which sends to all clients.

Use emit to send an event. Specify the room keyword to target the room, and broadcast=False to avoid sending to all clients.

Practice

1. What is the main purpose of using rooms in Flask-SocketIO for messaging?

easy

A. To group users so messages can be sent privately to that group

B. To store user passwords securely

C. To create database tables automatically

D. To handle HTTP requests faster

Solution

1. Step 1: Understand the concept of rooms in Flask-SocketIO

   Rooms are used to group users together for messaging purposes.

2. Step 2: Identify the purpose of grouping users

   Grouping users allows sending messages privately to only those in the same room.

3. Final Answer:

   To group users so messages can be sent privately to that group -> Option A

4. Quick Check:

   Rooms = private user groups [OK]

Hint: Rooms group users for private chats [OK]

Common Mistakes:

• Thinking rooms store passwords
• Confusing rooms with database tables
• Assuming rooms speed up HTTP requests

2. Which Flask-SocketIO function is used to add a user to a room?

easy

A. leave_room(room_name)

B. join_room(room_name)

C. send_room(room_name)

D. connect_room(room_name)

Solution

1. Step 1: Recall Flask-SocketIO functions for room management

   The function to add a user to a room is join_room.

2. Step 2: Match function names to their purposes

   leave_room removes a user, send_room is not a valid function, connect_room does not exist.

3. Final Answer:

   join_room(room_name) -> Option B

4. Quick Check:

   join_room = add user to room [OK]

Hint: Use join_room to add users to rooms [OK]

Common Mistakes:

• Using leave_room to add users
• Assuming send_room exists
• Confusing connect_room with join_room

3. Given this code snippet, what will be the output sent to the room 'chatroom1'?

from flask_socketio import send, join_room

@socketio.on('join')
def on_join(data):
    room = data['room']
    join_room(room)
    send('User has entered the room.', room=room)

medium

A. An error occurs because send() cannot specify a room

B. The message is sent to all connected clients regardless of room

C. No message is sent because join_room is missing

D. The message 'User has entered the room.' is sent to all clients in 'chatroom1'

Solution

1. Step 1: Analyze the join_room call

   The user joins the specified room from data['room'], e.g., 'chatroom1'.

2. Step 2: Understand the send function with room parameter

   send() with room=room sends the message only to clients in that room.

3. Final Answer:

   The message 'User has entered the room.' is sent to all clients in 'chatroom1' -> Option D

4. Quick Check:

   send(message, room=room) sends to that room [OK]

Hint: send(message, room=room) targets that room only [OK]

Common Mistakes:

• Thinking send() sends to all clients always
• Believing join_room is not called
• Assuming send() cannot specify a room

4. What is wrong with this code snippet for leaving a room?

@socketio.on('leave')
def on_leave(data):
    room = data['room']
    leave_room()
    send('User has left the room.', room=room)

medium

A. The event name 'leave' is invalid

B. send() cannot send messages after leaving a room

C. leave_room() is called without specifying the room to leave

D. The function on_leave must return a value

Solution

1. Step 1: Check leave_room usage

   leave_room requires the room name as an argument to remove the user from that room.

2. Step 2: Identify missing argument

   In the code, leave_room() is called without any argument, which is incorrect.

3. Final Answer:

   leave_room() is called without specifying the room to leave -> Option C

4. Quick Check:

   leave_room(room) needs room argument [OK]

Hint: Always pass room name to leave_room(room) [OK]

Common Mistakes:

• Calling leave_room without room argument
• Thinking send() cannot be called after leave_room
• Assuming event names must be predefined
• Believing on_leave must return a value

5. You want to send a message only to users in the room 'lobby' except the sender. Which Flask-SocketIO function and parameter combination should you use?

hard

A. send(message, room='lobby', include_self=False)

B. send(message, room='lobby', include_self=True)

C. send(message, broadcast=True)

D. send(message, room='lobby')

Solution

1. Step 1: Understand sending to a room excluding sender

   To send a message to a room but exclude the sender, use include_self=False.

2. Step 2: Match parameters to desired behavior

   send(message, room='lobby', include_self=False) uses send with room='lobby' and include_self=False, which sends to all in 'lobby' except sender.

3. Final Answer:

   send(message, room='lobby', include_self=False) -> Option A

4. Quick Check:

   include_self=False excludes sender [OK]

Hint: Use include_self=False to exclude sender in room message [OK]

Common Mistakes:

• Using include_self=True sends to sender too
• Using broadcast=True sends to all clients
• Omitting include_self sends to sender by default