ডকুমেন্টেশন/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-এর আদর্শ আকৃতি, তাই ক্লায়েন্ট এবং জেনারেট করা 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. আপনার API ক্লায়েন্ট প্রাপ্ত আকৃতি দেখতে Accept: application/json সহ JSON এর জন্য জিজ্ঞাসা করুন।
6. আপনি একটি সমস্যা খুললে বা লগ অনুসন্ধান করার সময় একটি 500 এর রেফারেন্স উদ্ধৃত করুন।

পরবর্তী পদক্ষেপ

• ত্রুটি পৃষ্ঠাগুলি: সম্পূর্ণ পৃষ্ঠার আচরণ, উদাহরণ সহ
• বৈধতা এবং ত্রুটি: API হ্যান্ডলার
• ট্রাবলশুটিং: মানুষ আসলে যে ত্রুটিগুলি আঘাত করে
• টেস্টিং : একটি স্ট্যাটাস এবং একটি শরীর জাহির করুন

পাতাটি Markdown হিসেবে কপি করুন GitHub-এ সম্পাদনা করুন