Repository pattern for data access in Flask - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the Repository pattern in data access?

The Repository pattern is a way to organize code that talks to the database. It acts like a middleman between your app and the database, making it easier to manage data and keep code clean.

beginner

Why use the Repository pattern in a Flask app?

It helps separate database code from business logic. This makes your app easier to test, change, and understand, just like keeping your tools in separate boxes for different jobs.

intermediate

In Flask, what does a repository class usually contain?

It usually has methods to add, get, update, and delete data. These methods hide the details of how data is stored, so the rest of the app doesn't need to know about the database.

intermediate

How does the Repository pattern improve testing in Flask apps?

Because the repository hides database details, you can replace it with a fake version during tests. This lets you test your app without needing a real database, making tests faster and simpler.

beginner

Give a simple example of a repository method in Flask.

A method like get_user_by_id(id) that returns a user from the database by their ID. The app calls this method without worrying about the database query details.

What is the main role of a repository in Flask apps?

A To serve static files

B To create HTML templates

C To manage user sessions

D To handle database operations and hide details from the app

The repository handles database operations and hides the details from the rest of the app.

Which benefit does the Repository pattern provide for testing?

A It allows replacing the database with a fake version

B It makes tests slower

C It removes the need for tests

D It makes the UI prettier

The pattern allows using fake repositories during tests, so you don't need a real database.

Which method would you expect in a repository class?

A get_user_by_id()

B send_email()

C render_template()

D start_server()

Repository classes usually have methods like get_user_by_id() to fetch data.

How does the Repository pattern affect code organization?

A It mixes database code with business logic

B It removes the need for business logic

C It separates database code from business logic

D It duplicates database code everywhere

It separates database code from business logic, making code cleaner.

In Flask, where would you typically use the Repository pattern?

A In the HTML templates

B In the database access layer

C In the CSS files

D In the static folder

The Repository pattern is used in the database access layer to manage data.

Explain the Repository pattern and why it is useful in Flask applications.

Think about how you keep your tools organized in different boxes for different jobs.

Describe how you would implement a simple repository class in Flask for managing user data.

Imagine a helper that handles all database talks for user info.

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