Skip to content

Commit fd8d757

Browse files
committed
lint
1 parent b2f4fd7 commit fd8d757

27 files changed

+258
-173
lines changed

docs/examples/usage/usage_framework_integrations_1.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@
55
from sqlspec.adapters.asyncpg import AsyncpgConfig
66
from sqlspec.extensions.litestar import SQLSpecPlugin
77

8+
__all__ = ("index", "test_app_exists" )
9+
10+
811
# Configure database and create plugin
912
spec = SQLSpec()
1013
db = spec.add_config(AsyncpgConfig(pool_config={"dsn": "postgresql://localhost/mydb", "min_size": 10, "max_size": 20}))
Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,18 @@
11
# start-example
2-
from fastapi import FastAPI, Depends
32
from contextlib import asynccontextmanager
3+
4+
from fastapi import FastAPI
5+
46
from sqlspec import SQLSpec
57
from sqlspec.adapters.asyncpg import AsyncpgConfig
6-
from sqlspec.driver import AsyncDriverAdapterBase
8+
9+
__all__ = ("lifespan", "test_stub" )
10+
711

812
# Configure database
913
spec = SQLSpec()
10-
db = spec.add_config(
11-
AsyncpgConfig(
12-
pool_config={
13-
"dsn": "postgresql://localhost/mydb",
14-
"min_size": 10,
15-
"max_size": 20,
16-
}
17-
)
18-
)
14+
db = spec.add_config(AsyncpgConfig(pool_config={"dsn": "postgresql://localhost/mydb", "min_size": 10, "max_size": 20}))
15+
1916

2017
# Lifespan context manager
2118
@asynccontextmanager
@@ -25,8 +22,10 @@ async def lifespan(app: FastAPI):
2522
# Shutdown
2623
await spec.close_all_pools()
2724

25+
2826
app = FastAPI(lifespan=lifespan)
2927
# end-example
3028

31-
def test_stub():
29+
30+
def test_stub() -> None:
3231
assert app is not None
Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,23 @@
11
# start-example
2-
from typing import AsyncGenerator
2+
from collections.abc import AsyncGenerator
3+
4+
__all__ = ("get_db_session", "get_user", "test_stub" )
5+
36

47
async def get_db_session() -> AsyncGenerator[AsyncDriverAdapterBase, None]:
58
async with spec.provide_session(config) as session:
69
yield session
710

11+
812
# Use in route handlers
913
@app.get("/users/{user_id}")
10-
async def get_user(
11-
user_id: int,
12-
db: AsyncDriverAdapterBase = Depends(get_db_session)
13-
) -> dict:
14-
result = await db.execute(
15-
"SELECT id, name, email FROM users WHERE id = $1",
16-
user_id
17-
)
14+
async def get_user(user_id: int, db: AsyncDriverAdapterBase = Depends(get_db_session)) -> dict:
15+
result = await db.execute("SELECT id, name, email FROM users WHERE id = $1", user_id)
1816
return result.one()
17+
18+
1919
# end-example
2020

21-
def test_stub():
21+
22+
def test_stub() -> None:
2223
assert True
Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,24 @@
11
# start-example
2+
__all__ = ("create_user", "test_stub" )
3+
4+
25
@app.post("/users")
3-
async def create_user(
4-
user_data: dict,
5-
db: AsyncDriverAdapterBase = Depends(get_db_session)
6-
) -> dict:
6+
async def create_user(user_data: dict, db: AsyncDriverAdapterBase = Depends(get_db_session)) -> dict:
77
async with db.begin_transaction():
88
result = await db.execute(
9-
"INSERT INTO users (name, email) VALUES ($1, $2) RETURNING id",
10-
user_data["name"],
11-
user_data["email"]
9+
"INSERT INTO users (name, email) VALUES ($1, $2) RETURNING id", user_data["name"], user_data["email"]
1210
)
1311

1412
user_id = result.scalar()
1513

1614
# Additional operations in same transaction
17-
await db.execute(
18-
"INSERT INTO audit_log (action, user_id) VALUES ($1, $2)",
19-
"user_created",
20-
user_id
21-
)
15+
await db.execute("INSERT INTO audit_log (action, user_id) VALUES ($1, $2)", "user_created", user_id)
2216

2317
return result.one()
18+
19+
2420
# end-example
2521

26-
def test_stub():
22+
23+
def test_stub() -> None:
2724
assert True
Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,38 @@
11
# start-example
2+
__all__ = ("generate_report", "get_analytics_db", "get_main_db", "test_stub" )
3+
4+
25
# Main database
36
main_db = spec.add_config(AsyncpgConfig(pool_config={"dsn": "postgresql://localhost/main"}))
47

58
# Analytics database
69
analytics_db = spec.add_config(AsyncpgConfig(pool_config={"dsn": "postgresql://localhost/analytics"}))
710

11+
812
# Dependency functions
913
async def get_main_db():
1014
async with spec.provide_session(main_db) as session:
1115
yield session
1216

17+
1318
async def get_analytics_db():
1419
async with spec.provide_session(analytics_db) as session:
1520
yield session
1621

22+
1723
# Use in handlers
1824
@app.get("/report")
1925
async def generate_report(
2026
main_db: AsyncDriverAdapterBase = Depends(get_main_db),
21-
analytics_db: AsyncDriverAdapterBase = Depends(get_analytics_db)
27+
analytics_db: AsyncDriverAdapterBase = Depends(get_analytics_db),
2228
) -> dict:
2329
users = await main_db.execute("SELECT COUNT(*) FROM users")
2430
events = await analytics_db.execute("SELECT COUNT(*) FROM events")
25-
return {
26-
"users": users.scalar(),
27-
"events": events.scalar()
28-
}
31+
return {"users": users.scalar(), "events": events.scalar()}
32+
33+
2934
# end-example
3035

31-
def test_stub():
36+
37+
def test_stub() -> None:
3238
assert True
Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
11
# start-example
2-
from sanic import Sanic, Request, json
2+
from sanic import Sanic
3+
34
from sqlspec import SQLSpec
45
from sqlspec.adapters.asyncpg import AsyncpgConfig
56

7+
__all__ = ("close_db", "test_stub" )
8+
9+
610
app = Sanic("MyApp")
711

812
# Initialize SQLSpec
@@ -13,11 +17,15 @@
1317
app.ctx.sqlspec = spec
1418
app.ctx.db_config = db
1519

20+
1621
# Cleanup on shutdown
1722
@app.before_server_stop
18-
async def close_db(app, loop):
23+
async def close_db(app, loop) -> None:
1924
await app.ctx.sqlspec.close_all_pools()
25+
26+
2027
# end-example
2128

22-
def test_stub():
29+
30+
def test_stub() -> None:
2331
assert app is not None
Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
11
# start-example
2+
__all__ = ("get_user", "test_stub" )
3+
4+
25
@app.get("/users/<user_id:int>")
36
async def get_user(request: Request, user_id: int):
47
async with request.app.ctx.sqlspec.provide_session(request.app.ctx.db_config) as db:
5-
result = await db.execute(
6-
"SELECT id, name, email FROM users WHERE id = $1",
7-
user_id
8-
)
8+
result = await db.execute("SELECT id, name, email FROM users WHERE id = $1", user_id)
99
return json(result.one())
10+
11+
1012
# end-example
1113

12-
def test_stub():
14+
15+
def test_stub() -> None:
1316
assert True
Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,27 @@
11
# start-example
2+
__all__ = ("add_db_session", "cleanup_db_session", "list_users", "test_stub" )
3+
4+
25
@app.middleware("request")
3-
async def add_db_session(request):
4-
request.ctx.db = await request.app.ctx.sqlspec.provide_session(
5-
request.app.ctx.db_config
6-
).__aenter__()
6+
async def add_db_session(request) -> None:
7+
request.ctx.db = await request.app.ctx.sqlspec.provide_session(request.app.ctx.db_config).__aenter__()
8+
79

810
@app.middleware("response")
9-
async def cleanup_db_session(request, response):
11+
async def cleanup_db_session(request, response) -> None:
1012
if hasattr(request.ctx, "db"):
1113
await request.ctx.db.__aexit__(None, None, None)
1214

15+
1316
# Use in handlers
1417
@app.get("/users")
1518
async def list_users(request: Request):
1619
result = await request.ctx.db.execute("SELECT * FROM users")
1720
return json(result.rows)
21+
22+
1823
# end-example
1924

20-
def test_stub():
25+
26+
def test_stub() -> None:
2127
assert True
Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,19 @@
11
# start-example
2-
from flask import Flask, g
2+
from flask import Flask
3+
34
from sqlspec import SQLSpec
45
from sqlspec.adapters.sqlite import SqliteConfig
56

7+
__all__ = ("test_stub", )
8+
9+
610
app = Flask(__name__)
711

812
# Initialize SQLSpec
913
spec = SQLSpec()
1014
db = spec.add_config(SqliteConfig(pool_config={"database": "app.db"}))
1115
# end-example
1216

13-
def test_stub():
17+
18+
def test_stub() -> None:
1419
assert app is not None
Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,30 @@
11
# start-example
2+
__all__ = ("close_db", "get_db", "get_user", "test_stub" )
3+
4+
25
def get_db():
3-
if 'db' not in g:
6+
if "db" not in g:
47
g.db = spec.provide_session(db).__enter__()
58
return g.db
69

10+
711
@app.teardown_appcontext
8-
def close_db(error):
9-
db = g.pop('db', None)
12+
def close_db(error) -> None:
13+
db = g.pop("db", None)
1014
if db is not None:
1115
db.__exit__(None, None, None)
1216

17+
1318
# Use in routes
14-
@app.route('/users/<int:user_id>')
19+
@app.route("/users/<int:user_id>")
1520
def get_user(user_id):
1621
db = get_db()
1722
result = db.execute("SELECT * FROM users WHERE id = ?", user_id)
1823
return result.one()
24+
25+
1926
# end-example
2027

21-
def test_stub():
28+
29+
def test_stub() -> None:
2230
assert True

0 commit comments

Comments
 (0)