From: Grey Li Date: Sun, 26 Feb 2023 10:56:37 +0000 (-0500) Subject: Add separate version notes for scalars X-Git-Tag: rel_2_0_5~20^2 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=ff97b9ab5e59283f684edac9a075702c43e8a4c1;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 --- diff --git a/doc/build/orm/contextual.rst b/doc/build/orm/contextual.rst index 1fc64c9659..754b7b7efb 100644 --- a/doc/build/orm/contextual.rst +++ b/doc/build/orm/contextual.rst @@ -271,7 +271,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/scoping.py b/lib/sqlalchemy/ext/asyncio/scoping.py index 302010a117..52eeb08281 100644 --- a/lib/sqlalchemy/ext/asyncio/scoping.py +++ b/lib/sqlalchemy/ext/asyncio/scoping.py @@ -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:: diff --git a/lib/sqlalchemy/ext/asyncio/session.py b/lib/sqlalchemy/ext/asyncio/session.py index 45b70ddebd..dabe1824e2 100644 --- a/lib/sqlalchemy/ext/asyncio/session.py +++ b/lib/sqlalchemy/ext/asyncio/session.py @@ -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:: diff --git a/lib/sqlalchemy/orm/scoping.py b/lib/sqlalchemy/orm/scoping.py index b46d26d0bb..3832664e56 100644 --- a/lib/sqlalchemy/orm/scoping.py +++ b/lib/sqlalchemy/orm/scoping.py @@ -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:: diff --git a/lib/sqlalchemy/orm/session.py b/lib/sqlalchemy/orm/session.py index 1a6b050dcc..a39dbc3eca 100644 --- a/lib/sqlalchemy/orm/session.py +++ b/lib/sqlalchemy/orm/session.py @@ -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::