Flask-Login extension - Step-by-Step Execution

Concept Flow - Flask-Login extension

User sends request

↓

Flask-Login checks session

↓

Is user authenticated?

No→Redirect to login page

Yes↓

Allow access to protected page

↓

User logs in

↓

User session created

↓

User logs out

↓

User session cleared

This flow shows how Flask-Login manages user sessions by checking authentication on requests, allowing access or redirecting, and handling login/logout.

Execution Sample

Flask

from flask_login import LoginManager, login_user, logout_user, login_required

login_manager = LoginManager()

@login_manager.user_loader
def load_user(user_id):
    return User.get(user_id)

This code sets up Flask-Login, defines how to load a user from an ID, and prepares login/logout functions.

Execution Table

Step	Action	Input	Check/Process	Result/Output
1	User sends request to protected page	Request with session cookie	Check if session has authenticated user	User not authenticated
2	Redirect to login page	No user session	Send redirect response	User sees login form
3	User submits login form	Username and password	Verify credentials	Credentials valid
4	Call login_user(user)	User object	Create user session	Session cookie set
5	User sends request to protected page	Request with session cookie	Check session user	User authenticated
6	Allow access to protected page	Authenticated user	Grant access	Page content shown
7	User clicks logout	Logout request	Call logout_user()	Session cleared
8	User sends request to protected page	Request without session	Check session	User not authenticated
9	Redirect to login page	No user session	Send redirect response	User sees login form

💡 Execution stops when user is either authenticated and allowed access or redirected to login if not authenticated.

Variable Tracker

Variable	Start	After Step 3	After Step 4	After Step 7	Final
user_authenticated	False	False	True	False	False
session_cookie	None	None	Set	Cleared	None
current_user	Anonymous	Anonymous	User object	Anonymous	Anonymous

Key Moments - 3 Insights

Why does the user get redirected to the login page even after submitting the login form?

If login_user() is not called or credentials are invalid (see execution_table step 3 and 4), the session is not created, so the user remains unauthenticated and is redirected again (step 2).

What happens to the session when logout_user() is called?

logout_user() clears the session cookie and resets current_user to anonymous (see execution_table step 7 and variable_tracker), so the user loses access to protected pages.

How does Flask-Login know which user is logged in on each request?

Flask-Login uses the session cookie to identify the user and calls the user_loader function to load the user object (see execution_sample code and execution_table step 5).

Visual Quiz - 3 Questions

Look at the execution_table at step 4: what happens when login_user(user) is called?

A The user credentials are verified

B The user is redirected to the login page

C A user session is created and a session cookie is set

D The session cookie is cleared

💡 Hint

Check the 'Result/Output' column at step 4 in the execution_table

At which step does the user lose authentication and get logged out?

A Step 5

B Step 7

C Step 3

D Step 9

💡 Hint

Look for logout_user() call and session clearing in the execution_table

If the user submits wrong credentials at step 3, what would change in the execution_table?

A Step 2 redirect would happen again after step 3

B Step 4 would create a session anyway

C Step 6 would allow access to protected page

D Step 7 would clear the session

💡 Hint

Refer to the flow of authentication failure and redirection in the execution_table steps 1, 2, and 3

Concept Snapshot

Flask-Login manages user sessions in Flask apps.
Use login_user(user) to log in and create a session.
Use logout_user() to clear the session.
Protect routes with @login_required.
Define user_loader to load user by ID.
Redirects unauthenticated users to login page.

Full Transcript

Flask-Login is a tool that helps Flask apps manage user login sessions. When a user sends a request, Flask-Login checks if the user is logged in by looking at the session cookie. If not logged in, it redirects the user to the login page. When the user submits the login form with correct credentials, login_user(user) is called to create a session and set a cookie. Then the user can access protected pages. When the user logs out, logout_user() clears the session cookie and the user is no longer authenticated. Flask-Login uses a user_loader function to find the user object from the stored user ID in the session. This flow ensures only logged-in users can access certain pages, and others are redirected to login.

Practice

1. What is the main purpose of the Flask-Login extension in a Flask application?

easy

A. To create database models for users

B. To manage user sessions and handle login/logout functionality

C. To style the login page with CSS

D. To send emails to users after login

Solution

1. Step 1: Understand Flask-Login's role

   Flask-Login is designed to manage user sessions, making it easy to log users in and out securely.

2. Step 2: Compare options with Flask-Login's purpose

   Creating database models, styling pages, or sending emails are not handled by Flask-Login.

3. Final Answer:

   To manage user sessions and handle login/logout functionality -> Option B

4. Quick Check:

   Flask-Login manages user sessions = A [OK]

Hint: Remember: Flask-Login handles login sessions, not styling or emails [OK]

Common Mistakes:

• Confusing Flask-Login with database or styling tools
• Thinking Flask-Login sends emails
• Assuming it creates user database models

2. Which of the following is the correct way to initialize Flask-Login's LoginManager in a Flask app using an application factory pattern?

easy

A. login_manager = LoginManager(); login_manager.init_app(app)

B. login_manager = LoginManager(app=app)

C. login_manager = LoginManager(app)

D. login_manager = LoginManager.init_app(app)

Solution

1. Step 1: Recall Flask-Login initialization pattern

   The usual pattern is to create a LoginManager instance without arguments, then call init_app(app) to bind it.

2. Step 2: Check each option's syntax

   login_manager = LoginManager(); login_manager.init_app(app) correctly creates the instance and calls init_app(app). login_manager = LoginManager(app) tries to pass app to constructor which is not standard. login_manager = LoginManager(app=app) uses a wrong keyword argument. login_manager = LoginManager.init_app(app) calls init_app as a class method, which is invalid.

3. Final Answer:

   login_manager = LoginManager(); login_manager.init_app(app) -> Option A

4. Quick Check:

   Use init_app() after creating LoginManager = C [OK]

Hint: Create LoginManager first, then call init_app(app) [OK]

Common Mistakes:

• Passing app directly to LoginManager constructor
• Using wrong argument names
• Calling init_app as a class method

3. Given this Flask-Login user loader function, what will load_user('42') return if the user with ID 42 exists in the database?

from flask_login import LoginManager
login_manager = LoginManager()

@login_manager.user_loader
def load_user(user_id):
    return User.query.get(int(user_id))

medium

A. Raises a TypeError because user_id is a string

B. None, because user_loader must return a boolean

C. A string '42' instead of a User object

D. A User object with ID 42

Solution

1. Step 1: Understand user_loader function role

   The user_loader function receives a user ID as a string and returns the corresponding User object or None if not found.

2. Step 2: Analyze the code behavior

   The function converts the string ID to int, then queries the database for that user. If user 42 exists, it returns the User object.

3. Final Answer:

   A User object with ID 42 -> Option D

4. Quick Check:

   user_loader returns User object = D [OK]

Hint: user_loader returns User object or None, never boolean [OK]

Common Mistakes:

• Thinking user_loader returns True/False
• Assuming user_id must be int already
• Expecting a string return instead of User object

4. What is the error in this Flask-Login setup code?

login_manager = LoginManager()

@login_manager.user_loader
def load_user(user_id):
    return User.get(user_id)

login_manager.init_app(app)

medium

A. User.get(user_id) should be User.query.get(user_id)

B. login_manager.init_app(app) must be called before defining load_user

C. user_loader decorator is missing parentheses

D. login_manager must be created after app

Solution

1. Step 1: Check user_loader function correctness

   The typical way to get a user by ID in Flask-SQLAlchemy is User.query.get(user_id). Using User.get(user_id) will cause an AttributeError.

2. Step 2: Verify other parts of the code

   Calling init_app(app) after defining user_loader is fine. The decorator syntax is correct. Creating LoginManager before app is allowed if init_app is called later.

3. Final Answer:

   User.get(user_id) should be User.query.get(user_id) -> Option A

4. Quick Check:

   User.get() is invalid, use User.query.get() = B [OK]

Hint: Use User.query.get() to fetch user by ID [OK]

Common Mistakes:

• Using User.get() instead of User.query.get()
• Thinking init_app must be called before user_loader
• Misunderstanding decorator syntax

5. You want to protect a Flask route so only logged-in users can access it. Which is the correct way to do this using Flask-Login?

hard

A. Manually check session variables for user login status

B. Check if current_user.is_authenticated inside the route and redirect if not

C. Use the @login_required decorator on the route function

D. Add login_manager.login_view = 'login' inside the route function

Solution

1. Step 1: Recall Flask-Login's route protection method

   Flask-Login provides a @login_required decorator to easily protect routes so only logged-in users can access them.

2. Step 2: Evaluate other options

   Check if current_user.is_authenticated inside the route and redirect if not is possible but less clean and requires manual redirect logic. Manually check session variables for user login status is low-level and error-prone. Add login_manager.login_view = 'login' inside the route function sets the login page globally but does not protect routes by itself.

3. Final Answer:

   Use the @login_required decorator on the route function -> Option C

4. Quick Check:

   Use @login_required to protect routes = A [OK]

Hint: Use @login_required decorator for easy route protection [OK]

Common Mistakes:

• Manually checking login status instead of using decorator
• Confusing login_view setting with route protection
• Ignoring Flask-Login's built-in decorators