Repository pattern for data access in Flask - Mini Project: Build & Apply

Repository Pattern for Data Access in Flask

📖 Scenario: You are building a simple Flask web app to manage books in a library. To keep your code clean and organized, you want to separate how you access data from the rest of your app. This is where the repository pattern helps.Think of the repository as a friendly librarian who knows exactly how to find, add, or remove books from the library database. Your app will ask the librarian instead of searching the shelves directly.

🎯 Goal: Build a Flask app that uses the repository pattern to manage book data. You will create a list of books, set up a repository class to handle data access, implement methods to get all books and add a new book, and finally connect this repository to a Flask route to display the books.

📋 What You'll Learn

Create a list of book dictionaries with exact titles and authors

Create a repository class called BookRepository to manage book data

Implement a method get_all_books that returns all books

Implement a method add_book that adds a new book to the list

Create a Flask route /books that uses the repository to show all books

💡 Why This Matters

🌍 Real World

The repository pattern helps keep your Flask app organized by separating data access from business logic. This makes your code easier to maintain and test.

💼 Career

Many companies use the repository pattern in web development to build scalable and clean applications. Knowing this pattern is valuable for backend and full-stack developer roles.

1

DATA SETUP: Create the initial book list

Create a list called books with these exact dictionaries: {'title': '1984', 'author': 'George Orwell'}, {'title': 'To Kill a Mockingbird', 'author': 'Harper Lee'}, and {'title': 'The Great Gatsby', 'author': 'F. Scott Fitzgerald'}.

Flask

# Create the list of books with exact entries
# Your code here

Hint

Remember to create a list named books with exactly three dictionaries inside it.

2

CONFIGURATION: Define the BookRepository class

Create a class called BookRepository with an __init__ method that takes a parameter books and assigns it to self.books.

Flask

books = [
    {'title': '1984', 'author': 'George Orwell'},
    {'title': 'To Kill a Mockingbird', 'author': 'Harper Lee'},
    {'title': 'The Great Gatsby', 'author': 'F. Scott Fitzgerald'}
]

# Define the BookRepository class with __init__ method
# Your code here

Hint

Define a class named BookRepository with an __init__ method that stores the passed books list in self.books.

3

CORE LOGIC: Add methods to get and add books

Inside the BookRepository class, add a method get_all_books that returns self.books. Also add a method add_book that takes a parameter book and appends it to self.books.

Flask

books = [
    {'title': '1984', 'author': 'George Orwell'},
    {'title': 'To Kill a Mockingbird', 'author': 'Harper Lee'},
    {'title': 'The Great Gatsby', 'author': 'F. Scott Fitzgerald'}
]

class BookRepository:
    def __init__(self, books):
        self.books = books

    # Add get_all_books method
    # Add add_book method
    # Your code here

Hint

Define two methods inside BookRepository: one to return all books, and one to add a new book to the list.

4

COMPLETION: Create Flask app and route using the repository

Import Flask and create an app instance called app. Instantiate BookRepository with the books list as repo. Create a route /books that returns a string listing all book titles from repo.get_all_books() separated by commas.

Flask

books = [
    {'title': '1984', 'author': 'George Orwell'},
    {'title': 'To Kill a Mockingbird', 'author': 'Harper Lee'},
    {'title': 'The Great Gatsby', 'author': 'F. Scott Fitzgerald'}
]

class BookRepository:
    def __init__(self, books):
        self.books = books

    def get_all_books(self):
        return self.books

    def add_book(self, book):
        self.books.append(book)

# Import Flask and create app
# Instantiate BookRepository as repo
# Create /books route that returns book titles separated by commas
# Your code here

Hint

Import Flask, create the app, instantiate the repository, and define a route that returns all book titles joined by commas.

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