Loyihani yakunlash

Loyiha strukturasi, settings (.env), exception handler, CORS, Swagger/ReDoc hujjati, testlar, alembic upgrade

10-sinfAdvanced Python Back-end6-hafta · 17-dars

Bugun nimalarni o'rganamiz?

Struktura va sozlamalar

Settings va .env

Xatolar va CORS

Bir xil format

Hujjat, test, migratsiya

Yakuniy tekshiruv

Takrorlash

Fayl hajmi chegaradan oshsa qaysi status?

413 — Payload Too Large.

Struktura va sozlamalar

Settings va .env

Sozlamalar yo'li

Settings sinfi


from pydantic_settings import BaseSettings, SettingsConfigDict


class Settings(BaseSettings):
    app_name: str = "Book API"
    debug: bool = False
    database_url: str = "sqlite+aiosqlite:///./dev.db"
    cors_origins: list[str] = ["http://localhost:3000"]

    model_config = SettingsConfigDict(env_file=".env")


settings = Settings()

.env da DEBUG=true yoki CORS_ORIGINS=["https://sayt.uz"] kabi yoziladi. Maxfiy qiymatlar kodda va GitHub da bo'lmasin.

Mini-test

.env fayli GitHub ga yuboriladimi?

Maxfiy qiymatlar repozitoriyga tushmasligi kerak.

Xatolar va CORS

Bir xil format

Xato javobi

Handler va CORS


app.add_middleware(
    CORSMiddleware,
    allow_origins=settings.cors_origins,
    allow_methods=["*"],
    allow_headers=["*"],
)

@app.exception_handler(HTTPException)
async def http_error(request: Request, exc: HTTPException):
    return JSONResponse(
        status_code=exc.status_code,
        content={"error": {"status": exc.status_code, "message": exc.detail}},
    )

Validatsiya xatosi uchun ham (RequestValidationError) shunday handler yozing va 422 qaytaring.

Mini-test

CORS nima uchun kerak?

Brauzer boshqa origin so'rovlarini cheklaydi, CORS ruxsat beradi.

Hujjat, test, migratsiya

Yakuniy tekshiruv

Testlar


from fastapi.testclient import TestClient
from app.main import app

client = TestClient(app)


def test_health():
    r = client.get("/health")
    assert r.status_code == 200
    assert r.json() == {"status": "ok"}


def test_not_found_format():
    r = client.get("/books/5")
    assert r.status_code == 404
    assert r.json()["error"]["message"] == "Kitob topilmadi"

Terminalda pytest -q va alembic upgrade head. alembic current joriy migratsiyani ko'rsatadi.

Mini-test

alembic upgrade head nima qiladi?

Barcha migratsiyalarni oxirigacha qo'llaydi.

Kod ichida va .env da sozlama

Kod ichida

Parol repozitoriyga tushadi, muhit almashtirish qiyin

`.env`

Maxfiy, muhitga mos, .env.example bilan

Sozlamalarni doim .env da saqlang.

Atamalar. Bosing

Settings

bosing

Sozlamalarni .env dan o'quvchi sinf

CORS

bosing

Boshqa manzildan so'rovga ruxsat siyosati

exception handler

bosing

Xatoni bir xil javobga aylantiruvchi funksiya

alembic

bosing

Baza migratsiyalari vositasi

Loyihani yakunlash

1. Tartiblang

Struktura va Settings.

2. Mustahkamlang

Xato formati va CORS.

3. Tekshiring

pytest va alembic.

Yakuniy checklist

Tekshiruv	Buyruq yoki joy	Natija
Testlar	`pytest -q`	hammasi yashil
Migratsiya	`alembic upgrade head`	xatosiz
Hujjat	`/docs`, `/redoc`	to'g'ri tavsif
Maxfiylik	`.gitignore`	`.env` yo'q
README	ishga tushirish	yo'riqnoma bor

Pastga bosing: checklist

Settings qo'shish

pip install pydantic-settings ni bajaring.
Settings sinfini yozing va .env yarating.
settings.database_url ni bazani ulashda ishlating.

Maxfiylik xatosi


SECRET = "abc123"

Maxfiylik xatosi


SECRET = settings.secret_key

Yakuniy loyiha raqamlarda

ta xato: HTTPException, validatsiya, umumiy

ta test: health, 404, 422

ta komanda: alembic upgrade head

Yakunlash — kod ishlaydi va boshqalar uni ishga tushira oladi.

Amaliy topshiriq 20 daqiqa

OsonSettings: app_name va debug maydonli Settings yozing.

Oson.env.example: Maxfiy qiymatsiz .env.example namunasini yozing.

O'rtaHandler: 404 xatosini {"error": ...} formatida qaytaring.

O'rtaCORS: Faqat http://localhost:3000 ga ruxsat bering.

QiyinTest: /health uchun test yozing.

BonusHujjat: Swagger da endpointlarni tags bilan guruhlang.

Dars xulosasi

Sozlamalar

.env va Settings; GitHub ga yubormang.

Xato va CORS

Bir xil JSON, kerakli origin lar.

Tekshiruv

pytest, alembic upgrade head, Swagger.

Uyga vazifa: Loyihani yakunlash.

Keyingi dars: Docker orqali deploy

Dockerfile va compose

6-hafta · 18-dars