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

جلسه‌ی 7: پیدا کردن چیزها Finding Things

داده‌ی سرور در یک لیست از دیکشنری‌ها در حافظه: حیوان‌های خانگی، هر کدام با یک id. همه را با GET /pets می‌دهی، یکی را با GET /pets/<int:pet_id> و 404 اگر نبود، با ?kind=cat جدا می‌کنی و می‌شماری.

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

درس

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

یادت هست؟ در جلسه‌ی ۵ با <int:n> یک عدد از مسیر گرفتیم و در جلسه‌ی ۶ با request.args.get("fill", "#") یک مقدار از پرسش، با پیش‌فرض. هر دو با هم هم کار می‌کنند: مسیر می‌گوید «کدام»، پرسش می‌گوید «چطور». امروز این‌ها را روی داده‌ی واقعی سرور به کار می‌بریم.

from server import app, ask, request

@app.get("/box/<int:n>")
def box(n):
    fill = request.args.get("fill", "#")
    return fill * n

ask("GET /box/4")
ask("GET /box/6?fill=o")

یک سرور معمولاً چیزهایی را نگه می‌دارد: کاربرها، پست‌ها، امتیازها. ساده‌ترین جا برای نگه داشتنشان یک لیست از دیکشنری‌ها است: هر دیکشنری یک چیز، با کلیدهای یکسان. هر کدام یک id (شماره‌ی یکتا) دارد تا حتی دو حیوان هم‌اسم هم با هم قاطی نشوند. این لیست در حافظه است: هر بار برنامه از اول اجرا شود، از اول ساخته می‌شود و تغییرها از بین می‌روند. در جلسه‌ی ۱۷ راه نگه داشتنشان را می‌بینیم.

PETS = [
    {"id": 1, "name": "Pishi", "kind": "cat", "age": 3},
    {"id": 2, "name": "Max", "kind": "dog", "age": 5},
    {"id": 3, "name": "Nemo", "kind": "fish", "age": 1},
    {"id": 4, "name": "Luna", "kind": "cat", "age": 2},
    {"id": 5, "name": "Rocky", "kind": "dog", "age": 7},
]

print(len(PETS), "pets")
print(PETS[1]["name"])
for pet in PETS:
    print(pet["id"], pet["name"], pet["kind"])

GET /pets: همه. با یک حلقه اسم‌ها را در یک لیست جمع کن. بعد ", ".join(names) همه‌ی متن‌های لیست را با , بینشان پشت هم می‌چسباند و یک متن می‌سازد: ["Pishi", "Max"] می‌شود "Pishi, Max". (join فقط با لیستی از متن‌ها کار می‌کند.) فعلاً جواب را متن می‌فرستیم؛ در جلسه‌ی ۹ خودِ لیست را به شکل JSON می‌فرستیم.

from server import app, ask

PETS = [
    {"id": 1, "name": "Pishi", "kind": "cat", "age": 3},
    {"id": 2, "name": "Max", "kind": "dog", "age": 5},
    {"id": 3, "name": "Nemo", "kind": "fish", "age": 1},
    {"id": 4, "name": "Luna", "kind": "cat", "age": 2},
    {"id": 5, "name": "Rocky", "kind": "dog", "age": 7},
]

@app.get("/pets")
def all_pets():
    names = []
    for pet in PETS:
        names.append(pet["name"])
    return ", ".join(names)

ask("GET /pets")

GET /pets/<int:pet_id>: یکی. روی لیست بچرخ و id هر حیوان را با pet_id مقایسه کن. وقتی پیدا شد، return همان لحظه تابع را تمام می‌کند و بقیه‌ی حلقه اجرا نمی‌شود. اگر حلقه تمام شد و هنوز اینجاییم، یعنی چنین حیوانی نیست: بعد از حلقه abort(404, ...).

from server import app, ask, abort

PETS = [
    {"id": 1, "name": "Pishi", "kind": "cat", "age": 3},
    {"id": 2, "name": "Max", "kind": "dog", "age": 5},
    {"id": 3, "name": "Nemo", "kind": "fish", "age": 1},
    {"id": 4, "name": "Luna", "kind": "cat", "age": 2},
    {"id": 5, "name": "Rocky", "kind": "dog", "age": 7},
]

@app.get("/pets/<int:pet_id>")
def one_pet(pet_id):
    for pet in PETS:
        if pet["id"] == pet_id:
            return f"{pet['name']} is a {pet['kind']}, {pet['age']} years old"
    abort(404, f"no pet with id {pet_id}")

ask("GET /pets/2")
ask("GET /pets/9")

جدا کردن با ?kind=cat. همان /pets می‌تواند یک پرسش اختیاری هم بگیرد. request.args.get("kind") اگر kind نیامده باشد None (هیچ) می‌دهد. پس شرط حلقه این است: «kind نیامده (kind is None) یا نوع این حیوان همان است». اگر هیچ حیوانی نماند، یک جواب روشن بده، نه یک متن خالی.

from server import app, ask, request

PETS = [
    {"id": 1, "name": "Pishi", "kind": "cat", "age": 3},
    {"id": 2, "name": "Max", "kind": "dog", "age": 5},
    {"id": 3, "name": "Nemo", "kind": "fish", "age": 1},
    {"id": 4, "name": "Luna", "kind": "cat", "age": 2},
    {"id": 5, "name": "Rocky", "kind": "dog", "age": 7},
]

@app.get("/pets")
def all_pets():
    kind = request.args.get("kind")
    names = []
    for pet in PETS:
        if kind is None or pet["kind"] == kind:
            names.append(pet["name"])
    if not names:
        return "No pets found."
    return ", ".join(names)

ask("GET /pets")
ask("GET /pets?kind=cat")
ask("GET /pets?kind=bird")

شمردن. گاهی فقط تعداد مهم است: «چند سگ داریم؟». یک شمارنده از ۰ بگذار و برای هر حیوانِ جور یکی اضافه کن (یا len(...) لیست جورها را بگیر). مسیر /pets/count با /pets/<int:pet_id> قاطی نمی‌شود: count عدد نیست، پس به مسیر <int:...> نمی‌خورد.

from server import app, ask, request

PETS = [
    {"id": 1, "name": "Pishi", "kind": "cat", "age": 3},
    {"id": 2, "name": "Max", "kind": "dog", "age": 5},
    {"id": 3, "name": "Nemo", "kind": "fish", "age": 1},
    {"id": 4, "name": "Luna", "kind": "cat", "age": 2},
    {"id": 5, "name": "Rocky", "kind": "dog", "age": 7},
]

@app.get("/pets/count")
def count_pets():
    kind = request.args.get("kind")
    count = 0
    for pet in PETS:
        if kind is None or pet["kind"] == kind:
            count = count + 1
    return f"{count} pets"

ask("GET /pets/count")
ask("GET /pets/count?kind=dog")

اشتباه رایج: گذاشتن abort (یا return «پیدا نشد») در else داخل حلقه. آن‌وقت حلقه فقط اولین حیوان را نگاه می‌کند: اگر id آن جور نبود، همان‌جا 404 می‌دهد و بقیه را اصلاً نمی‌بیند. «خودت امتحان کن» را بزن: Max هست، ولی /pets/2 می‌گوید نیست! «پیدا نشد» همیشه بعد از تمام شدن حلقه می‌آید.

from server import app, ask, abort

PETS = [
    {"id": 1, "name": "Pishi", "kind": "cat", "age": 3},
    {"id": 2, "name": "Max", "kind": "dog", "age": 5},
    {"id": 3, "name": "Nemo", "kind": "fish", "age": 1},
    {"id": 4, "name": "Luna", "kind": "cat", "age": 2},
    {"id": 5, "name": "Rocky", "kind": "dog", "age": 7},
]

@app.get("/pets/<int:pet_id>")
def one_pet(pet_id):
    for pet in PETS:
        if pet["id"] == pet_id:
            return pet["name"]
        else:
            abort(404, f"no pet with id {pet_id}")

ask("GET /pets/1")
ask("GET /pets/2")

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

چالش‌ها

  1. Path or Query? (آسان)
  2. Every Pet and Its Kind (آسان)
  3. One Pet by Its id (متوسط)
  4. Where Did Nemo Go? (متوسط)
  5. Only Dogs, Please (سخت)
  6. Old Enough (سخت)

بیشتر بخوان

← جلسه‌ی 6: پرسش در آدرس جلسه‌ی 8: پروژه: API فرهنگ لغت کلاس →