دستاویزات/Python API اور غلطیاں

مستثنیات اور غلطیاں

ایک درخواست چار جگہوں پر ناکام ہو سکتی ہے، اور Nexy ہر ایک کو مختلف طریقے سے جواب دیتا ہے۔ یہ صفحہ انڈیکس ہے: وہ اسٹیٹس تلاش کریں جو آپ دیکھتے ہیں، پھر وہ لائن جس نے اسے بنایا، پھر وہ فائل جو باڈی کا فیصلہ کرتی ہے۔

مختصر ورژن

ایک API کلائنٹ ایک درخواست ہے جس کی Accept ہیڈر JSON کے لیے پوچھتا ہے نہ کہ کسی صفحہ کے لیے:

curl -H "Accept: application/json" http://localhost:3000/api/items/500# {"detail":"Out of range"}

ناکامی کہاں سے آتی ہے۔

Browser ──► Middleware ──► Router ──► Page or handler
                 │            │             │
                 │            │             ├─ return ───────────► 200
                 │            │             ├─ HTTPException ────► its status
                 │            │             └─ other exception ───► 500
                 │            └─ no match ────────────────────────► 404
                 └─ raises ──────────────────────────────────────► 500

کہیں سے بھی چلے جائیں۔

redirect، permanentRedirect، notFound، forbidden اور unauthorized ایک HTTP استثنیٰ کو بڑھاتے ہیں، لہذا وہی کال ایک .nexy صفحہ، ایک API ہینڈلر، ایک ماڈیولر کنٹرولر، ایک گارڈ، ایک dependencies.py اور ایک کارروائی میں کام کرتی ہے۔

from nexy import notFound, redirect from src.posts import find  async def GET(slug: str):    post = find(slug)    if post is None:        notFound("No such post")    if post.moved_to:        redirect(post.moved_to)    return post

from nexy import notFound, redirectfrom nexy.decorators import Controller from src.posts import find  @Controller("/posts/{slug}")class PostsBySlugController:    async def get(self, slug: str):        post = find(slug)        if post is None:            notFound("No such post")        if post.moved_to:            redirect(post.moved_to)        return post

ان اقدار سے منزل کی تعمیر کریں جن پر آپ اعتماد کرتے ہیں۔ redirect(request.query_params["next"]) جہاں بھی لنک کہتا ہے وہاں زائرین بھیجتا ہے۔ یہ ایک کھلا ری ڈائریکٹ ہے۔ ایک منزل جس میں لائن بریک ہو اسے مسترد کر دیا جاتا ہے۔

توثیق: 422، یا 404

ہینڈلر پیرامیٹرز کو ان کی تشریحات کے خلاف FastAPI کے ذریعہ توثیق کیا جاتا ہے۔

from nexy.http import Header  async def GET(q: str, limit: int = 10, x_token: str = Header(...)):    return {"q": q, "limit": limit}

from nexy.decorators import Controllerfrom nexy.http import Header  @Controller("/api/search")class SearchApiController:    async def get(self, q: str, limit: int = 10, x_token: str = Header(...)):        return {"q": q, "limit": limit}

422 باڈی FastAPI کی معیاری شکل ہے، لہذا کلائنٹ اور تیار کردہ SDKs کام کرتے رہتے ہیں:

{"detail": [{"loc": ["query", "q"], "msg": "Field required", "type": "missing"}]}

کسی فارم یا ایکشن کے لیے، کلائنٹ کو status اور detail کے ساتھ ایک ActionError ملتا ہے؛ a 422 بھی error.fields کو فی فیلڈ ایک پیغام کے ساتھ بھرتا ہے۔ دیکھیں اعمال۔

حسب ضرورت خرابی والے صفحات

<h1>Page not found</h1><p>The link may be old. <a href="/">Start from the home page</a>.</p>

<h1>Something went wrong</h1><p>Try again in a moment.</p>

غیر ہینڈل شدہ مستثنیات

ایک استثناء ہے کہ پکڑی گئی کوئی بھی چیز ایک بار لاگ ان نہیں ہوتی ہے، اس کے حوالہ کے ساتھ، یہ کہاں سے آیا ہے اور اس کے ارد گرد کوڈ۔ حیثیت 500 ہے، اور جسم کا انحصار ماحول پر ہے۔

  x ZeroDivisionError: division by zero  GET /boom  ref fe6a5217    at src/routes/boom.py:2 in GET       1 | def GET():       2 |     return {"a": 1 / 0}

حوالہ آٹھ حروف ہے، ہر ناکامی کے لیے نیا۔ ایک وزیٹر اس کا حوالہ دے سکتا ہے، اور آپ اس کے لیے لاگ کو تلاش کر کے ٹریس بیک تلاش کر سکتے ہیں۔ پیداوار میں نہ تو استثناء اور نہ ہی کوڈ وزیٹر تک پہنچتا ہے۔

اعمال اور شکلیں۔

ایک عمل ایک POST اختتامی نقطہ ہے جس میں پیدا شدہ راستہ ہے۔ اس کی ناکامیاں انہی اصولوں پر عمل کرتی ہیں:

ایک فارم بغیر JavaScript ایکشن پاتھ پر پوسٹ کرتا ہے۔ ایک کامیابی صفحہ پر واپس 303 جواب دیتی ہے، ناکامی غلطی کا صفحہ دکھاتی ہے۔ دیکھیں اعمال۔

ایک چیک لسٹ جب ایک صفحہ غلط چیز کا جواب دیتا ہے۔

1. حالت دیکھو صفحہ کو نہیں۔ ایک رواج notfound.nexy اب بھی جواب دیتا ہے 404۔
2. پڑھیں ٹرمینل ایک صفحہ جو درآمد کرنے میں ناکام ہوتا ہے وہ رجسٹرڈ نہیں ہوتا، اس لیے اس کا URL جواب دیتا ہے 404 جب کہ فائل موجود ہے۔ درآمد کی خرابی لاگ میں ہے۔
3. چیک کریں۔ توسیع useCSR = True کے ساتھ، .nexy صفحات کا تعلق سرور موڈ سے ہے۔ غلط موڈ میں ایک صفحہ ایک راستہ نہیں ہے.
4. چیک کریں۔ گہرائی A notfound.nexy یا errors.nexy صرف اس وقت کام کرتا ہے جب روٹ کاپی موجود ہو۔
5. آپ کے API کلائنٹ کو موصول ہونے والی شکل دیکھنے کے لیے Accept: application/json کے ساتھ JSON کے لیے پوچھیں۔
6. جب آپ کوئی مسئلہ کھولتے ہیں یا لاگ کو تلاش کرتے ہیں تو 500 کا حوالہ دیں۔

اگلے اقدامات

• خرابی کے صفحات: پورے صفحے کا برتاؤ، مثالوں کے ساتھ
• توثیق اور غلطیاں: API ہینڈلرز
• ٹربل شوٹنگ: وہ غلطیاں جو لوگ اصل میں مارتے ہیں۔
• ٹیسٹنگ : ایک حیثیت اور جسم پر زور دیں۔

صفحہ Markdown کے طور پر کاپی کریں GitHub پر ترمیم کریں