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

جلسه‌ی 6: پرسش در آدرس Query Strings

بخش بعد از ? در آدرس (?city=Tehran&n=3) با request.args.get(...) به سرور می‌رسد و همیشه متن است. با int() عددش می‌کنی، با try/except ValueError جلوی خراب شدن را می‌گیری و برای چیزی که نیامده یا غلط آمده 400 برمی‌گردانی.

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

درس

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

یادت هست؟ در جلسه‌ی ۵ با <name> یک تکه از مسیر را به تابع دادیم. در جلسه‌ی ۱ هم از سایت ساختگی هواشناسی پرسیدیم: https://weather.test/today?city=Shiraz. آن ?city=Shiraz چه بود؟ مسیر نبود؛ یک پرسش بود که به آدرس چسبیده بود. امروز یاد می‌گیریم سرور خودمان چطور این پرسش‌ها را بخواند.

from server import app, ask

@app.get("/hello/<name>")
def hello(name):
    return f"Hello, {name}!"

ask("GET /hello/Leila")
ask("https://weather.test/today?city=Shiraz")

در /greet?name=Sara&color=blue، مسیر فقط /greet است. بعد از ? «رشته‌ی پرسش» (query string) می‌آید: چند جفت key=value که با & از هم جدا شده‌اند. مسیر را مثل قبل با @app.get("/greet") می‌سازی و پرسش داخل request.args است: یک دیکشنری که request را باید از server بیاوری. با request.args.get("name", "friend") مقدار name را می‌گیری، و اگر نیامده بود همان پیش‌فرض "friend" را. خط args: را print داخل تابع چاپ می‌کند؛ برای همین پیش از خط ask می‌آید: اول تابع اجرا می‌شود، بعد جواب چاپ می‌شود.

from server import app, ask, request

@app.get("/greet")
def greet():
    print("args:", request.args)
    name = request.args.get("name", "friend")
    return f"Hello, {name}!"

ask("GET /greet?name=Sara")
ask("GET /greet")
ask("GET /greet?name=Ali&color=blue")

بعضی وقت‌ها بدون یک مقدار کاری نمی‌شود کرد: هواشناسی بدون اسم شهر جوابی ندارد. آن‌وقت request.args.get("city") را بدون پیش‌فرض بنویس؛ اگر نیامده باشد None (هیچ) می‌دهد. if not city: هم برای None درست است و هم برای ?city= خالی. جواب درست برای «چیزی کم است» 400 Bad Request است، با یک پیام که بگوید چه کم است. از request.args["city"] استفاده نکن: اگر نباشد، برنامه با KeyError می‌ایستد.

from server import app, ask, request, abort

@app.get("/weather")
def weather():
    city = request.args.get("city")
    if not city:
        abort(400, "add ?city=... to the address")
    return f"I will look up the weather in {city}"

ask("GET /weather?city=Rasht")
ask("GET /weather")
ask("GET /weather?city=")

هر چه در request.args است همیشه متن است، حتی ?n=5. برای حساب کردن با int(...) عددش کن. برای همین مقدار پیش‌فرض را هم متن بنویس ("3"، نه 3) تا هر دو حالت از یک راه بگذرند. print(type(n)) در کد زیر نشان می‌دهد چه رسیده: <class 'str'> یعنی متن.

from server import app, ask, request

@app.get("/stars")
def stars():
    n = request.args.get("n", "3")
    print(type(n))
    n = int(n)
    return "*" * n

ask("GET /stars?n=5")
ask("GET /stars")

اگر کسی بفرستد ?n=abc چه؟ int("abc") خطای ValueError می‌دهد و برنامه می‌ایستد. پایتون راهی برای «امتحان کن، اگر نشد کار دیگری کن» دارد: try/except. کدی که ممکن است خطا بدهد زیر try: می‌آید. اگر داخلش ValueError پیش بیاید، پایتون به‌جای ایستادن می‌پرد به except ValueError: و کد آنجا را اجرا می‌کند. اگر خطایی نباشد، بخش except اصلاً اجرا نمی‌شود.

for text in ["12", "abc", "7", "3.5"]:
    try:
        n = int(text)
        print(text, "is the whole number", n)
    except ValueError:
        print(text, "is not a whole number")

حالا در سرور: int(...) را زیر try: بگذار و در except ValueError: با abort(400, "...") جواب بده. این درست همان کاری است که game.test/top?n=... در جلسه‌ی ۱ می‌کرد. چند پارامتر هم با & می‌آیند و ترتیبشان مهم نیست: ?a=3&b=4 و ?b=4&a=3 یکی‌اند، چون هر مقدار را با اسمش می‌گیری.

from server import app, ask, request, abort

@app.get("/add")
def add():
    try:
        a = int(request.args.get("a", "0"))
        b = int(request.args.get("b", "0"))
    except ValueError:
        abort(400, "a and b must be whole numbers")
    return f"{a} + {b} = {a + b}"

ask("GET /add?a=3&b=4")
ask("GET /add?b=10&a=5")
ask("GET /add?a=3&b=four")

اشتباه رایج: int() یادت برود. آن‌وقت a + b برای "3" و "4" می‌شود "34": دو متن پشت هم چسبیده‌اند. خطا نمی‌دهد، فقط جواب غلط است؛ امتحانش کن. دو اشتباه دیگر: request.args["a"] که اگر a نیامده باشد برنامه را می‌خواباند، و int() بیرون از try، که برای ?a=x به‌جای 400 کل برنامه را با ValueError نگه می‌دارد.

from server import app, ask, request

@app.get("/add")
def add():
    a = request.args.get("a", "0")
    b = request.args.get("b", "0")
    return f"{a} + {b} = {a + b}"

ask("GET /add?a=3&b=4")

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

چالش‌ها

  1. A Number in the Path (آسان)
  2. Welcome, Guest (آسان)
  3. Draw a Line (متوسط)
  4. Twelve Plus Thirty (متوسط)
  5. How Old? (سخت)
  6. Celsius or Fahrenheit (سخت)

بیشتر بخوان

← جلسه‌ی 5: پارامتر در آدرس جلسه‌ی 7: پیدا کردن چیزها →