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

1from typing import List, Optional 10 ctx1abcdefghij

2 

3from fastapi import Depends, FastAPI, HTTPException, Query 10 ctx1abcdefghij

4from sqlmodel import Field, Relationship, Session, SQLModel, create_engine, select 10 ctx1abcdefghij

5 

6 

7class TeamBase(SQLModel): 10 ctx1abcdefghij

8 name: str = Field(index=True) 10 ctx1abcdefghij

9 headquarters: str 10 ctx1abcdefghij

10 

11 

12class Team(TeamBase, table=True): 10 ctx1abcdefghij

13 id: Optional[int] = Field(default=None, primary_key=True) 10 ctx1abcdefghij

14 

15 heroes: List["Hero"] = Relationship(back_populates="team") 10 ctx1abcdefghij

16 

17 

18class TeamCreate(TeamBase): 10 ctx1abcdefghij

19 pass 10 ctx1abcdefghij

20 

21 

22class TeamPublic(TeamBase): 10 ctx1abcdefghij

23 id: int 10 ctx1abcdefghij

24 

25 

26class TeamUpdate(SQLModel): 10 ctx1abcdefghij

27 name: Optional[str] = None 10 ctx1abcdefghij

28 headquarters: Optional[str] = None 10 ctx1abcdefghij

29 

30 

31class HeroBase(SQLModel): 10 ctx1abcdefghij

32 name: str = Field(index=True) 10 ctx1abcdefghij

33 secret_name: str 10 ctx1abcdefghij

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

35 

36 team_id: Optional[int] = Field(default=None, foreign_key="team.id") 10 ctx1abcdefghij

37 

38 

39class Hero(HeroBase, table=True): 10 ctx1abcdefghij

40 id: Optional[int] = Field(default=None, primary_key=True) 10 ctx1abcdefghij

41 

42 team: Optional[Team] = Relationship(back_populates="heroes") 10 ctx1abcdefghij

43 

44 

45class HeroPublic(HeroBase): 10 ctx1abcdefghij

46 id: int 10 ctx1abcdefghij

47 

48 

49class HeroCreate(HeroBase): 10 ctx1abcdefghij

50 pass 10 ctx1abcdefghij

51 

52 

53class HeroUpdate(SQLModel): 10 ctx1abcdefghij

54 name: Optional[str] = None 10 ctx1abcdefghij

55 secret_name: Optional[str] = None 10 ctx1abcdefghij

56 age: Optional[int] = None 10 ctx1abcdefghij

57 team_id: Optional[int] = None 10 ctx1abcdefghij

58 

59 

60sqlite_file_name = "database.db" 10 ctx1abcdefghij

61sqlite_url = f"sqlite:///{sqlite_file_name}" 10 ctx1abcdefghij

62 

63connect_args = {"check_same_thread": False} 10 ctx1abcdefghij

64engine = create_engine(sqlite_url, echo=True, connect_args=connect_args) 10 ctx1abcdefghij

65 

66 

67def create_db_and_tables(): 10 ctx1abcdefghij

68 SQLModel.metadata.create_all(engine) 10 ctx1abcdefghij

69 

70 

71def get_session(): 10 ctx1abcdefghij

72 with Session(engine) as session: 10 ctx1abcdefghij

73 yield session 10 ctx1abcdefghij

74 

75 

76app = FastAPI() 10 ctx1abcdefghij

77 

78 

79@app.on_event("startup") 10 ctx1abcdefghij

80def on_startup(): 10 ctx1abcdefghij

81 create_db_and_tables() 10 ctx1abcdefghij

82 

83 

84@app.post("/heroes/", response_model=HeroPublic) 10 ctx1abcdefghij

85def create_hero(*, session: Session = Depends(get_session), hero: HeroCreate): 10 ctx1abcdefghij

86 db_hero = Hero.model_validate(hero) 10 ctx1abcdefghij

87 session.add(db_hero) 10 ctx1abcdefghij

88 session.commit() 10 ctx1abcdefghij

89 session.refresh(db_hero) 10 ctx1abcdefghij

90 return db_hero 10 ctx1abcdefghij

91 

92 

93@app.get("/heroes/", response_model=List[HeroPublic]) 10 ctx1abcdefghij

94def read_heroes( 10 ctx1abcdefghij

95 *, 

96 session: Session = Depends(get_session), 

97 offset: int = 0, 

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

99): 

100 heroes = session.exec(select(Hero).offset(offset).limit(limit)).all() 10 ctx1abcdefghij

101 return heroes 10 ctx1abcdefghij

102 

103 

104@app.get("/heroes/{hero_id}", response_model=HeroPublic) 10 ctx1abcdefghij

105def read_hero(*, session: Session = Depends(get_session), hero_id: int): 10 ctx1abcdefghij

106 hero = session.get(Hero, hero_id) 10 ctx1abcdefghij

107 if not hero: 10 ctx1abcdefghij

108 raise HTTPException(status_code=404, detail="Hero not found") 10 ctx1abcdefghij

109 return hero 10 ctx1abcdefghij

110 

111 

112@app.patch("/heroes/{hero_id}", response_model=HeroPublic) 10 ctx1abcdefghij

113def update_hero( 10 ctx1abcdefghij

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

115): 

116 db_hero = session.get(Hero, hero_id) 10 ctx1abcdefghij

117 if not db_hero: 10 ctx1abcdefghij

118 raise HTTPException(status_code=404, detail="Hero not found") 10 ctx1abcdefghij

119 hero_data = hero.model_dump(exclude_unset=True) 10 ctx1abcdefghij

120 db_hero.sqlmodel_update(hero_data) 10 ctx1abcdefghij

121 session.add(db_hero) 10 ctx1abcdefghij

122 session.commit() 10 ctx1abcdefghij

123 session.refresh(db_hero) 10 ctx1abcdefghij

124 return db_hero 10 ctx1abcdefghij

125 

126 

127@app.delete("/heroes/{hero_id}") 10 ctx1abcdefghij

128def delete_hero(*, session: Session = Depends(get_session), hero_id: int): 10 ctx1abcdefghij

129 hero = session.get(Hero, hero_id) 10 ctx1abcdefghij

130 if not hero: 10 ctx1abcdefghij

131 raise HTTPException(status_code=404, detail="Hero not found") 10 ctx1abcdefghij

132 session.delete(hero) 10 ctx1abcdefghij

133 session.commit() 10 ctx1abcdefghij

134 return {"ok": True} 10 ctx1abcdefghij

135 

136 

137@app.post("/teams/", response_model=TeamPublic) 10 ctx1abcdefghij

138def create_team(*, session: Session = Depends(get_session), team: TeamCreate): 10 ctx1abcdefghij

139 db_team = Team.model_validate(team) 10 ctx1abcdefghij

140 session.add(db_team) 10 ctx1abcdefghij

141 session.commit() 10 ctx1abcdefghij

142 session.refresh(db_team) 10 ctx1abcdefghij

143 return db_team 10 ctx1abcdefghij

144 

145 

146@app.get("/teams/", response_model=List[TeamPublic]) 10 ctx1abcdefghij

147def read_teams( 10 ctx1abcdefghij

148 *, 

149 session: Session = Depends(get_session), 

150 offset: int = 0, 

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

152): 

153 teams = session.exec(select(Team).offset(offset).limit(limit)).all() 10 ctx1abcdefghij

154 return teams 10 ctx1abcdefghij

155 

156 

157@app.get("/teams/{team_id}", response_model=TeamPublic) 10 ctx1abcdefghij

158def read_team(*, team_id: int, session: Session = Depends(get_session)): 10 ctx1abcdefghij

159 team = session.get(Team, team_id) 10 ctx1abcdefghij

160 if not team: 10 ctx1abcdefghij

161 raise HTTPException(status_code=404, detail="Team not found") 10 ctx1abcdefghij

162 return team 10 ctx1abcdefghij

163 

164 

165@app.patch("/teams/{team_id}", response_model=TeamPublic) 10 ctx1abcdefghij

166def update_team( 10 ctx1abcdefghij

167 *, 

168 session: Session = Depends(get_session), 

169 team_id: int, 

170 team: TeamUpdate, 

171): 

172 db_team = session.get(Team, team_id) 10 ctx1abcdefghij

173 if not db_team: 10 ctx1abcdefghij

174 raise HTTPException(status_code=404, detail="Team not found") 10 ctx1abcdefghij

175 team_data = team.model_dump(exclude_unset=True) 10 ctx1abcdefghij

176 db_team.sqlmodel_update(team_data) 10 ctx1abcdefghij

177 session.add(db_team) 10 ctx1abcdefghij

178 session.commit() 10 ctx1abcdefghij

179 session.refresh(db_team) 10 ctx1abcdefghij

180 return db_team 10 ctx1abcdefghij

181 

182 

183@app.delete("/teams/{team_id}") 10 ctx1abcdefghij

184def delete_team(*, session: Session = Depends(get_session), team_id: int): 10 ctx1abcdefghij

185 team = session.get(Team, team_id) 10 ctx1abcdefghij

186 if not team: 10 ctx1abcdefghij

187 raise HTTPException(status_code=404, detail="Team not found") 10 ctx1abcdefghij

188 session.delete(team) 10 ctx1abcdefghij

189 session.commit() 10 ctx1abcdefghij

190 return {"ok": True} 10 ctx1abcdefghij