Coverage for docs_src/tutorial/fastapi/limit_and_offset/tutorial001.py: 100%

43 statements  

« prev     ^ index     » next       coverage.py v7.17.2, created at 2026-11-16 00:02 +0000

1from typing import Annotated 1abcdefghijklm

2 

3from fastapi import FastAPI, HTTPException, Query 1abcdefghijklm

4from sqlmodel import Field, Session, SQLModel, create_engine, select 1abcdefghijklm

5 

6 

7class HeroBase(SQLModel): 1abcdefghijklm

8 name: str = Field(index=True) 1abcdefghijklm

9 secret_name: str 1abcdefghijklm

10 age: int | None = Field(default=None, index=True) 1abcdefghijklm

11 

12 

13class Hero(HeroBase, table=True): 1abcdefghijklm

14 id: int | None = Field(default=None, primary_key=True) 1abcdefghijklm

15 

16 

17class HeroCreate(HeroBase): 1abcdefghijklm

18 pass 1abcdefghijklm

19 

20 

21class HeroPublic(HeroBase): 1abcdefghijklm

22 id: int 1abcdefghijklm

23 

24 

25sqlite_file_name = "database.db" 1abcdefghijklm

26sqlite_url = f"sqlite:///{sqlite_file_name}" 1abcdefghijklm

27 

28connect_args = {"check_same_thread": False} 1abcdefghijklm

29engine = create_engine(sqlite_url, echo=True, connect_args=connect_args) 1abcdefghijklm

30 

31 

32def create_db_and_tables(): 1abcdefghijklm

33 SQLModel.metadata.create_all(engine) 1nopqrstuvwxyz

34 

35 

36app = FastAPI() 1abcdefghijklm

37 

38 

39@app.on_event("startup") 1abcdefghijklm

40def on_startup(): 1abcdefghijklm

41 create_db_and_tables() 1nopqrstuvwxyz

42 

43 

44@app.post("/heroes/", response_model=HeroPublic) 1abcdefghijklm

45def create_hero(hero: HeroCreate): 1abcdefghijklm

46 with Session(engine) as session: 1nopqrstuvwxyz

47 db_hero = Hero.model_validate(hero) 1nopqrstuvwxyz

48 session.add(db_hero) 1nopqrstuvwxyz

49 session.commit() 1nopqrstuvwxyz

50 session.refresh(db_hero) 1nopqrstuvwxyz

51 return db_hero 1nopqrstuvwxyz

52 

53 

54@app.get("/heroes/", response_model=list[HeroPublic]) 1abcdefghijklm

55def read_heroes(offset: int = 0, limit: Annotated[int, Query(le=100)] = 100): 1abcdefghijklm

56 with Session(engine) as session: 1nopqrstuvwxyz

57 heroes = session.exec(select(Hero).offset(offset).limit(limit)).all() 1nopqrstuvwxyz

58 return heroes 1nopqrstuvwxyz

59 

60 

61@app.get("/heroes/{hero_id}", response_model=HeroPublic) 1abcdefghijklm

62def read_hero(hero_id: int): 1abcdefghijklm

63 with Session(engine) as session: 1nopqrstuvwxyz

64 hero = session.get(Hero, hero_id) 1nopqrstuvwxyz

65 if not hero: 1nopqrstuvwxyz

66 raise HTTPException(status_code=404, detail="Hero not found") 1nopqrstuvwxyz

67 return hero 1nopqrstuvwxyz