Coverage for docs_src / tutorial / fastapi / session_with_dependency / tutorial001_py310.py: 100%

1from fastapi import Depends, FastAPI, HTTPException, Query 9 ctx1abcdefghi

2from sqlmodel import Field, Session, SQLModel, create_engine, select 9 ctx1abcdefghi

3 

4 

5class HeroBase(SQLModel): 9 ctx1abcdefghi

6 name: str = Field(index=True) 9 ctx1abcdefghi

7 secret_name: str 9 ctx1abcdefghi

8 age: int | None = Field(default=None, index=True) 9 ctx1abcdefghi

9 

10 

11class Hero(HeroBase, table=True): 9 ctx1abcdefghi

12 id: int | None = Field(default=None, primary_key=True) 9 ctx1abcdefghi

13 

14 

15class HeroCreate(HeroBase): 9 ctx1abcdefghi

16 pass 9 ctx1abcdefghi

17 

18 

19class HeroPublic(HeroBase): 9 ctx1abcdefghi

20 id: int 9 ctx1abcdefghi

21 

22 

23class HeroUpdate(SQLModel): 9 ctx1abcdefghi

24 name: str | None = None 9 ctx1abcdefghi

25 secret_name: str | None = None 9 ctx1abcdefghi

26 age: int | None = None 9 ctx1abcdefghi

27 

28 

29sqlite_file_name = "database.db" 9 ctx1abcdefghi

30sqlite_url = f"sqlite:///{sqlite_file_name}" 9 ctx1abcdefghi

31 

32connect_args = {"check_same_thread": False} 9 ctx1abcdefghi

33engine = create_engine(sqlite_url, echo=True, connect_args=connect_args) 9 ctx1abcdefghi

34 

35 

36def create_db_and_tables(): 9 ctx1abcdefghi

37 SQLModel.metadata.create_all(engine) 9 ctx1jklmnopqr

38 

39 

40def get_session(): 9 ctx1abcdefghi

41 with Session(engine) as session: 9 ctx1jklmnopqr

42 yield session 9 ctx1jklmnopqr

43 

44 

45app = FastAPI() 9 ctx1abcdefghi

46 

47 

48@app.on_event("startup") 9 ctx1abcdefghi

49def on_startup(): 9 ctx1abcdefghi

50 create_db_and_tables() 9 ctx1jklmnopqr

51 

52 

53@app.post("/heroes/", response_model=HeroPublic) 9 ctx1abcdefghi

54def create_hero(*, session: Session = Depends(get_session), hero: HeroCreate): 9 ctx1abcdefghi

55 db_hero = Hero.model_validate(hero) 9 ctx1jklmnopqr

56 session.add(db_hero) 9 ctx1jklmnopqr

57 session.commit() 9 ctx1jklmnopqr

58 session.refresh(db_hero) 9 ctx1jklmnopqr

59 return db_hero 9 ctx1jklmnopqr

60 

61 

62@app.get("/heroes/", response_model=list[HeroPublic]) 9 ctx1abcdefghi

63def read_heroes( 9 ctx1abcdefghi

64 *, 

65 session: Session = Depends(get_session), 

66 offset: int = 0, 

67 limit: int = Query(default=100, le=100), 

68): 

69 heroes = session.exec(select(Hero).offset(offset).limit(limit)).all() 9 ctx1jklmnopqr

70 return heroes 9 ctx1jklmnopqr

71 

72 

73@app.get("/heroes/{hero_id}", response_model=HeroPublic) 9 ctx1abcdefghi

74def read_hero(*, session: Session = Depends(get_session), hero_id: int): 9 ctx1abcdefghi

75 hero = session.get(Hero, hero_id) 9 ctx1jklmnopqr

76 if not hero: 9 ctx1jklmnopqr

77 raise HTTPException(status_code=404, detail="Hero not found") 9 ctx1jklmnopqr

78 return hero 9 ctx1jklmnopqr

79 

80 

81@app.patch("/heroes/{hero_id}", response_model=HeroPublic) 9 ctx1abcdefghi

82def update_hero( 9 ctx1abcdefghi

83 *, session: Session = Depends(get_session), hero_id: int, hero: HeroUpdate 

84): 

85 db_hero = session.get(Hero, hero_id) 9 ctx1jklmnopqr

86 if not db_hero: 9 ctx1jklmnopqr

87 raise HTTPException(status_code=404, detail="Hero not found") 9 ctx1jklmnopqr

88 hero_data = hero.model_dump(exclude_unset=True) 9 ctx1jklmnopqr

89 db_hero.sqlmodel_update(hero_data) 9 ctx1jklmnopqr

90 session.add(db_hero) 9 ctx1jklmnopqr

91 session.commit() 9 ctx1jklmnopqr

92 session.refresh(db_hero) 9 ctx1jklmnopqr

93 return db_hero 9 ctx1jklmnopqr

94 

95 

96@app.delete("/heroes/{hero_id}") 9 ctx1abcdefghi

97def delete_hero(*, session: Session = Depends(get_session), hero_id: int): 9 ctx1abcdefghi

98 hero = session.get(Hero, hero_id) 9 ctx1jklmnopqr

99 if not hero: 9 ctx1jklmnopqr

100 raise HTTPException(status_code=404, detail="Hero not found") 9 ctx1jklmnopqr

101 session.delete(hero) 9 ctx1jklmnopqr

102 session.commit() 9 ctx1jklmnopqr

103 return {"ok": True} 9 ctx1jklmnopqr