Coverage for docs_src/tutorial/fastapi/teams/tutorial001.py: 100%
118 statements
« prev ^ index » next coverage.py v7.9.2, created at 2025-07-15 09:31 +0000
1from typing import List, Optional 1abcdef
3from fastapi import Depends, FastAPI, HTTPException, Query 1abcdef
4from sqlmodel import Field, Relationship, Session, SQLModel, create_engine, select 1abcdef
7class TeamBase(SQLModel): 1abcdef
8 name: str = Field(index=True) 1abcdef
9 headquarters: str 1abcdef
12class Team(TeamBase, table=True): 1abcdef
13 id: Optional[int] = Field(default=None, primary_key=True) 1abcdef
15 heroes: List["Hero"] = Relationship(back_populates="team") 1abcdef
18class TeamCreate(TeamBase): 1abcdef
19 pass 1abcdef
22class TeamPublic(TeamBase): 1abcdef
23 id: int 1abcdef
26class TeamUpdate(SQLModel): 1abcdef
27 name: Optional[str] = None 1abcdef
28 headquarters: Optional[str] = None 1abcdef
31class HeroBase(SQLModel): 1abcdef
32 name: str = Field(index=True) 1abcdef
33 secret_name: str 1abcdef
34 age: Optional[int] = Field(default=None, index=True) 1abcdef
36 team_id: Optional[int] = Field(default=None, foreign_key="team.id") 1abcdef
39class Hero(HeroBase, table=True): 1abcdef
40 id: Optional[int] = Field(default=None, primary_key=True) 1abcdef
42 team: Optional[Team] = Relationship(back_populates="heroes") 1abcdef
45class HeroPublic(HeroBase): 1abcdef
46 id: int 1abcdef
49class HeroCreate(HeroBase): 1abcdef
50 pass 1abcdef
53class HeroUpdate(SQLModel): 1abcdef
54 name: Optional[str] = None 1abcdef
55 secret_name: Optional[str] = None 1abcdef
56 age: Optional[int] = None 1abcdef
57 team_id: Optional[int] = None 1abcdef
60sqlite_file_name = "database.db" 1abcdef
61sqlite_url = f"sqlite:///{sqlite_file_name}" 1abcdef
63connect_args = {"check_same_thread": False} 1abcdef
64engine = create_engine(sqlite_url, echo=True, connect_args=connect_args) 1abcdef
67def create_db_and_tables(): 1abcdef
68 SQLModel.metadata.create_all(engine) 1abcdef
71def get_session(): 1abcdef
72 with Session(engine) as session: 1abcdef
73 yield session 1abcdef
76app = FastAPI() 1abcdef
79@app.on_event("startup") 1abcdef
80def on_startup(): 1abcdef
81 create_db_and_tables() 1abcdef
84@app.post("/heroes/", response_model=HeroPublic) 1abcdef
85def create_hero(*, session: Session = Depends(get_session), hero: HeroCreate): 1abcdef
86 db_hero = Hero.model_validate(hero) 1abcdef
87 session.add(db_hero) 1abcdef
88 session.commit() 1abcdef
89 session.refresh(db_hero) 1abcdef
90 return db_hero 1abcdef
93@app.get("/heroes/", response_model=List[HeroPublic]) 1abcdef
94def read_heroes( 1abcdef
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() 1abcdef
101 return heroes 1abcdef
104@app.get("/heroes/{hero_id}", response_model=HeroPublic) 1abcdef
105def read_hero(*, session: Session = Depends(get_session), hero_id: int): 1abcdef
106 hero = session.get(Hero, hero_id) 1abcdef
107 if not hero: 1abcdef
108 raise HTTPException(status_code=404, detail="Hero not found") 1abcdef
109 return hero 1abcdef
112@app.patch("/heroes/{hero_id}", response_model=HeroPublic) 1abcdef
113def update_hero( 1abcdef
114 *, session: Session = Depends(get_session), hero_id: int, hero: HeroUpdate
115):
116 db_hero = session.get(Hero, hero_id) 1abcdef
117 if not db_hero: 1abcdef
118 raise HTTPException(status_code=404, detail="Hero not found") 1abcdef
119 hero_data = hero.model_dump(exclude_unset=True) 1abcdef
120 db_hero.sqlmodel_update(hero_data) 1abcdef
121 session.add(db_hero) 1abcdef
122 session.commit() 1abcdef
123 session.refresh(db_hero) 1abcdef
124 return db_hero 1abcdef
127@app.delete("/heroes/{hero_id}") 1abcdef
128def delete_hero(*, session: Session = Depends(get_session), hero_id: int): 1abcdef
129 hero = session.get(Hero, hero_id) 1abcdef
130 if not hero: 1abcdef
131 raise HTTPException(status_code=404, detail="Hero not found") 1abcdef
132 session.delete(hero) 1abcdef
133 session.commit() 1abcdef
134 return {"ok": True} 1abcdef
137@app.post("/teams/", response_model=TeamPublic) 1abcdef
138def create_team(*, session: Session = Depends(get_session), team: TeamCreate): 1abcdef
139 db_team = Team.model_validate(team) 1abcdef
140 session.add(db_team) 1abcdef
141 session.commit() 1abcdef
142 session.refresh(db_team) 1abcdef
143 return db_team 1abcdef
146@app.get("/teams/", response_model=List[TeamPublic]) 1abcdef
147def read_teams( 1abcdef
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() 1abcdef
154 return teams 1abcdef
157@app.get("/teams/{team_id}", response_model=TeamPublic) 1abcdef
158def read_team(*, team_id: int, session: Session = Depends(get_session)): 1abcdef
159 team = session.get(Team, team_id) 1abcdef
160 if not team: 1abcdef
161 raise HTTPException(status_code=404, detail="Team not found") 1abcdef
162 return team 1abcdef
165@app.patch("/teams/{team_id}", response_model=TeamPublic) 1abcdef
166def update_team( 1abcdef
167 *,
168 session: Session = Depends(get_session),
169 team_id: int,
170 team: TeamUpdate,
171):
172 db_team = session.get(Team, team_id) 1abcdef
173 if not db_team: 1abcdef
174 raise HTTPException(status_code=404, detail="Team not found") 1abcdef
175 team_data = team.model_dump(exclude_unset=True) 1abcdef
176 db_team.sqlmodel_update(team_data) 1abcdef
177 session.add(db_team) 1abcdef
178 session.commit() 1abcdef
179 session.refresh(db_team) 1abcdef
180 return db_team 1abcdef
183@app.delete("/teams/{team_id}") 1abcdef
184def delete_team(*, session: Session = Depends(get_session), team_id: int): 1abcdef
185 team = session.get(Team, team_id) 1abcdef
186 if not team: 1abcdef
187 raise HTTPException(status_code=404, detail="Team not found") 1abcdef
188 session.delete(team) 1abcdef
189 session.commit() 1abcdef
190 return {"ok": True} 1abcdef