Room-based messaging in Flask - Mini Project: Build & Apply

Room-based messaging

📖 Scenario: You are building a simple chat application where users can join different chat rooms and send messages visible only to that room.

🎯 Goal: Create a Flask app that supports multiple chat rooms. Users can join a room and send messages that only appear in that room.

📋 What You'll Learn

Create a dictionary to hold chat rooms and their messages

Add a variable to track the current room

Write a function to add messages to the current room

Complete the Flask route to display messages for the current room

💡 Why This Matters

🌍 Real World

Chat apps often separate conversations into rooms or channels so users can join topics they like.

💼 Career

Understanding how to manage data for different user groups and display dynamic content is key for web developers.

1

Create the chat rooms data structure

Create a dictionary called chat_rooms with these exact keys and values: 'general': [], 'sports': [], 'music': [].

Flask

# Create the chat_rooms dictionary with keys 'general', 'sports', and 'music' each set to an empty list
# Your code here

Hint

Use curly braces to create a dictionary. Each key is a room name and the value is an empty list for messages.

2

Add current room variable

Add a variable called current_room and set it to the string 'general'.

Flask

chat_rooms = {'general': [], 'sports': [], 'music': []}
# Set current_room to 'general'
# Your code here

Hint

Just assign the string 'general' to the variable current_room.

3

Write function to add messages

Write a function called add_message that takes a parameter message and appends it to the list in chat_rooms[current_room].

Flask

chat_rooms = {'general': [], 'sports': [], 'music': []}
current_room = 'general'

# Define add_message(message) to add message to chat_rooms[current_room]
# Your code here

Hint

Use the append() method on the list for the current room.

4

Complete Flask route to show messages

Complete the Flask route function called show_room that returns a string joining all messages in chat_rooms[current_room] separated by commas.

Flask

chat_rooms = {'general': [], 'sports': [], 'music': []}
current_room = 'general'

def add_message(message):
    chat_rooms[current_room].append(message)

from flask import Flask
app = Flask(__name__)

@app.route('/')
def show_room():
    # Return all messages in chat_rooms[current_room] joined by commas
    # Your code here

Hint

Use the join() method on the list of messages for the current room.

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