Skip to content

Commit cf492ed

Browse files
authored
AsyncSession: correct (stream_)scalars arg name (#238)
The execute parameters argument is named 'params', not 'parameters'. See the [`AsyncSession.scalars()`][1] and [`AsyncSession.stream_scalars()`][2] implementations. Fixes #230 [1]: https://github.com/sqlalchemy/sqlalchemy/blob/a84f474051cae710e33b3d9486194ed534fe0167/lib/sqlalchemy/ext/asyncio/session.py#L249-L256 [2]: https://github.com/sqlalchemy/sqlalchemy/blob/a84f474051cae710e33b3d9486194ed534fe0167/lib/sqlalchemy/ext/asyncio/session.py#L338-L345
1 parent a2e2d14 commit cf492ed

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

sqlalchemy-stubs/ext/asyncio/session.pyi

+4-4
Original file line numberDiff line numberDiff line change
@@ -135,13 +135,13 @@ class _AsyncSessionProtocol(
135135
async def scalars(
136136
self,
137137
statement: Executable,
138-
parameters: Optional[_ExecuteParams] = ...,
138+
params: Optional[_ExecuteParams] = ...,
139139
execution_options: Optional[_ExecuteOptions] = ...,
140140
) -> ScalarResult: ...
141141
async def stream_scalars(
142142
self,
143143
statement: Executable,
144-
parameters: Optional[_ExecuteParams] = ...,
144+
params: Optional[_ExecuteParams] = ...,
145145
execution_options: Optional[_ExecuteOptions] = ...,
146146
) -> AsyncScalarResult: ...
147147
async def delete(self, instance: Any) -> None: ...
@@ -211,13 +211,13 @@ class _AsyncSessionTypingCommon(
211211
async def scalars(
212212
self,
213213
statement: Executable,
214-
parameters: Optional[_ExecuteParams] = ...,
214+
params: Optional[_ExecuteParams] = ...,
215215
execution_options: Optional[_ExecuteOptions] = ...,
216216
) -> ScalarResult: ...
217217
async def stream_scalars(
218218
self,
219219
statement: Executable,
220-
parameters: Optional[_ExecuteParams] = ...,
220+
params: Optional[_ExecuteParams] = ...,
221221
execution_options: Optional[_ExecuteOptions] = ...,
222222
) -> AsyncScalarResult: ...
223223
@classmethod

test/files/async_stuff.py

+4-4
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,13 @@
1515

1616

1717
async def go() -> None:
18-
r = await async_session.scalars(text("select 1"))
18+
r = await async_session.scalars(text("select 1"), params=[])
1919
r.first()
20-
sr = await async_session.stream_scalars(text("select 1"))
20+
sr = await async_session.stream_scalars(text("select 1"), params=[])
2121
await sr.all()
22-
r = await as_session.scalars(text("select 1"))
22+
r = await as_session.scalars(text("select 1"), params=[])
2323
r.first()
24-
sr = await as_session.stream_scalars(text("select 1"))
24+
sr = await as_session.stream_scalars(text("select 1"), params=[])
2525
await sr.all()
2626

2727
async with engine.connect() as conn:

0 commit comments

Comments
 (0)