summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGrey Li <withlihui@gmail.com>2023-02-26 05:56:37 -0500
committermike bayer <mike_mp@zzzcomputing.com>2023-02-27 13:18:41 +0000
commit4878ede0d921bb03758b0c79293bf23b6e248c49 (patch)
treecc238eb6b40283859ec90999ba5c844a254519be
parent81dd922cf79f4df0eafceb2e5092915d79d72853 (diff)
downloadsqlalchemy-4878ede0d921bb03758b0c79293bf23b6e248c49.tar.gz
Add separate version notes for scalars
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 (cherry picked from commit ff97b9ab5e59283f684edac9a075702c43e8a4c1)
-rw-r--r--doc/build/orm/contextual.rst2
-rw-r--r--lib/sqlalchemy/ext/asyncio/session.py5
-rw-r--r--lib/sqlalchemy/orm/session.py4
3 files changed, 8 insertions, 3 deletions
diff --git a/doc/build/orm/contextual.rst b/doc/build/orm/contextual.rst
index 9fadf6c73..adafc4bab 100644
--- a/doc/build/orm/contextual.rst
+++ b/doc/build/orm/contextual.rst
@@ -269,7 +269,7 @@ otherwise self-managed.
Contextual Session API
----------------------
-.. autoclass:: sqlalchemy.orm.scoping.scoped_session
+.. autoclass:: sqlalchemy.orm.scoped_session
:members:
:inherited-members:
diff --git a/lib/sqlalchemy/ext/asyncio/session.py b/lib/sqlalchemy/ext/asyncio/session.py
index 59beb2370..5238b8d1e 100644
--- a/lib/sqlalchemy/ext/asyncio/session.py
+++ b/lib/sqlalchemy/ext/asyncio/session.py
@@ -258,7 +258,10 @@ class AsyncSession(ReversibleProxy):
: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::
diff --git a/lib/sqlalchemy/orm/session.py b/lib/sqlalchemy/orm/session.py
index 2b90269b2..753d1ec5f 100644
--- a/lib/sqlalchemy/orm/session.py
+++ b/lib/sqlalchemy/orm/session.py
@@ -1766,7 +1766,9 @@ class Session(_SessionClassMethods):
: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`
"""