Skip to content
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

Jump to bottom

Incorrect keyword argument name 'parameters' for AsyncSession.scalars, AsyncEngine.scalars #230

Closed
mjpieters opened this issue Sep 23, 2022 · 1 comment · Fixed by #238
Closed

Incorrect keyword argument name 'parameters' for AsyncSession.scalars, AsyncEngine.scalars #230

mjpieters opened this issue Sep 23, 2022 · 1 comment · Fixed by #238
Labels
bug Something isn't working

Comments

@mjpieters
Copy link
Contributor

The type hints for the AsyncSession.scalars() method uses the keyword argument parameters, but the actual argument is named params.

The same issue applies to AsyncSession.stream_scalars() and to the async_scoped_session proxies for these.

See:

sqlalchemy2-stubs/sqlalchemy-stubs/ext/asyncio/session.pyi

Lines 135 to 146 in ccca179

async def scalars(
self,
statement: Executable,
parameters: Optional[_ExecuteParams] = ...,
execution_options: Optional[_ExecuteOptions] = ...,
) -> ScalarResult: ...
async def stream_scalars(
self,
statement: Executable,
parameters: Optional[_ExecuteParams] = ...,
execution_options: Optional[_ExecuteOptions] = ...,
) -> AsyncScalarResult: ...

sqlalchemy2-stubs/sqlalchemy-stubs/ext/asyncio/session.pyi

Lines 211 to 222 in ccca179

async def scalars(
self,
statement: Executable,
parameters: Optional[_ExecuteParams] = ...,
execution_options: Optional[_ExecuteOptions] = ...,
) -> ScalarResult: ...
async def stream_scalars(
self,
statement: Executable,
parameters: Optional[_ExecuteParams] = ...,
execution_options: Optional[_ExecuteOptions] = ...,
) -> AsyncScalarResult: ...

@mjpieters mjpieters added the requires triage New issue that requires categorization label Sep 23, 2022
@CaselIT CaselIT added bug Something isn't working and removed requires triage New issue that requires categorization labels Sep 23, 2022
@CaselIT
Copy link
Member

CaselIT commented Sep 23, 2022

Thanks for reporting.

If you could provide a PR it would be great

@mjpieters mjpieters mentioned this issue Oct 11, 2022
Merged
1 task
CaselIT pushed a commit that referenced this issue Oct 11, 2022
@mjpieters
AsyncSession: correct (stream_)scalars arg name (#238)
cf492ed 
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

AsyncSession: correct (stream_)scalars arg name
2 participants
@mjpieters @CaselIT