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

جلسه‌ی 15: بررسی ورودی Checking What Comes In

هر چیزی ممکن است به سرورت برسد: کلید جاافتاده، عدد به‌جای متن، اسم خالی، ستاره‌ی ۹ از ۵، یا اصلاً هیچ بدنه‌ای. سرور خوب قبل از نگه داشتن، همه را بررسی می‌کند: کلیدهای لازم با in و .get، نوع با isinstance، طول با len و بازه با 1 <= stars <= 5. اشکال‌ها را با 400 و پیامی روشن برمی‌گرداند، تکراری‌ها را با 409، و می‌تواند همه‌ی اشکال‌ها را در یک لیست جمع کند.

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

درس

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

یادت هست؟ در جلسه‌ی ۱۴ با PATCH فقط کلیدهایی را عوض کردیم که آمده بودند، و برای شماره‌ی ناموجود 404 دادیم. ولی سرور ما هر چه بیاید را باور می‌کند! کد زیر را اجرا کن: کلاینت به‌جای true متن "yes please" فرستاده و سرور همان را نگه داشته. حالا done دیگر «انجام شد / نشد» نیست. امروز یاد می‌گیریم جلوی این را بگیریم.

from server import app, ask, request, abort

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

@app.patch("/notes/<int:note_id>")
def change_note(note_id):
    for note in notes:
        if note["id"] == note_id:
            data = request.json
            if "done" in data:
                note["done"] = data["done"]
            return note
    abort(404, "no note " + str(note_id))

ask("PATCH /notes/1", {"done": True})
ask("PATCH /notes/1", {"done": "yes please"})
ask("PATCH /notes/9", {"done": True})

قانون طلایی را یادت هست: به هر چه از بیرون می‌آید شک کن. هر کسی می‌تواند هر چیزی بفرستد، از روی اشتباه یا از روی شیطنت. پس سرور اول بررسی می‌کند، بعد نگه می‌دارد. اولین بررسی: کلیدهای لازم آمده‌اند؟ با not in نگاه کن و اگر نبود، abort(400, ...) با پیامی که بگوید چه کم است. 400 Bad Request یعنی «درخواستت ایراد دارد»، تقصیر کلاینت است.

from server import app, ask, request, abort

players = []

@app.post("/players")
def add_player():
    data = request.json
    if "name" not in data:
        abort(400, "name is missing")
    player = {"id": len(players) + 1, "name": data["name"]}
    players.append(player)
    return player, 201

ask("POST /players", {"name": "Sara"})
ask("POST /players", {"nam": "Ali"})

کلید آمده، ولی از چه نوعی؟ isinstance(value, str) می‌پرسد «آیا value متن است؟» و True یا False می‌دهد. نوع‌های دیگر: int (عدد صحیح)، bool (True/False)، list و dict. دو نکته‌ی کاربردی:
- اگر کلاینت هیچ بدنه‌ای نفرستد، request.json می‌شود None؛ پس اول isinstance(data, dict) را بپرس.
- data.get("name") مثل data["name"] است، ولی اگر کلید نباشد به‌جای خطا None می‌دهد. پس isinstance(data.get("name"), str) هم «نیامده» و هم «متن نیست» را یک‌جا می‌گیرد.

from server import app, ask, request, abort

print(isinstance("Sara", str), isinstance(12, str))
print(isinstance(12, int), isinstance("12", int))
print(isinstance(True, bool), isinstance(None, dict))

@app.post("/players")
def add_player():
    data = request.json
    if not isinstance(data, dict):
        abort(400, "send a JSON object")
    if not isinstance(data.get("name"), str):
        abort(400, "name must be text")
    return {"name": data["name"]}, 201

ask("POST /players")
ask("POST /players", {"name": 42})
ask("POST /players", {"name": "Sara"})

نوع درست است، ولی اندازه چه؟ یک اسم خالی ("") یا اسمی با ۵۰۰ حرف هم متن است. با len طول را بسنج: if len(name) < 1 or len(name) > 12:. برای عدد، بازه را بسنج. پایتون اجازه می‌دهد دو مقایسه را پشت هم بنویسی: 1 <= stars <= 5 یعنی «stars دست‌کم ۱ و حداکثر ۵ است». پیام خطا هم بگوید چه چیزی قبول است: stars must be 1 to 5 خیلی بهتر از bad stars است.

from server import app, ask, request, abort

@app.post("/reviews")
def add_review():
    data = request.json
    if len(data["game"]) < 1 or len(data["game"]) > 12:
        abort(400, "game must be 1 to 12 characters")
    if not 1 <= data["stars"] <= 5:
        abort(400, "stars must be 1 to 5")
    return data, 201

ask("POST /reviews", {"game": "Snake", "stars": 4})
ask("POST /reviews", {"game": "", "stars": 4})
ask("POST /reviews", {"game": "Snake", "stars": 9})

گاهی همه‌چیز درست است، ولی آن چیز از قبل هست: نام کاربری‌ای که کس دیگری گرفته، یا ایمیلی که قبلاً ثبت شده. این‌جا کد درست 409 Conflict است، یعنی «با چیزی که داریم جور درنمی‌آید». با یک حلقه دنبال تکراری بگرد. اگر Sara و sara باید یکی حساب شوند، هر دو را با .lower() کوچک کن و بعد مقایسه کن.

from server import app, ask, request, abort

members = []

@app.post("/members")
def join():
    name = request.json["name"]
    for member in members:
        if member["name"].lower() == name.lower():
            abort(409, name + " is already taken")
    member = {"id": len(members) + 1, "name": name}
    members.append(member)
    return member, 201

ask("POST /members", {"name": "Sara"})
ask("POST /members", {"name": "sara"})
ask("POST /members", {"name": "Reza"})

abort با اولین اشکال متوقف می‌شود. اگر فرمی سه اشکال داشته باشد، کاربر باید سه بار بفرستد تا هر سه را بفهمد! راه بهتر: یک لیست خالی problems = [] بساز، هر بررسی اگر ایراد دید problems.append(...) کند و آخر کار اگر لیست خالی نبود، همه را یک‌جا با 400 برگردان: {"error": "bad data", "problems": [...]}. شکل {"error": ...} جلسه‌ی ۱۰ هم سر جایش می‌ماند. (if problems: یعنی «اگر لیست خالی نیست».)

from server import app, ask, request

@app.post("/signups")
def sign_up():
    data = request.json
    problems = []
    if not isinstance(data.get("name"), str):
        problems.append("name must be text")
    if not isinstance(data.get("age"), int):
        problems.append("age must be a whole number")
    elif not 10 <= data["age"] <= 18:
        problems.append("age must be 10 to 18")
    if problems:
        return {"error": "bad data", "problems": problems}, 400
    return {"name": data["name"], "age": data["age"]}, 201

ask("POST /signups", {"name": "Mina", "age": 14})
ask("POST /signups", {"age": 30})
ask("POST /signups", {"name": 5, "age": "ten"})

اشتباه‌های رایج:
- اندازه را پیش از نوع سنجیدن: len(42) خطای TypeError می‌دهد و سرور واقعی با 500 جواب می‌دهد. اول isinstance، بعد len (مثل elif بالا).
- data["name"] وقتی کلید شاید نیامده: KeyError. با in یا .get بپرس.
- کد غلط: جواب 200 با یک پیام خطا، 404 برای داده‌ی بد (404 یعنی «پیدا نشد»)، یا 400 برای تکراری (آن 409 است).
- پیام مبهم مثل "error": بگو چه چیزی غلط است و چه چیزی قبول است.
- isinstance(True, int) هم True است، چون در پایتون bool نوعی int است! برای «درست/غلط» همیشه bool را بپرس.

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

چالش‌ها

  1. Rename a Pet (آسان)
  2. How Many Texts? (آسان)
  3. Only Real Names (متوسط)
  4. Which Error Code? (متوسط)
  5. Join the Club (سخت)
  6. Every Problem at Once (سخت)

بیشتر بخوان

← جلسه‌ی 14: PUT، PATCH و DELETE جلسه‌ی 16: پروژه: API کارهای من →