Updating Existing ToDos

Welcome back! You've already made great progress by learning how to list and create todo items in your Flask application. Now, we will enhance your ToDo app by adding the ability to edit existing todo items. This feature is essential in any task management app, as it allows users to update and refine their tasks as needed.

By the end of this lesson, you will be able to:

• Retrieve an existing todo item for editing.
• Update the todo item with new details and save the changes.

Let's dive in!

First, let's focus on the TodoService class and the update method. This method will allow us to modify the existing todo items.

class TodoService:

    # Constructor and other methods...

    # Method to retrieve an item by its ID
    def get_by_id(self, todo_id):
        # Iterate through the list of todos to find the matching ID
        for todo in self._todos:
            # Return the matching todo item
            if todo.todo_id == todo_id:
                return todo
        # Return None if no matching item is found
        return None

    # Method to update an item using its ID
    def update(self, todo_id, title, description):
        # Retrieve the todo item by its ID
        todo = self.get_by_id(todo_id)
        if todo:
            # Update the title and description of the todo item
            todo.title = title
            todo.description = description
            # Return True if the update was successful
            return True
        # Return False if the todo item was not found
        return False

Here, we define two methods within the TodoService class. The get_by_id method searches for and returns a todo item by its unique identifier. If found, the item is returned; otherwise, None is returned.

The update method leverages this retrieval functionality and updates an existing todo item's title and description. If the item is found and updated, the method returns True; otherwise, it returns False.

Now, let's move on to the controller layer. We will handle routes for displaying the edit form and for submitting updates.

Here are the relevant routes in todo_controller.py:

from flask import Blueprint, render_template, request, redirect, url_for
from services.todo_service import TodoService

todo_service = TodoService()
todo_controller = Blueprint('todo', __name__)

# Routes for listing and adding items...

# Route for rendering a page for a specific todo item
@todo_controller.route('/edit/<int:todo_id>', methods=['GET'])
def edit_todo(todo_id):
    # Retrieve the todo item by its ID
    todo_item = todo_service.get_by_id(todo_id)
    if not todo_item:
        # Redirect to list view if the todo item is not found
        return redirect(url_for('todo.list_todos'))
    # Render the edit template with the retrieved todo item
    return render_template('todo_edit.html', todo=todo_item)

# Route for updating the data of a specific todo item
@todo_controller.route('/update/<int:todo_id>', methods=['POST'])
def update(todo_id):
    title = request.form.get('title')
    description = request.form.get('description')
    if title and description:
        # Update the todo item with new title and description
        todo_service.update(todo_id, title, description)
    # Redirect to the list view after updating
    return redirect(url_for('todo.list_todos'))

In this segment, we set up two new routes:

1. Edit Route: The edit_todo route displays a form for editing a specific todo item. It uses the get_by_id method to retrieve the item and renders the todo_edit.html template for editing. If the item isn't found, it redirects back to the list view.
2. Update Route: The update route handles form submission, extracts the new title and description from the request, updates the todo item using the update method, and then redirects back to the main todo list. Although there are other HTTP methods more suited for update operations, such as PUT, we will use POST because HTML forms only natively support GET and POST methods.

Note that we use route parameters (e.g., <int:todo_id>) to capture dynamic values directly from the URL. For example, <int:todo_id> means todo_id is an integer parameter. In a URL, it might look like /edit/1 where 1 is the todo_id.

This allows us to pass the specific todo_id to the route functions for precise item handling.