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

1from typing import List, Optional 6 ctx1fabcde

2 

3from fastapi import Depends, FastAPI, HTTPException, Query 6 ctx1fabcde

4from sqlmodel import Field, Session, SQLModel, create_engine, select 6 ctx1fabcde

5 

6 

7class HeroBase(SQLModel): 6 ctx1fabcde

8 name: str = Field(index=True) 6 ctx1fabcde

9 secret_name: str 6 ctx1fabcde

10 age: Optional[int] = Field(default=None, index=True) 6 ctx1fabcde

11 

12 

13class Hero(HeroBase, table=True): 6 ctx1fabcde

14 id: Optional[int] = Field(default=None, primary_key=True) 6 ctx1fabcde

15 

16 

17class HeroCreate(HeroBase): 6 ctx1fabcde

18 pass 6 ctx1fabcde

19 

20 

21class HeroPublic(HeroBase): 6 ctx1fabcde

22 id: int 6 ctx1fabcde

23 

24 

25class HeroUpdate(SQLModel): 6 ctx1fabcde

26 name: Optional[str] = None 6 ctx1fabcde

27 secret_name: Optional[str] = None 6 ctx1fabcde

28 age: Optional[int] = None 6 ctx1fabcde

29 

30 

31sqlite_file_name = "database.db" 6 ctx1fabcde

32sqlite_url = f"sqlite:///{sqlite_file_name}" 6 ctx1fabcde

33 

34connect_args = {"check_same_thread": False} 6 ctx1fabcde

35engine = create_engine(sqlite_url, echo=True, connect_args=connect_args) 6 ctx1fabcde

36 

37 

38def create_db_and_tables(): 6 ctx1fabcde

39 SQLModel.metadata.create_all(engine) 6 ctx1fabcde

40 

41 

42def get_session(): 6 ctx1fabcde

43 with Session(engine) as session: 6 ctx1fabcde

44 yield session 6 ctx1fabcde

45 

46 

47app = FastAPI() 6 ctx1fabcde

48 

49 

50@app.on_event("startup") 6 ctx1fabcde

51def on_startup(): 5 ctx1abcde

52 create_db_and_tables() 6 ctx1fabcde

53 

54 

55@app.post("/heroes/", response_model=HeroPublic) 6 ctx1fabcde

56def create_hero(*, session: Session = Depends(get_session), hero: HeroCreate): 6 ctx1fabcde

57 db_hero = Hero.model_validate(hero) 6 ctx1fabcde

58 session.add(db_hero) 6 ctx1fabcde

59 session.commit() 6 ctx1fabcde

60 session.refresh(db_hero) 6 ctx1fabcde

61 return db_hero 6 ctx1fabcde

62 

63 

64@app.get("/heroes/", response_model=List[HeroPublic]) 6 ctx1fabcde

65def read_heroes( 5 ctx1abcde

66 *, 

67 session: Session = Depends(get_session), 

68 offset: int = 0, 

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

70): 

71 heroes = session.exec(select(Hero).offset(offset).limit(limit)).all() 6 ctx1fabcde

72 return heroes 6 ctx1fabcde

73 

74 

75@app.get("/heroes/{hero_id}", response_model=HeroPublic) 6 ctx1fabcde

76def read_hero(*, session: Session = Depends(get_session), hero_id: int): 6 ctx1fabcde

77 hero = session.get(Hero, hero_id) 6 ctx1fabcde

78 if not hero: 6 ctx1fabcde

79 raise HTTPException(status_code=404, detail="Hero not found") 6 ctx1fabcde

80 return hero 6 ctx1fabcde

81 

82 

83@app.patch("/heroes/{hero_id}", response_model=HeroPublic) 6 ctx1fabcde

84def update_hero( 5 ctx1abcde

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

86): 

87 db_hero = session.get(Hero, hero_id) 6 ctx1fabcde

88 if not db_hero: 6 ctx1fabcde

89 raise HTTPException(status_code=404, detail="Hero not found") 6 ctx1fabcde

90 hero_data = hero.model_dump(exclude_unset=True) 6 ctx1fabcde

91 for key, value in hero_data.items(): 6 ctx1fabcde

92 setattr(db_hero, key, value) 6 ctx1fabcde

93 session.add(db_hero) 6 ctx1fabcde

94 session.commit() 6 ctx1fabcde

95 session.refresh(db_hero) 6 ctx1fabcde

96 return db_hero 6 ctx1fabcde

97 

98 

99@app.delete("/heroes/{hero_id}") 6 ctx1fabcde

100def delete_hero(*, session: Session = Depends(get_session), hero_id: int): 6 ctx1fabcde

101 hero = session.get(Hero, hero_id) 6 ctx1fabcde

102 if not hero: 6 ctx1fabcde

103 raise HTTPException(status_code=404, detail="Hero not found") 6 ctx1fabcde

104 session.delete(hero) 6 ctx1fabcde

105 session.commit() 6 ctx1fabcde

106 return {"ok": True} 6 ctx1fabcde