🎨 Update inline source examples, hide # in annotations (from MkDocs Material)#677

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tiangolo merged 3 commits into from
Oct 29, 2023
Merged

🎨 Update inline source examples, hide # in annotations (from MkDocs Material) #677

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ab08cbd
Hide # for all annotations
Matthieu-LAURENT39 Oct 24, 2023
37db3c3
📝 Add extra missing exclamation points for MkDocs Material annotations
tiangolo Oct 29, 2023
ec31941
Merge branch 'main' into prettify_docs
tiangolo Oct 29, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
100 changes: 50 additions & 50 deletions docs_src/tutorial/automatic_id_none_refresh/tutorial002.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,56 +21,56 @@ def create_db_and_tables():


def create_heroes():
hero_1 = Hero(name="Deadpond", secret_name="Dive Wilson") # (1)
hero_2 = Hero(name="Spider-Boy", secret_name="Pedro Parqueador") # (2)
hero_3 = Hero(name="Rusty-Man", secret_name="Tommy Sharp", age=48) # (3)

print("Before interacting with the database") # (4)
print("Hero 1:", hero_1) # (5)
print("Hero 2:", hero_2) # (6)
print("Hero 3:", hero_3) # (7)

with Session(engine) as session: # (8)
session.add(hero_1) # (9)
session.add(hero_2) # (10)
session.add(hero_3) # (11)

print("After adding to the session") # (12)
print("Hero 1:", hero_1) # (13)
print("Hero 2:", hero_2) # (14)
print("Hero 3:", hero_3) # (15)

session.commit() # (16)

print("After committing the session") # (17)
print("Hero 1:", hero_1) # (18)
print("Hero 2:", hero_2) # (19)
print("Hero 3:", hero_3) # (20)

print("After committing the session, show IDs") # (21)
print("Hero 1 ID:", hero_1.id) # (22)
print("Hero 2 ID:", hero_2.id) # (23)
print("Hero 3 ID:", hero_3.id) # (24)

print("After committing the session, show names") # (25)
print("Hero 1 name:", hero_1.name) # (26)
print("Hero 2 name:", hero_2.name) # (27)
print("Hero 3 name:", hero_3.name) # (28)

session.refresh(hero_1) # (29)
session.refresh(hero_2) # (30)
session.refresh(hero_3) # (31)

print("After refreshing the heroes") # (32)
print("Hero 1:", hero_1) # (33)
print("Hero 2:", hero_2) # (34)
print("Hero 3:", hero_3) # (35)
# (36)

print("After the session closes") # (37)
print("Hero 1:", hero_1) # (38)
print("Hero 2:", hero_2) # (39)
print("Hero 3:", hero_3) # (40)
hero_1 = Hero(name="Deadpond", secret_name="Dive Wilson") # (1)!
hero_2 = Hero(name="Spider-Boy", secret_name="Pedro Parqueador") # (2)!
hero_3 = Hero(name="Rusty-Man", secret_name="Tommy Sharp", age=48) # (3)!

print("Before interacting with the database") # (4)!
print("Hero 1:", hero_1) # (5)!
print("Hero 2:", hero_2) # (6)!
print("Hero 3:", hero_3) # (7)!

with Session(engine) as session: # (8)!
session.add(hero_1) # (9)!
session.add(hero_2) # (10)!
session.add(hero_3) # (11)!

print("After adding to the session") # (12)!
print("Hero 1:", hero_1) # (13)!
print("Hero 2:", hero_2) # (14)!
print("Hero 3:", hero_3) # (15)!

session.commit() # (16)!

print("After committing the session") # (17)!
print("Hero 1:", hero_1) # (18)!
print("Hero 2:", hero_2) # (19)!
print("Hero 3:", hero_3) # (20)!

print("After committing the session, show IDs") # (21)!
print("Hero 1 ID:", hero_1.id) # (22)!
print("Hero 2 ID:", hero_2.id) # (23)!
print("Hero 3 ID:", hero_3.id) # (24)!

print("After committing the session, show names") # (25)!
print("Hero 1 name:", hero_1.name) # (26)!
print("Hero 2 name:", hero_2.name) # (27)!
print("Hero 3 name:", hero_3.name) # (28)!

session.refresh(hero_1) # (29)!
session.refresh(hero_2) # (30)!
session.refresh(hero_3) # (31)!

print("After refreshing the heroes") # (32)!
print("Hero 1:", hero_1) # (33)!
print("Hero 2:", hero_2) # (34)!
print("Hero 3:", hero_3) # (35)!
# (36)!

print("After the session closes") # (37)!
print("Hero 1:", hero_1) # (38)!
print("Hero 2:", hero_2) # (39)!
print("Hero 3:", hero_3) # (40)!


def main():
Expand Down
28 changes: 14 additions & 14 deletions docs_src/tutorial/create_db_and_table/tutorial003.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
from typing import Optional # (1)
from typing import Optional # (1)!

from sqlmodel import Field, SQLModel, create_engine # (2)
from sqlmodel import Field, SQLModel, create_engine # (2)!


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


sqlite_file_name = "database.db" # (8)
sqlite_url = f"sqlite:///{sqlite_file_name}" # (9)
sqlite_file_name = "database.db" # (8)!
sqlite_url = f"sqlite:///{sqlite_file_name}" # (9)!

engine = create_engine(sqlite_url, echo=True) # (10)
engine = create_engine(sqlite_url, echo=True) # (10)!


def create_db_and_tables(): # (11)
SQLModel.metadata.create_all(engine) # (12)
def create_db_and_tables(): # (11)!
SQLModel.metadata.create_all(engine) # (12)!


if __name__ == "__main__": # (13)
create_db_and_tables() # (14)
if __name__ == "__main__": # (13)!
create_db_and_tables() # (14)!
26 changes: 13 additions & 13 deletions docs_src/tutorial/delete/tutorial002.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -71,23 +71,23 @@ def update_heroes():

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

session.delete(hero) # (5)
session.commit() # (6)
session.delete(hero) # (5)!
session.commit() # (6)!

print("Deleted hero:", hero) # (7)
print("Deleted hero:", hero) # (7)!

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

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


def main():
Expand Down
18 changes: 9 additions & 9 deletions docs_src/tutorial/fastapi/app_testing/tutorial001/test_main_001.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
from fastapi.testclient import TestClient
from sqlmodel import Session, SQLModel, create_engine

from .main import app, get_session # (1)
from .main import app, get_session # (1)!


def test_create_hero():
Expand All@@ -17,16 +17,16 @@ def get_session_override():

app.dependency_overrides[get_session] = get_session_override

client = TestClient(app) # (2)
client = TestClient(app) # (2)!

response = client.post( # (3)
response = client.post( # (3)!
"/heroes/", json={"name": "Deadpond", "secret_name": "Dive Wilson"}
)
app.dependency_overrides.clear()
data = response.json() # (4)
data = response.json() # (4)!

assert response.status_code == 200 # (5)
assert data["name"] == "Deadpond" # (6)
assert data["secret_name"] == "Dive Wilson" # (7)
assert data["age"] is None # (8)
assert data["id"] is not None # (9)
assert response.status_code == 200 # (5)!
assert data["name"] == "Deadpond" # (6)!
assert data["secret_name"] == "Dive Wilson" # (7)!
assert data["age"] is None # (8)!
assert data["id"] is not None # (9)!
10 changes: 5 additions & 5 deletions docs_src/tutorial/fastapi/app_testing/tutorial001/test_main_002.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
from fastapi.testclient import TestClient
from sqlmodel import Session, SQLModel, create_engine

from .main import app, get_session # (1)
from .main import app, get_session # (1)!


def test_create_hero():
Expand All@@ -12,17 +12,17 @@ def test_create_hero():

with Session(engine) as session:

def get_session_override(): # (2)
return session # (3)
def get_session_override(): # (2)!
return session # (3)!

app.dependency_overrides[get_session] = get_session_override # (4)
app.dependency_overrides[get_session] = get_session_override # (4)!

client = TestClient(app)

response = client.post(
"/heroes/", json={"name": "Deadpond", "secret_name": "Dive Wilson"}
)
app.dependency_overrides.clear() # (5)
app.dependency_overrides.clear() # (5)!
data = response.json()

assert response.status_code == 200
Expand Down
14 changes: 7 additions & 7 deletions docs_src/tutorial/fastapi/app_testing/tutorial001/test_main_003.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
from fastapi.testclient import TestClient
from sqlmodel import Session, SQLModel, create_engine

from .main import app, get_session # (1)
from .main import app, get_session # (1)!


def test_create_hero():
engine = create_engine( # (2)
engine = create_engine( # (2)!
"sqlite:///testing.db", connect_args={"check_same_thread": False}
)
SQLModel.metadata.create_all(engine) # (3)
SQLModel.metadata.create_all(engine) # (3)!

with Session(engine) as session: # (4)
with Session(engine) as session: # (4)!

def get_session_override():
return session # (5)
return session # (5)!

app.dependency_overrides[get_session] = get_session_override # (4)
app.dependency_overrides[get_session] = get_session_override # (4)!

client = TestClient(app)

Expand All@@ -30,4 +30,4 @@ def get_session_override():
assert data["secret_name"] == "Dive Wilson"
assert data["age"] is None
assert data["id"] is not None
# (6)
# (6)!
6 changes: 3 additions & 3 deletions docs_src/tutorial/fastapi/app_testing/tutorial001/test_main_004.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
from fastapi.testclient import TestClient
from sqlmodel import Session, SQLModel, create_engine
from sqlmodel.pool import StaticPool # (1)
from sqlmodel.pool import StaticPool # (1)!

from .main import app, get_session


def test_create_hero():
engine = create_engine(
"sqlite://", # (2)
"sqlite://", # (2)!
connect_args={"check_same_thread": False},
poolclass=StaticPool, # (3)
poolclass=StaticPool, # (3)!
)
SQLModel.metadata.create_all(engine)

Expand Down
12 changes: 6 additions & 6 deletions docs_src/tutorial/fastapi/app_testing/tutorial001/test_main_005.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
import pytest # (1)
import pytest # (1)!
from fastapi.testclient import TestClient
from sqlmodel import Session, SQLModel, create_engine
from sqlmodel.pool import StaticPool

from .main import app, get_session


@pytest.fixture(name="session") # (2)
def session_fixture(): # (3)
@pytest.fixture(name="session") # (2)!
def session_fixture(): # (3)!
engine = create_engine(
"sqlite://", connect_args={"check_same_thread": False}, poolclass=StaticPool
)
SQLModel.metadata.create_all(engine)
with Session(engine) as session:
yield session # (4)
yield session # (4)!


def test_create_hero(session: Session): # (5)
def test_create_hero(session: Session): # (5)!
def get_session_override():
return session # (6)
return session # (6)!

app.dependency_overrides[get_session] = get_session_override

Expand Down
16 changes: 8 additions & 8 deletions docs_src/tutorial/fastapi/app_testing/tutorial001/test_main_006.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,19 +16,19 @@ def session_fixture():
yield session


@pytest.fixture(name="client") # (1)
def client_fixture(session: Session): # (2)
def get_session_override(): # (3)
@pytest.fixture(name="client") # (1)!
def client_fixture(session: Session): # (2)!
def get_session_override(): # (3)!
return session

app.dependency_overrides[get_session] = get_session_override # (4)
app.dependency_overrides[get_session] = get_session_override # (4)!

client = TestClient(app) # (5)
yield client # (6)
app.dependency_overrides.clear() # (7)
client = TestClient(app) # (5)!
yield client # (6)!
app.dependency_overrides.clear() # (7)!


def test_create_hero(client: TestClient): # (8)
def test_create_hero(client: TestClient): # (8)!
response = client.post(
"/heroes/", json={"name": "Deadpond", "secret_name": "Dive Wilson"}
)
Expand Down
22 changes: 11 additions & 11 deletions docs_src/tutorial/insert/tutorial003.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,24 +20,24 @@ def create_db_and_tables():
SQLModel.metadata.create_all(engine)


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

with Session(engine) as session: # (3)
session.add(hero_1) # (4)
with Session(engine) as session: # (3)!
session.add(hero_1) # (4)!
session.add(hero_2)
session.add(hero_3)

session.commit() # (5)
# (6)
session.commit() # (5)!
# (6)!


def main(): # (7)
create_db_and_tables() # (8)
create_heroes() # (9)
def main(): # (7)!
create_db_and_tables() # (8)!
create_heroes() # (9)!


if __name__ == "__main__": # (10)
main() # (11)
if __name__ == "__main__": # (10)!
main() # (11)!
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
🎨 Update inline source examples, hide # in annotations (from MkDocs Material)#677

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tiangolo
merged 3 commits into

from

Oct 29, 2023
 Merged


🎨 Update inline source examples, hide # in annotations (from MkDocs Material)
#677
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
ab08cbd

Hide # for all annotations


Matthieu-LAURENT39 Oct 24, 2023
37db3c3

📝 Add extra missing exclamation points for MkDocs Material annotations


tiangolo Oct 29, 2023
ec31941

Merge branch 'main' into prettify_docs


tiangolo Oct 29, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


100 changes: 50 additions & 50 deletions
docs_src/tutorial/automatic_id_none_refresh/tutorial002.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,56 +21,56 @@ def create_db_and_tables():


def create_heroes():
 hero_1 = Hero(name="Deadpond", secret_name="Dive Wilson") # (1)
 hero_2 = Hero(name="Spider-Boy", secret_name="Pedro Parqueador") # (2)
 hero_3 = Hero(name="Rusty-Man", secret_name="Tommy Sharp", age=48) # (3)

 print("Before interacting with the database") # (4)
 print("Hero 1:", hero_1) # (5)
 print("Hero 2:", hero_2) # (6)
 print("Hero 3:", hero_3) # (7)

 with Session(engine) as session: # (8)
 session.add(hero_1) # (9)
 session.add(hero_2) # (10)
 session.add(hero_3) # (11)

 print("After adding to the session") # (12)
 print("Hero 1:", hero_1) # (13)
 print("Hero 2:", hero_2) # (14)
 print("Hero 3:", hero_3) # (15)

 session.commit() # (16)

 print("After committing the session") # (17)
 print("Hero 1:", hero_1) # (18)
 print("Hero 2:", hero_2) # (19)
 print("Hero 3:", hero_3) # (20)

 print("After committing the session, show IDs") # (21)
 print("Hero 1 ID:", hero_1.id) # (22)
 print("Hero 2 ID:", hero_2.id) # (23)
 print("Hero 3 ID:", hero_3.id) # (24)

 print("After committing the session, show names") # (25)
 print("Hero 1 name:", hero_1.name) # (26)
 print("Hero 2 name:", hero_2.name) # (27)
 print("Hero 3 name:", hero_3.name) # (28)

 session.refresh(hero_1) # (29)
 session.refresh(hero_2) # (30)
 session.refresh(hero_3) # (31)

 print("After refreshing the heroes") # (32)
 print("Hero 1:", hero_1) # (33)
 print("Hero 2:", hero_2) # (34)
 print("Hero 3:", hero_3) # (35)
 # (36)

 print("After the session closes") # (37)
 print("Hero 1:", hero_1) # (38)
 print("Hero 2:", hero_2) # (39)
 print("Hero 3:", hero_3) # (40)
 hero_1 = Hero(name="Deadpond", secret_name="Dive Wilson") # (1)!
 hero_2 = Hero(name="Spider-Boy", secret_name="Pedro Parqueador") # (2)!
 hero_3 = Hero(name="Rusty-Man", secret_name="Tommy Sharp", age=48) # (3)!

 print("Before interacting with the database") # (4)!
 print("Hero 1:", hero_1) # (5)!
 print("Hero 2:", hero_2) # (6)!
 print("Hero 3:", hero_3) # (7)!

 with Session(engine) as session: # (8)!
 session.add(hero_1) # (9)!
 session.add(hero_2) # (10)!
 session.add(hero_3) # (11)!

 print("After adding to the session") # (12)!
 print("Hero 1:", hero_1) # (13)!
 print("Hero 2:", hero_2) # (14)!
 print("Hero 3:", hero_3) # (15)!

 session.commit() # (16)!

 print("After committing the session") # (17)!
 print("Hero 1:", hero_1) # (18)!
 print("Hero 2:", hero_2) # (19)!
 print("Hero 3:", hero_3) # (20)!

 print("After committing the session, show IDs") # (21)!
 print("Hero 1 ID:", hero_1.id) # (22)!
 print("Hero 2 ID:", hero_2.id) # (23)!
 print("Hero 3 ID:", hero_3.id) # (24)!

 print("After committing the session, show names") # (25)!
 print("Hero 1 name:", hero_1.name) # (26)!
 print("Hero 2 name:", hero_2.name) # (27)!
 print("Hero 3 name:", hero_3.name) # (28)!

 session.refresh(hero_1) # (29)!
 session.refresh(hero_2) # (30)!
 session.refresh(hero_3) # (31)!

 print("After refreshing the heroes") # (32)!
 print("Hero 1:", hero_1) # (33)!
 print("Hero 2:", hero_2) # (34)!
 print("Hero 3:", hero_3) # (35)!
 # (36)!

 print("After the session closes") # (37)!
 print("Hero 1:", hero_1) # (38)!
 print("Hero 2:", hero_2) # (39)!
 print("Hero 3:", hero_3) # (40)!


def main():
Expand Down

28 changes: 14 additions & 14 deletions
docs_src/tutorial/create_db_and_table/tutorial003.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
from typing import Optional # (1)
from typing import Optional # (1)!

from sqlmodel import Field, SQLModel, create_engine # (2)
from sqlmodel import Field, SQLModel, create_engine # (2)!


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


sqlite_file_name = "database.db" # (8)
sqlite_url = f"sqlite:///{sqlite_file_name}" # (9)
sqlite_file_name = "database.db" # (8)!
sqlite_url = f"sqlite:///{sqlite_file_name}" # (9)!

engine = create_engine(sqlite_url, echo=True) # (10)
engine = create_engine(sqlite_url, echo=True) # (10)!


def create_db_and_tables(): # (11)
 SQLModel.metadata.create_all(engine) # (12)
def create_db_and_tables(): # (11)!
 SQLModel.metadata.create_all(engine) # (12)!


if __name__ == "__main__": # (13)
 create_db_and_tables() # (14)
if __name__ == "__main__": # (13)!
 create_db_and_tables() # (14)!

26 changes: 13 additions & 13 deletions
docs_src/tutorial/delete/tutorial002.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -71,23 +71,23 @@ def update_heroes():

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

 session.delete(hero) # (5)
 session.commit() # (6)
 session.delete(hero) # (5)!
 session.commit() # (6)!

 print("Deleted hero:", hero) # (7)
 print("Deleted hero:", hero) # (7)!

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

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


def main():
Expand Down

18 changes: 9 additions & 9 deletions
docs_src/tutorial/fastapi/app_testing/tutorial001/test_main_001.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
from fastapi.testclient import TestClient
from sqlmodel import Session, SQLModel, create_engine

from .main import app, get_session # (1)
from .main import app, get_session # (1)!


def test_create_hero():
Expand All@@ -17,16 +17,16 @@ def get_session_override():

 app.dependency_overrides[get_session] = get_session_override

 client = TestClient(app) # (2)
 client = TestClient(app) # (2)!

 response = client.post( # (3)
 response = client.post( # (3)!
 "/heroes/", json={"name": "Deadpond", "secret_name": "Dive Wilson"}
 )
 app.dependency_overrides.clear()
 data = response.json() # (4)
 data = response.json() # (4)!

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

10 changes: 5 additions & 5 deletions
docs_src/tutorial/fastapi/app_testing/tutorial001/test_main_002.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
from fastapi.testclient import TestClient
from sqlmodel import Session, SQLModel, create_engine

from .main import app, get_session # (1)
from .main import app, get_session # (1)!


def test_create_hero():
Expand All@@ -12,17 +12,17 @@ def test_create_hero():

 with Session(engine) as session:

 def get_session_override(): # (2)
 return session # (3)
 def get_session_override(): # (2)!
 return session # (3)!

 app.dependency_overrides[get_session] = get_session_override # (4)
 app.dependency_overrides[get_session] = get_session_override # (4)!

 client = TestClient(app)

 response = client.post(
 "/heroes/", json={"name": "Deadpond", "secret_name": "Dive Wilson"}
 )
 app.dependency_overrides.clear() # (5)
 app.dependency_overrides.clear() # (5)!
 data = response.json()

 assert response.status_code == 200
Expand Down

14 changes: 7 additions & 7 deletions
docs_src/tutorial/fastapi/app_testing/tutorial001/test_main_003.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
from fastapi.testclient import TestClient
from sqlmodel import Session, SQLModel, create_engine

from .main import app, get_session # (1)
from .main import app, get_session # (1)!


def test_create_hero():
 engine = create_engine( # (2)
 engine = create_engine( # (2)!
 "sqlite:///testing.db", connect_args={"check_same_thread": False}
 )
 SQLModel.metadata.create_all(engine) # (3)
 SQLModel.metadata.create_all(engine) # (3)!

 with Session(engine) as session: # (4)
 with Session(engine) as session: # (4)!

 def get_session_override():
 return session # (5)
 return session # (5)!

 app.dependency_overrides[get_session] = get_session_override # (4)
 app.dependency_overrides[get_session] = get_session_override # (4)!

 client = TestClient(app)

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

6 changes: 3 additions & 3 deletions
docs_src/tutorial/fastapi/app_testing/tutorial001/test_main_004.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
from fastapi.testclient import TestClient
from sqlmodel import Session, SQLModel, create_engine
from sqlmodel.pool import StaticPool # (1)
from sqlmodel.pool import StaticPool # (1)!

from .main import app, get_session


def test_create_hero():
 engine = create_engine(
 "sqlite://", # (2)
 "sqlite://", # (2)!
 connect_args={"check_same_thread": False},
 poolclass=StaticPool, # (3)
 poolclass=StaticPool, # (3)!
 )
 SQLModel.metadata.create_all(engine)

Expand Down

12 changes: 6 additions & 6 deletions
docs_src/tutorial/fastapi/app_testing/tutorial001/test_main_005.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
import pytest # (1)
import pytest # (1)!
from fastapi.testclient import TestClient
from sqlmodel import Session, SQLModel, create_engine
from sqlmodel.pool import StaticPool

from .main import app, get_session


@pytest.fixture(name="session") # (2)
def session_fixture(): # (3)
@pytest.fixture(name="session") # (2)!
def session_fixture(): # (3)!
 engine = create_engine(
 "sqlite://", connect_args={"check_same_thread": False}, poolclass=StaticPool
 )
 SQLModel.metadata.create_all(engine)
 with Session(engine) as session:
 yield session # (4)
 yield session # (4)!


def test_create_hero(session: Session): # (5)
def test_create_hero(session: Session): # (5)!
 def get_session_override():
 return session # (6)
 return session # (6)!

 app.dependency_overrides[get_session] = get_session_override

Expand Down

16 changes: 8 additions & 8 deletions
docs_src/tutorial/fastapi/app_testing/tutorial001/test_main_006.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,19 +16,19 @@ def session_fixture():
 yield session


@pytest.fixture(name="client") # (1)
def client_fixture(session: Session): # (2)
 def get_session_override(): # (3)
@pytest.fixture(name="client") # (1)!
def client_fixture(session: Session): # (2)!
 def get_session_override(): # (3)!
 return session

 app.dependency_overrides[get_session] = get_session_override # (4)
 app.dependency_overrides[get_session] = get_session_override # (4)!

 client = TestClient(app) # (5)
 yield client # (6)
 app.dependency_overrides.clear() # (7)
 client = TestClient(app) # (5)!
 yield client # (6)!
 app.dependency_overrides.clear() # (7)!


def test_create_hero(client: TestClient): # (8)
def test_create_hero(client: TestClient): # (8)!
 response = client.post(
 "/heroes/", json={"name": "Deadpond", "secret_name": "Dive Wilson"}
 )
Expand Down

22 changes: 11 additions & 11 deletions
docs_src/tutorial/insert/tutorial003.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,24 +20,24 @@ def create_db_and_tables():
 SQLModel.metadata.create_all(engine)


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

 with Session(engine) as session: # (3)
 session.add(hero_1) # (4)
 with Session(engine) as session: # (3)!
 session.add(hero_1) # (4)!
 session.add(hero_2)
 session.add(hero_3)

 session.commit() # (5)
 # (6)
 session.commit() # (5)!
 # (6)!


def main(): # (7)
 create_db_and_tables() # (8)
 create_heroes() # (9)
def main(): # (7)!
 create_db_and_tables() # (8)!
 create_heroes() # (9)!


if __name__ == "__main__": # (10)
 main() # (11)
if __name__ == "__main__": # (10)!
 main() # (11)!
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
🎨 Update inline source examples, hide # in annotations (from MkDocs Material)#677

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tiangolo
merged 3 commits into

from

Oct 29, 2023
 Merged


🎨 Update inline source examples, hide # in annotations (from MkDocs Material)
#677
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
ab08cbd

Hide # for all annotations


Matthieu-LAURENT39 Oct 24, 2023
37db3c3

📝 Add extra missing exclamation points for MkDocs Material annotations


tiangolo Oct 29, 2023
ec31941

Merge branch 'main' into prettify_docs


tiangolo Oct 29, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


100 changes: 50 additions & 50 deletions
docs_src/tutorial/automatic_id_none_refresh/tutorial002.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,56 +21,56 @@ def create_db_and_tables():


def create_heroes():
 hero_1 = Hero(name="Deadpond", secret_name="Dive Wilson") # (1)
 hero_2 = Hero(name="Spider-Boy", secret_name="Pedro Parqueador") # (2)
 hero_3 = Hero(name="Rusty-Man", secret_name="Tommy Sharp", age=48) # (3)

 print("Before interacting with the database") # (4)
 print("Hero 1:", hero_1) # (5)
 print("Hero 2:", hero_2) # (6)
 print("Hero 3:", hero_3) # (7)

 with Session(engine) as session: # (8)
 session.add(hero_1) # (9)
 session.add(hero_2) # (10)
 session.add(hero_3) # (11)

 print("After adding to the session") # (12)
 print("Hero 1:", hero_1) # (13)
 print("Hero 2:", hero_2) # (14)
 print("Hero 3:", hero_3) # (15)

 session.commit() # (16)

 print("After committing the session") # (17)
 print("Hero 1:", hero_1) # (18)
 print("Hero 2:", hero_2) # (19)
 print("Hero 3:", hero_3) # (20)

 print("After committing the session, show IDs") # (21)
 print("Hero 1 ID:", hero_1.id) # (22)
 print("Hero 2 ID:", hero_2.id) # (23)
 print("Hero 3 ID:", hero_3.id) # (24)

 print("After committing the session, show names") # (25)
 print("Hero 1 name:", hero_1.name) # (26)
 print("Hero 2 name:", hero_2.name) # (27)
 print("Hero 3 name:", hero_3.name) # (28)

 session.refresh(hero_1) # (29)
 session.refresh(hero_2) # (30)
 session.refresh(hero_3) # (31)

 print("After refreshing the heroes") # (32)
 print("Hero 1:", hero_1) # (33)
 print("Hero 2:", hero_2) # (34)
 print("Hero 3:", hero_3) # (35)
 # (36)

 print("After the session closes") # (37)
 print("Hero 1:", hero_1) # (38)
 print("Hero 2:", hero_2) # (39)
 print("Hero 3:", hero_3) # (40)
 hero_1 = Hero(name="Deadpond", secret_name="Dive Wilson") # (1)!
 hero_2 = Hero(name="Spider-Boy", secret_name="Pedro Parqueador") # (2)!
 hero_3 = Hero(name="Rusty-Man", secret_name="Tommy Sharp", age=48) # (3)!

 print("Before interacting with the database") # (4)!
 print("Hero 1:", hero_1) # (5)!
 print("Hero 2:", hero_2) # (6)!
 print("Hero 3:", hero_3) # (7)!

 with Session(engine) as session: # (8)!
 session.add(hero_1) # (9)!
 session.add(hero_2) # (10)!
 session.add(hero_3) # (11)!

 print("After adding to the session") # (12)!
 print("Hero 1:", hero_1) # (13)!
 print("Hero 2:", hero_2) # (14)!
 print("Hero 3:", hero_3) # (15)!

 session.commit() # (16)!

 print("After committing the session") # (17)!
 print("Hero 1:", hero_1) # (18)!
 print("Hero 2:", hero_2) # (19)!
 print("Hero 3:", hero_3) # (20)!

 print("After committing the session, show IDs") # (21)!
 print("Hero 1 ID:", hero_1.id) # (22)!
 print("Hero 2 ID:", hero_2.id) # (23)!
 print("Hero 3 ID:", hero_3.id) # (24)!

 print("After committing the session, show names") # (25)!
 print("Hero 1 name:", hero_1.name) # (26)!
 print("Hero 2 name:", hero_2.name) # (27)!
 print("Hero 3 name:", hero_3.name) # (28)!

 session.refresh(hero_1) # (29)!
 session.refresh(hero_2) # (30)!
 session.refresh(hero_3) # (31)!

 print("After refreshing the heroes") # (32)!
 print("Hero 1:", hero_1) # (33)!
 print("Hero 2:", hero_2) # (34)!
 print("Hero 3:", hero_3) # (35)!
 # (36)!

 print("After the session closes") # (37)!
 print("Hero 1:", hero_1) # (38)!
 print("Hero 2:", hero_2) # (39)!
 print("Hero 3:", hero_3) # (40)!


def main():
Expand Down

28 changes: 14 additions & 14 deletions
docs_src/tutorial/create_db_and_table/tutorial003.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
from typing import Optional # (1)
from typing import Optional # (1)!

from sqlmodel import Field, SQLModel, create_engine # (2)
from sqlmodel import Field, SQLModel, create_engine # (2)!


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


sqlite_file_name = "database.db" # (8)
sqlite_url = f"sqlite:///{sqlite_file_name}" # (9)
sqlite_file_name = "database.db" # (8)!
sqlite_url = f"sqlite:///{sqlite_file_name}" # (9)!

engine = create_engine(sqlite_url, echo=True) # (10)
engine = create_engine(sqlite_url, echo=True) # (10)!


def create_db_and_tables(): # (11)
 SQLModel.metadata.create_all(engine) # (12)
def create_db_and_tables(): # (11)!
 SQLModel.metadata.create_all(engine) # (12)!


if __name__ == "__main__": # (13)
 create_db_and_tables() # (14)
if __name__ == "__main__": # (13)!
 create_db_and_tables() # (14)!

26 changes: 13 additions & 13 deletions
docs_src/tutorial/delete/tutorial002.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -71,23 +71,23 @@ def update_heroes():

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

 session.delete(hero) # (5)
 session.commit() # (6)
 session.delete(hero) # (5)!
 session.commit() # (6)!

 print("Deleted hero:", hero) # (7)
 print("Deleted hero:", hero) # (7)!

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

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


def main():
Expand Down

18 changes: 9 additions & 9 deletions
docs_src/tutorial/fastapi/app_testing/tutorial001/test_main_001.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
from fastapi.testclient import TestClient
from sqlmodel import Session, SQLModel, create_engine

from .main import app, get_session # (1)
from .main import app, get_session # (1)!


def test_create_hero():
Expand All@@ -17,16 +17,16 @@ def get_session_override():

 app.dependency_overrides[get_session] = get_session_override

 client = TestClient(app) # (2)
 client = TestClient(app) # (2)!

 response = client.post( # (3)
 response = client.post( # (3)!
 "/heroes/", json={"name": "Deadpond", "secret_name": "Dive Wilson"}
 )
 app.dependency_overrides.clear()
 data = response.json() # (4)
 data = response.json() # (4)!

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

10 changes: 5 additions & 5 deletions
docs_src/tutorial/fastapi/app_testing/tutorial001/test_main_002.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
from fastapi.testclient import TestClient
from sqlmodel import Session, SQLModel, create_engine

from .main import app, get_session # (1)
from .main import app, get_session # (1)!


def test_create_hero():
Expand All@@ -12,17 +12,17 @@ def test_create_hero():

 with Session(engine) as session:

 def get_session_override(): # (2)
 return session # (3)
 def get_session_override(): # (2)!
 return session # (3)!

 app.dependency_overrides[get_session] = get_session_override # (4)
 app.dependency_overrides[get_session] = get_session_override # (4)!

 client = TestClient(app)

 response = client.post(
 "/heroes/", json={"name": "Deadpond", "secret_name": "Dive Wilson"}
 )
 app.dependency_overrides.clear() # (5)
 app.dependency_overrides.clear() # (5)!
 data = response.json()

 assert response.status_code == 200
Expand Down

14 changes: 7 additions & 7 deletions
docs_src/tutorial/fastapi/app_testing/tutorial001/test_main_003.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
from fastapi.testclient import TestClient
from sqlmodel import Session, SQLModel, create_engine

from .main import app, get_session # (1)
from .main import app, get_session # (1)!


def test_create_hero():
 engine = create_engine( # (2)
 engine = create_engine( # (2)!
 "sqlite:///testing.db", connect_args={"check_same_thread": False}
 )
 SQLModel.metadata.create_all(engine) # (3)
 SQLModel.metadata.create_all(engine) # (3)!

 with Session(engine) as session: # (4)
 with Session(engine) as session: # (4)!

 def get_session_override():
 return session # (5)
 return session # (5)!

 app.dependency_overrides[get_session] = get_session_override # (4)
 app.dependency_overrides[get_session] = get_session_override # (4)!

 client = TestClient(app)

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

6 changes: 3 additions & 3 deletions
docs_src/tutorial/fastapi/app_testing/tutorial001/test_main_004.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
from fastapi.testclient import TestClient
from sqlmodel import Session, SQLModel, create_engine
from sqlmodel.pool import StaticPool # (1)
from sqlmodel.pool import StaticPool # (1)!

from .main import app, get_session


def test_create_hero():
 engine = create_engine(
 "sqlite://", # (2)
 "sqlite://", # (2)!
 connect_args={"check_same_thread": False},
 poolclass=StaticPool, # (3)
 poolclass=StaticPool, # (3)!
 )
 SQLModel.metadata.create_all(engine)

Expand Down

12 changes: 6 additions & 6 deletions
docs_src/tutorial/fastapi/app_testing/tutorial001/test_main_005.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
import pytest # (1)
import pytest # (1)!
from fastapi.testclient import TestClient
from sqlmodel import Session, SQLModel, create_engine
from sqlmodel.pool import StaticPool

from .main import app, get_session


@pytest.fixture(name="session") # (2)
def session_fixture(): # (3)
@pytest.fixture(name="session") # (2)!
def session_fixture(): # (3)!
 engine = create_engine(
 "sqlite://", connect_args={"check_same_thread": False}, poolclass=StaticPool
 )
 SQLModel.metadata.create_all(engine)
 with Session(engine) as session:
 yield session # (4)
 yield session # (4)!


def test_create_hero(session: Session): # (5)
def test_create_hero(session: Session): # (5)!
 def get_session_override():
 return session # (6)
 return session # (6)!

 app.dependency_overrides[get_session] = get_session_override

Expand Down

16 changes: 8 additions & 8 deletions
docs_src/tutorial/fastapi/app_testing/tutorial001/test_main_006.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,19 +16,19 @@ def session_fixture():
 yield session


@pytest.fixture(name="client") # (1)
def client_fixture(session: Session): # (2)
 def get_session_override(): # (3)
@pytest.fixture(name="client") # (1)!
def client_fixture(session: Session): # (2)!
 def get_session_override(): # (3)!
 return session

 app.dependency_overrides[get_session] = get_session_override # (4)
 app.dependency_overrides[get_session] = get_session_override # (4)!

 client = TestClient(app) # (5)
 yield client # (6)
 app.dependency_overrides.clear() # (7)
 client = TestClient(app) # (5)!
 yield client # (6)!
 app.dependency_overrides.clear() # (7)!


def test_create_hero(client: TestClient): # (8)
def test_create_hero(client: TestClient): # (8)!
 response = client.post(
 "/heroes/", json={"name": "Deadpond", "secret_name": "Dive Wilson"}
 )
Expand Down

22 changes: 11 additions & 11 deletions
docs_src/tutorial/insert/tutorial003.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,24 +20,24 @@ def create_db_and_tables():
 SQLModel.metadata.create_all(engine)


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

 with Session(engine) as session: # (3)
 session.add(hero_1) # (4)
 with Session(engine) as session: # (3)!
 session.add(hero_1) # (4)!
 session.add(hero_2)
 session.add(hero_3)

 session.commit() # (5)
 # (6)
 session.commit() # (5)!
 # (6)!


def main(): # (7)
 create_db_and_tables() # (8)
 create_heroes() # (9)
def main(): # (7)!
 create_db_and_tables() # (8)!
 create_heroes() # (9)!


if __name__ == "__main__": # (10)
 main() # (11)
if __name__ == "__main__": # (10)!
 main() # (11)!
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
🎨 Update inline source examples, hide # in annotations (from MkDocs Material)#677

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tiangolo
merged 3 commits into

from

Oct 29, 2023
 Merged


🎨 Update inline source examples, hide # in annotations (from MkDocs Material)
#677
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
ab08cbd

Hide # for all annotations


Matthieu-LAURENT39 Oct 24, 2023
37db3c3

📝 Add extra missing exclamation points for MkDocs Material annotations


tiangolo Oct 29, 2023
ec31941

Merge branch 'main' into prettify_docs


tiangolo Oct 29, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


100 changes: 50 additions & 50 deletions
docs_src/tutorial/automatic_id_none_refresh/tutorial002.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,56 +21,56 @@ def create_db_and_tables():


def create_heroes():
 hero_1 = Hero(name="Deadpond", secret_name="Dive Wilson") # (1)
 hero_2 = Hero(name="Spider-Boy", secret_name="Pedro Parqueador") # (2)
 hero_3 = Hero(name="Rusty-Man", secret_name="Tommy Sharp", age=48) # (3)

 print("Before interacting with the database") # (4)
 print("Hero 1:", hero_1) # (5)
 print("Hero 2:", hero_2) # (6)
 print("Hero 3:", hero_3) # (7)

 with Session(engine) as session: # (8)
 session.add(hero_1) # (9)
 session.add(hero_2) # (10)
 session.add(hero_3) # (11)

 print("After adding to the session") # (12)
 print("Hero 1:", hero_1) # (13)
 print("Hero 2:", hero_2) # (14)
 print("Hero 3:", hero_3) # (15)

 session.commit() # (16)

 print("After committing the session") # (17)
 print("Hero 1:", hero_1) # (18)
 print("Hero 2:", hero_2) # (19)
 print("Hero 3:", hero_3) # (20)

 print("After committing the session, show IDs") # (21)
 print("Hero 1 ID:", hero_1.id) # (22)
 print("Hero 2 ID:", hero_2.id) # (23)
 print("Hero 3 ID:", hero_3.id) # (24)

 print("After committing the session, show names") # (25)
 print("Hero 1 name:", hero_1.name) # (26)
 print("Hero 2 name:", hero_2.name) # (27)
 print("Hero 3 name:", hero_3.name) # (28)

 session.refresh(hero_1) # (29)
 session.refresh(hero_2) # (30)
 session.refresh(hero_3) # (31)

 print("After refreshing the heroes") # (32)
 print("Hero 1:", hero_1) # (33)
 print("Hero 2:", hero_2) # (34)
 print("Hero 3:", hero_3) # (35)
 # (36)

 print("After the session closes") # (37)
 print("Hero 1:", hero_1) # (38)
 print("Hero 2:", hero_2) # (39)
 print("Hero 3:", hero_3) # (40)
 hero_1 = Hero(name="Deadpond", secret_name="Dive Wilson") # (1)!
 hero_2 = Hero(name="Spider-Boy", secret_name="Pedro Parqueador") # (2)!
 hero_3 = Hero(name="Rusty-Man", secret_name="Tommy Sharp", age=48) # (3)!

 print("Before interacting with the database") # (4)!
 print("Hero 1:", hero_1) # (5)!
 print("Hero 2:", hero_2) # (6)!
 print("Hero 3:", hero_3) # (7)!

 with Session(engine) as session: # (8)!
 session.add(hero_1) # (9)!
 session.add(hero_2) # (10)!
 session.add(hero_3) # (11)!

 print("After adding to the session") # (12)!
 print("Hero 1:", hero_1) # (13)!
 print("Hero 2:", hero_2) # (14)!
 print("Hero 3:", hero_3) # (15)!

 session.commit() # (16)!

 print("After committing the session") # (17)!
 print("Hero 1:", hero_1) # (18)!
 print("Hero 2:", hero_2) # (19)!
 print("Hero 3:", hero_3) # (20)!

 print("After committing the session, show IDs") # (21)!
 print("Hero 1 ID:", hero_1.id) # (22)!
 print("Hero 2 ID:", hero_2.id) # (23)!
 print("Hero 3 ID:", hero_3.id) # (24)!

 print("After committing the session, show names") # (25)!
 print("Hero 1 name:", hero_1.name) # (26)!
 print("Hero 2 name:", hero_2.name) # (27)!
 print("Hero 3 name:", hero_3.name) # (28)!

 session.refresh(hero_1) # (29)!
 session.refresh(hero_2) # (30)!
 session.refresh(hero_3) # (31)!

 print("After refreshing the heroes") # (32)!
 print("Hero 1:", hero_1) # (33)!
 print("Hero 2:", hero_2) # (34)!
 print("Hero 3:", hero_3) # (35)!
 # (36)!

 print("After the session closes") # (37)!
 print("Hero 1:", hero_1) # (38)!
 print("Hero 2:", hero_2) # (39)!
 print("Hero 3:", hero_3) # (40)!


def main():
Expand Down

28 changes: 14 additions & 14 deletions
docs_src/tutorial/create_db_and_table/tutorial003.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
from typing import Optional # (1)
from typing import Optional # (1)!

from sqlmodel import Field, SQLModel, create_engine # (2)
from sqlmodel import Field, SQLModel, create_engine # (2)!


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


sqlite_file_name = "database.db" # (8)
sqlite_url = f"sqlite:///{sqlite_file_name}" # (9)
sqlite_file_name = "database.db" # (8)!
sqlite_url = f"sqlite:///{sqlite_file_name}" # (9)!

engine = create_engine(sqlite_url, echo=True) # (10)
engine = create_engine(sqlite_url, echo=True) # (10)!


def create_db_and_tables(): # (11)
 SQLModel.metadata.create_all(engine) # (12)
def create_db_and_tables(): # (11)!
 SQLModel.metadata.create_all(engine) # (12)!


if __name__ == "__main__": # (13)
 create_db_and_tables() # (14)
if __name__ == "__main__": # (13)!
 create_db_and_tables() # (14)!

26 changes: 13 additions & 13 deletions
docs_src/tutorial/delete/tutorial002.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -71,23 +71,23 @@ def update_heroes():

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

 session.delete(hero) # (5)
 session.commit() # (6)
 session.delete(hero) # (5)!
 session.commit() # (6)!

 print("Deleted hero:", hero) # (7)
 print("Deleted hero:", hero) # (7)!

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

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


def main():
Expand Down

18 changes: 9 additions & 9 deletions
docs_src/tutorial/fastapi/app_testing/tutorial001/test_main_001.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
from fastapi.testclient import TestClient
from sqlmodel import Session, SQLModel, create_engine

from .main import app, get_session # (1)
from .main import app, get_session # (1)!


def test_create_hero():
Expand All@@ -17,16 +17,16 @@ def get_session_override():

 app.dependency_overrides[get_session] = get_session_override

 client = TestClient(app) # (2)
 client = TestClient(app) # (2)!

 response = client.post( # (3)
 response = client.post( # (3)!
 "/heroes/", json={"name": "Deadpond", "secret_name": "Dive Wilson"}
 )
 app.dependency_overrides.clear()
 data = response.json() # (4)
 data = response.json() # (4)!

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

10 changes: 5 additions & 5 deletions
docs_src/tutorial/fastapi/app_testing/tutorial001/test_main_002.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
from fastapi.testclient import TestClient
from sqlmodel import Session, SQLModel, create_engine

from .main import app, get_session # (1)
from .main import app, get_session # (1)!


def test_create_hero():
Expand All@@ -12,17 +12,17 @@ def test_create_hero():

 with Session(engine) as session:

 def get_session_override(): # (2)
 return session # (3)
 def get_session_override(): # (2)!
 return session # (3)!

 app.dependency_overrides[get_session] = get_session_override # (4)
 app.dependency_overrides[get_session] = get_session_override # (4)!

 client = TestClient(app)

 response = client.post(
 "/heroes/", json={"name": "Deadpond", "secret_name": "Dive Wilson"}
 )
 app.dependency_overrides.clear() # (5)
 app.dependency_overrides.clear() # (5)!
 data = response.json()

 assert response.status_code == 200
Expand Down

14 changes: 7 additions & 7 deletions
docs_src/tutorial/fastapi/app_testing/tutorial001/test_main_003.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
from fastapi.testclient import TestClient
from sqlmodel import Session, SQLModel, create_engine

from .main import app, get_session # (1)
from .main import app, get_session # (1)!


def test_create_hero():
 engine = create_engine( # (2)
 engine = create_engine( # (2)!
 "sqlite:///testing.db", connect_args={"check_same_thread": False}
 )
 SQLModel.metadata.create_all(engine) # (3)
 SQLModel.metadata.create_all(engine) # (3)!

 with Session(engine) as session: # (4)
 with Session(engine) as session: # (4)!

 def get_session_override():
 return session # (5)
 return session # (5)!

 app.dependency_overrides[get_session] = get_session_override # (4)
 app.dependency_overrides[get_session] = get_session_override # (4)!

 client = TestClient(app)

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

6 changes: 3 additions & 3 deletions
docs_src/tutorial/fastapi/app_testing/tutorial001/test_main_004.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
from fastapi.testclient import TestClient
from sqlmodel import Session, SQLModel, create_engine
from sqlmodel.pool import StaticPool # (1)
from sqlmodel.pool import StaticPool # (1)!

from .main import app, get_session


def test_create_hero():
 engine = create_engine(
 "sqlite://", # (2)
 "sqlite://", # (2)!
 connect_args={"check_same_thread": False},
 poolclass=StaticPool, # (3)
 poolclass=StaticPool, # (3)!
 )
 SQLModel.metadata.create_all(engine)

Expand Down

12 changes: 6 additions & 6 deletions
docs_src/tutorial/fastapi/app_testing/tutorial001/test_main_005.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
import pytest # (1)
import pytest # (1)!
from fastapi.testclient import TestClient
from sqlmodel import Session, SQLModel, create_engine
from sqlmodel.pool import StaticPool

from .main import app, get_session


@pytest.fixture(name="session") # (2)
def session_fixture(): # (3)
@pytest.fixture(name="session") # (2)!
def session_fixture(): # (3)!
 engine = create_engine(
 "sqlite://", connect_args={"check_same_thread": False}, poolclass=StaticPool
 )
 SQLModel.metadata.create_all(engine)
 with Session(engine) as session:
 yield session # (4)
 yield session # (4)!


def test_create_hero(session: Session): # (5)
def test_create_hero(session: Session): # (5)!
 def get_session_override():
 return session # (6)
 return session # (6)!

 app.dependency_overrides[get_session] = get_session_override

Expand Down

16 changes: 8 additions & 8 deletions
docs_src/tutorial/fastapi/app_testing/tutorial001/test_main_006.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,19 +16,19 @@ def session_fixture():
 yield session


@pytest.fixture(name="client") # (1)
def client_fixture(session: Session): # (2)
 def get_session_override(): # (3)
@pytest.fixture(name="client") # (1)!
def client_fixture(session: Session): # (2)!
 def get_session_override(): # (3)!
 return session

 app.dependency_overrides[get_session] = get_session_override # (4)
 app.dependency_overrides[get_session] = get_session_override # (4)!

 client = TestClient(app) # (5)
 yield client # (6)
 app.dependency_overrides.clear() # (7)
 client = TestClient(app) # (5)!
 yield client # (6)!
 app.dependency_overrides.clear() # (7)!


def test_create_hero(client: TestClient): # (8)
def test_create_hero(client: TestClient): # (8)!
 response = client.post(
 "/heroes/", json={"name": "Deadpond", "secret_name": "Dive Wilson"}
 )
Expand Down

22 changes: 11 additions & 11 deletions
docs_src/tutorial/insert/tutorial003.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,24 +20,24 @@ def create_db_and_tables():
 SQLModel.metadata.create_all(engine)


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

 with Session(engine) as session: # (3)
 session.add(hero_1) # (4)
 with Session(engine) as session: # (3)!
 session.add(hero_1) # (4)!
 session.add(hero_2)
 session.add(hero_3)

 session.commit() # (5)
 # (6)
 session.commit() # (5)!
 # (6)!


def main(): # (7)
 create_db_and_tables() # (8)
 create_heroes() # (9)
def main(): # (7)!
 create_db_and_tables() # (8)!
 create_heroes() # (9)!


if __name__ == "__main__": # (10)
 main() # (11)
if __name__ == "__main__": # (10)!
 main() # (11)!
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
🎨 Update inline source examples, hide # in annotations (from MkDocs Material)#677

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tiangolo
merged 3 commits into

from

Oct 29, 2023
 Merged


🎨 Update inline source examples, hide # in annotations (from MkDocs Material)
#677
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
ab08cbd

Hide # for all annotations


Matthieu-LAURENT39 Oct 24, 2023
37db3c3

📝 Add extra missing exclamation points for MkDocs Material annotations


tiangolo Oct 29, 2023
ec31941

Merge branch 'main' into prettify_docs


tiangolo Oct 29, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


100 changes: 50 additions & 50 deletions
docs_src/tutorial/automatic_id_none_refresh/tutorial002.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,56 +21,56 @@ def create_db_and_tables():


def create_heroes():
 hero_1 = Hero(name="Deadpond", secret_name="Dive Wilson") # (1)
 hero_2 = Hero(name="Spider-Boy", secret_name="Pedro Parqueador") # (2)
 hero_3 = Hero(name="Rusty-Man", secret_name="Tommy Sharp", age=48) # (3)

 print("Before interacting with the database") # (4)
 print("Hero 1:", hero_1) # (5)
 print("Hero 2:", hero_2) # (6)
 print("Hero 3:", hero_3) # (7)

 with Session(engine) as session: # (8)
 session.add(hero_1) # (9)
 session.add(hero_2) # (10)
 session.add(hero_3) # (11)

 print("After adding to the session") # (12)
 print("Hero 1:", hero_1) # (13)
 print("Hero 2:", hero_2) # (14)
 print("Hero 3:", hero_3) # (15)

 session.commit() # (16)

 print("After committing the session") # (17)
 print("Hero 1:", hero_1) # (18)
 print("Hero 2:", hero_2) # (19)
 print("Hero 3:", hero_3) # (20)

 print("After committing the session, show IDs") # (21)
 print("Hero 1 ID:", hero_1.id) # (22)
 print("Hero 2 ID:", hero_2.id) # (23)
 print("Hero 3 ID:", hero_3.id) # (24)

 print("After committing the session, show names") # (25)
 print("Hero 1 name:", hero_1.name) # (26)
 print("Hero 2 name:", hero_2.name) # (27)
 print("Hero 3 name:", hero_3.name) # (28)

 session.refresh(hero_1) # (29)
 session.refresh(hero_2) # (30)
 session.refresh(hero_3) # (31)

 print("After refreshing the heroes") # (32)
 print("Hero 1:", hero_1) # (33)
 print("Hero 2:", hero_2) # (34)
 print("Hero 3:", hero_3) # (35)
 # (36)

 print("After the session closes") # (37)
 print("Hero 1:", hero_1) # (38)
 print("Hero 2:", hero_2) # (39)
 print("Hero 3:", hero_3) # (40)
 hero_1 = Hero(name="Deadpond", secret_name="Dive Wilson") # (1)!
 hero_2 = Hero(name="Spider-Boy", secret_name="Pedro Parqueador") # (2)!
 hero_3 = Hero(name="Rusty-Man", secret_name="Tommy Sharp", age=48) # (3)!

 print("Before interacting with the database") # (4)!
 print("Hero 1:", hero_1) # (5)!
 print("Hero 2:", hero_2) # (6)!
 print("Hero 3:", hero_3) # (7)!

 with Session(engine) as session: # (8)!
 session.add(hero_1) # (9)!
 session.add(hero_2) # (10)!
 session.add(hero_3) # (11)!

 print("After adding to the session") # (12)!
 print("Hero 1:", hero_1) # (13)!
 print("Hero 2:", hero_2) # (14)!
 print("Hero 3:", hero_3) # (15)!

 session.commit() # (16)!

 print("After committing the session") # (17)!
 print("Hero 1:", hero_1) # (18)!
 print("Hero 2:", hero_2) # (19)!
 print("Hero 3:", hero_3) # (20)!

 print("After committing the session, show IDs") # (21)!
 print("Hero 1 ID:", hero_1.id) # (22)!
 print("Hero 2 ID:", hero_2.id) # (23)!
 print("Hero 3 ID:", hero_3.id) # (24)!

 print("After committing the session, show names") # (25)!
 print("Hero 1 name:", hero_1.name) # (26)!
 print("Hero 2 name:", hero_2.name) # (27)!
 print("Hero 3 name:", hero_3.name) # (28)!

 session.refresh(hero_1) # (29)!
 session.refresh(hero_2) # (30)!
 session.refresh(hero_3) # (31)!

 print("After refreshing the heroes") # (32)!
 print("Hero 1:", hero_1) # (33)!
 print("Hero 2:", hero_2) # (34)!
 print("Hero 3:", hero_3) # (35)!
 # (36)!

 print("After the session closes") # (37)!
 print("Hero 1:", hero_1) # (38)!
 print("Hero 2:", hero_2) # (39)!
 print("Hero 3:", hero_3) # (40)!


def main():
Expand Down

28 changes: 14 additions & 14 deletions
docs_src/tutorial/create_db_and_table/tutorial003.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
from typing import Optional # (1)
from typing import Optional # (1)!

from sqlmodel import Field, SQLModel, create_engine # (2)
from sqlmodel import Field, SQLModel, create_engine # (2)!


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


sqlite_file_name = "database.db" # (8)
sqlite_url = f"sqlite:///{sqlite_file_name}" # (9)
sqlite_file_name = "database.db" # (8)!
sqlite_url = f"sqlite:///{sqlite_file_name}" # (9)!

engine = create_engine(sqlite_url, echo=True) # (10)
engine = create_engine(sqlite_url, echo=True) # (10)!


def create_db_and_tables(): # (11)
 SQLModel.metadata.create_all(engine) # (12)
def create_db_and_tables(): # (11)!
 SQLModel.metadata.create_all(engine) # (12)!


if __name__ == "__main__": # (13)
 create_db_and_tables() # (14)
if __name__ == "__main__": # (13)!
 create_db_and_tables() # (14)!

26 changes: 13 additions & 13 deletions
docs_src/tutorial/delete/tutorial002.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -71,23 +71,23 @@ def update_heroes():

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

 session.delete(hero) # (5)
 session.commit() # (6)
 session.delete(hero) # (5)!
 session.commit() # (6)!

 print("Deleted hero:", hero) # (7)
 print("Deleted hero:", hero) # (7)!

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

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


def main():
Expand Down

18 changes: 9 additions & 9 deletions
docs_src/tutorial/fastapi/app_testing/tutorial001/test_main_001.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
from fastapi.testclient import TestClient
from sqlmodel import Session, SQLModel, create_engine

from .main import app, get_session # (1)
from .main import app, get_session # (1)!


def test_create_hero():
Expand All@@ -17,16 +17,16 @@ def get_session_override():

 app.dependency_overrides[get_session] = get_session_override

 client = TestClient(app) # (2)
 client = TestClient(app) # (2)!

 response = client.post( # (3)
 response = client.post( # (3)!
 "/heroes/", json={"name": "Deadpond", "secret_name": "Dive Wilson"}
 )
 app.dependency_overrides.clear()
 data = response.json() # (4)
 data = response.json() # (4)!

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

10 changes: 5 additions & 5 deletions
docs_src/tutorial/fastapi/app_testing/tutorial001/test_main_002.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
from fastapi.testclient import TestClient
from sqlmodel import Session, SQLModel, create_engine

from .main import app, get_session # (1)
from .main import app, get_session # (1)!


def test_create_hero():
Expand All@@ -12,17 +12,17 @@ def test_create_hero():

 with Session(engine) as session:

 def get_session_override(): # (2)
 return session # (3)
 def get_session_override(): # (2)!
 return session # (3)!

 app.dependency_overrides[get_session] = get_session_override # (4)
 app.dependency_overrides[get_session] = get_session_override # (4)!

 client = TestClient(app)

 response = client.post(
 "/heroes/", json={"name": "Deadpond", "secret_name": "Dive Wilson"}
 )
 app.dependency_overrides.clear() # (5)
 app.dependency_overrides.clear() # (5)!
 data = response.json()

 assert response.status_code == 200
Expand Down

14 changes: 7 additions & 7 deletions
docs_src/tutorial/fastapi/app_testing/tutorial001/test_main_003.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
from fastapi.testclient import TestClient
from sqlmodel import Session, SQLModel, create_engine

from .main import app, get_session # (1)
from .main import app, get_session # (1)!


def test_create_hero():
 engine = create_engine( # (2)
 engine = create_engine( # (2)!
 "sqlite:///testing.db", connect_args={"check_same_thread": False}
 )
 SQLModel.metadata.create_all(engine) # (3)
 SQLModel.metadata.create_all(engine) # (3)!

 with Session(engine) as session: # (4)
 with Session(engine) as session: # (4)!

 def get_session_override():
 return session # (5)
 return session # (5)!

 app.dependency_overrides[get_session] = get_session_override # (4)
 app.dependency_overrides[get_session] = get_session_override # (4)!

 client = TestClient(app)

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

6 changes: 3 additions & 3 deletions
docs_src/tutorial/fastapi/app_testing/tutorial001/test_main_004.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
from fastapi.testclient import TestClient
from sqlmodel import Session, SQLModel, create_engine
from sqlmodel.pool import StaticPool # (1)
from sqlmodel.pool import StaticPool # (1)!

from .main import app, get_session


def test_create_hero():
 engine = create_engine(
 "sqlite://", # (2)
 "sqlite://", # (2)!
 connect_args={"check_same_thread": False},
 poolclass=StaticPool, # (3)
 poolclass=StaticPool, # (3)!
 )
 SQLModel.metadata.create_all(engine)

Expand Down

12 changes: 6 additions & 6 deletions
docs_src/tutorial/fastapi/app_testing/tutorial001/test_main_005.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
import pytest # (1)
import pytest # (1)!
from fastapi.testclient import TestClient
from sqlmodel import Session, SQLModel, create_engine
from sqlmodel.pool import StaticPool

from .main import app, get_session


@pytest.fixture(name="session") # (2)
def session_fixture(): # (3)
@pytest.fixture(name="session") # (2)!
def session_fixture(): # (3)!
 engine = create_engine(
 "sqlite://", connect_args={"check_same_thread": False}, poolclass=StaticPool
 )
 SQLModel.metadata.create_all(engine)
 with Session(engine) as session:
 yield session # (4)
 yield session # (4)!


def test_create_hero(session: Session): # (5)
def test_create_hero(session: Session): # (5)!
 def get_session_override():
 return session # (6)
 return session # (6)!

 app.dependency_overrides[get_session] = get_session_override

Expand Down

16 changes: 8 additions & 8 deletions
docs_src/tutorial/fastapi/app_testing/tutorial001/test_main_006.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,19 +16,19 @@ def session_fixture():
 yield session


@pytest.fixture(name="client") # (1)
def client_fixture(session: Session): # (2)
 def get_session_override(): # (3)
@pytest.fixture(name="client") # (1)!
def client_fixture(session: Session): # (2)!
 def get_session_override(): # (3)!
 return session

 app.dependency_overrides[get_session] = get_session_override # (4)
 app.dependency_overrides[get_session] = get_session_override # (4)!

 client = TestClient(app) # (5)
 yield client # (6)
 app.dependency_overrides.clear() # (7)
 client = TestClient(app) # (5)!
 yield client # (6)!
 app.dependency_overrides.clear() # (7)!


def test_create_hero(client: TestClient): # (8)
def test_create_hero(client: TestClient): # (8)!
 response = client.post(
 "/heroes/", json={"name": "Deadpond", "secret_name": "Dive Wilson"}
 )
Expand Down

22 changes: 11 additions & 11 deletions
docs_src/tutorial/insert/tutorial003.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,24 +20,24 @@ def create_db_and_tables():
 SQLModel.metadata.create_all(engine)


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

 with Session(engine) as session: # (3)
 session.add(hero_1) # (4)
 with Session(engine) as session: # (3)!
 session.add(hero_1) # (4)!
 session.add(hero_2)
 session.add(hero_3)

 session.commit() # (5)
 # (6)
 session.commit() # (5)!
 # (6)!


def main(): # (7)
 create_db_and_tables() # (8)
 create_heroes() # (9)
def main(): # (7)!
 create_db_and_tables() # (8)!
 create_heroes() # (9)!


if __name__ == "__main__": # (10)
 main() # (11)
if __name__ == "__main__": # (10)!
 main() # (11)!
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
🎨 Update inline source examples, hide # in annotations (from MkDocs Material)#677

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tiangolo
merged 3 commits into

from

Oct 29, 2023
 Merged


🎨 Update inline source examples, hide # in annotations (from MkDocs Material)
#677
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
ab08cbd

Hide # for all annotations


Matthieu-LAURENT39 Oct 24, 2023
37db3c3

📝 Add extra missing exclamation points for MkDocs Material annotations


tiangolo Oct 29, 2023
ec31941

Merge branch 'main' into prettify_docs


tiangolo Oct 29, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


100 changes: 50 additions & 50 deletions
docs_src/tutorial/automatic_id_none_refresh/tutorial002.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,56 +21,56 @@ def create_db_and_tables():


def create_heroes():
 hero_1 = Hero(name="Deadpond", secret_name="Dive Wilson") # (1)
 hero_2 = Hero(name="Spider-Boy", secret_name="Pedro Parqueador") # (2)
 hero_3 = Hero(name="Rusty-Man", secret_name="Tommy Sharp", age=48) # (3)

 print("Before interacting with the database") # (4)
 print("Hero 1:", hero_1) # (5)
 print("Hero 2:", hero_2) # (6)
 print("Hero 3:", hero_3) # (7)

 with Session(engine) as session: # (8)
 session.add(hero_1) # (9)
 session.add(hero_2) # (10)
 session.add(hero_3) # (11)

 print("After adding to the session") # (12)
 print("Hero 1:", hero_1) # (13)
 print("Hero 2:", hero_2) # (14)
 print("Hero 3:", hero_3) # (15)

 session.commit() # (16)

 print("After committing the session") # (17)
 print("Hero 1:", hero_1) # (18)
 print("Hero 2:", hero_2) # (19)
 print("Hero 3:", hero_3) # (20)

 print("After committing the session, show IDs") # (21)
 print("Hero 1 ID:", hero_1.id) # (22)
 print("Hero 2 ID:", hero_2.id) # (23)
 print("Hero 3 ID:", hero_3.id) # (24)

 print("After committing the session, show names") # (25)
 print("Hero 1 name:", hero_1.name) # (26)
 print("Hero 2 name:", hero_2.name) # (27)
 print("Hero 3 name:", hero_3.name) # (28)

 session.refresh(hero_1) # (29)
 session.refresh(hero_2) # (30)
 session.refresh(hero_3) # (31)

 print("After refreshing the heroes") # (32)
 print("Hero 1:", hero_1) # (33)
 print("Hero 2:", hero_2) # (34)
 print("Hero 3:", hero_3) # (35)
 # (36)

 print("After the session closes") # (37)
 print("Hero 1:", hero_1) # (38)
 print("Hero 2:", hero_2) # (39)
 print("Hero 3:", hero_3) # (40)
 hero_1 = Hero(name="Deadpond", secret_name="Dive Wilson") # (1)!
 hero_2 = Hero(name="Spider-Boy", secret_name="Pedro Parqueador") # (2)!
 hero_3 = Hero(name="Rusty-Man", secret_name="Tommy Sharp", age=48) # (3)!

 print("Before interacting with the database") # (4)!
 print("Hero 1:", hero_1) # (5)!
 print("Hero 2:", hero_2) # (6)!
 print("Hero 3:", hero_3) # (7)!

 with Session(engine) as session: # (8)!
 session.add(hero_1) # (9)!
 session.add(hero_2) # (10)!
 session.add(hero_3) # (11)!

 print("After adding to the session") # (12)!
 print("Hero 1:", hero_1) # (13)!
 print("Hero 2:", hero_2) # (14)!
 print("Hero 3:", hero_3) # (15)!

 session.commit() # (16)!

 print("After committing the session") # (17)!
 print("Hero 1:", hero_1) # (18)!
 print("Hero 2:", hero_2) # (19)!
 print("Hero 3:", hero_3) # (20)!

 print("After committing the session, show IDs") # (21)!
 print("Hero 1 ID:", hero_1.id) # (22)!
 print("Hero 2 ID:", hero_2.id) # (23)!
 print("Hero 3 ID:", hero_3.id) # (24)!

 print("After committing the session, show names") # (25)!
 print("Hero 1 name:", hero_1.name) # (26)!
 print("Hero 2 name:", hero_2.name) # (27)!
 print("Hero 3 name:", hero_3.name) # (28)!

 session.refresh(hero_1) # (29)!
 session.refresh(hero_2) # (30)!
 session.refresh(hero_3) # (31)!

 print("After refreshing the heroes") # (32)!
 print("Hero 1:", hero_1) # (33)!
 print("Hero 2:", hero_2) # (34)!
 print("Hero 3:", hero_3) # (35)!
 # (36)!

 print("After the session closes") # (37)!
 print("Hero 1:", hero_1) # (38)!
 print("Hero 2:", hero_2) # (39)!
 print("Hero 3:", hero_3) # (40)!


def main():
Expand Down

28 changes: 14 additions & 14 deletions
docs_src/tutorial/create_db_and_table/tutorial003.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
from typing import Optional # (1)
from typing import Optional # (1)!

from sqlmodel import Field, SQLModel, create_engine # (2)
from sqlmodel import Field, SQLModel, create_engine # (2)!


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


sqlite_file_name = "database.db" # (8)
sqlite_url = f"sqlite:///{sqlite_file_name}" # (9)
sqlite_file_name = "database.db" # (8)!
sqlite_url = f"sqlite:///{sqlite_file_name}" # (9)!

engine = create_engine(sqlite_url, echo=True) # (10)
engine = create_engine(sqlite_url, echo=True) # (10)!


def create_db_and_tables(): # (11)
 SQLModel.metadata.create_all(engine) # (12)
def create_db_and_tables(): # (11)!
 SQLModel.metadata.create_all(engine) # (12)!


if __name__ == "__main__": # (13)
 create_db_and_tables() # (14)
if __name__ == "__main__": # (13)!
 create_db_and_tables() # (14)!

26 changes: 13 additions & 13 deletions
docs_src/tutorial/delete/tutorial002.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -71,23 +71,23 @@ def update_heroes():

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

 session.delete(hero) # (5)
 session.commit() # (6)
 session.delete(hero) # (5)!
 session.commit() # (6)!

 print("Deleted hero:", hero) # (7)
 print("Deleted hero:", hero) # (7)!

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

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


def main():
Expand Down

18 changes: 9 additions & 9 deletions
docs_src/tutorial/fastapi/app_testing/tutorial001/test_main_001.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
from fastapi.testclient import TestClient
from sqlmodel import Session, SQLModel, create_engine

from .main import app, get_session # (1)
from .main import app, get_session # (1)!


def test_create_hero():
Expand All@@ -17,16 +17,16 @@ def get_session_override():

 app.dependency_overrides[get_session] = get_session_override

 client = TestClient(app) # (2)
 client = TestClient(app) # (2)!

 response = client.post( # (3)
 response = client.post( # (3)!
 "/heroes/", json={"name": "Deadpond", "secret_name": "Dive Wilson"}
 )
 app.dependency_overrides.clear()
 data = response.json() # (4)
 data = response.json() # (4)!

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

10 changes: 5 additions & 5 deletions
docs_src/tutorial/fastapi/app_testing/tutorial001/test_main_002.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
from fastapi.testclient import TestClient
from sqlmodel import Session, SQLModel, create_engine

from .main import app, get_session # (1)
from .main import app, get_session # (1)!


def test_create_hero():
Expand All@@ -12,17 +12,17 @@ def test_create_hero():

 with Session(engine) as session:

 def get_session_override(): # (2)
 return session # (3)
 def get_session_override(): # (2)!
 return session # (3)!

 app.dependency_overrides[get_session] = get_session_override # (4)
 app.dependency_overrides[get_session] = get_session_override # (4)!

 client = TestClient(app)

 response = client.post(
 "/heroes/", json={"name": "Deadpond", "secret_name": "Dive Wilson"}
 )
 app.dependency_overrides.clear() # (5)
 app.dependency_overrides.clear() # (5)!
 data = response.json()

 assert response.status_code == 200
Expand Down

14 changes: 7 additions & 7 deletions
docs_src/tutorial/fastapi/app_testing/tutorial001/test_main_003.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
from fastapi.testclient import TestClient
from sqlmodel import Session, SQLModel, create_engine

from .main import app, get_session # (1)
from .main import app, get_session # (1)!


def test_create_hero():
 engine = create_engine( # (2)
 engine = create_engine( # (2)!
 "sqlite:///testing.db", connect_args={"check_same_thread": False}
 )
 SQLModel.metadata.create_all(engine) # (3)
 SQLModel.metadata.create_all(engine) # (3)!

 with Session(engine) as session: # (4)
 with Session(engine) as session: # (4)!

 def get_session_override():
 return session # (5)
 return session # (5)!

 app.dependency_overrides[get_session] = get_session_override # (4)
 app.dependency_overrides[get_session] = get_session_override # (4)!

 client = TestClient(app)

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

6 changes: 3 additions & 3 deletions
docs_src/tutorial/fastapi/app_testing/tutorial001/test_main_004.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
from fastapi.testclient import TestClient
from sqlmodel import Session, SQLModel, create_engine
from sqlmodel.pool import StaticPool # (1)
from sqlmodel.pool import StaticPool # (1)!

from .main import app, get_session


def test_create_hero():
 engine = create_engine(
 "sqlite://", # (2)
 "sqlite://", # (2)!
 connect_args={"check_same_thread": False},
 poolclass=StaticPool, # (3)
 poolclass=StaticPool, # (3)!
 )
 SQLModel.metadata.create_all(engine)

Expand Down

12 changes: 6 additions & 6 deletions
docs_src/tutorial/fastapi/app_testing/tutorial001/test_main_005.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
import pytest # (1)
import pytest # (1)!
from fastapi.testclient import TestClient
from sqlmodel import Session, SQLModel, create_engine
from sqlmodel.pool import StaticPool

from .main import app, get_session


@pytest.fixture(name="session") # (2)
def session_fixture(): # (3)
@pytest.fixture(name="session") # (2)!
def session_fixture(): # (3)!
 engine = create_engine(
 "sqlite://", connect_args={"check_same_thread": False}, poolclass=StaticPool
 )
 SQLModel.metadata.create_all(engine)
 with Session(engine) as session:
 yield session # (4)
 yield session # (4)!


def test_create_hero(session: Session): # (5)
def test_create_hero(session: Session): # (5)!
 def get_session_override():
 return session # (6)
 return session # (6)!

 app.dependency_overrides[get_session] = get_session_override

Expand Down

16 changes: 8 additions & 8 deletions
docs_src/tutorial/fastapi/app_testing/tutorial001/test_main_006.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,19 +16,19 @@ def session_fixture():
 yield session


@pytest.fixture(name="client") # (1)
def client_fixture(session: Session): # (2)
 def get_session_override(): # (3)
@pytest.fixture(name="client") # (1)!
def client_fixture(session: Session): # (2)!
 def get_session_override(): # (3)!
 return session

 app.dependency_overrides[get_session] = get_session_override # (4)
 app.dependency_overrides[get_session] = get_session_override # (4)!

 client = TestClient(app) # (5)
 yield client # (6)
 app.dependency_overrides.clear() # (7)
 client = TestClient(app) # (5)!
 yield client # (6)!
 app.dependency_overrides.clear() # (7)!


def test_create_hero(client: TestClient): # (8)
def test_create_hero(client: TestClient): # (8)!
 response = client.post(
 "/heroes/", json={"name": "Deadpond", "secret_name": "Dive Wilson"}
 )
Expand Down

22 changes: 11 additions & 11 deletions
docs_src/tutorial/insert/tutorial003.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,24 +20,24 @@ def create_db_and_tables():
 SQLModel.metadata.create_all(engine)


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

 with Session(engine) as session: # (3)
 session.add(hero_1) # (4)
 with Session(engine) as session: # (3)!
 session.add(hero_1) # (4)!
 session.add(hero_2)
 session.add(hero_3)

 session.commit() # (5)
 # (6)
 session.commit() # (5)!
 # (6)!


def main(): # (7)
 create_db_and_tables() # (8)
 create_heroes() # (9)
def main(): # (7)!
 create_db_and_tables() # (8)!
 create_heroes() # (9)!


if __name__ == "__main__": # (10)
 main() # (11)
if __name__ == "__main__": # (10)!
 main() # (11)!
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
🎨 Update inline source examples, hide # in annotations (from MkDocs Material)#677

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tiangolo
merged 3 commits into

from

Oct 29, 2023
 Merged


🎨 Update inline source examples, hide # in annotations (from MkDocs Material)
#677
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
ab08cbd

Hide # for all annotations


Matthieu-LAURENT39 Oct 24, 2023
37db3c3

📝 Add extra missing exclamation points for MkDocs Material annotations


tiangolo Oct 29, 2023
ec31941

Merge branch 'main' into prettify_docs


tiangolo Oct 29, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


100 changes: 50 additions & 50 deletions
docs_src/tutorial/automatic_id_none_refresh/tutorial002.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,56 +21,56 @@ def create_db_and_tables():


def create_heroes():
 hero_1 = Hero(name="Deadpond", secret_name="Dive Wilson") # (1)
 hero_2 = Hero(name="Spider-Boy", secret_name="Pedro Parqueador") # (2)
 hero_3 = Hero(name="Rusty-Man", secret_name="Tommy Sharp", age=48) # (3)

 print("Before interacting with the database") # (4)
 print("Hero 1:", hero_1) # (5)
 print("Hero 2:", hero_2) # (6)
 print("Hero 3:", hero_3) # (7)

 with Session(engine) as session: # (8)
 session.add(hero_1) # (9)
 session.add(hero_2) # (10)
 session.add(hero_3) # (11)

 print("After adding to the session") # (12)
 print("Hero 1:", hero_1) # (13)
 print("Hero 2:", hero_2) # (14)
 print("Hero 3:", hero_3) # (15)

 session.commit() # (16)

 print("After committing the session") # (17)
 print("Hero 1:", hero_1) # (18)
 print("Hero 2:", hero_2) # (19)
 print("Hero 3:", hero_3) # (20)

 print("After committing the session, show IDs") # (21)
 print("Hero 1 ID:", hero_1.id) # (22)
 print("Hero 2 ID:", hero_2.id) # (23)
 print("Hero 3 ID:", hero_3.id) # (24)

 print("After committing the session, show names") # (25)
 print("Hero 1 name:", hero_1.name) # (26)
 print("Hero 2 name:", hero_2.name) # (27)
 print("Hero 3 name:", hero_3.name) # (28)

 session.refresh(hero_1) # (29)
 session.refresh(hero_2) # (30)
 session.refresh(hero_3) # (31)

 print("After refreshing the heroes") # (32)
 print("Hero 1:", hero_1) # (33)
 print("Hero 2:", hero_2) # (34)
 print("Hero 3:", hero_3) # (35)
 # (36)

 print("After the session closes") # (37)
 print("Hero 1:", hero_1) # (38)
 print("Hero 2:", hero_2) # (39)
 print("Hero 3:", hero_3) # (40)
 hero_1 = Hero(name="Deadpond", secret_name="Dive Wilson") # (1)!
 hero_2 = Hero(name="Spider-Boy", secret_name="Pedro Parqueador") # (2)!
 hero_3 = Hero(name="Rusty-Man", secret_name="Tommy Sharp", age=48) # (3)!

 print("Before interacting with the database") # (4)!
 print("Hero 1:", hero_1) # (5)!
 print("Hero 2:", hero_2) # (6)!
 print("Hero 3:", hero_3) # (7)!

 with Session(engine) as session: # (8)!
 session.add(hero_1) # (9)!
 session.add(hero_2) # (10)!
 session.add(hero_3) # (11)!

 print("After adding to the session") # (12)!
 print("Hero 1:", hero_1) # (13)!
 print("Hero 2:", hero_2) # (14)!
 print("Hero 3:", hero_3) # (15)!

 session.commit() # (16)!

 print("After committing the session") # (17)!
 print("Hero 1:", hero_1) # (18)!
 print("Hero 2:", hero_2) # (19)!
 print("Hero 3:", hero_3) # (20)!

 print("After committing the session, show IDs") # (21)!
 print("Hero 1 ID:", hero_1.id) # (22)!
 print("Hero 2 ID:", hero_2.id) # (23)!
 print("Hero 3 ID:", hero_3.id) # (24)!

 print("After committing the session, show names") # (25)!
 print("Hero 1 name:", hero_1.name) # (26)!
 print("Hero 2 name:", hero_2.name) # (27)!
 print("Hero 3 name:", hero_3.name) # (28)!

 session.refresh(hero_1) # (29)!
 session.refresh(hero_2) # (30)!
 session.refresh(hero_3) # (31)!

 print("After refreshing the heroes") # (32)!
 print("Hero 1:", hero_1) # (33)!
 print("Hero 2:", hero_2) # (34)!
 print("Hero 3:", hero_3) # (35)!
 # (36)!

 print("After the session closes") # (37)!
 print("Hero 1:", hero_1) # (38)!
 print("Hero 2:", hero_2) # (39)!
 print("Hero 3:", hero_3) # (40)!


def main():
Expand Down

28 changes: 14 additions & 14 deletions
docs_src/tutorial/create_db_and_table/tutorial003.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
from typing import Optional # (1)
from typing import Optional # (1)!

from sqlmodel import Field, SQLModel, create_engine # (2)
from sqlmodel import Field, SQLModel, create_engine # (2)!


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


sqlite_file_name = "database.db" # (8)
sqlite_url = f"sqlite:///{sqlite_file_name}" # (9)
sqlite_file_name = "database.db" # (8)!
sqlite_url = f"sqlite:///{sqlite_file_name}" # (9)!

engine = create_engine(sqlite_url, echo=True) # (10)
engine = create_engine(sqlite_url, echo=True) # (10)!


def create_db_and_tables(): # (11)
 SQLModel.metadata.create_all(engine) # (12)
def create_db_and_tables(): # (11)!
 SQLModel.metadata.create_all(engine) # (12)!


if __name__ == "__main__": # (13)
 create_db_and_tables() # (14)
if __name__ == "__main__": # (13)!
 create_db_and_tables() # (14)!

26 changes: 13 additions & 13 deletions
docs_src/tutorial/delete/tutorial002.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -71,23 +71,23 @@ def update_heroes():

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

 session.delete(hero) # (5)
 session.commit() # (6)
 session.delete(hero) # (5)!
 session.commit() # (6)!

 print("Deleted hero:", hero) # (7)
 print("Deleted hero:", hero) # (7)!

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

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


def main():
Expand Down

18 changes: 9 additions & 9 deletions
docs_src/tutorial/fastapi/app_testing/tutorial001/test_main_001.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
from fastapi.testclient import TestClient
from sqlmodel import Session, SQLModel, create_engine

from .main import app, get_session # (1)
from .main import app, get_session # (1)!


def test_create_hero():
Expand All@@ -17,16 +17,16 @@ def get_session_override():

 app.dependency_overrides[get_session] = get_session_override

 client = TestClient(app) # (2)
 client = TestClient(app) # (2)!

 response = client.post( # (3)
 response = client.post( # (3)!
 "/heroes/", json={"name": "Deadpond", "secret_name": "Dive Wilson"}
 )
 app.dependency_overrides.clear()
 data = response.json() # (4)
 data = response.json() # (4)!

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

10 changes: 5 additions & 5 deletions
docs_src/tutorial/fastapi/app_testing/tutorial001/test_main_002.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
from fastapi.testclient import TestClient
from sqlmodel import Session, SQLModel, create_engine

from .main import app, get_session # (1)
from .main import app, get_session # (1)!


def test_create_hero():
Expand All@@ -12,17 +12,17 @@ def test_create_hero():

 with Session(engine) as session:

 def get_session_override(): # (2)
 return session # (3)
 def get_session_override(): # (2)!
 return session # (3)!

 app.dependency_overrides[get_session] = get_session_override # (4)
 app.dependency_overrides[get_session] = get_session_override # (4)!

 client = TestClient(app)

 response = client.post(
 "/heroes/", json={"name": "Deadpond", "secret_name": "Dive Wilson"}
 )
 app.dependency_overrides.clear() # (5)
 app.dependency_overrides.clear() # (5)!
 data = response.json()

 assert response.status_code == 200
Expand Down

14 changes: 7 additions & 7 deletions
docs_src/tutorial/fastapi/app_testing/tutorial001/test_main_003.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
from fastapi.testclient import TestClient
from sqlmodel import Session, SQLModel, create_engine

from .main import app, get_session # (1)
from .main import app, get_session # (1)!


def test_create_hero():
 engine = create_engine( # (2)
 engine = create_engine( # (2)!
 "sqlite:///testing.db", connect_args={"check_same_thread": False}
 )
 SQLModel.metadata.create_all(engine) # (3)
 SQLModel.metadata.create_all(engine) # (3)!

 with Session(engine) as session: # (4)
 with Session(engine) as session: # (4)!

 def get_session_override():
 return session # (5)
 return session # (5)!

 app.dependency_overrides[get_session] = get_session_override # (4)
 app.dependency_overrides[get_session] = get_session_override # (4)!

 client = TestClient(app)

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

6 changes: 3 additions & 3 deletions
docs_src/tutorial/fastapi/app_testing/tutorial001/test_main_004.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
from fastapi.testclient import TestClient
from sqlmodel import Session, SQLModel, create_engine
from sqlmodel.pool import StaticPool # (1)
from sqlmodel.pool import StaticPool # (1)!

from .main import app, get_session


def test_create_hero():
 engine = create_engine(
 "sqlite://", # (2)
 "sqlite://", # (2)!
 connect_args={"check_same_thread": False},
 poolclass=StaticPool, # (3)
 poolclass=StaticPool, # (3)!
 )
 SQLModel.metadata.create_all(engine)

Expand Down

12 changes: 6 additions & 6 deletions
docs_src/tutorial/fastapi/app_testing/tutorial001/test_main_005.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
import pytest # (1)
import pytest # (1)!
from fastapi.testclient import TestClient
from sqlmodel import Session, SQLModel, create_engine
from sqlmodel.pool import StaticPool

from .main import app, get_session


@pytest.fixture(name="session") # (2)
def session_fixture(): # (3)
@pytest.fixture(name="session") # (2)!
def session_fixture(): # (3)!
 engine = create_engine(
 "sqlite://", connect_args={"check_same_thread": False}, poolclass=StaticPool
 )
 SQLModel.metadata.create_all(engine)
 with Session(engine) as session:
 yield session # (4)
 yield session # (4)!


def test_create_hero(session: Session): # (5)
def test_create_hero(session: Session): # (5)!
 def get_session_override():
 return session # (6)
 return session # (6)!

 app.dependency_overrides[get_session] = get_session_override

Expand Down

16 changes: 8 additions & 8 deletions
docs_src/tutorial/fastapi/app_testing/tutorial001/test_main_006.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,19 +16,19 @@ def session_fixture():
 yield session


@pytest.fixture(name="client") # (1)
def client_fixture(session: Session): # (2)
 def get_session_override(): # (3)
@pytest.fixture(name="client") # (1)!
def client_fixture(session: Session): # (2)!
 def get_session_override(): # (3)!
 return session

 app.dependency_overrides[get_session] = get_session_override # (4)
 app.dependency_overrides[get_session] = get_session_override # (4)!

 client = TestClient(app) # (5)
 yield client # (6)
 app.dependency_overrides.clear() # (7)
 client = TestClient(app) # (5)!
 yield client # (6)!
 app.dependency_overrides.clear() # (7)!


def test_create_hero(client: TestClient): # (8)
def test_create_hero(client: TestClient): # (8)!
 response = client.post(
 "/heroes/", json={"name": "Deadpond", "secret_name": "Dive Wilson"}
 )
Expand Down

22 changes: 11 additions & 11 deletions
docs_src/tutorial/insert/tutorial003.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,24 +20,24 @@ def create_db_and_tables():
 SQLModel.metadata.create_all(engine)


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

 with Session(engine) as session: # (3)
 session.add(hero_1) # (4)
 with Session(engine) as session: # (3)!
 session.add(hero_1) # (4)!
 session.add(hero_2)
 session.add(hero_3)

 session.commit() # (5)
 # (6)
 session.commit() # (5)!
 # (6)!


def main(): # (7)
 create_db_and_tables() # (8)
 create_heroes() # (9)
def main(): # (7)!
 create_db_and_tables() # (8)!
 create_heroes() # (9)!


if __name__ == "__main__": # (10)
 main() # (11)
if __name__ == "__main__": # (10)!
 main() # (11)!
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
🎨 Update inline source examples, hide # in annotations (from MkDocs Material)#677

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tiangolo
merged 3 commits into

from

Oct 29, 2023
 Merged


🎨 Update inline source examples, hide # in annotations (from MkDocs Material)
#677
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
ab08cbd

Hide # for all annotations


Matthieu-LAURENT39 Oct 24, 2023
37db3c3

📝 Add extra missing exclamation points for MkDocs Material annotations


tiangolo Oct 29, 2023
ec31941

Merge branch 'main' into prettify_docs


tiangolo Oct 29, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


100 changes: 50 additions & 50 deletions
docs_src/tutorial/automatic_id_none_refresh/tutorial002.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,56 +21,56 @@ def create_db_and_tables():


def create_heroes():
 hero_1 = Hero(name="Deadpond", secret_name="Dive Wilson") # (1)
 hero_2 = Hero(name="Spider-Boy", secret_name="Pedro Parqueador") # (2)
 hero_3 = Hero(name="Rusty-Man", secret_name="Tommy Sharp", age=48) # (3)

 print("Before interacting with the database") # (4)
 print("Hero 1:", hero_1) # (5)
 print("Hero 2:", hero_2) # (6)
 print("Hero 3:", hero_3) # (7)

 with Session(engine) as session: # (8)
 session.add(hero_1) # (9)
 session.add(hero_2) # (10)
 session.add(hero_3) # (11)

 print("After adding to the session") # (12)
 print("Hero 1:", hero_1) # (13)
 print("Hero 2:", hero_2) # (14)
 print("Hero 3:", hero_3) # (15)

 session.commit() # (16)

 print("After committing the session") # (17)
 print("Hero 1:", hero_1) # (18)
 print("Hero 2:", hero_2) # (19)
 print("Hero 3:", hero_3) # (20)

 print("After committing the session, show IDs") # (21)
 print("Hero 1 ID:", hero_1.id) # (22)
 print("Hero 2 ID:", hero_2.id) # (23)
 print("Hero 3 ID:", hero_3.id) # (24)

 print("After committing the session, show names") # (25)
 print("Hero 1 name:", hero_1.name) # (26)
 print("Hero 2 name:", hero_2.name) # (27)
 print("Hero 3 name:", hero_3.name) # (28)

 session.refresh(hero_1) # (29)
 session.refresh(hero_2) # (30)
 session.refresh(hero_3) # (31)

 print("After refreshing the heroes") # (32)
 print("Hero 1:", hero_1) # (33)
 print("Hero 2:", hero_2) # (34)
 print("Hero 3:", hero_3) # (35)
 # (36)

 print("After the session closes") # (37)
 print("Hero 1:", hero_1) # (38)
 print("Hero 2:", hero_2) # (39)
 print("Hero 3:", hero_3) # (40)
 hero_1 = Hero(name="Deadpond", secret_name="Dive Wilson") # (1)!
 hero_2 = Hero(name="Spider-Boy", secret_name="Pedro Parqueador") # (2)!
 hero_3 = Hero(name="Rusty-Man", secret_name="Tommy Sharp", age=48) # (3)!

 print("Before interacting with the database") # (4)!
 print("Hero 1:", hero_1) # (5)!
 print("Hero 2:", hero_2) # (6)!
 print("Hero 3:", hero_3) # (7)!

 with Session(engine) as session: # (8)!
 session.add(hero_1) # (9)!
 session.add(hero_2) # (10)!
 session.add(hero_3) # (11)!

 print("After adding to the session") # (12)!
 print("Hero 1:", hero_1) # (13)!
 print("Hero 2:", hero_2) # (14)!
 print("Hero 3:", hero_3) # (15)!

 session.commit() # (16)!

 print("After committing the session") # (17)!
 print("Hero 1:", hero_1) # (18)!
 print("Hero 2:", hero_2) # (19)!
 print("Hero 3:", hero_3) # (20)!

 print("After committing the session, show IDs") # (21)!
 print("Hero 1 ID:", hero_1.id) # (22)!
 print("Hero 2 ID:", hero_2.id) # (23)!
 print("Hero 3 ID:", hero_3.id) # (24)!

 print("After committing the session, show names") # (25)!
 print("Hero 1 name:", hero_1.name) # (26)!
 print("Hero 2 name:", hero_2.name) # (27)!
 print("Hero 3 name:", hero_3.name) # (28)!

 session.refresh(hero_1) # (29)!
 session.refresh(hero_2) # (30)!
 session.refresh(hero_3) # (31)!

 print("After refreshing the heroes") # (32)!
 print("Hero 1:", hero_1) # (33)!
 print("Hero 2:", hero_2) # (34)!
 print("Hero 3:", hero_3) # (35)!
 # (36)!

 print("After the session closes") # (37)!
 print("Hero 1:", hero_1) # (38)!
 print("Hero 2:", hero_2) # (39)!
 print("Hero 3:", hero_3) # (40)!


def main():
Expand Down

28 changes: 14 additions & 14 deletions
docs_src/tutorial/create_db_and_table/tutorial003.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
from typing import Optional # (1)
from typing import Optional # (1)!

from sqlmodel import Field, SQLModel, create_engine # (2)
from sqlmodel import Field, SQLModel, create_engine # (2)!


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


sqlite_file_name = "database.db" # (8)
sqlite_url = f"sqlite:///{sqlite_file_name}" # (9)
sqlite_file_name = "database.db" # (8)!
sqlite_url = f"sqlite:///{sqlite_file_name}" # (9)!

engine = create_engine(sqlite_url, echo=True) # (10)
engine = create_engine(sqlite_url, echo=True) # (10)!


def create_db_and_tables(): # (11)
 SQLModel.metadata.create_all(engine) # (12)
def create_db_and_tables(): # (11)!
 SQLModel.metadata.create_all(engine) # (12)!


if __name__ == "__main__": # (13)
 create_db_and_tables() # (14)
if __name__ == "__main__": # (13)!
 create_db_and_tables() # (14)!

26 changes: 13 additions & 13 deletions
docs_src/tutorial/delete/tutorial002.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -71,23 +71,23 @@ def update_heroes():

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

 session.delete(hero) # (5)
 session.commit() # (6)
 session.delete(hero) # (5)!
 session.commit() # (6)!

 print("Deleted hero:", hero) # (7)
 print("Deleted hero:", hero) # (7)!

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

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


def main():
Expand Down

18 changes: 9 additions & 9 deletions
docs_src/tutorial/fastapi/app_testing/tutorial001/test_main_001.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
from fastapi.testclient import TestClient
from sqlmodel import Session, SQLModel, create_engine

from .main import app, get_session # (1)
from .main import app, get_session # (1)!


def test_create_hero():
Expand All@@ -17,16 +17,16 @@ def get_session_override():

 app.dependency_overrides[get_session] = get_session_override

 client = TestClient(app) # (2)
 client = TestClient(app) # (2)!

 response = client.post( # (3)
 response = client.post( # (3)!
 "/heroes/", json={"name": "Deadpond", "secret_name": "Dive Wilson"}
 )
 app.dependency_overrides.clear()
 data = response.json() # (4)
 data = response.json() # (4)!

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

10 changes: 5 additions & 5 deletions
docs_src/tutorial/fastapi/app_testing/tutorial001/test_main_002.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
from fastapi.testclient import TestClient
from sqlmodel import Session, SQLModel, create_engine

from .main import app, get_session # (1)
from .main import app, get_session # (1)!


def test_create_hero():
Expand All@@ -12,17 +12,17 @@ def test_create_hero():

 with Session(engine) as session:

 def get_session_override(): # (2)
 return session # (3)
 def get_session_override(): # (2)!
 return session # (3)!

 app.dependency_overrides[get_session] = get_session_override # (4)
 app.dependency_overrides[get_session] = get_session_override # (4)!

 client = TestClient(app)

 response = client.post(
 "/heroes/", json={"name": "Deadpond", "secret_name": "Dive Wilson"}
 )
 app.dependency_overrides.clear() # (5)
 app.dependency_overrides.clear() # (5)!
 data = response.json()

 assert response.status_code == 200
Expand Down

14 changes: 7 additions & 7 deletions
docs_src/tutorial/fastapi/app_testing/tutorial001/test_main_003.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
from fastapi.testclient import TestClient
from sqlmodel import Session, SQLModel, create_engine

from .main import app, get_session # (1)
from .main import app, get_session # (1)!


def test_create_hero():
 engine = create_engine( # (2)
 engine = create_engine( # (2)!
 "sqlite:///testing.db", connect_args={"check_same_thread": False}
 )
 SQLModel.metadata.create_all(engine) # (3)
 SQLModel.metadata.create_all(engine) # (3)!

 with Session(engine) as session: # (4)
 with Session(engine) as session: # (4)!

 def get_session_override():
 return session # (5)
 return session # (5)!

 app.dependency_overrides[get_session] = get_session_override # (4)
 app.dependency_overrides[get_session] = get_session_override # (4)!

 client = TestClient(app)

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

6 changes: 3 additions & 3 deletions
docs_src/tutorial/fastapi/app_testing/tutorial001/test_main_004.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
from fastapi.testclient import TestClient
from sqlmodel import Session, SQLModel, create_engine
from sqlmodel.pool import StaticPool # (1)
from sqlmodel.pool import StaticPool # (1)!

from .main import app, get_session


def test_create_hero():
 engine = create_engine(
 "sqlite://", # (2)
 "sqlite://", # (2)!
 connect_args={"check_same_thread": False},
 poolclass=StaticPool, # (3)
 poolclass=StaticPool, # (3)!
 )
 SQLModel.metadata.create_all(engine)

Expand Down

12 changes: 6 additions & 6 deletions
docs_src/tutorial/fastapi/app_testing/tutorial001/test_main_005.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
import pytest # (1)
import pytest # (1)!
from fastapi.testclient import TestClient
from sqlmodel import Session, SQLModel, create_engine
from sqlmodel.pool import StaticPool

from .main import app, get_session


@pytest.fixture(name="session") # (2)
def session_fixture(): # (3)
@pytest.fixture(name="session") # (2)!
def session_fixture(): # (3)!
 engine = create_engine(
 "sqlite://", connect_args={"check_same_thread": False}, poolclass=StaticPool
 )
 SQLModel.metadata.create_all(engine)
 with Session(engine) as session:
 yield session # (4)
 yield session # (4)!


def test_create_hero(session: Session): # (5)
def test_create_hero(session: Session): # (5)!
 def get_session_override():
 return session # (6)
 return session # (6)!

 app.dependency_overrides[get_session] = get_session_override

Expand Down

16 changes: 8 additions & 8 deletions
docs_src/tutorial/fastapi/app_testing/tutorial001/test_main_006.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,19 +16,19 @@ def session_fixture():
 yield session


@pytest.fixture(name="client") # (1)
def client_fixture(session: Session): # (2)
 def get_session_override(): # (3)
@pytest.fixture(name="client") # (1)!
def client_fixture(session: Session): # (2)!
 def get_session_override(): # (3)!
 return session

 app.dependency_overrides[get_session] = get_session_override # (4)
 app.dependency_overrides[get_session] = get_session_override # (4)!

 client = TestClient(app) # (5)
 yield client # (6)
 app.dependency_overrides.clear() # (7)
 client = TestClient(app) # (5)!
 yield client # (6)!
 app.dependency_overrides.clear() # (7)!


def test_create_hero(client: TestClient): # (8)
def test_create_hero(client: TestClient): # (8)!
 response = client.post(
 "/heroes/", json={"name": "Deadpond", "secret_name": "Dive Wilson"}
 )
Expand Down

22 changes: 11 additions & 11 deletions
docs_src/tutorial/insert/tutorial003.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,24 +20,24 @@ def create_db_and_tables():
 SQLModel.metadata.create_all(engine)


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

 with Session(engine) as session: # (3)
 session.add(hero_1) # (4)
 with Session(engine) as session: # (3)!
 session.add(hero_1) # (4)!
 session.add(hero_2)
 session.add(hero_3)

 session.commit() # (5)
 # (6)
 session.commit() # (5)!
 # (6)!


def main(): # (7)
 create_db_and_tables() # (8)
 create_heroes() # (9)
def main(): # (7)!
 create_db_and_tables() # (8)!
 create_heroes() # (9)!


if __name__ == "__main__": # (10)
 main() # (11)
if __name__ == "__main__": # (10)!
 main() # (11)!
Loading