بتل کد Battle Codeدارد باز می‌شود…

جلسه‌ی 14: PUT، PATCH و DELETE PUT, PATCH and DELETE

حالا که می‌توانی چیز بسازی و بخوانی، وقت عوض کردن و پاک کردن است. PUT یک چیز را کامل جایگزین می‌کند، PATCH فقط بخشی از آن را عوض می‌کند و DELETE پاکش می‌کند و با return "", 204 جواب خالی می‌دهد. برای شماره‌ای که نیست 404. این چهار کار با هم CRUD هستند. آخر سر می‌بینی چرا len(notes) + 1 بعد از پاک کردن شماره‌ی تکراری می‌سازد و چطور درستش کنی.

در این جلسه یاد می‌گیری

درس

🔐 قانون طلایی این دوره: سرور امانت‌دار است. هر سروری که می‌سازی داده‌ی آدم‌ها را نگه می‌دارد: اسم، امتیاز، یادداشت، رمز. پس به هر چه از بیرون می‌آید شک کن، رمز را هیچ‌وقت خام نگه ندار و داده‌ی کسی را به دیگری نشان نده. فقط سرورهای خودت را امتحان کن. سرور این دوره ساختگی است و داخل همین صفحه کار می‌کند: هر بار که برنامه را اجرا می‌کنی از صفر ساخته می‌شود، پس هر چه می‌خواهی امتحان کن.

یادت هست؟ در جلسه‌ی ۱۳ با POST و request.json یادداشت تازه ساختیم و با 201 برگرداندیم. در جلسه‌ی ۷ هم با <int:...> یک چیز را از روی شماره‌اش پیدا کردیم و اگر نبود abort(404, ...) زدیم. این دو را کنار هم ببین.

from server import app, ask, request, abort

notes = []

@app.post("/notes")
def add_note():
    note = {"id": len(notes) + 1, "text": request.json["text"], "done": False}
    notes.append(note)
    return note, 201

@app.get("/notes/<int:note_id>")
def one_note(note_id):
    for note in notes:
        if note["id"] == note_id:
            return note
    abort(404, "no note " + str(note_id))

ask("POST /notes", {"text": "Buy milk"})
ask("GET /notes/1")
ask("GET /notes/7")

تقریباً هر اپی چهار کار با داده‌اش می‌کند. به این چهار کار CRUD می‌گویند و هر کدام یک روش دارد:

| کار | یعنی | روش | آدرس |
|---|---|---|---|
| Create | ساختن | POST | /notes |
| Read | خواندن | GET | /notes و /notes/1 |
| Update | عوض کردن | PUT یا PATCH | /notes/1 |
| Delete | پاک کردن | DELETE | /notes/1 |

سه کار آخر روی یک یادداشت‌اند، پس هر سه باید آن را پیدا کنند. به‌جای سه بار نوشتن حلقه، یک تابع کمکی find_note می‌نویسیم. abort داخل این تابع هم کل درخواست را همان‌جا متوقف می‌کند و 404 می‌فرستد.

from server import app, ask, abort

notes = [
    {"id": 1, "text": "Buy milk", "done": False},
    {"id": 2, "text": "Call Ali", "done": False},
]

def find_note(note_id):
    for note in notes:
        if note["id"] == note_id:
            return note
    abort(404, "no note " + str(note_id))

@app.get("/notes/<int:note_id>")
def one_note(note_id):
    return find_note(note_id)

ask("GET /notes/2")
ask("GET /notes/5")

PUT یعنی «این را کامل جایگزین کن». کلاینت همه‌ی کلیدها را می‌فرستد و سرور همه را عوض می‌کند. نکته‌ی جالب: note که find_note می‌دهد همان dict داخل لیست است، نه یک کپی. پس note["text"] = ... خود یادداشت داخل لیست را عوض می‌کند. جواب، یادداشت عوض‌شده با 200 است.

from server import app, ask, request, abort

notes = [
    {"id": 1, "text": "Buy milk", "done": False},
]

def find_note(note_id):
    for note in notes:
        if note["id"] == note_id:
            return note
    abort(404, "no note " + str(note_id))

@app.put("/notes/<int:note_id>")
def replace_note(note_id):
    note = find_note(note_id)
    data = request.json
    note["text"] = data["text"]
    note["done"] = data["done"]
    return note

ask("PUT /notes/1", {"text": "Buy bread", "done": True})
print(notes)

PATCH یعنی «فقط این تکه را عوض کن». کلاینت فقط کلیدهایی را می‌فرستد که می‌خواهد عوض شوند، مثلاً {"done": true} برای تیک زدن یک کار. سرور با in نگاه می‌کند کدام کلید آمده و فقط همان را عوض می‌کند. بقیه همان که بود می‌ماند.

from server import app, ask, request, abort

notes = [
    {"id": 1, "text": "Buy milk", "done": False},
    {"id": 2, "text": "Call Ali", "done": False},
]

def find_note(note_id):
    for note in notes:
        if note["id"] == note_id:
            return note
    abort(404, "no note " + str(note_id))

@app.patch("/notes/<int:note_id>")
def change_note(note_id):
    note = find_note(note_id)
    data = request.json
    if "text" in data:
        note["text"] = data["text"]
    if "done" in data:
        note["done"] = data["done"]
    return note

ask("PATCH /notes/2", {"done": True})
ask("PATCH /notes/1", {"text": "Buy milk and eggs"})

DELETE پاک می‌کند. notes.remove(note) آن dict را از لیست برمی‌دارد. بعد از پاک کردن، چیزی برای فرستادن نمانده، پس جواب 204 No Content است: return "", 204. ask برای 204 فقط خط اول را چاپ می‌کند. اگر همان شماره را دوباره پاک کنی، دیگر نیست و 404 می‌گیری.

from server import app, ask, abort

notes = [
    {"id": 1, "text": "Buy milk", "done": False},
    {"id": 2, "text": "Call Ali", "done": False},
]

def find_note(note_id):
    for note in notes:
        if note["id"] == note_id:
            return note
    abort(404, "no note " + str(note_id))

@app.get("/notes")
def all_notes():
    return notes

@app.delete("/notes/<int:note_id>")
def delete_note(note_id):
    note = find_note(note_id)
    notes.remove(note)
    return "", 204

ask("DELETE /notes/1")
ask("GET /notes")
ask("DELETE /notes/1")

مشکل شماره‌ی تکراری. len(notes) + 1 تا وقتی چیزی پاک نشده درست کار می‌کند. ولی اگر از دو یادداشت، شماره‌ی ۱ را پاک کنی، len(notes) می‌شود ۱ و یادداشت بعدی شماره‌ی ۲ می‌گیرد که از قبل هست! راه درست یک شمارنده است که فقط جلو می‌رود: counter = {"next": 1}. هر بار از counter["next"] شماره بگیر و یکی به آن اضافه کن. چرا dict و نه یک متغیر ساده؟ اگر داخل تابع بنویسی next_id = next_id + 1، پایتون next_id را متغیر خود تابع حساب می‌کند و خطا می‌دهد؛ ولی عوض کردن چیزی داخل یک dict بیرونی مشکلی ندارد، درست مثل notes.append.

from server import app, ask, request, abort

notes = []
counter = {"next": 1}

@app.post("/notes")
def add_note():
    note = {"id": counter["next"], "text": request.json["text"]}
    counter["next"] = counter["next"] + 1
    notes.append(note)
    return note, 201

@app.delete("/notes/<int:note_id>")
def delete_note(note_id):
    for note in notes:
        if note["id"] == note_id:
            notes.remove(note)
            return "", 204
    abort(404, "no note " + str(note_id))

ask("POST /notes", {"text": "Buy milk"})
ask("POST /notes", {"text": "Call Ali"})
ask("DELETE /notes/1")
ask("POST /notes", {"text": "Feed the cat"})

اشتباه‌های رایج:
- PUT با فقط یک کلید: PUT همه را می‌خواهد و data["done"] اگر نیامده باشد خطای KeyError می‌دهد. برای عوض کردن یک تکه PATCH بفرست.
- جا انداختن return بعد از remove: سرور خطا می‌دهد که تابع «هیچ چیز برنگرداند».
- return "Deleted!", 204: با 204 بدنه فرستاده نمی‌شود؛ اگر پیامی می‌خواهی، 200 بده.
- <note_id> بدون int:: آن‌وقت note_id متن "1" است و هیچ‌وقت با عدد 1 برابر نمی‌شود؛ همیشه 404.
- notes[note_id - 1]: بعد از پاک کردن، جای یادداشت‌ها در لیست با شماره‌شان یکی نیست. همیشه با حلقه دنبال id بگرد.

مثال‌های این جلسه

چالش‌ها

  1. A New Pet (آسان)
  2. Which Method? (آسان)
  3. Remove a Book (متوسط)
  4. Level Up (متوسط)
  5. PUT or PATCH? (سخت)
  6. No Repeated Numbers (سخت)

بیشتر بخوان

← جلسه‌ی 13: POST: ساختن چیز تازه جلسه‌ی 15: بررسی ورودی →