add api changes from sqlalchemy/sqlalchemy#6990 (#179)

Author: CaselIT

sqlalchemy-stubs/engine/base.pyi

@@ -15,6 +15,7 @@ from .interfaces import Connectable as Connectable
 from .interfaces import Dialect
 from .interfaces import ExceptionContext
 from .interfaces import ExecutionContext
+from .result import ScalarResult
 from .url import URL
 from .. import log
 from .._typing import _ExecuteOptions
@@ -86,6 +87,9 @@ class Connection(_ConnectionTypingCommon, Connectable):
     def scalar(
         self, object_: Any, *multiparams: Any, **params: Any
     ) -> Any: ...
+    def scalars(
+        self, statement: Any, *multiparams: Any, **params: Any
+    ) -> ScalarResult: ...
     def execute(self, statement: Any, *multiparams: Any, **params: Any) -> CursorResult: ...  # type: ignore[override]
     def exec_driver_sql(
         self,

sqlalchemy-stubs/ext/asyncio/engine.pyi

@@ -1,6 +1,7 @@
 from typing import Any
 from typing import Callable
 from typing import Generator
+from typing import List
 from typing import MutableMapping
 from typing import NoReturn
 from typing import Optional
@@ -9,10 +10,12 @@ from typing import TypeVar
 from .base import ProxyComparable
 from .base import StartableContext
 from .result import AsyncResult
+from .result import AsyncScalarResult
 from ..._typing import _ExecuteOptions
 from ..._typing import _ExecuteParams
 from ...engine import Dialect
 from ...engine import Result
+from ...engine import ScalarResult
 from ...engine import Transaction
 from ...engine.base import _ConnectionTypingCommon
 from ...engine.base import _EngineTypingCommon
@@ -97,6 +100,18 @@ class AsyncConnection(
         parameters: Optional[_ExecuteParams] = ...,
         execution_options: Optional[_ExecuteOptions] = ...,
     ) -> Any: ...
+    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: ...
     async def run_sync(
         self, fn: Callable[..., Any], *arg: Any, **kw: Any
     ) -> Any: ...

sqlalchemy-stubs/ext/asyncio/session.pyi

@@ -16,9 +16,11 @@ from .base import StartableContext
 from .engine import AsyncConnection
 from .engine import AsyncEngine
 from .result import AsyncResult
+from .result import AsyncScalarResult
 from ..._typing import _ExecuteOptions
 from ..._typing import _ExecuteParams
 from ...engine import Result
+from ...engine import ScalarResult
 from ...orm import Session
 from ...orm.session import _BindArguments
 from ...orm.session import _SessionClassMethodNoIoTypingCommon
@@ -119,7 +121,19 @@ class _AsyncSessionProtocol(
         execution_options: Optional[_ExecuteOptions] = ...,
         bind_arguments: Optional[_BindArguments] = ...,
         **kw: Any,
-    ) -> Any: ...
+    ) -> AsyncResult: ...
+    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: ...
     async def delete(self, instance: Any) -> None: ...
     async def merge(
         self,
@@ -183,6 +197,18 @@ class _AsyncSessionTypingCommon(
         bind_arguments: Optional[Mapping[str, Any]] = ...,
         **kw: Any,
     ) -> Any: ...
+    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: ...
     @classmethod
     async def close_all(self) -> None: ...
 

sqlalchemy-stubs/orm/session.pyi

@@ -30,6 +30,7 @@ from .._typing import _ExecuteParams
 from ..engine import Connection
 from ..engine import Engine
 from ..engine import Result
+from ..engine import ScalarResult
 from ..sql import ClauseElement
 from ..sql import Executable
 from ..sql.base import Options
@@ -129,6 +130,14 @@ class _SessionProtocol(
         bind_arguments: Optional[_BindArguments] = ...,
         **kw: Any,
     ) -> Any: ...
+    def scalars(
+        self,
+        statement: Executable,
+        params: Optional[_ExecuteParams] = ...,
+        execution_options: Optional[_ExecuteOptions] = ...,
+        bind_arguments: Optional[_BindArguments] = ...,
+        **kw: Any,
+    ) -> ScalarResult: ...
     def close(self) -> None: ...
     def refresh(
         self,
@@ -416,6 +425,14 @@ class _SessionTypingCommon(
         bind_arguments: Optional[_BindArguments] = ...,
         **kw: Any,
     ) -> Any: ...
+    def scalars(
+        self,
+        statement: Executable,
+        params: Optional[_ExecuteParams] = ...,
+        execution_options: Optional[_ExecuteOptions] = ...,
+        bind_arguments: Optional[_BindArguments] = ...,
+        **kw: Any,
+    ) -> ScalarResult: ...
 
 class _SessionInTransactionTypingCommon:
     def in_transaction(self) -> bool: ...

test/files/async_stuff.py

@@ -1,7 +1,31 @@
+from asyncio import current_task
+
+from sqlalchemy import text
+from sqlalchemy.ext.asyncio import async_scoped_session
 from sqlalchemy.ext.asyncio import AsyncSession
 from sqlalchemy.ext.asyncio import create_async_engine
 from sqlalchemy.orm import sessionmaker
-from sqlalchemy.orm import Session
 
 engine = create_async_engine(...)
-async_session = sessionmaker(engine, class_=AsyncSession)
+SM = sessionmaker(engine, class_=AsyncSession)
+
+async_session = AsyncSession(engine)
+
+as_session = async_scoped_session(SM, current_task)
+
+
+async def go() -> None:
+    r = await async_session.scalars(text("select 1"))
+    r.first()
+    sr = await async_session.stream_scalars(text("select 1"))
+    await sr.all()
+    r = await as_session.scalars(text("select 1"))
+    r.first()
+    sr = await as_session.stream_scalars(text("select 1"))
+    await sr.all()
+
+    async with engine.connect() as conn:
+        cr = await conn.scalars(text("select 1"))
+        cr.first()
+        scr = await conn.stream_scalars(text("select 1"))
+        await scr.all()

test/files/sync_stuff.py

@@ -0,0 +1,23 @@
+from sqlalchemy import create_engine
+from sqlalchemy import text
+from sqlalchemy.orm import scoped_session
+from sqlalchemy.orm import Session
+from sqlalchemy.orm import sessionmaker
+
+engine = create_engine("")
+SM = sessionmaker(engine)
+
+session = Session(engine)
+
+s_session = scoped_session(SM)
+
+
+def go() -> None:
+    r = session.scalars(text("select 1"))
+    r.first()
+    r = s_session.scalars(text("select 1"))
+    r.first()
+
+    with engine.connect() as conn:
+        cr = conn.scalars(text("select 1"))
+        cr.first()