Repository pattern for data access in Flask - Step-by-Step Execution

Concept Flow - Repository pattern for data access

Start Application

↓

Controller calls Repository

↓

Repository handles Data Access

↓

Repository queries Database

↓

Database returns Data

↓

Repository returns Data to Controller

↓

Controller sends Response

The controller asks the repository for data. The repository talks to the database and returns data back. The controller then sends the response.

Execution Sample

Flask

class UserRepository:
    def get_user(self, user_id):
        return User.query.filter_by(id=user_id).first()

user_repo = UserRepository()
user = user_repo.get_user(1)

This code shows a repository class fetching a user by ID from the database.

Execution Table

Step	Action	Evaluation	Result
1	Create UserRepository instance	user_repo = UserRepository()	user_repo is ready
2	Call get_user with user_id=1	user_repo.get_user(1)	Query User table for id=1
3	Database filters users where id=1	User.query.filter_by(id=1).first()	Returns user object or None
4	Return user object to caller	return user	user variable holds user data
5	Use user data in controller	user = user_repo.get_user(1)	user available for response

💡 Finished fetching user data, repository returns control to controller

Variable Tracker

Variable	Start	After Step 2	After Step 4	Final
user_repo	None	UserRepository instance	UserRepository instance	UserRepository instance
user_id	None	1	1	1
user	None	User object or None	User object or None	User object or None

Key Moments - 2 Insights

Why does the controller not access the database directly?

The controller calls the repository (see execution_table step 2) to keep data access separate and organized.

What happens if no user is found with the given ID?

The repository returns None (see execution_table step 3), so the controller can handle missing data safely.

Visual Quiz - 3 Questions

Look at the execution table, what does step 3 do?

A Creates a new user in the database

B Filters the User table for a user with id=1

C Deletes a user from the database

D Returns the controller response

💡 Hint

Check the 'Evaluation' column in step 3 for the database query action

At which step does the repository return data to the controller?

A Step 4

B Step 2

C Step 3

D Step 5

💡 Hint

Look at the 'Action' and 'Result' columns to find when data is returned

If the user ID passed was 5 instead of 1, how would the execution table change?

A Step 4 would return a different repository

B Step 3 would filter by id=1 still

C Step 2 would call get_user(5) instead of get_user(1)

D No changes in the execution table

💡 Hint

Check the 'Action' column in step 2 for the method call parameter

Concept Snapshot

Repository pattern separates data access from business logic.
Controller calls repository methods.
Repository queries database and returns data.
Keeps code organized and easier to maintain.
Example: user_repo.get_user(user_id) fetches user data.

Full Transcript

The repository pattern helps organize code by separating data access from the controller. The controller calls the repository to get data. The repository runs database queries and returns results. This keeps the controller simple and focused on handling requests and responses. In the example, the UserRepository class has a method get_user that queries the User table for a user by ID. The controller creates a UserRepository instance and calls get_user(1). The repository queries the database and returns the user object or None if not found. This pattern makes the code easier to read, test, and maintain.

Practice

1. What is the main purpose of using the Repository pattern in a Flask application?

easy

A. To create HTML templates for the frontend

B. To speed up the Flask server response time

C. To handle user authentication automatically

D. To separate data access logic from business logic

Solution

1. Step 1: Understand the role of repository pattern

   The repository pattern is designed to separate how data is accessed from how it is used in the app logic.

2. Step 2: Identify the correct purpose in Flask context

   In Flask, this means keeping database queries inside repository classes, so the rest of the app doesn't need to know database details.

3. Final Answer:

   To separate data access logic from business logic -> Option D

4. Quick Check:

   Repository pattern = separation of concerns [OK]

Hint: Repository pattern means separate data from app logic [OK]

Common Mistakes:

• Thinking it speeds up server response
• Confusing it with authentication handling
• Assuming it creates frontend templates

2. Which of the following is the correct way to define a repository class method to get all users in Flask?

easy

A. def get_all_users(): return User.query.all()

B. def get_all_users(self): return User.query.all()

C. def get_all_users(self): return User.all()

D. def get_all_users(self): return User.query.get_all()

Solution

1. Step 1: Check method signature in a class

   Repository methods inside a class must have self as the first parameter.

2. Step 2: Verify correct SQLAlchemy query syntax

   To get all records, use User.query.all(). Other options use incorrect method names or miss self.

3. Final Answer:

   def get_all_users(self): return User.query.all() -> Option B

4. Quick Check:

   Method with self + User.query.all() = correct [OK]

Hint: Repository methods need self and correct query syntax [OK]

Common Mistakes:

• Omitting self parameter in method
• Using wrong query method like User.all()
• Using User.query.get_all() which doesn't exist

3. Given this repository method in Flask:

def get_user_by_id(self, user_id):
    return User.query.filter_by(id=user_id).first()

What will repo.get_user_by_id(5) return if no user with ID 5 exists?

medium

A. None

B. Raises an exception

C. An empty list []

D. A User object with id 5

Solution

1. Step 1: Understand SQLAlchemy filter_by().first() behavior

   The first() method returns the first matching record or None if no match is found.

2. Step 2: Apply to user_id 5 with no matching user

   Since no user with ID 5 exists, the method returns None, not a list or exception.

3. Final Answer:

   None -> Option A

4. Quick Check:

   filter_by().first() returns None if no match [OK]

Hint: filter_by().first() returns None if no record found [OK]

Common Mistakes:

• Expecting an empty list instead of None
• Thinking it raises an exception
• Assuming it returns a dummy User object

4. You wrote this repository method:

def add_user(self, user):
    db.session.add(user)
    db.session.commit

What is the error here?

medium

A. Missing parentheses after commit method call

B. db.session.add should be db.add

C. user parameter should be a dictionary, not an object

D. commit should be called before add

Solution

1. Step 1: Check method calls on db.session

   The commit method must be called with parentheses: commit().

2. Step 2: Identify the missing parentheses error

   Without parentheses, commit is just a reference, so changes are not saved.

3. Final Answer:

   Missing parentheses after commit method call -> Option A

4. Quick Check:

   commit() needs parentheses to execute [OK]

Hint: Always call commit() with parentheses [OK]

Common Mistakes:

• Forgetting parentheses on commit
• Using db.add instead of db.session.add
• Calling commit before add

5. You want to implement a repository method that returns all users whose email ends with '@example.com'. Which of these is the best way to write it using SQLAlchemy in Flask?

hard

A. def get_example_users(self): return User.query.filter(User.email.contains('@example.com')).first()

B. def get_example_users(self): return User.query.filter_by(email='@example.com').all()

C. def get_example_users(self): return User.query.filter(User.email.endswith('@example.com')).all()

D. def get_example_users(self): return User.query.filter(User.email == '@example.com').all()

Solution

1. Step 1: Understand filtering by string suffix in SQLAlchemy

   To filter emails ending with a string, use filter(User.email.endswith(...)).

2. Step 2: Check each option's correctness

   def get_example_users(self): return User.query.filter(User.email.endswith('@example.com')).all() uses endswith and all() to get all matches, which is correct. def get_example_users(self): return User.query.filter_by(email='@example.com').all() uses filter_by with exact match, not suffix. def get_example_users(self): return User.query.filter(User.email.contains('@example.com')).first() uses contains but returns only first match. def get_example_users(self): return User.query.filter(User.email == '@example.com').all() uses equality check, not suffix.

3. Final Answer:

   def get_example_users(self): return User.query.filter(User.email.endswith('@example.com')).all() -> Option C

4. Quick Check:

   Use endswith() + all() for suffix filtering [OK]

Hint: Use endswith() for suffix filtering in queries [OK]

Common Mistakes:

• Using filter_by for partial matches
• Using contains but returning only first result
• Using equality operator instead of endswith