الوثائق/Python واجهة برمجة التطبيقات والأخطاء

الاستثناءات والأخطاء

يمكن أن يفشل الطلب في أربعة أماكن، ويجيب 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، لذلك يستمر العملاء ومجموعات SDK التي تم إنشاؤها في العمل:

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

بالنسبة للنموذج أو الإجراء، يتلقى العميل ActionError مع status و detail؛ يقوم 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. تحقق من العمق. يعمل notfound.nexy أو errors.nexy فقط عند وجود النسخة الجذرية.
5. اطلب JSON مع Accept: application/json لمعرفة الشكل الذي يتلقاه عميل API الخاص بك.
6. اقتبس المرجع من 500 عندما تفتح مشكلة أو تبحث في السجل.

الخطوات التالية

• صفحات الخطأ: سلوك الصفحة بالكامل مع الأمثلة
• التحقق من الصحة والأخطاء: معالجات API
• استكشاف الأخطاء وإصلاحها: الأخطاء التي وقع فيها الأشخاص بالفعل
• اختبار: تأكيد الحالة والجسم

انسخ الصفحة بصيغة Markdown حرِّر على GitHub