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

جلسه‌ی 9: JSON: زبان APIها JSON: The Language of APIs

وقتی یک route دیکشنری یا لیست برمی‌گرداند، سرور آن را به متنی به اسم JSON تبدیل می‌کند و می‌فرستد. JSON زبان مشترک همه‌ی APIهاست. با json.dumps و json.loads خودت این تبدیل را انجام می‌دهی، فرق‌های کوچک JSON با پایتون (true، null، کلیدهای متنی) را می‌شناسی، JSON تودرتو می‌سازی و در سمت مشتری با r.json می‌خوانی‌اش.

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

درس

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

یادت هست؟ در جلسه‌ی ۷ حیوان‌های خانگی را در یک لیست از دیکشنری‌ها نگه داشتیم. route GET /pets/<int:pet_id> روی لیست می‌چرخید، حیوان پیدا‌شده را برمی‌گرداند و اگر نبود abort(404, ...) می‌کرد. ask جواب را این‌طوری چاپ می‌کرد: {"id": 2, "name": "Max", "kind": "dog"}. این متنِ چاپ‌شده اسم دارد: JSON. امروز می‌فهمیم چیست.

from server import app, ask, abort

pets = [
    {"id": 1, "name": "Pishi", "kind": "cat"},
    {"id": 2, "name": "Max", "kind": "dog"},
]

@app.get("/pets/<int:pet_id>")
def one_pet(pet_id):
    for pet in pets:
        if pet["id"] == pet_id:
            return pet
    abort(404, "no such pet")

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

JSON (بخوانید «جِیسون»، کوتاه‌شده‌ی JavaScript Object Notation) راهی است برای نوشتن داده به شکل متن، طوری که هر برنامه‌ای با هر زبانی بتواند بخواندش. سرور با پایتون، سایت با جاوااسکریپت، اپ گوشی با زبانی دیگر: همه JSON بلدند. پشت شبکه فقط متن می‌رود، پس وقتی route تو دیکشنری یا لیست برمی‌گرداند، سرور اول آن را به متن JSON تبدیل می‌کند. JSON خیلی شبیه دیکشنری پایتون است، با سه فرق کوچک: True و False می‌شوند true و false، None می‌شود null، و متن همیشه داخل "..." (کوتیشن دوتایی) است.

from server import app, ask

@app.get("/me")
def me():
    return {"name": "Sara", "level": 7, "online": True, "banned": False, "pet": None, "badges": ["gold", "speed"]}

ask("GET /me")

پایتون جعبه‌ابزار JSON خودش را دارد: import json. json.dumps(data) (بخوان dump-s؛ s یعنی string، متن) یک دیکشنری یا لیست را به متن JSON تبدیل می‌کند. سرور ما قبل از فرستادن جواب همین کار را می‌کند. نتیجه فقط یک متن است: می‌شود len آن را گرفت یا حرف اولش را دید، ولی دیگر نمی‌شود text["name"] نوشت.

import json

player = {"name": "Ali", "online": True, "clan": None}
text = json.dumps(player)
print(text)
print(len(text), "characters")
print(text[0])

json.loads(text) (load-s) برعکس است: متن JSON را به دیکشنری یا لیست پایتون برمی‌گرداند تا بتوانی data["name"] بنویسی. true دوباره True می‌شود و null می‌شود None. وقتی داده از بیرون می‌رسد (از یک اپ، از یک فایل ذخیره‌شده) اول متن است، پس اول loads. متن JSON را در پایتون داخل '...' می‌گذاریم تا کوتیشن‌های دوتایی داخلش راحت بمانند. دو کمک‌کار پایتون هم به درد می‌خورند: max(list) بزرگ‌ترین عدد یک لیست و sum(list) جمع همه‌ی عددهایش را می‌دهد.

import json

text = '{"name": "Mina", "level": 9, "online": true, "pet": null, "scores": [12, 30, 18]}'
data = json.loads(text)
print(data["name"], "is level", data["level"])
print(data["online"], data["pet"])
print("best:", max(data["scores"]), "total:", sum(data["scores"]))

JSON می‌تواند تودرتو باشد: داخل یک دیکشنری، دیکشنری دیگر یا لیستی از دیکشنری‌ها، هر قدر که بخواهی. یک کلاس یک معلم دارد (یک دیکشنری) و چند دانش‌آموز (لیستی از دیکشنری‌ها). برای رسیدن به داخل، کروشه‌ها را پشت هم بنویس: data["teacher"]["name"] یا data["students"][0]["name"]. route هم می‌تواند متغیرهای دیگر را داخل جوابش بگذارد: {"teacher": teacher}.

from server import app, ask

teacher = {"name": "Omid", "subject": "math"}

@app.get("/class")
def my_class():
    return {
        "name": "8B",
        "teacher": teacher,
        "students": [{"name": "Sara", "age": 13}, {"name": "Kian", "age": 14}],
    }

ask("GET /class")

حالا سمت مشتری. در جلسه‌ی ۱ نوشتی r = ask(..., quiet=True) و بعد r.json["temp"]. حالا می‌دانی چه شد: سرور متن JSON فرستاد (آن متن در r.text هست) و ask خودش json.loads را برایت انجام داد، پس r.json یک دیکشنری یا لیست واقعی پایتون است. اگر جواب متن ساده باشد و JSON نباشد، r.json برابر None است.

from server import app, ask

@app.get("/class")
def my_class():
    return {"name": "8B", "teacher": {"name": "Omid", "subject": "math"}, "students": ["Sara", "Kian", "Leila"]}

r = ask("GET /class", quiet=True)
print(r.text)
print(r.json["teacher"]["name"])
print(r.json["students"][0])
print(len(r.json["students"]), "students")

اشتباه‌های رایج:
- در JSON کلیدها همیشه متن‌اند. {1: "Mina"} بعد از رفتن و برگشتن می‌شود {"1": "Mina"}، پس data[1] خطای KeyError می‌دهد و باید data["1"] بنویسی (یا data[str(n)]).
- در کد پایتون True و None بنویس؛ true و null فقط داخل متن JSON‌اند. true در کد پایتون خطای NameError می‌دهد.
- متن JSON فقط کوتیشن دوتایی دارد: {'name': 'Ali'} JSON نیست و json.loads خطا می‌دهد. این خطا از خانواده‌ی ValueError است، پس با try/except ValueError (جلسه‌ی ۶) می‌گیریش.

import json

places = {1: "Mina", 2: "Yasmin"}
text = json.dumps(places)
print(text)
back = json.loads(text)
print(back["1"])

try:
    json.loads("{'name': 'Ali'}")
except ValueError:
    print("That is not JSON: JSON needs double quotes")

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

چالش‌ها

  1. Find One Pet (آسان)
  2. True and None (آسان)
  3. What Does dumps Give? (متوسط)
  4. Read a JSON Text (متوسط)
  5. A Nested Class (سخت)
  6. The Podium (سخت)

بیشتر بخوان

← جلسه‌ی 8: پروژه: API فرهنگ لغت کلاس جلسه‌ی 10: طراحی یک API خوب →