جلسهی 8: پروژه: API فرهنگ لغت کلاس Project: The Class Dictionary API
پایان فاز دوم. پارامتر در مسیر، پرسش در آدرس و پیدا کردن چیزها در یک لیست را یک بار دیگر در یک نگاه میبینی، با یک یادآوری از کدهای وضعیت فاز اول. بعد پروژهی «API فرهنگ لغت کلاس»: سروری که همهی کلمهها را میدهد، معنی یک کلمه را با /words/<word> میگوید و با /search?q= جستوجو میکند.
در این جلسه یاد میگیری
- ایدههای جلسههای ۵ تا ۷ را مرور میکنی و اشتباههای رایجشان را میشناسی.
- کدهای وضعیت فاز اول را دوباره در جای درستشان به کار میبری.
- یک API کوچک با سه مسیر میسازی: همه، یکی با پارامتر مسیر، و جستوجو با پرسش.
- سرورت را در برابر ورودی بد مقاوم میکنی: حروف بزرگ، پرسش خالی و عددی که عدد نیست.
درس
🔐 قانون طلایی این دوره: سرور امانتدار است. هر سروری که میسازی دادهی آدمها را نگه میدارد: اسم، امتیاز، یادداشت، رمز. پس به هر چه از بیرون میآید شک کن، رمز را هیچوقت خام نگه ندار و دادهی کسی را به دیگری نشان نده. فقط سرورهای خودت را امتحان کن. سرور این دوره ساختگی است و داخل همین صفحه کار میکند: هر بار که برنامه را اجرا میکنی از صفر ساخته میشود، پس هر چه میخواهی امتحان کن.
📌 جلسهی ۵ در یک نگاه: پارامتر در آدرس. @app.get("/hello/<name>") یک تکه از مسیر را به آرگومانی به همان اسم میدهد: def hello(name):. همیشه متن است و فقط تا / بعدی. <int:n> عدد میدهد و برای abc خودش 404 میشود. یک مسیر چند پارامتر هم میتواند داشته باشد (/add/<int:a>/<int:b>)، و مقدار بد را با if و abort رد میکنی.
📌 جلسهی ۶ در یک نگاه: پرسش در آدرس. در /add?a=3&b=4 مسیر /add است و بعد از ? جفتهای key=value با & میآیند. request.args.get("a", "0") مقدار را با پیشفرض میدهد و همیشه متن است. int() عددش میکند و try: ... except ValueError: جلوی خراب شدن را میگیرد. چیزی که کم است یا غلط آمده: abort(400, "...").
from server import app, ask, request, abort
@app.get("/stars")
def stars():
try:
n = int(request.args.get("n", "3"))
except ValueError:
abort(400, "n must be a whole number")
return "*" * n
ask("GET /stars?n=6")
ask("GET /stars?n=six")📌 جلسهی ۷ در یک نگاه: پیدا کردن چیزها. داده در یک لیست از دیکشنریها در حافظه است، هر کدام با id. همه: حلقه و ", ".join(names). یکی: حلقه، return وقتی پیدا شد، و abort(404, ...) بعد از حلقه. جدا کردن: ?kind=cat و یک if در حلقه. شمردن: یک شمارنده یا len(...).
⚠️ اشتباههای رایج این بخش:
- اسم داخل <> با اسم آرگومان فرق دارد (<name> ولی def hello(n)).
- int: یا int() یادت میرود و "7" * 2 میشود "77"، "3" + "4" میشود "34".
- request.args["n"] بهجای .get(...)، که اگر نیامده باشد برنامه را میخواباند.
- int() بیرون از try.
- «پیدا نشد» در else داخل حلقه، بهجای بعد از حلقه.
- request را از server نیاوردن.
🔁 از فاز اول: کدهای وضعیت. هر جواب یک کد دارد: 2xx یعنی خوب بود (200 OK، 201 Created)، 4xx یعنی اشتباه از درخواستکننده (400 درخواست بد، 401 نمیدانیم کیستی، 403 اجازه نداری، 404 چنین چیزی نیست، 405 این روش اینجا نیست) و 5xx یعنی سرور خراب شد (500). return "...", 404 یک متن با کد میفرستد و abort(404, "...") جواب {"error": ...}. r.ok برای 2xx درست است.
from server import app, ask, abort
@app.get("/open")
def open_door():
return "Come in!"
@app.get("/closed")
def closed_door():
return "Sorry, closed today", 403
@app.get("/broken")
def broken_door():
abort(500, "the door is stuck")
for path in ["/open", "/closed", "/broken", "/nowhere"]:
r = ask("GET " + path, quiet=True)
print(path, r.status, r.ok)
ask("POST /open")📚 پروژه: API فرهنگ لغت کلاس. کلاس یک فرهنگ لغت کوچک از کلمههای بکاند میخواهد که هر کس با یک درخواست بتواند معنی کلمهای را بپرسد. کلمهها در لیست WORDS هستند، هر کدام یک دیکشنری با word و meaning. سه قدم:
1. GET /words همهی کلمهها، و GET /words/<word> معنی یک کلمه یا 404.
2. GET /search?q=... کلمههایی که q داخلشان هست، 400 برای پرسش خالی.
3. مقاوم کردن: حروف بزرگ (/words/Server) و یک limit عددی برای جستوجو.
هر قدم روی کد قدم قبل ساخته میشود؛ دکمهی «ادامه از کد مرحلهی قبلم» کدت را میآورد.
🧰 سه ابزار کوچک برای پروژه. "qu" in "query" میپرسد آیا یک متن داخل متن دیگری هست (True). "Server".lower() همهی حروف را کوچک میکند ("server")؛ اگر هم ورودی و هم داده کوچک باشند، حروف بزرگ دیگر مهم نیست. و names[:2] یعنی «دو عضو اول لیست»؛ اگر لیست کوتاهتر باشد، همهاش را میدهد و خطا نمیدهد.
print("qu" in "query")
print("qu" in "server")
print("Server".lower())
names = ["server", "client", "route"]
print(names[:2])
print(names[:10])مثالهای این جلسه
- مثال مدیریت خطا با try (بکاند با پایتون): try: — پروژه: API فرهنگ لغت کلاس
- مثال تابع (بکاند با پایتون): def open_door():
- مثال لیست (بکاند با پایتون): names = ["server", "client", "route"]
چالشها
- Does It Match? (آسان)
- Six or six? (آسان)
- Whose Mistake? (متوسط)
- Step 1: Every Word and One Word (متوسط)
- Step 2: Search (سخت)
- Step 3: Capitals and a Limit (سخت)