Coverage for docs_src/sql_databases/tutorial002.py: 100%

1from typing import List, Union 5 ctx1abcde

2 

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

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

5 

6 

7class HeroBase(SQLModel): 5 ctx1abcde

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

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

10 

11 

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

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

14 secret_name: str 5 ctx1abcde

15 

16 

17class HeroPublic(HeroBase): 5 ctx1abcde

18 id: int 5 ctx1abcde

19 

20 

21class HeroCreate(HeroBase): 5 ctx1abcde

22 secret_name: str 5 ctx1abcde

23 

24 

25class HeroUpdate(HeroBase): 5 ctx1abcde

26 name: Union[str, None] = None 5 ctx1abcde

27 age: Union[int, None] = None 5 ctx1abcde

28 secret_name: Union[str, None] = None 5 ctx1abcde

29 

30 

31sqlite_file_name = "database.db" 5 ctx1abcde

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

33 

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

35engine = create_engine(sqlite_url, connect_args=connect_args) 5 ctx1abcde

36 

37 

38def create_db_and_tables(): 5 ctx1abcde

39 SQLModel.metadata.create_all(engine) 5 ctx1abcde

40 

41 

42def get_session(): 5 ctx1abcde

43 with Session(engine) as session: 5 ctx1fghij

44 yield session 5 ctx1fghij

45 

46 

47app = FastAPI() 5 ctx1abcde

48 

49 

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

51def on_startup(): 5 ctx1abcde

52 create_db_and_tables() 5 ctx1abcde

53 

54 

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

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

57 db_hero = Hero.model_validate(hero) 5 ctx1fghij

58 session.add(db_hero) 5 ctx1fghij

59 session.commit() 5 ctx1fghij

60 session.refresh(db_hero) 5 ctx1fghij

61 return db_hero 5 ctx1fghij

62 

63 

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

65def read_heroes( 5 ctx1abcde

66 session: Session = Depends(get_session), 

67 offset: int = 0, 

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

69): 

70 heroes = session.exec(select(Hero).offset(offset).limit(limit)).all() 5 ctx1fghij

71 return heroes 5 ctx1fghij

72 

73 

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

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

76 hero = session.get(Hero, hero_id) 5 ctx1fghij

77 if not hero: 5 ctx1fghij

78 raise HTTPException(status_code=404, detail="Hero not found") 5 ctx1fghij

79 return hero 5 ctx1fghij

80 

81 

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

83def update_hero( 5 ctx1abcde

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

85): 

86 hero_db = session.get(Hero, hero_id) 5 ctx1fghij

87 if not hero_db: 5 ctx1fghij

88 raise HTTPException(status_code=404, detail="Hero not found") 5 ctx1fghij

89 hero_data = hero.model_dump(exclude_unset=True) 5 ctx1fghij

90 hero_db.sqlmodel_update(hero_data) 5 ctx1fghij

91 session.add(hero_db) 5 ctx1fghij

92 session.commit() 5 ctx1fghij

93 session.refresh(hero_db) 5 ctx1fghij

94 return hero_db 5 ctx1fghij

95 

96 

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

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

99 hero = session.get(Hero, hero_id) 5 ctx1fghij

100 if not hero: 5 ctx1fghij

101 raise HTTPException(status_code=404, detail="Hero not found") 5 ctx1fghij

102 session.delete(hero) 5 ctx1fghij

103 session.commit() 5 ctx1fghij

104 return {"ok": True} 5 ctx1fghij