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

1from typing import Optional 5 ctx1abcde

2 

3from fastapi import Depends, FastAPI, HTTPException, Query 5 ctx1abcde

4from sqlmodel import Field, Relationship, Session, SQLModel, create_engine, select 5 ctx1abcde

5 

6 

7class TeamBase(SQLModel): 5 ctx1abcde

8 name: str = Field(index=True) 5 ctx1abcde

9 headquarters: str 5 ctx1abcde

10 

11 

12class Team(TeamBase, table=True): 5 ctx1abcde

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

14 

15 heroes: list["Hero"] = Relationship(back_populates="team") 5 ctx1abcde

16 

17 

18class TeamCreate(TeamBase): 5 ctx1abcde

19 pass 5 ctx1abcde

20 

21 

22class TeamPublic(TeamBase): 5 ctx1abcde

23 id: int 5 ctx1abcde

24 

25 

26class TeamUpdate(SQLModel): 5 ctx1abcde

27 name: Optional[str] = None 5 ctx1abcde

28 headquarters: Optional[str] = None 5 ctx1abcde

29 

30 

31class HeroBase(SQLModel): 5 ctx1abcde

32 name: str = Field(index=True) 5 ctx1abcde

33 secret_name: str 5 ctx1abcde

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

35 

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

37 

38 

39class Hero(HeroBase, table=True): 5 ctx1abcde

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

41 

42 team: Optional[Team] = Relationship(back_populates="heroes") 5 ctx1abcde

43 

44 

45class HeroPublic(HeroBase): 5 ctx1abcde

46 id: int 5 ctx1abcde

47 

48 

49class HeroCreate(HeroBase): 5 ctx1abcde

50 pass 5 ctx1abcde

51 

52 

53class HeroUpdate(SQLModel): 5 ctx1abcde

54 name: Optional[str] = None 5 ctx1abcde

55 secret_name: Optional[str] = None 5 ctx1abcde

56 age: Optional[int] = None 5 ctx1abcde

57 team_id: Optional[int] = None 5 ctx1abcde

58 

59 

60sqlite_file_name = "database.db" 5 ctx1abcde

61sqlite_url = f"sqlite:///{sqlite_file_name}" 5 ctx1abcde

62 

63connect_args = {"check_same_thread": False} 5 ctx1abcde

64engine = create_engine(sqlite_url, echo=True, connect_args=connect_args) 5 ctx1abcde

65 

66 

67def create_db_and_tables(): 5 ctx1abcde

68 SQLModel.metadata.create_all(engine) 5 ctx1abcde

69 

70 

71def get_session(): 5 ctx1abcde

72 with Session(engine) as session: 5 ctx1abcde

73 yield session 5 ctx1abcde

74 

75 

76app = FastAPI() 5 ctx1abcde

77 

78 

79@app.on_event("startup") 5 ctx1abcde

80def on_startup(): 5 ctx1abcde

81 create_db_and_tables() 5 ctx1abcde

82 

83 

84@app.post("/heroes/", response_model=HeroPublic) 5 ctx1abcde

85def create_hero(*, session: Session = Depends(get_session), hero: HeroCreate): 5 ctx1abcde

86 db_hero = Hero.model_validate(hero) 5 ctx1abcde

87 session.add(db_hero) 5 ctx1abcde

88 session.commit() 5 ctx1abcde

89 session.refresh(db_hero) 5 ctx1abcde

90 return db_hero 5 ctx1abcde

91 

92 

93@app.get("/heroes/", response_model=list[HeroPublic]) 5 ctx1abcde

94def read_heroes( 5 ctx1abcde

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() 5 ctx1abcde

101 return heroes 5 ctx1abcde

102 

103 

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

105def read_hero(*, session: Session = Depends(get_session), hero_id: int): 5 ctx1abcde

106 hero = session.get(Hero, hero_id) 5 ctx1abcde

107 if not hero: 5 ctx1abcde

108 raise HTTPException(status_code=404, detail="Hero not found") 5 ctx1abcde

109 return hero 5 ctx1abcde

110 

111 

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

113def update_hero( 5 ctx1abcde

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

115): 

116 db_hero = session.get(Hero, hero_id) 5 ctx1abcde

117 if not db_hero: 5 ctx1abcde

118 raise HTTPException(status_code=404, detail="Hero not found") 5 ctx1abcde

119 hero_data = hero.model_dump(exclude_unset=True) 5 ctx1abcde

120 db_hero.sqlmodel_update(hero_data) 5 ctx1abcde

121 session.add(db_hero) 5 ctx1abcde

122 session.commit() 5 ctx1abcde

123 session.refresh(db_hero) 5 ctx1abcde

124 return db_hero 5 ctx1abcde

125 

126 

127@app.delete("/heroes/{hero_id}") 5 ctx1abcde

128def delete_hero(*, session: Session = Depends(get_session), hero_id: int): 5 ctx1abcde

129 hero = session.get(Hero, hero_id) 5 ctx1abcde

130 if not hero: 5 ctx1abcde

131 raise HTTPException(status_code=404, detail="Hero not found") 5 ctx1abcde

132 session.delete(hero) 5 ctx1abcde

133 session.commit() 5 ctx1abcde

134 return {"ok": True} 5 ctx1abcde

135 

136 

137@app.post("/teams/", response_model=TeamPublic) 5 ctx1abcde

138def create_team(*, session: Session = Depends(get_session), team: TeamCreate): 5 ctx1abcde

139 db_team = Team.model_validate(team) 5 ctx1abcde

140 session.add(db_team) 5 ctx1abcde

141 session.commit() 5 ctx1abcde

142 session.refresh(db_team) 5 ctx1abcde

143 return db_team 5 ctx1abcde

144 

145 

146@app.get("/teams/", response_model=list[TeamPublic]) 5 ctx1abcde

147def read_teams( 5 ctx1abcde

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() 5 ctx1abcde

154 return teams 5 ctx1abcde

155 

156 

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

158def read_team(*, team_id: int, session: Session = Depends(get_session)): 5 ctx1abcde

159 team = session.get(Team, team_id) 5 ctx1abcde

160 if not team: 5 ctx1abcde

161 raise HTTPException(status_code=404, detail="Team not found") 5 ctx1abcde

162 return team 5 ctx1abcde

163 

164 

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

166def update_team( 5 ctx1abcde

167 *, 

168 session: Session = Depends(get_session), 

169 team_id: int, 

170 team: TeamUpdate, 

171): 

172 db_team = session.get(Team, team_id) 5 ctx1abcde

173 if not db_team: 5 ctx1abcde

174 raise HTTPException(status_code=404, detail="Team not found") 5 ctx1abcde

175 team_data = team.model_dump(exclude_unset=True) 5 ctx1abcde

176 db_team.sqlmodel_update(team_data) 5 ctx1abcde

177 session.add(db_team) 5 ctx1abcde

178 session.commit() 5 ctx1abcde

179 session.refresh(db_team) 5 ctx1abcde

180 return db_team 5 ctx1abcde

181 

182 

183@app.delete("/teams/{team_id}") 5 ctx1abcde

184def delete_team(*, session: Session = Depends(get_session), team_id: int): 5 ctx1abcde

185 team = session.get(Team, team_id) 5 ctx1abcde

186 if not team: 5 ctx1abcde

187 raise HTTPException(status_code=404, detail="Team not found") 5 ctx1abcde

188 session.delete(team) 5 ctx1abcde

189 session.commit() 5 ctx1abcde

190 return {"ok": True} 5 ctx1abcde