Skip to content

Commit 9632980

Browse files
Matthieu-LAURENT39tiangolo
Matthieu-LAURENT39
and
tiangolo
authored
🎨 Update inline source examples, hide # in annotations (from MkDocs Material) (#677)
Co-authored-by: Sebastián Ramírez <[email protected]>
1 parent 6457775 commit 9632980

File tree

13 files changed

+174
-174
lines changed

13 files changed

+174
-174
lines changed

‎docs_src/tutorial/automatic_id_none_refresh/tutorial002.py‎

Lines changed: 50 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -21,56 +21,56 @@ def create_db_and_tables():
2121

2222

2323
def create_heroes():
24-
hero_1 = Hero(name="Deadpond", secret_name="Dive Wilson") # (1)
25-
hero_2 = Hero(name="Spider-Boy", secret_name="Pedro Parqueador") # (2)
26-
hero_3 = Hero(name="Rusty-Man", secret_name="Tommy Sharp", age=48) # (3)
27-
28-
print("Before interacting with the database") # (4)
29-
print("Hero 1:", hero_1) # (5)
30-
print("Hero 2:", hero_2) # (6)
31-
print("Hero 3:", hero_3) # (7)
32-
33-
with Session(engine) as session: # (8)
34-
session.add(hero_1) # (9)
35-
session.add(hero_2) # (10)
36-
session.add(hero_3) # (11)
37-
38-
print("After adding to the session") # (12)
39-
print("Hero 1:", hero_1) # (13)
40-
print("Hero 2:", hero_2) # (14)
41-
print("Hero 3:", hero_3) # (15)
42-
43-
session.commit() # (16)
44-
45-
print("After committing the session") # (17)
46-
print("Hero 1:", hero_1) # (18)
47-
print("Hero 2:", hero_2) # (19)
48-
print("Hero 3:", hero_3) # (20)
49-
50-
print("After committing the session, show IDs") # (21)
51-
print("Hero 1 ID:", hero_1.id) # (22)
52-
print("Hero 2 ID:", hero_2.id) # (23)
53-
print("Hero 3 ID:", hero_3.id) # (24)
54-
55-
print("After committing the session, show names") # (25)
56-
print("Hero 1 name:", hero_1.name) # (26)
57-
print("Hero 2 name:", hero_2.name) # (27)
58-
print("Hero 3 name:", hero_3.name) # (28)
59-
60-
session.refresh(hero_1) # (29)
61-
session.refresh(hero_2) # (30)
62-
session.refresh(hero_3) # (31)
63-
64-
print("After refreshing the heroes") # (32)
65-
print("Hero 1:", hero_1) # (33)
66-
print("Hero 2:", hero_2) # (34)
67-
print("Hero 3:", hero_3) # (35)
68-
# (36)
69-
70-
print("After the session closes") # (37)
71-
print("Hero 1:", hero_1) # (38)
72-
print("Hero 2:", hero_2) # (39)
73-
print("Hero 3:", hero_3) # (40)
24+
hero_1 = Hero(name="Deadpond", secret_name="Dive Wilson") # (1)!
25+
hero_2 = Hero(name="Spider-Boy", secret_name="Pedro Parqueador") # (2)!
26+
hero_3 = Hero(name="Rusty-Man", secret_name="Tommy Sharp", age=48) # (3)!
27+
28+
print("Before interacting with the database") # (4)!
29+
print("Hero 1:", hero_1) # (5)!
30+
print("Hero 2:", hero_2) # (6)!
31+
print("Hero 3:", hero_3) # (7)!
32+
33+
with Session(engine) as session: # (8)!
34+
session.add(hero_1) # (9)!
35+
session.add(hero_2) # (10)!
36+
session.add(hero_3) # (11)!
37+
38+
print("After adding to the session") # (12)!
39+
print("Hero 1:", hero_1) # (13)!
40+
print("Hero 2:", hero_2) # (14)!
41+
print("Hero 3:", hero_3) # (15)!
42+
43+
session.commit() # (16)!
44+
45+
print("After committing the session") # (17)!
46+
print("Hero 1:", hero_1) # (18)!
47+
print("Hero 2:", hero_2) # (19)!
48+
print("Hero 3:", hero_3) # (20)!
49+
50+
print("After committing the session, show IDs") # (21)!
51+
print("Hero 1 ID:", hero_1.id) # (22)!
52+
print("Hero 2 ID:", hero_2.id) # (23)!
53+
print("Hero 3 ID:", hero_3.id) # (24)!
54+
55+
print("After committing the session, show names") # (25)!
56+
print("Hero 1 name:", hero_1.name) # (26)!
57+
print("Hero 2 name:", hero_2.name) # (27)!
58+
print("Hero 3 name:", hero_3.name) # (28)!
59+
60+
session.refresh(hero_1) # (29)!
61+
session.refresh(hero_2) # (30)!
62+
session.refresh(hero_3) # (31)!
63+
64+
print("After refreshing the heroes") # (32)!
65+
print("Hero 1:", hero_1) # (33)!
66+
print("Hero 2:", hero_2) # (34)!
67+
print("Hero 3:", hero_3) # (35)!
68+
# (36)!
69+
70+
print("After the session closes") # (37)!
71+
print("Hero 1:", hero_1) # (38)!
72+
print("Hero 2:", hero_2) # (39)!
73+
print("Hero 3:", hero_3) # (40)!
7474

7575

7676
def main():

‎docs_src/tutorial/create_db_and_table/tutorial003.py‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
1-
from typing import Optional # (1)
1+
from typing import Optional # (1)!
22

3-
from sqlmodel import Field, SQLModel, create_engine # (2)
3+
from sqlmodel import Field, SQLModel, create_engine # (2)!
44

55

6-
class Hero(SQLModel, table=True): # (3)
7-
id: Optional[int] = Field(default=None, primary_key=True) # (4)
8-
name: str # (5)
9-
secret_name: str # (6)
10-
age: Optional[int] = None # (7)
6+
class Hero(SQLModel, table=True): # (3)!
7+
id: Optional[int] = Field(default=None, primary_key=True) # (4)!
8+
name: str # (5)!
9+
secret_name: str # (6)!
10+
age: Optional[int] = None # (7)!
1111

1212

13-
sqlite_file_name = "database.db" # (8)
14-
sqlite_url = f"sqlite:///{sqlite_file_name}" # (9)
13+
sqlite_file_name = "database.db" # (8)!
14+
sqlite_url = f"sqlite:///{sqlite_file_name}" # (9)!
1515

16-
engine = create_engine(sqlite_url, echo=True) # (10)
16+
engine = create_engine(sqlite_url, echo=True) # (10)!
1717

1818

19-
def create_db_and_tables(): # (11)
20-
SQLModel.metadata.create_all(engine) # (12)
19+
def create_db_and_tables(): # (11)!
20+
SQLModel.metadata.create_all(engine) # (12)!
2121

2222

23-
if __name__ == "__main__": # (13)
24-
create_db_and_tables() # (14)
23+
if __name__ == "__main__": # (13)!
24+
create_db_and_tables() # (14)!

‎docs_src/tutorial/delete/tutorial002.py‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -71,23 +71,23 @@ def update_heroes():
7171

7272
def delete_heroes():
7373
with Session(engine) as session:
74-
statement = select(Hero).where(Hero.name == "Spider-Youngster") # (1)
75-
results = session.exec(statement) # (2)
76-
hero = results.one() # (3)
77-
print("Hero: ", hero) # (4)
74+
statement = select(Hero).where(Hero.name == "Spider-Youngster") # (1)!
75+
results = session.exec(statement) # (2)!
76+
hero = results.one() # (3)!
77+
print("Hero: ", hero) # (4)!
7878

79-
session.delete(hero) # (5)
80-
session.commit() # (6)
79+
session.delete(hero) # (5)!
80+
session.commit() # (6)!
8181

82-
print("Deleted hero:", hero) # (7)
82+
print("Deleted hero:", hero) # (7)!
8383

84-
statement = select(Hero).where(Hero.name == "Spider-Youngster") # (8)
85-
results = session.exec(statement) # (9)
86-
hero = results.first() # (10)
84+
statement = select(Hero).where(Hero.name == "Spider-Youngster") # (8)!
85+
results = session.exec(statement) # (9)!
86+
hero = results.first() # (10)!
8787

88-
if hero is None: # (11)
89-
print("There's no hero named Spider-Youngster") # (12)
90-
# (13)
88+
if hero is None: # (11)!
89+
print("There's no hero named Spider-Youngster") # (12)!
90+
# (13)!
9191

9292

9393
def main():

‎docs_src/tutorial/fastapi/app_testing/tutorial001/test_main_001.py‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
from fastapi.testclient import TestClient
22
from sqlmodel import Session, SQLModel, create_engine
33

4-
from .main import app, get_session # (1)
4+
from .main import app, get_session # (1)!
55

66

77
def test_create_hero():
@@ -17,16 +17,16 @@ def get_session_override():
1717

1818
app.dependency_overrides[get_session] = get_session_override
1919

20-
client = TestClient(app) # (2)
20+
client = TestClient(app) # (2)!
2121

22-
response = client.post( # (3)
22+
response = client.post( # (3)!
2323
"/heroes/", json={"name": "Deadpond", "secret_name": "Dive Wilson"}
2424
)
2525
app.dependency_overrides.clear()
26-
data = response.json() # (4)
26+
data = response.json() # (4)!
2727

28-
assert response.status_code == 200 # (5)
29-
assert data["name"] == "Deadpond" # (6)
30-
assert data["secret_name"] == "Dive Wilson" # (7)
31-
assert data["age"] is None # (8)
32-
assert data["id"] is not None # (9)
28+
assert response.status_code == 200 # (5)!
29+
assert data["name"] == "Deadpond" # (6)!
30+
assert data["secret_name"] == "Dive Wilson" # (7)!
31+
assert data["age"] is None # (8)!
32+
assert data["id"] is not None # (9)!

‎docs_src/tutorial/fastapi/app_testing/tutorial001/test_main_002.py‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
from fastapi.testclient import TestClient
22
from sqlmodel import Session, SQLModel, create_engine
33

4-
from .main import app, get_session # (1)
4+
from .main import app, get_session # (1)!
55

66

77
def test_create_hero():
@@ -12,17 +12,17 @@ def test_create_hero():
1212

1313
with Session(engine) as session:
1414

15-
def get_session_override(): # (2)
16-
return session # (3)
15+
def get_session_override(): # (2)!
16+
return session # (3)!
1717

18-
app.dependency_overrides[get_session] = get_session_override # (4)
18+
app.dependency_overrides[get_session] = get_session_override # (4)!
1919

2020
client = TestClient(app)
2121

2222
response = client.post(
2323
"/heroes/", json={"name": "Deadpond", "secret_name": "Dive Wilson"}
2424
)
25-
app.dependency_overrides.clear() # (5)
25+
app.dependency_overrides.clear() # (5)!
2626
data = response.json()
2727

2828
assert response.status_code == 200

‎docs_src/tutorial/fastapi/app_testing/tutorial001/test_main_003.py‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
from fastapi.testclient import TestClient
22
from sqlmodel import Session, SQLModel, create_engine
33

4-
from .main import app, get_session # (1)
4+
from .main import app, get_session # (1)!
55

66

77
def test_create_hero():
8-
engine = create_engine( # (2)
8+
engine = create_engine( # (2)!
99
"sqlite:///testing.db", connect_args={"check_same_thread": False}
1010
)
11-
SQLModel.metadata.create_all(engine) # (3)
11+
SQLModel.metadata.create_all(engine) # (3)!
1212

13-
with Session(engine) as session: # (4)
13+
with Session(engine) as session: # (4)!
1414

1515
def get_session_override():
16-
return session # (5)
16+
return session # (5)!
1717

18-
app.dependency_overrides[get_session] = get_session_override # (4)
18+
app.dependency_overrides[get_session] = get_session_override # (4)!
1919

2020
client = TestClient(app)
2121

@@ -30,4 +30,4 @@ def get_session_override():
3030
assert data["secret_name"] == "Dive Wilson"
3131
assert data["age"] is None
3232
assert data["id"] is not None
33-
# (6)
33+
# (6)!

‎docs_src/tutorial/fastapi/app_testing/tutorial001/test_main_004.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
from fastapi.testclient import TestClient
22
from sqlmodel import Session, SQLModel, create_engine
3-
from sqlmodel.pool import StaticPool # (1)
3+
from sqlmodel.pool import StaticPool # (1)!
44

55
from .main import app, get_session
66

77

88
def test_create_hero():
99
engine = create_engine(
10-
"sqlite://", # (2)
10+
"sqlite://", # (2)!
1111
connect_args={"check_same_thread": False},
12-
poolclass=StaticPool, # (3)
12+
poolclass=StaticPool, # (3)!
1313
)
1414
SQLModel.metadata.create_all(engine)
1515

‎docs_src/tutorial/fastapi/app_testing/tutorial001/test_main_005.py‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
1-
import pytest # (1)
1+
import pytest # (1)!
22
from fastapi.testclient import TestClient
33
from sqlmodel import Session, SQLModel, create_engine
44
from sqlmodel.pool import StaticPool
55

66
from .main import app, get_session
77

88

9-
@pytest.fixture(name="session") # (2)
10-
def session_fixture(): # (3)
9+
@pytest.fixture(name="session") # (2)!
10+
def session_fixture(): # (3)!
1111
engine = create_engine(
1212
"sqlite://", connect_args={"check_same_thread": False}, poolclass=StaticPool
1313
)
1414
SQLModel.metadata.create_all(engine)
1515
with Session(engine) as session:
16-
yield session # (4)
16+
yield session # (4)!
1717

1818

19-
def test_create_hero(session: Session): # (5)
19+
def test_create_hero(session: Session): # (5)!
2020
def get_session_override():
21-
return session # (6)
21+
return session # (6)!
2222

2323
app.dependency_overrides[get_session] = get_session_override
2424

‎docs_src/tutorial/fastapi/app_testing/tutorial001/test_main_006.py‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,19 +16,19 @@ def session_fixture():
1616
yield session
1717

1818

19-
@pytest.fixture(name="client") # (1)
20-
def client_fixture(session: Session): # (2)
21-
def get_session_override(): # (3)
19+
@pytest.fixture(name="client") # (1)!
20+
def client_fixture(session: Session): # (2)!
21+
def get_session_override(): # (3)!
2222
return session
2323

24-
app.dependency_overrides[get_session] = get_session_override # (4)
24+
app.dependency_overrides[get_session] = get_session_override # (4)!
2525

26-
client = TestClient(app) # (5)
27-
yield client # (6)
28-
app.dependency_overrides.clear() # (7)
26+
client = TestClient(app) # (5)!
27+
yield client # (6)!
28+
app.dependency_overrides.clear() # (7)!
2929

3030

31-
def test_create_hero(client: TestClient): # (8)
31+
def test_create_hero(client: TestClient): # (8)!
3232
response = client.post(
3333
"/heroes/", json={"name": "Deadpond", "secret_name": "Dive Wilson"}
3434
)

‎docs_src/tutorial/insert/tutorial003.py‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -20,24 +20,24 @@ def create_db_and_tables():
2020
SQLModel.metadata.create_all(engine)
2121

2222

23-
def create_heroes(): # (1)
24-
hero_1 = Hero(name="Deadpond", secret_name="Dive Wilson") # (2)
23+
def create_heroes(): # (1)!
24+
hero_1 = Hero(name="Deadpond", secret_name="Dive Wilson") # (2)!
2525
hero_2 = Hero(name="Spider-Boy", secret_name="Pedro Parqueador")
2626
hero_3 = Hero(name="Rusty-Man", secret_name="Tommy Sharp", age=48)
2727

28-
with Session(engine) as session: # (3)
29-
session.add(hero_1) # (4)
28+
with Session(engine) as session: # (3)!
29+
session.add(hero_1) # (4)!
3030
session.add(hero_2)
3131
session.add(hero_3)
3232

33-
session.commit() # (5)
34-
# (6)
33+
session.commit() # (5)!
34+
# (6)!
3535

3636

37-
def main(): # (7)
38-
create_db_and_tables() # (8)
39-
create_heroes() # (9)
37+
def main(): # (7)!
38+
create_db_and_tables() # (8)!
39+
create_heroes() # (9)!
4040

4141

42-
if __name__ == "__main__": # (10)
43-
main() # (11)
42+
if __name__ == "__main__": # (10)!
43+
main() # (11)!

0 commit comments

Comments
 (0)