Why Repository pattern for data access in Flask? - Purpose & Use Cases

The Big Idea

What if you could change your database without rewriting your whole app?

The Scenario

Imagine building a Flask app where you write raw database queries everywhere in your code to get or save data.

Every time you want to change the database or fix a bug, you have to hunt down all those queries scattered around.

The Problem

Writing database code everywhere makes your app messy and hard to fix.

If the database changes, you must update many places, risking mistakes and bugs.

This slows down development and makes your app fragile.

The Solution

The Repository pattern creates a single place to handle all data access.

Your app talks to this repository instead of the database directly.

This keeps your code clean, easy to maintain, and ready for changes.

Before vs After

✗ Before

db.session.query(User).filter_by(id=1).first()
db.session.add(new_user)
db.session.commit()

✓ After

user_repo.get_user_by_id(1)
user_repo.add_user(new_user)
user_repo.commit()

What It Enables

You can change how data is stored without touching the rest of your app.

Real Life Example

When switching from SQLite to PostgreSQL, you only update the repository code, not the whole app.

Key Takeaways

Manual data access scatters database code everywhere.

Repository pattern centralizes data logic in one place.

This makes your Flask app easier to maintain and evolve.

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