Pybites Platform

Back

← Previous Next →

Update and delete food objects

Pybites

View Learning Paths

Level: Intermediate (score: 3)

Now that we're able to create and retrieve Food objects, it's time to add code to update and delete them.

Create the two corresponding endpoints:

1. To update, the API should

1. receive a PUT request with the Food object's id and new / updated object

2. update the item in the foods dictionary (to keep it simple, no need to update individual attributes, just swap out the whole Food object matching its id)

3. return the updated item.

2. To delete the API should

1. receive a DELETE request with the id of the food to be deleted

2. delete it from the foods dictionary

3. return a respone of {"ok": True} (as found here).

* We use PUT because we're replacing the whole item. For a partial update, PATCH would be the more appropriate HTTP verb / action.

For both endpoints raise an HTTPException with a status_code of 404 and message (detail) of Food not found, when the id passed in is not in the foods dictionary.

WIN: You have a simple API for food objects up and running with minimal code! We still need to add authentication, but first we'll make two more Pydantic models so that a user can start logging daily food intake.

FastAPI

Code
Tests

import difflib

import pytest
from fastapi import HTTPException
from fastapi.testclient import TestClient

from app import app

@pytest.fixture
def client():
    client = TestClient(app)
    return client

@pytest.fixture(autouse=True)
def create_foods(client):
    """
    Payload for two food objects, "autouse" runs this
    automatically before the tests.
    """
    food1_payload = dict(
        id=1,
        name="egg",
        serving_size="piece",
        kcal_per_serving=78,
        protein_grams=6.2,
        fibre_grams=0,
    )
    food2_payload = dict(
        id=2,
        name="oatmeal",
        serving_size="100 grams",
        kcal_per_serving=336,
        protein_grams=13.2,
        fibre_grams=10.1,
    )
    for payload in (food1_payload, food2_payload):
        client.post("/", json=payload)

def test_update_food(client):
    orig_egg = client.get("/1").json()
    resp = client.get("/2")
    orig_food = resp.json()
    food = orig_food.copy()
    food["kcal_per_serving"] = 350
    client.put("/2", json=food)
    resp = client.get("/2")
    updated_food = resp.json()
    diff = set(updated_food.values()) - set(orig_food.values())
    assert diff == {350}
    # the other item is not updated
    egg = client.get("/1").json()
    assert orig_egg == egg

def test_update_nonexisting_food_returns_404(client):
    resp = client.get("/2")
    payload = resp.json()
    resp = client.put("/3", json=payload)
    assert resp.status_code == 404
    assert resp.json() == {"detail": "Food not found"}

def test_delete_food(client):
    resp = client.get("/")
    assert len(resp.json()) == 2
    resp = client.delete("/2")
    assert resp.json() == {"ok": True}
    # oatmeal deleted
    with pytest.raises(KeyError):
        client.get("/2")
    resp = client.get("/")
    data = resp.json()
    assert len(data) == 1
    # only egg remains
    assert data[0]["id"] == 1
    assert data[0]["name"] == "egg"

def test_delete_nonexisting_food_returns_404(client):
    resp = client.delete("/3")
    assert resp.status_code == 404
    assert resp.json() == {"detail": "Food not found"}