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

جلسه‌ی 5: پارامتر در آدرس Path Parameters

یک مسیر برای هزار آدرس: با <name> تکه‌ای از آدرس به تابع می‌رسد و با <int:id> به شکل عدد. دو پارامتر در یک مسیر، بررسی مقدار با abort، و اینکه چرا /square/abc خودبه‌خود 404 می‌گیرد.

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

درس

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

یادت هست؟ در جلسه‌ی ۲ با @app.get("/") یک تابع را به یک آدرس بستیم و متن برگرداندیم. در جلسه‌ی ۳ دیدیم abort(403, "...") درخواست را همان‌جا با یک کد وضعیت تمام می‌کند و جواب {"error": ...} می‌دهد، و آدرسی که مسیری ندارد 404 می‌گیرد. «خودت امتحان کن» را بزن و هر سه را ببین.

from server import app, ask, abort

@app.get("/")
def home():
    return "Welcome to the class server!"

@app.get("/secret")
def secret():
    abort(403, "teachers only")

ask("GET /")
ask("GET /secret")
ask("GET /homework")

فرض کن می‌خواهی /hello/Sara بگوید «سلام سارا» و /hello/Ali بگوید «سلام علی». سی هم‌کلاسی داری؛ سی تابع بنویسی؟ نه! در مسیر به‌جای اسم یک جای خالی بگذار: @app.get("/hello/<name>"). هر چه در آن تکه از آدرس بیاید، به اسم name به تابع می‌رسد؛ پس تابع باید آرگومانی به همین اسم داشته باشد: def hello(name):. به این جای خالی پارامتر مسیر (path parameter) می‌گویند.

from server import app, ask

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

ask("GET /hello/Sara")
ask("GET /hello/Ali")
ask("GET /hello/Mina")

سه نکته درباره‌ی <name>: (۱) چیزی که می‌رسد همیشه متن است. (۲) فقط یک تکه از آدرس را می‌گیرد، یعنی تا / بعدی؛ پس /profile/Kian/photos به این مسیر نمی‌خورد و 404 می‌گیرد. (۳) تکه نمی‌تواند خالی باشد: /profile/ هم 404 است. سایت‌های واقعی پر از این‌اند: صفحه‌ی هر کاربر، هر محصول یا هر ویدیو یک مسیر با پارامتر است.

from server import app, ask

@app.get("/profile/<username>")
def profile(username):
    return f"This is the page of {username}. Name length: {len(username)}"

ask("GET /profile/Kian")
ask("GET /profile/Kian/photos")
ask("GET /profile/")

اگر عدد لازم داری، بنویس <int:n>. حالا n یک عدد صحیح واقعی (int) است و می‌شود با آن حساب کرد. بهتر از آن: اگر کسی به‌جای عدد چیز دیگری بفرستد (/square/abc)، این مسیر اصلاً به آن نمی‌خورد و سرور خودش 404 می‌دهد؛ لازم نیست خودت بررسی کنی.

from server import app, ask

@app.get("/square/<int:n>")
def square(n):
    return f"{n} x {n} = {n * n}"

ask("GET /square/7")
ask("GET /square/12")
ask("GET /square/abc")

یک مسیر می‌تواند چند پارامتر داشته باشد: /add/<int:a>/<int:b> دو عدد می‌گیرد و /team/<team>/player/<name> یک تیم و یک بازیکن. هر پارامتر به اسم خودش می‌رسد، پس ترتیب آرگومان‌های تابع مهم نیست؛ فقط اسم‌ها باید با اسم‌های داخل <> یکی باشند.

from server import app, ask

@app.get("/add/<int:a>/<int:b>")
def add(a, b):
    return f"{a} + {b} = {a + b}"

@app.get("/team/<team>/player/<name>")
def player(name, team):
    return f"{name} plays for the {team} team"

ask("GET /add/3/4")
ask("GET /team/red/player/Sara")

<int:...> فقط می‌گوید «عدد باشد»، نه «عدد درستی باشد». مدرسه‌ی ما فقط کلاس ۷ تا ۹ دارد، پس /grade/12 باید خطا بدهد. اینجا همان abort جلسه‌ی ۳ به کار می‌آید: مقدار را با if بررسی کن و اگر بد بود، abort(404, "..."). یادت باشد عدد منفی هم عدد است: /grade/-3 هم به این مسیر می‌خورد.

from server import app, ask, abort

@app.get("/grade/<int:g>")
def grade(g):
    if g < 7 or g > 9:
        abort(404, f"our school has no grade {g}")
    return f"Welcome to grade {g}!"

ask("GET /grade/8")
ask("GET /grade/12")
ask("GET /grade/-3")

اشتباه رایج: یادت برود int: بنویسی. آن‌وقت n متن است و n * 2 برای "7" می‌شود "77" (متن دو بار پشت هم)، نه ۱۴. خطا نمی‌دهد ولی جواب غلط است؛ «خودت امتحان کن» را بزن. اشتباه دوم: اسم داخل <> با اسم آرگومان فرق کند:
``
@app.get("/hello/<name>")
def hello(n):
`
این خطای
got an unexpected keyword argument 'name' می‌دهد، چون سرور name` را می‌فرستد و تابع چنین آرگومانی ندارد.

from server import app, ask

@app.get("/double/<n>")
def double(n):
    return f"double of {n} is {n * 2}"

ask("GET /double/7")

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

چالش‌ها

  1. No Such Route (آسان)
  2. Hi, Anyone (آسان)
  3. Hours to Minutes (متوسط)
  4. Three Times What? (متوسط)
  5. Scores in the Address (سخت)
  6. Same Grade? (سخت)

بیشتر بخوان

← جلسه‌ی 4: پروژه: سرور اطلاعات کلاس جلسه‌ی 6: پرسش در آدرس →