From: Grey Li Date: Sun, 26 Feb 2023 10:56:37 +0000 (-0500) Subject: Add separate version notes for scalars X-Git-Tag: rel_1_4_47~4 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=4878ede0d921bb03758b0c79293bf23b6e248c49;p=thirdparty%2Fsqlalchemy%2Fsqlalchemy.git 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) --- diff --git a/doc/build/orm/contextual.rst b/doc/build/orm/contextual.rst index 9fadf6c732..adafc4bab6 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 59beb23705..5238b8d1eb 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 2b90269b2a..753d1ec5f9 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` """