o g@sddlmZddlZddlmZddlmZddlmZddlmZddlmZddlm Z dd lm Z dd lm Z dd lm Z dd lm Z dd lmZddlmZddlmZddlmZddlmZddlmZddlmZddlmZddlmZddlmZddlmZddlmZddlmZddlmZddlm Z!ddlm"Z"ddlm#Z#dd lm$Z$dd!lm%Z&dd"l'm(Z(dd#l)m*Z*dd$l)m+Z+erudd%lm,Z,dd&lm-Z-dd'lm.Z.dd(lm/Z/dd)lm0Z0dd*lm1Z1dd+lm2Z2dd,lm3Z3dd-lm4Z4dd.l5m6Z6dd/l5m7Z7dd0l8m9Z9dd1l:m;Z;dd2l:mm?Z?dd5l@mAZAdd6lBmCZCdd7lBmDZDdd8lBmEZEdd9lBmFZFdd:lBmGZGdd;lHmIZIddlNmOZOdd?lPmQZQdd@lPmRZRedAZSe+dBZTedCedDZUeVdEdFiZWeVdGdFiZXGdHdIdIZYejZe#dJdKdLdMggdNgdOdPGdQdRdRee#Z[edSdRdDZ\GdTdUdUe e\Z]GdVdWdWe e\Z^GdXdYdYee$edYZ_dgd^d_Z`dhdbdcZadidedfZ eae&_bdS)j) annotationsN)Any) Awaitable)Callable)cast)Dict)Generic)Iterable)Iterator)NoReturn)Optional)overload)Sequence)Tuple)Type) TYPE_CHECKING)TypeVar)Union)engine)ReversibleProxy)StartableContext)_ensure_sync_result) AsyncResult)AsyncScalarResult)utilclose_all_sessions)object_session)Session)SessionTransaction)state)greenlet_spawn) Concatenate) ParamSpec)AsyncConnection) AsyncEngine) Connection) CursorResult)Engine)Result)Row) RowMapping) ScalarResult)_CoreAnyExecuteParams)CoreExecuteOptionsParameter) dispatcher)_IdentityKeyType)_O)OrmExecuteOptionsParameter) IdentityMap) ORMOption)_BindArguments)_EntityBindKey)_PKIdentityArgument) _SessionBind)_SessionBindKey) _InfoType) Executable) UpdateBase) ClauseElement)ForUpdateParameter)TypedReturnsRows)r'r&_P_T)boundprebuffer_rowsTstream_resultsc@s,eZdZdZGdddZed ddZdS) AsyncAttrsa0Mixin class which provides an awaitable accessor for all attributes. E.g.:: from __future__ import annotations from typing import List from sqlalchemy import ForeignKey from sqlalchemy import func from sqlalchemy.ext.asyncio import AsyncAttrs from sqlalchemy.orm import DeclarativeBase from sqlalchemy.orm import Mapped from sqlalchemy.orm import mapped_column from sqlalchemy.orm import relationship class Base(AsyncAttrs, DeclarativeBase): pass class A(Base): __tablename__ = "a" id: Mapped[int] = mapped_column(primary_key=True) data: Mapped[str] bs: Mapped[List[B]] = relationship() class B(Base): __tablename__ = "b" id: Mapped[int] = mapped_column(primary_key=True) a_id: Mapped[int] = mapped_column(ForeignKey("a.id")) data: Mapped[str] In the above example, the :class:`_asyncio.AsyncAttrs` mixin is applied to the declarative ``Base`` class where it takes effect for all subclasses. This mixin adds a single new attribute :attr:`_asyncio.AsyncAttrs.awaitable_attrs` to all classes, which will yield the value of any attribute as an awaitable. This allows attributes which may be subject to lazy loading or deferred / unexpiry loading to be accessed such that IO can still be emitted:: a1 = (await async_session.scalars(select(A).where(A.id == 5))).one() # use the lazy loader on ``a1.bs`` via the ``.awaitable_attrs`` # interface, so that it may be awaited for b1 in await a1.awaitable_attrs.bs: print(b1) The :attr:`_asyncio.AsyncAttrs.awaitable_attrs` performs a call against the attribute that is approximately equivalent to using the :meth:`_asyncio.AsyncSession.run_sync` method, e.g.:: for b1 in await async_session.run_sync(lambda sess: a1.bs): print(b1) .. versionadded:: 2.0.13 .. seealso:: :ref:`asyncio_orm_avoid_lazyloads` c@s$eZdZdZd ddZd d d Zd S)AsyncAttrs._AsyncAttrGetitem _instancercC ||_dSN)rI)selfrIrM`/var/www/html/ecg_monitoring/venv/lib/python3.10/site-packages/sqlalchemy/ext/asyncio/session.py__init__ z%AsyncAttrs._AsyncAttrGetitem.__init__namestrreturnAwaitable[Any]cCstt|j|SrK)r#getattrrI)rLrQrMrMrN __getattr__sz(AsyncAttrs._AsyncAttrGetitem.__getattr__N)rIr)rQrRrSrT)__name__ __module__ __qualname__ __slots__rOrVrMrMrMrN_AsyncAttrGetitems r[rSrHcCs t|S)aVprovide a namespace of all attributes on this object wrapped as awaitables. e.g.:: a1 = (await async_session.scalars(select(A).where(A.id == 5))).one() some_attribute = await a1.awaitable_attrs.some_deferred_attribute some_collection = await a1.awaitable_attrs.some_collection )rGr[rLrMrMrNawaitable_attrss zAsyncAttrs.awaitable_attrsN)rSrH)rWrXrY__doc__r[propertyr]rMrMrMrNrGUs A rGz:class:`_orm.Session`z:class:`_asyncio.AsyncSession`r identity_key) __contains____iter__addadd_allexpire expire_allexpunge expunge_all is_modifiedin_transactionin_nested_transaction)dirtydeletednew identity_map is_active autoflush no_autoflushinfo) classmethodsmethods attributesc@seZdZUdZdZded< dddddddZeZded < ded< e dddZ  dddd Z dd'd(Z e dejdddd)dd6d7Ze dejdddd)dd:d7Ze dejdddd)dd=d7Z dejdd>dd?d7Ze dejdd>ddBdCZe dejdd>ddDdCZ dejdd>ddEdCZe dejdd>ddGdHZe dejdd>ddJdHZ dejdd>ddKdHZddLddejdMddXdYZddLddejdMdd[d\Ze dejdd>dd^d_Ze dejdd>ddad_Z dejdd>ddbd_Ze dejdd>ddddeZe dejdd>ddgdeZ dejdd>ddhdeZddidjZdddkddmdnZdddqdrZddtduZddvdwZ   ddd~dZ  ddddZdddZdddZdddZ dddZ!dddZ"dddZ#dddZ$dddZ%e e&dddddZ'dddZ(dddZ)dddZ*dddZ+dddZ,ddddZ-dddZ. ddddZ/dddZ0dddZ1dddZ2 ddddZ3dddZ4dddZ5e6dddZ7e6dddÄZ8e6dddńZ9e6d ddȄZ:e:j;d ddȄZ:e6ddd̄Ze6dddӄZ?e d ddքZ@e  dddddלd dd߄ZAdS( AsyncSessionaAsyncio version of :class:`_orm.Session`. The :class:`_asyncio.AsyncSession` is a proxy for a traditional :class:`_orm.Session` instance. The :class:`_asyncio.AsyncSession` is **not safe for use in concurrent tasks.**. See :ref:`session_faq_threadsafe` for background. .. versionadded:: 1.4 To use an :class:`_asyncio.AsyncSession` with custom :class:`_orm.Session` implementations, see the :paramref:`_asyncio.AsyncSession.sync_session_class` parameter. Tzdispatcher[Session]dispatchN)bindssync_session_classbindOptional[_AsyncSessionBind]ry2Optional[Dict[_SessionBindKey, _AsyncSessionBind]]rzOptional[Type[Session]]kwrcKsjd}}|r||_t|}|r||_dd|D}|r!||_||jd||d||_|_dS)aConstruct a new :class:`_asyncio.AsyncSession`. All parameters other than ``sync_session_class`` are passed to the ``sync_session_class`` callable directly to instantiate a new :class:`_orm.Session`. Refer to :meth:`_orm.Session.__init__` for parameter documentation. :param sync_session_class: A :class:`_orm.Session` subclass or other callable which will be used to construct the :class:`_orm.Session` which will be proxied. This parameter may be used to provide custom :class:`_orm.Session` subclasses. Defaults to the :attr:`_asyncio.AsyncSession.sync_session_class` class-level attribute. .. versionadded:: 1.4.24 NcSsi|] \}}|t|qSrM)r_get_sync_engine_or_connection).0keybrMrMrN s z)AsyncSession.__init__..)r{ryrM) r{rrryitemsrz_assign_proxied sync_session_proxied)rLr{ryrzr sync_bind sync_bindsrMrMrNrOs zAsyncSession.__init__z Type[Session]r rrSr cCstd)Nztasynchronous events are not implemented at this time. Apply synchronous listeners to the AsyncSession.sync_session.)NotImplementedErrorclsrMrMrN_no_async_engine_events0sz$AsyncSession._no_async_engine_eventsinstanceobjectattribute_namesOptional[Iterable[str]]with_for_updater@Nonecs t|jj|||dIdHdS)aExpire and refresh the attributes on the given instance. A query will be issued to the database and all attributes will be refreshed with their current database value. This is the async version of the :meth:`_orm.Session.refresh` method. See that method for a complete description of all options. .. seealso:: :meth:`_orm.Session.refresh` - main documentation for refresh )rrN)r#rrefresh)rLrrrrMrMrNr7szAsyncSession.refreshfn&Callable[Concatenate[Session, _P], _T]arg_P.args _P.kwargsrCcs&t||jg|Rddi|IdHS)aInvoke the given synchronous (i.e. not async) callable, passing a synchronous-style :class:`_orm.Session` as the first argument. This method allows traditional synchronous SQLAlchemy functions to run within the context of an asyncio application. E.g.:: def some_business_method(session: Session, param: str) -> str: """A synchronous function that does not require awaiting :param session: a SQLAlchemy Session, used synchronously :return: an optional return value is supported """ session.add(MyObject(param=param)) session.flush() return "success" async def do_something_async(async_engine: AsyncEngine) -> None: """an async function that uses awaiting""" with AsyncSession(async_engine) as async_session: # run some_business_method() with a sync-style # Session, proxied into an awaitable return_code = await async_session.run_sync( some_business_method, param="param1" ) print(return_code) This method maintains the asyncio event loop all the way through to the database connection by running the given callable in a specially instrumented greenlet. .. tip:: The provided callable is invoked inline within the asyncio event loop, and will block on traditional IO calls. IO within this callable should only call into SQLAlchemy's asyncio database APIs which will be properly adapted to the greenlet context. .. seealso:: :class:`.AsyncAttrs` - a mixin for ORM mapped classes that provides a similar feature more succinctly on a per-attribute basis :meth:`.AsyncConnection.run_sync` :ref:`session_run_sync` _require_awaitFN)r#r)rLrrrrMrMrNrun_syncRs< zAsyncSession.run_sync)execution_optionsbind_arguments_parent_execute_state _add_event statementTypedReturnsRows[_T]paramsOptional[_CoreAnyExecuteParams]rr4rOptional[_BindArguments]r Optional[Any]r Result[_T]cdSrKrMrLrrrrrrrMrMrNexecute zAsyncSession.executer>CursorResult[Any]crrKrMrrMrMrNrrr= Result[Any]crrKrMrrMrMrNrr)rrcsR|r t|t}nt}t|jj|f|||d|IdH}t||jIdHS)zExecute a statement and return a buffered :class:`_engine.Result` object. .. seealso:: :meth:`_orm.Session.execute` - main documentation for execute rrrN)r immutabledictunion_EXECUTE_OPTIONSr#rrrrLrrrrrresultrMrMrNrs"  TypedReturnsRows[Tuple[_T]] Optional[_T]crrKrMrLrrrrrrMrMrNscalar zAsyncSession.scalarcrrKrMrrMrMrNrrcs@|r t|t}nt}t|jj|f|||d|IdHS)zExecute a statement and return a scalar result. .. seealso:: :meth:`_orm.Session.scalar` - main documentation for scalar rN)rrrrr#rrrrMrMrNrs   ScalarResult[_T]crrKrMrrMrMrNscalarsrzAsyncSession.scalarsScalarResult[Any]crrKrMrrMrMrNrrc*|j|f|||d|IdH}|S)aExecute a statement and return scalar results. :return: a :class:`_result.ScalarResult` object .. versionadded:: 1.4.24 Added :meth:`_asyncio.AsyncSession.scalars` .. versionadded:: 1.4.26 Added :meth:`_asyncio.async_scoped_session.scalars` .. seealso:: :meth:`_orm.Session.scalars` - main documentation for scalars :meth:`_asyncio.AsyncSession.stream_scalars` - streaming version rN)rrrrMrMrNr&s Foptionspopulate_existingridentity_tokenrentity_EntityBindKey[_O]identr9rOptional[Sequence[ORMOption]]rboolrUnion[_O, None]c *ttd|jj|||||||dIdHS)zReturn an instance based on the given primary key identifier, or ``None`` if not found. .. seealso:: :meth:`_orm.Session.get` - main documentation for get Callable[..., _O]rN)r#rrgetrLrrrrrrrrMrMrNrIs  zAsyncSession.getr3c r)aOReturn an instance based on the given primary key identifier, or raise an exception if not found. Raises ``sqlalchemy.orm.exc.NoResultFound`` if the query selects no rows. ..versionadded: 2.0.22 .. seealso:: :meth:`_orm.Session.get_one` - main documentation for get_one rrN)r#rrget_onerrMrMrNris  zAsyncSession.get_oneAsyncResult[_T]crrKrMrrMrMrNstreamrzAsyncSession.streamAsyncResult[Any]crrKrMrrMrMrNrrcsH|r t|t}nt}t|jj|f|||d|IdH}t|S)zbExecute a statement and return a streaming :class:`_asyncio.AsyncResult` object. rN)rrr_STREAM_OPTIONSr#rrrrrMrMrNrs"  AsyncScalarResult[_T]crrKrMrrMrMrNstream_scalarsrzAsyncSession.stream_scalarsAsyncScalarResult[Any]crrKrMrrMrMrNrrcr)aRExecute a statement and return a stream of scalar results. :return: an :class:`_asyncio.AsyncScalarResult` object .. versionadded:: 1.4.24 .. seealso:: :meth:`_orm.Session.scalars` - main documentation for scalars :meth:`_asyncio.AsyncSession.scalars` - non streaming version rN)rrrrMrMrNrs cst|jj|IdHdS)aTMark an instance as deleted. The database delete operation occurs upon ``flush()``. As this operation may need to cascade along unloaded relationships, it is awaitable to allow for those queries to take place. .. seealso:: :meth:`_orm.Session.delete` - main documentation for delete N)r#rdeleterLrrMrMrNrs zAsyncSession.deleteloadrrcst|jj|||dIdHS)zCopy the state of a given instance into a corresponding instance within this :class:`_asyncio.AsyncSession`. .. seealso:: :meth:`_orm.Session.merge` - main documentation for merge rN)r#rmerge)rLrrrrMrMrNrs  zAsyncSession.mergeobjectsOptional[Sequence[Any]]cst|jj|dIdHdS)zFlush all the object changes to the database. .. seealso:: :meth:`_orm.Session.flush` - main documentation for flush )rN)r#rflush)rLrrMrMrNrszAsyncSession.flush!Optional[AsyncSessionTransaction]cC |j}|durt|SdS)zReturn the current root transaction in progress, if any. :return: an :class:`_asyncio.AsyncSessionTransaction` object, or ``None``. .. versionadded:: 1.4.18 N)rget_transactionAsyncSessionTransaction_retrieve_proxy_for_targetrLtransrMrMrNr$s  zAsyncSession.get_transactioncCr)zReturn the current nested transaction in progress, if any. :return: an :class:`_asyncio.AsyncSessionTransaction` object, or ``None``. .. versionadded:: 1.4.18 N)rget_nested_transactionrrrrMrMrNr3s  z#AsyncSession.get_nested_transactionmapperOptional[_EntityBindKey[_O]]clauseOptional[ClauseElement]Optional[_SessionBind]Union[Engine, Connection]cKs|jjd|||d|S)a Return a "bind" to which the synchronous proxied :class:`_orm.Session` is bound. Unlike the :meth:`_orm.Session.get_bind` method, this method is currently **not** used by this :class:`.AsyncSession` in any way in order to resolve engines for requests. .. note:: This method proxies directly to the :meth:`_orm.Session.get_bind` method, however is currently **not** useful as an override target, in contrast to that of the :meth:`_orm.Session.get_bind` method. The example below illustrates how to implement custom :meth:`_orm.Session.get_bind` schemes that work with :class:`.AsyncSession` and :class:`.AsyncEngine`. The pattern introduced at :ref:`session_custom_partitioning` illustrates how to apply a custom bind-lookup scheme to a :class:`_orm.Session` given a set of :class:`_engine.Engine` objects. To apply a corresponding :meth:`_orm.Session.get_bind` implementation for use with a :class:`.AsyncSession` and :class:`.AsyncEngine` objects, continue to subclass :class:`_orm.Session` and apply it to :class:`.AsyncSession` using :paramref:`.AsyncSession.sync_session_class`. The inner method must continue to return :class:`_engine.Engine` instances, which can be acquired from a :class:`_asyncio.AsyncEngine` using the :attr:`_asyncio.AsyncEngine.sync_engine` attribute:: # using example from "Custom Vertical Partitioning" import random from sqlalchemy.ext.asyncio import AsyncSession from sqlalchemy.ext.asyncio import create_async_engine from sqlalchemy.ext.asyncio import async_sessionmaker from sqlalchemy.orm import Session # construct async engines w/ async drivers engines = { "leader": create_async_engine("sqlite+aiosqlite:///leader.db"), "other": create_async_engine("sqlite+aiosqlite:///other.db"), "follower1": create_async_engine("sqlite+aiosqlite:///follower1.db"), "follower2": create_async_engine("sqlite+aiosqlite:///follower2.db"), } class RoutingSession(Session): def get_bind(self, mapper=None, clause=None, **kw): # within get_bind(), return sync engines if mapper and issubclass(mapper.class_, MyOtherClass): return engines["other"].sync_engine elif self._flushing or isinstance(clause, (Update, Delete)): return engines["leader"].sync_engine else: return engines[ random.choice(["follower1", "follower2"]) ].sync_engine # apply to AsyncSession using sync_session_class AsyncSessionMaker = async_sessionmaker(sync_session_class=RoutingSession) The :meth:`_orm.Session.get_bind` method is called in a non-asyncio, implicitly non-blocking context in the same manner as ORM event hooks and functions that are invoked via :meth:`.AsyncSession.run_sync`, so routines that wish to run SQL commands inside of :meth:`_orm.Session.get_bind` can continue to do so using blocking-style code, which will be translated to implicitly async calls at the point of invoking IO on the database drivers. )rrr{NrM)rget_bind)rLrrr{rrMrMrNrCs PzAsyncSession.get_bind%Optional[CoreExecuteOptionsParameter]r&cs.t|jjf||d|IdH}tj|S)aReturn a :class:`_asyncio.AsyncConnection` object corresponding to this :class:`.Session` object's transactional state. This method may also be used to establish execution options for the database connection used by the current transaction. .. versionadded:: 1.4.24 Added \**kw arguments which are passed through to the underlying :meth:`_orm.Session.connection` method. .. seealso:: :meth:`_orm.Session.connection` - main documentation for "connection" )rrN)r#r connectionrr&r)rLrrrsync_connectionrMrMrNrs zAsyncSession.connectionrcCt|S)aReturn an :class:`_asyncio.AsyncSessionTransaction` object. The underlying :class:`_orm.Session` will perform the "begin" action when the :class:`_asyncio.AsyncSessionTransaction` object is entered:: async with async_session.begin(): ... # ORM transaction is begun Note that database IO will not normally occur when the session-level transaction is begun, as database transactions begin on an on-demand basis. However, the begin block is async to accommodate for a :meth:`_orm.SessionEvents.after_transaction_create` event hook that may perform IO. For a general description of ORM begin, see :meth:`_orm.Session.begin`. rr\rMrMrNbeginszAsyncSession.begincCs t|ddS)aReturn an :class:`_asyncio.AsyncSessionTransaction` object which will begin a "nested" transaction, e.g. SAVEPOINT. Behavior is the same as that of :meth:`_asyncio.AsyncSession.begin`. For a general description of ORM begin nested, see :meth:`_orm.Session.begin_nested`. .. seealso:: :ref:`aiosqlite_serializable` - special workarounds required with the SQLite asyncio driver in order for SAVEPOINT to work correctly. T)nestedrr\rMrMrN begin_nesteds zAsyncSession.begin_nestedct|jjIdHdS)zRollback the current transaction in progress. .. seealso:: :meth:`_orm.Session.rollback` - main documentation for "rollback" N)r#rrollbackr\rMrMrNrzAsyncSession.rollbackcr)zCommit the current transaction in progress. .. seealso:: :meth:`_orm.Session.commit` - main documentation for "commit" N)r#rcommitr\rMrMrNrrzAsyncSession.commitcr)aClose out the transactional resources and ORM objects used by this :class:`_asyncio.AsyncSession`. .. seealso:: :meth:`_orm.Session.close` - main documentation for "close" :ref:`session_closing` - detail on the semantics of :meth:`_asyncio.AsyncSession.close` and :meth:`_asyncio.AsyncSession.reset`. N)r#rcloser\rMrMrNrszAsyncSession.closecr)aClose out the transactional resources and ORM objects used by this :class:`_orm.Session`, resetting the session to its initial state. .. versionadded:: 2.0.22 .. seealso:: :meth:`_orm.Session.reset` - main documentation for "reset" :ref:`session_closing` - detail on the semantics of :meth:`_asyncio.AsyncSession.close` and :meth:`_asyncio.AsyncSession.reset`. N)r#rresetr\rMrMrNrszAsyncSession.resetcs|IdHdS)aA synonym for :meth:`_asyncio.AsyncSession.close`. The :meth:`_asyncio.AsyncSession.aclose` name is specifically to support the Python standard library ``@contextlib.aclosing`` context manager function. .. versionadded:: 2.0.20 N)rr\rMrMrNaclose zAsyncSession.aclosecr)zClose this Session, using connection invalidation. For a complete description, see :meth:`_orm.Session.invalidate`. N)r#r invalidater\rMrMrNr#szAsyncSession.invalidatez2.0zThe :meth:`.AsyncSession.close_all` method is deprecated and will be removed in a future release. Please refer to :func:`_asyncio.close_all_sessions`.cstIdHdS)z2Close all :class:`_asyncio.AsyncSession` sessions.NrrrMrMrN close_all*s zAsyncSession.close_allrL_AScs|SrKrMr\rMrMrN __aenter__5szAsyncSession.__aenter__type_value tracebackcs$t|}t|IdHdSrK)asyncio create_taskrshield)rLrrrtaskrMrMrN __aexit__8szAsyncSession.__aexit__ _AsyncSessionContextManager[_AS]cCrrK)_AsyncSessionContextManagerr\rMrMrN_maker_context_manager<sz#AsyncSession._maker_context_managercC |j|S)aKReturn True if the instance is associated with this session. .. container:: class_bases Proxied for the :class:`_orm.Session` class on behalf of the :class:`_asyncio.AsyncSession` class. The instance may be pending or persistent within the Session for a result of True. )rrarrMrMrNraD zAsyncSession.__contains__Iterator[object]cC |jS)zIterate over all pending or persistent instances within this Session. .. container:: class_bases Proxied for the :class:`_orm.Session` class on behalf of the :class:`_asyncio.AsyncSession` class. )rrbr\rMrMrNrbTs zAsyncSession.__iter___warncC|jj||dS)a:Place an object into this :class:`_orm.Session`. .. container:: class_bases Proxied for the :class:`_orm.Session` class on behalf of the :class:`_asyncio.AsyncSession` class. Objects that are in the :term:`transient` state when passed to the :meth:`_orm.Session.add` method will move to the :term:`pending` state, until the next flush, at which point they will move to the :term:`persistent` state. Objects that are in the :term:`detached` state when passed to the :meth:`_orm.Session.add` method will move to the :term:`persistent` state directly. If the transaction used by the :class:`_orm.Session` is rolled back, objects which were transient when they were passed to :meth:`_orm.Session.add` will be moved back to the :term:`transient` state, and will no longer be present within this :class:`_orm.Session`. .. seealso:: :meth:`_orm.Session.add_all` :ref:`session_adding` - at :ref:`session_basics` )r )rrc)rLrr rMrMrNrcbs zAsyncSession.add instancesIterable[object]cCr )aAdd the given collection of instances to this :class:`_orm.Session`. .. container:: class_bases Proxied for the :class:`_orm.Session` class on behalf of the :class:`_asyncio.AsyncSession` class. See the documentation for :meth:`_orm.Session.add` for a general behavioral description. .. seealso:: :meth:`_orm.Session.add` :ref:`session_adding` - at :ref:`session_basics` )rrd)rLrrMrMrNrds zAsyncSession.add_allcCr)aaExpire the attributes on an instance. .. container:: class_bases Proxied for the :class:`_orm.Session` class on behalf of the :class:`_asyncio.AsyncSession` class. Marks the attributes of an instance as out of date. When an expired attribute is next accessed, a query will be issued to the :class:`.Session` object's current transactional context in order to load all expired attributes for the given instance. Note that a highly isolated transaction will return the same values as were previously read in that same transaction, regardless of changes in database state outside of that transaction. To expire all objects in the :class:`.Session` simultaneously, use :meth:`Session.expire_all`. The :class:`.Session` object's default behavior is to expire all state whenever the :meth:`Session.rollback` or :meth:`Session.commit` methods are called, so that new state can be loaded for the new transaction. For this reason, calling :meth:`Session.expire` only makes sense for the specific case that a non-ORM SQL statement was emitted in the current transaction. :param instance: The instance to be refreshed. :param attribute_names: optional list of string attribute names indicating a subset of attributes to be expired. .. seealso:: :ref:`session_expire` - introductory material :meth:`.Session.expire` :meth:`.Session.refresh` :meth:`_orm.Query.populate_existing` )r)rre)rLrrrMrMrNres.zAsyncSession.expirecCr )akExpires all persistent instances within this Session. .. container:: class_bases Proxied for the :class:`_orm.Session` class on behalf of the :class:`_asyncio.AsyncSession` class. When any attributes on a persistent instance is next accessed, a query will be issued using the :class:`.Session` object's current transactional context in order to load all expired attributes for the given instance. Note that a highly isolated transaction will return the same values as were previously read in that same transaction, regardless of changes in database state outside of that transaction. To expire individual objects and individual attributes on those objects, use :meth:`Session.expire`. The :class:`.Session` object's default behavior is to expire all state whenever the :meth:`Session.rollback` or :meth:`Session.commit` methods are called, so that new state can be loaded for the new transaction. For this reason, calling :meth:`Session.expire_all` is not usually needed, assuming the transaction is isolated. .. seealso:: :ref:`session_expire` - introductory material :meth:`.Session.expire` :meth:`.Session.refresh` :meth:`_orm.Query.populate_existing` )rrfr\rMrMrNrfs 'zAsyncSession.expire_allcCr )adRemove the `instance` from this ``Session``. .. container:: class_bases Proxied for the :class:`_orm.Session` class on behalf of the :class:`_asyncio.AsyncSession` class. This will free all internal references to the instance. Cascading will be applied according to the *expunge* cascade rule. )rrgrrMrMrNrgr zAsyncSession.expungecCr )aARemove all object instances from this ``Session``. .. container:: class_bases Proxied for the :class:`_orm.Session` class on behalf of the :class:`_asyncio.AsyncSession` class. This is equivalent to calling ``expunge(obj)`` on all objects in this ``Session``. )rrhr\rMrMrNrh zAsyncSession.expunge_allinclude_collectionscCr)a Return ``True`` if the given instance has locally modified attributes. .. container:: class_bases Proxied for the :class:`_orm.Session` class on behalf of the :class:`_asyncio.AsyncSession` class. This method retrieves the history for each instrumented attribute on the instance and performs a comparison of the current value to its previously flushed or committed value, if any. It is in effect a more expensive and accurate version of checking for the given instance in the :attr:`.Session.dirty` collection; a full test for each attribute's net "dirty" status is performed. E.g.:: return session.is_modified(someobject) A few caveats to this method apply: * Instances present in the :attr:`.Session.dirty` collection may report ``False`` when tested with this method. This is because the object may have received change events via attribute mutation, thus placing it in :attr:`.Session.dirty`, but ultimately the state is the same as that loaded from the database, resulting in no net change here. * Scalar attributes may not have recorded the previously set value when a new value was applied, if the attribute was not loaded, or was expired, at the time the new value was received - in these cases, the attribute is assumed to have a change, even if there is ultimately no net change against its database value. SQLAlchemy in most cases does not need the "old" value when a set event occurs, so it skips the expense of a SQL call if the old value isn't present, based on the assumption that an UPDATE of the scalar value is usually needed, and in those few cases where it isn't, is less expensive on average than issuing a defensive SELECT. The "old" value is fetched unconditionally upon set only if the attribute container has the ``active_history`` flag set to ``True``. This flag is set typically for primary key attributes and scalar object references that are not a simple many-to-one. To set this flag for any arbitrary mapped column, use the ``active_history`` argument with :func:`.column_property`. :param instance: mapped instance to be tested for pending changes. :param include_collections: Indicates if multivalued collections should be included in the operation. Setting this to ``False`` is a way to detect only local-column based properties (i.e. scalar columns or many-to-one foreign keys) that would result in an UPDATE for this instance upon flush. )r)rri)rLrrrMrMrNris<zAsyncSession.is_modifiedcCr )aOReturn True if this :class:`_orm.Session` has begun a transaction. .. container:: class_bases Proxied for the :class:`_orm.Session` class on behalf of the :class:`_asyncio.AsyncSession` class. .. versionadded:: 1.4 .. seealso:: :attr:`_orm.Session.is_active` )rrjr\rMrMrNrjSs zAsyncSession.in_transactioncCr )a+Return True if this :class:`_orm.Session` has begun a nested transaction, e.g. SAVEPOINT. .. container:: class_bases Proxied for the :class:`_orm.Session` class on behalf of the :class:`_asyncio.AsyncSession` class. .. versionadded:: 1.4 )rrkr\rMrMrNrkgrz"AsyncSession.in_nested_transactioncC|jjS)aThe set of all persistent instances considered dirty. .. container:: class_bases Proxied for the :class:`_orm.Session` class on behalf of the :class:`_asyncio.AsyncSession` class. E.g.:: some_mapped_object in session.dirty Instances are considered dirty when they were modified but not deleted. Note that this 'dirty' calculation is 'optimistic'; most attribute-setting or collection modification operations will mark an instance as 'dirty' and place it in this set, even if there is no net change to the attribute's value. At flush time, the value of each attribute is compared to its previously saved value, and if there's no net change, no SQL operation will occur (this is a more expensive operation so it's only done at flush time). To check if an instance has actionable net changes to its attributes, use the :meth:`.Session.is_modified` method. )rrlr\rMrMrNrlwszAsyncSession.dirtycCr)zThe set of all instances marked as 'deleted' within this ``Session`` .. container:: class_bases Proxied for the :class:`_orm.Session` class on behalf of the :class:`_asyncio.AsyncSession` class. )rrmr\rMrMrNrm zAsyncSession.deletedcCr)zThe set of all instances marked as 'new' within this ``Session``. .. container:: class_bases Proxied for the :class:`_orm.Session` class on behalf of the :class:`_asyncio.AsyncSession` class. )rrnr\rMrMrNrnrzAsyncSession.newr5cCr)zProxy for the :attr:`_orm.Session.identity_map` attribute on behalf of the :class:`_asyncio.AsyncSession` class. rror\rMrMrNrozAsyncSession.identity_mapattrcC ||j_dSrKrrLrrMrMrNro cCr)aTrue if this :class:`.Session` not in "partial rollback" state. .. container:: class_bases Proxied for the :class:`_orm.Session` class on behalf of the :class:`_asyncio.AsyncSession` class. .. versionchanged:: 1.4 The :class:`_orm.Session` no longer begins a new transaction immediately, so this attribute will be False when the :class:`_orm.Session` is first instantiated. "partial rollback" state typically indicates that the flush process of the :class:`_orm.Session` has failed, and that the :meth:`_orm.Session.rollback` method must be emitted in order to fully roll back the transaction. If this :class:`_orm.Session` is not in a transaction at all, the :class:`_orm.Session` will autobegin when it is first used, so in this case :attr:`_orm.Session.is_active` will return True. Otherwise, if this :class:`_orm.Session` is within a transaction, and that transaction has not been rolled back internally, the :attr:`_orm.Session.is_active` will also return True. .. seealso:: :ref:`faq_session_rollback` :meth:`_orm.Session.in_transaction` )rrpr\rMrMrNrps#zAsyncSession.is_activecCr)zProxy for the :attr:`_orm.Session.autoflush` attribute on behalf of the :class:`_asyncio.AsyncSession` class. rrqr\rMrMrNrqrzAsyncSession.autoflushcCrrKrrrMrMrNrqrcCr)aReturn a context manager that disables autoflush. .. container:: class_bases Proxied for the :class:`_orm.Session` class on behalf of the :class:`_asyncio.AsyncSession` class. e.g.:: with session.no_autoflush: some_object = SomeClass() session.add(some_object) # won't autoflush some_object.related_thing = session.query(SomeRelated).first() Operations that proceed within the ``with:`` block will not be subject to flushes occurring upon query access. This is useful when initializing a series of objects which involve existing database queries, where the uncompleted object should not yet be flushed. )rrrr\rMrMrNrrszAsyncSession.no_autoflushcCr)a+A user-modifiable dictionary. .. container:: class_bases Proxied for the :class:`_orm.Session` class on behalf of the :class:`_asyncio.AsyncSession` class. The initial value of this dictionary can be populated using the ``info`` argument to the :class:`.Session` constructor or :class:`.sessionmaker` constructor or factory methods. The dictionary here is always local to this :class:`.Session` and can be modified independently of all other :class:`.Session` objects. )rrsr\rMrMrNrsszAsyncSession.infoOptional[Session]cCs t|S)aReturn the :class:`.Session` to which an object belongs. .. container:: class_bases Proxied for the :class:`_orm.Session` class on behalf of the :class:`_asyncio.AsyncSession` class. This is an alias of :func:`.object_session`. )r r)rrrMrMrNr"rzAsyncSession.object_session)rrowrclass_Optional[Type[Any]]Union[Any, Tuple[Any, ...]]r%Optional[Union[Row[Any], RowMapping]]_IdentityKeyType[Any]cCstj|||||dS)zReturn an identity key. .. container:: class_bases Proxied for the :class:`_orm.Session` class on behalf of the :class:`_asyncio.AsyncSession` class. This is an alias of :func:`.util.identity_key`. )rrrrr)r r`)rrrrrrrMrMrNr`2szAsyncSession.identity_keyrK)r{r|ryr}rzr~rr)rSr )NN)rrrrrr@rSr)rrrrrrrSrC)rrrrrr4rrrrrrrSr)rr>rrrr4rrrrrrrSr)rr=rrrr4rrrrrrrSr) rr=rrrr4rrrrrSr) rrrrrr4rrrrrSr) rr=rrrr4rrrrrSr) rrrrrr4rrrrrSr) rr=rrrr4rrrrrSr)rrrr9rrrrrr@rrrr4rSr)rrrr9rrrrrr@rrrr4rSr3) rrrrrr4rrrrrSr) rr=rrrr4rrrrrSr) rrrrrr4rrrrrSr) rr=rrrr4rrrrrSr)rrrSr)rr3rrrrrSr3)rrrSr)rSr)NNN) rrrrr{rrrrSr)rrrrrrrSr&)rSrrSr)rLrrSrrrrrrrrSr)rLrrSr)rrrSr)rSr )T)rrr rrSr)rrrSr)rrrrrSr)rrrrrSrrSr)rSr)rSr5)rr5rSr)rrrSr)rrrSr) rrrr rrrr!rrrSr")BrWrXrYr^ _is_asyncio__annotations__rOr rz classmethodrrrr r EMPTY_DICTrrrrrrrrrrrrrrrrrrrrrr deprecatedrrrrrarbrcrdrerfrgrhrirjrkr_rlrmrnrosetterrprqrrrsrr`rMrMrMrNrws  .   @  #  !  (%$        V           " 0 )  @    $rwrc@seZdZUdZded<e d'ddddd(ddZe d'ddddd)ddZ d*eddddd(ddZd+ddZd,ddZ d-d"d#Z d.d%d&Z dS)/async_sessionmakera"A configurable :class:`.AsyncSession` factory. The :class:`.async_sessionmaker` factory works in the same way as the :class:`.sessionmaker` factory, to generate new :class:`.AsyncSession` objects when called, creating them given the configurational arguments established here. e.g.:: from sqlalchemy.ext.asyncio import create_async_engine from sqlalchemy.ext.asyncio import AsyncSession from sqlalchemy.ext.asyncio import async_sessionmaker async def run_some_sql( async_session: async_sessionmaker[AsyncSession], ) -> None: async with async_session() as session: session.add(SomeObject(data="object")) session.add(SomeOtherObject(name="other object")) await session.commit() async def main() -> None: # an AsyncEngine, which the AsyncSession will use for connection # resources engine = create_async_engine( "postgresql+asyncpg://scott:tiger@localhost/" ) # create a reusable factory for new AsyncSession instances async_session = async_sessionmaker(engine) await run_some_sql(async_session) await engine.dispose() The :class:`.async_sessionmaker` is useful so that different parts of a program can create new :class:`.AsyncSession` objects with a fixed configuration established up front. Note that :class:`.AsyncSession` objects may also be instantiated directly when not using :class:`.async_sessionmaker`. .. versionadded:: 2.0 :class:`.async_sessionmaker` provides a :class:`.sessionmaker` class that's dedicated to the :class:`.AsyncSession` object, including pep-484 typing support. .. seealso:: :ref:`asyncio_orm` - shows example use :class:`.sessionmaker` - general overview of the :class:`.sessionmaker` architecture :ref:`session_getting` - introductory text on creating sessions using :class:`.sessionmaker`. Type[_AS]r.)rqexpire_on_commitrsr{r|rqrr.rsOptional[_InfoType]rrcKdSrKrMrLr{rrqr.rsrrMrMrNrOs zasync_sessionmaker.__init__rL"'async_sessionmaker[AsyncSession]'cKr0rKrM)rLr{rqr.rsrrMrMrNrOs NT)rrqr.rscKs8||d<||d<||d<|dur||d<||_||_dS)aConstruct a new :class:`.async_sessionmaker`. All arguments here except for ``class_`` correspond to arguments accepted by :class:`.Session` directly. See the :meth:`.AsyncSession.__init__` docstring for more details on parameters. r{rqr.Nrs)rrr1rMrMrNrOs rSrcCs|}|S)aProduce a context manager that both provides a new :class:`_orm.AsyncSession` as well as a transaction that commits. e.g.:: async def main(): Session = async_sessionmaker(some_engine) async with Session.begin() as session: session.add(some_object) # commits transaction, closes session )r)rLsessionrMrMrNrszasync_sessionmaker.beginlocal_kwrcKs`|jD]"\}}|dkr!d|vr!|}||d||d<q|||q|jdi|S)aProduce a new :class:`.AsyncSession` object using the configuration established in this :class:`.async_sessionmaker`. In Python, the ``__call__`` method is invoked on an object when it is "called" in the same way as a function:: AsyncSession = async_sessionmaker(async_engine, expire_on_commit=False) session = AsyncSession() # invokes sessionmaker.__call__() rsNrM)rrcopyupdate setdefaultr)rLr4kvdrMrMrN__call__s  zasync_sessionmaker.__call__new_kwrcKs|j|dS)z(Re)configure the arguments for this async_sessionmaker. e.g.:: AsyncSession = async_sessionmaker(some_engine) AsyncSession.configure(bind=create_async_engine("sqlite+aiosqlite://")) N)rr6)rLr<rMrMrN configures zasync_sessionmaker.configurerRcCs,d|jj|jjddd|jDfS)Nz%s(class_=%r, %s)z, css |] \}}d||fVqdS)z%s=%rNrM)rr8r9rMrMrN sz.async_sessionmaker.__repr__..) __class__rWrjoinrrr\rMrMrN__repr__s zasync_sessionmaker.__repr__).) r{r|rr-rqrr.rrsr/rr) rLr2r{r|rqrr.rrsr/rrrK)rSr)r4rrSr)r<rrSr)rSrR) rWrXrYr^r'r rOrwrr;r=rArMrMrMrNr,Vs8 <      r,c@s@eZdZUdZded<ded<dddZdd d ZdddZdS)r) async_sessionrrrBrrcCrJrK)rB)rLrBrMrMrNrO rPz$_AsyncSessionContextManager.__init__rScs$|j|_|jIdH|jSrK)rBrrrr\rMrMrNr s z&_AsyncSessionContextManager.__aenter__rrrrrcs6dfdd }t|}t|IdHdS)NrSrcs2jIdHjIdHdSrK)rrrBrMrLrrrrMrNgosz1_AsyncSessionContextManager.__aexit__..gor#)rrr)rLrrrrDrrMrCrNrs z%_AsyncSessionContextManager.__aexit__N)rBr)rSrr$)rWrXrYrZr'rOrrrMrMrMrNrs   rc@sveZdZUdZdZded<ded<d!d"d d Zed#d dZd$ddZ d%ddZ d%ddZ d!d&ddZ d'ddZ d S)(raA wrapper for the ORM :class:`_orm.SessionTransaction` object. This object is provided so that a transaction-holding object for the :meth:`_asyncio.AsyncSession.begin` may be returned. The object supports both explicit calls to :meth:`_asyncio.AsyncSessionTransaction.commit` and :meth:`_asyncio.AsyncSessionTransaction.rollback`, as well as use as an async context manager. .. versionadded:: 1.4 )r3sync_transactionrrwr3zOptional[SessionTransaction]rEFrrcCs||_||_d|_dSrK)r3rrE)rLr3rrMrMrNrO2s z AsyncSessionTransaction.__init__rScCs|duo |jSrK)_sync_transactionrpr\rMrMrNrp7s z!AsyncSessionTransaction.is_activer!cCs|js||jSrK)rE_raise_for_not_startedr\rMrMrNrF>sz)AsyncSessionTransaction._sync_transactionrct|jIdHdS)z2Roll back this :class:`_asyncio.AsyncTransaction`.N)r#rFrr\rMrMrNrCsz AsyncSessionTransaction.rollbackcrH)z/Commit this :class:`_asyncio.AsyncTransaction`.N)r#rFrr\rMrMrNrGszAsyncSessionTransaction.commit is_ctxmanagercs@|t|jr |jjjn|jjjIdH|_|r|j|SrK) rr#rr3rrrrE __enter__)rLrIrMrMrNstartLs  zAsyncSessionTransaction.startrrrrcs t|j|||IdHdSrK)r#rF__exit__)rLrrrrMrMrNrZsz!AsyncSessionTransaction.__aexit__N)F)r3rwrrr%)rSr!r#)rIrrSrr$)rWrXrYr^rZr'rOr_rprFrrrKrrMrMrMrNrs       rrrrSOptional[AsyncSession]cCst|}|dur t|SdS)aReturn the :class:`_asyncio.AsyncSession` to which the given instance belongs. This function makes use of the sync-API function :class:`_orm.object_session` to retrieve the :class:`_orm.Session` which refers to the given instance, and from there links it to the original :class:`_asyncio.AsyncSession`. If the :class:`_asyncio.AsyncSession` has been garbage collected, the return value is ``None``. This functionality is also available from the :attr:`_orm.InstanceState.async_session` accessor. :param instance: an ORM mapped instance :return: an :class:`_asyncio.AsyncSession` object, or ``None``. .. versionadded:: 1.4.18 N)rrB)rr3rMrMrNasync_object_session`srNr3r cCstj|ddS)aReturn the :class:`_asyncio.AsyncSession` which is proxying the given :class:`_orm.Session` object, if any. :param session: a :class:`_orm.Session` instance. :return: a :class:`_asyncio.AsyncSession` instance, or ``None``. .. versionadded:: 1.4.18 F) regenerate)rwr)r3rMrMrNrB}s rBrcsttIdHdS)zClose all :class:`_asyncio.AsyncSession` sessions. .. versionadded:: 2.0.23 .. seealso:: :func:`.session.close_all_sessions` N)r#_sync_close_all_sessionsrMrMrMrNrrr)rrrSrM)r3r rSrMr#)c __future__rrtypingrrrrrrr r r r r rrrrrrrbaserrrrrrrormrrPrr r!r"_instance_stateutil.concurrencyr# util.typingr$r%r&r'r(r)r*r+r,r-r.engine.interfacesr/r0eventr1 orm._typingr2r3r4 orm.identityr5orm.interfacesr6 orm.sessionr7r8r9r:r; sql._typingr<sql.baser=sql.dmlr> sql.elementsr?sql.selectabler@rA_AsyncSessionBindrBrCrrrrGcreate_proxy_methodsrwrr,rrrNrB_async_providerrMrMrMrNs                                                              ]  .  F