]> git.ipfire.org Git - thirdparty/sqlalchemy/sqlalchemy.git/commitdiff
Add separate version notes for scalars
authorGrey Li <withlihui@gmail.com>
Sun, 26 Feb 2023 10:56:37 +0000 (05:56 -0500)
committerMike Bayer <mike_mp@zzzcomputing.com>
Mon, 27 Feb 2023 04:04:35 +0000 (23:04 -0500)
Add separate 1.4.24 and 1.4.26 version notes for the .scalars method;
this covers Session, scoped_session, AsyncSession, async_scoped_session
as the "scoped" versions did not have the method added until 1.4.26
as part of :ticket:`7103`.

Also indicate scoped_session as ``sqlalchemy.orm.scoped_session`` in
docs rather than ``sqlalchemy.orm.scoping.scoped_session``.  This is
also happening in I77da54891860095edcb1f0625ead99fee89bd76f separately,
as both changesets refer to scoped_session without using ".scoping".

References: #7103
Closes: #9371
Pull-request: https://github.com/sqlalchemy/sqlalchemy/pull/9371
Pull-request-sha: 61132230cc6e897ab61beff25d98b19a4c0aefd0

Change-Id: I84c8b1aad752db124cfee6bc8516f6eed7ba2faf

doc/build/orm/contextual.rst
lib/sqlalchemy/ext/asyncio/scoping.py
lib/sqlalchemy/ext/asyncio/session.py
lib/sqlalchemy/orm/scoping.py
lib/sqlalchemy/orm/session.py

index 1fc64c965963c5b7e661f1a2307b20cd7f06a161..754b7b7efb2e5a35c368438c2c6fe6ed60156a34 100644 (file)
@@ -271,7 +271,7 @@ otherwise self-managed.
 Contextual Session API
 ----------------------
 
-.. autoclass:: sqlalchemy.orm.scoping.scoped_session
+.. autoclass:: sqlalchemy.orm.scoped_session
     :members:
     :inherited-members:
 
index 302010a117f7cec322db7fa817fcb8c34c048af0..52eeb08281ec9838d60be7dcb01b4ec0655e2c0d 100644 (file)
@@ -1071,7 +1071,10 @@ class async_scoped_session(Generic[_AS]):
 
         :return: a :class:`_result.ScalarResult` object
 
-        .. versionadded:: 1.4.24
+        .. versionadded:: 1.4.24 Added :meth:`_asyncio.AsyncSession.scalars`
+
+        .. versionadded:: 1.4.26 Added
+           :meth:`_asyncio.async_scoped_session.scalars`
 
         .. seealso::
 
index 45b70ddebd33a501cb1a91844a24433175486d0f..dabe1824e285453d4d8e7456e56206c44ae2ae76 100644 (file)
@@ -415,7 +415,10 @@ class AsyncSession(ReversibleProxy[Session]):
 
         :return: a :class:`_result.ScalarResult` object
 
-        .. versionadded:: 1.4.24
+        .. versionadded:: 1.4.24 Added :meth:`_asyncio.AsyncSession.scalars`
+
+        .. versionadded:: 1.4.26 Added
+           :meth:`_asyncio.async_scoped_session.scalars`
 
         .. seealso::
 
index b46d26d0bb2a0c31afc21561451304f2b49a2df3..3832664e561b30661a68b63c5173fb62ed09cea6 100644 (file)
@@ -1792,7 +1792,9 @@ class scoped_session(Generic[_S]):
 
         :return:  a :class:`_result.ScalarResult` object
 
-        .. versionadded:: 1.4.24
+        .. versionadded:: 1.4.24 Added :meth:`_orm.Session.scalars`
+
+        .. versionadded:: 1.4.26 Added :meth:`_orm.scoped_session.scalars`
 
         .. seealso::
 
index 1a6b050dccbfd5f30d90a799ab07a1a8f92503f7..a39dbc3eca84de09fdc3369d453908228c2a0d0f 100644 (file)
@@ -2327,7 +2327,9 @@ class Session(_SessionClassMethods, EventTarget):
 
         :return:  a :class:`_result.ScalarResult` object
 
-        .. versionadded:: 1.4.24
+        .. versionadded:: 1.4.24 Added :meth:`_orm.Session.scalars`
+
+        .. versionadded:: 1.4.26 Added :meth:`_orm.scoped_session.scalars`
 
         .. seealso::