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

118 statements  

« prev     ^ index     » next       coverage.py v7.13.0, created at 2026-01-06 21:09 +0000

1from typing import Optional 1abcdefghi

2 

3from fastapi import Depends, FastAPI, HTTPException, Query 1abcdefghi

4from sqlmodel import Field, Relationship, Session, SQLModel, create_engine, select 1abcdefghi

5 

6 

7class TeamBase(SQLModel): 1abcdefghi

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

9 headquarters: str 1abcdefghi

10 

11 

12class Team(TeamBase, table=True): 1abcdefghi

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

14 

15 heroes: list["Hero"] = Relationship(back_populates="team") 1abcdefghi

16 

17 

18class TeamCreate(TeamBase): 1abcdefghi

19 pass 1abcdefghi

20 

21 

22class TeamPublic(TeamBase): 1abcdefghi

23 id: int 1abcdefghi

24 

25 

26class TeamUpdate(SQLModel): 1abcdefghi

27 name: Optional[str] = None 1abcdefghi

28 headquarters: Optional[str] = None 1abcdefghi

29 

30 

31class HeroBase(SQLModel): 1abcdefghi

32 name: str = Field(index=True) 1abcdefghi

33 secret_name: str 1abcdefghi

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

35 

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

37 

38 

39class Hero(HeroBase, table=True): 1abcdefghi

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

41 

42 team: Optional[Team] = Relationship(back_populates="heroes") 1abcdefghi

43 

44 

45class HeroPublic(HeroBase): 1abcdefghi

46 id: int 1abcdefghi

47 

48 

49class HeroCreate(HeroBase): 1abcdefghi

50 pass 1abcdefghi

51 

52 

53class HeroUpdate(SQLModel): 1abcdefghi

54 name: Optional[str] = None 1abcdefghi

55 secret_name: Optional[str] = None 1abcdefghi

56 age: Optional[int] = None 1abcdefghi

57 team_id: Optional[int] = None 1abcdefghi

58 

59 

60sqlite_file_name = "database.db" 1abcdefghi

61sqlite_url = f"sqlite:///{sqlite_file_name}" 1abcdefghi

62 

63connect_args = {"check_same_thread": False} 1abcdefghi

64engine = create_engine(sqlite_url, echo=True, connect_args=connect_args) 1abcdefghi

65 

66 

67def create_db_and_tables(): 1abcdefghi

68 SQLModel.metadata.create_all(engine) 1jklmnopqr

69 

70 

71def get_session(): 1abcdefghi

72 with Session(engine) as session: 1jklmnopqr

73 yield session 1jklmnopqr

74 

75 

76app = FastAPI() 1abcdefghi

77 

78 

79@app.on_event("startup") 1abcdefghi

80def on_startup(): 1abcdefghi

81 create_db_and_tables() 1jklmnopqr

82 

83 

84@app.post("/heroes/", response_model=HeroPublic) 1abcdefghi

85def create_hero(*, session: Session = Depends(get_session), hero: HeroCreate): 1abcdefghi

86 db_hero = Hero.model_validate(hero) 1jklmnopqr

87 session.add(db_hero) 1jklmnopqr

88 session.commit() 1jklmnopqr

89 session.refresh(db_hero) 1jklmnopqr

90 return db_hero 1jklmnopqr

91 

92 

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

94def read_heroes( 1abcdefghi

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() 1jklmnopqr

101 return heroes 1jklmnopqr

102 

103 

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

105def read_hero(*, session: Session = Depends(get_session), hero_id: int): 1abcdefghi

106 hero = session.get(Hero, hero_id) 1jklmnopqr

107 if not hero: 1jklmnopqr

108 raise HTTPException(status_code=404, detail="Hero not found") 1jklmnopqr

109 return hero 1jklmnopqr

110 

111 

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

113def update_hero( 1abcdefghi

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

115): 

116 db_hero = session.get(Hero, hero_id) 1jklmnopqr

117 if not db_hero: 1jklmnopqr

118 raise HTTPException(status_code=404, detail="Hero not found") 1jklmnopqr

119 hero_data = hero.model_dump(exclude_unset=True) 1jklmnopqr

120 db_hero.sqlmodel_update(hero_data) 1jklmnopqr

121 session.add(db_hero) 1jklmnopqr

122 session.commit() 1jklmnopqr

123 session.refresh(db_hero) 1jklmnopqr

124 return db_hero 1jklmnopqr

125 

126 

127@app.delete("/heroes/{hero_id}") 1abcdefghi

128def delete_hero(*, session: Session = Depends(get_session), hero_id: int): 1abcdefghi

129 hero = session.get(Hero, hero_id) 1jklmnopqr

130 if not hero: 1jklmnopqr

131 raise HTTPException(status_code=404, detail="Hero not found") 1jklmnopqr

132 session.delete(hero) 1jklmnopqr

133 session.commit() 1jklmnopqr

134 return {"ok": True} 1jklmnopqr

135 

136 

137@app.post("/teams/", response_model=TeamPublic) 1abcdefghi

138def create_team(*, session: Session = Depends(get_session), team: TeamCreate): 1abcdefghi

139 db_team = Team.model_validate(team) 1jklmnopqr

140 session.add(db_team) 1jklmnopqr

141 session.commit() 1jklmnopqr

142 session.refresh(db_team) 1jklmnopqr

143 return db_team 1jklmnopqr

144 

145 

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

147def read_teams( 1abcdefghi

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() 1jklmnopqr

154 return teams 1jklmnopqr

155 

156 

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

158def read_team(*, team_id: int, session: Session = Depends(get_session)): 1abcdefghi

159 team = session.get(Team, team_id) 1jklmnopqr

160 if not team: 1jklmnopqr

161 raise HTTPException(status_code=404, detail="Team not found") 1jklmnopqr

162 return team 1jklmnopqr

163 

164 

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

166def update_team( 1abcdefghi

167 *, 

168 session: Session = Depends(get_session), 

169 team_id: int, 

170 team: TeamUpdate, 

171): 

172 db_team = session.get(Team, team_id) 1jklmnopqr

173 if not db_team: 1jklmnopqr

174 raise HTTPException(status_code=404, detail="Team not found") 1jklmnopqr

175 team_data = team.model_dump(exclude_unset=True) 1jklmnopqr

176 db_team.sqlmodel_update(team_data) 1jklmnopqr

177 session.add(db_team) 1jklmnopqr

178 session.commit() 1jklmnopqr

179 session.refresh(db_team) 1jklmnopqr

180 return db_team 1jklmnopqr

181 

182 

183@app.delete("/teams/{team_id}") 1abcdefghi

184def delete_team(*, session: Session = Depends(get_session), team_id: int): 1abcdefghi

185 team = session.get(Team, team_id) 1jklmnopqr

186 if not team: 1jklmnopqr

187 raise HTTPException(status_code=404, detail="Team not found") 1jklmnopqr

188 session.delete(team) 1jklmnopqr

189 session.commit() 1jklmnopqr

190 return {"ok": True} 1jklmnopqr