diff options
author | Federico Caselli <cfederico87@gmail.com> | 2021-09-29 21:54:09 +0200 |
---|---|---|
committer | mike bayer <mike_mp@zzzcomputing.com> | 2021-10-08 17:09:59 +0000 |
commit | 38d6c6c5dc3d0c7da2268e0f9a1a71c108ab7c51 (patch) | |
tree | 0fdafb9cf740a3333b15f3a4815138736af5c995 /lib/sqlalchemy/ext/asyncio/engine.py | |
parent | 64e6da307c79981119cbd6f95957ead310e3456f (diff) | |
download | sqlalchemy-38d6c6c5dc3d0c7da2268e0f9a1a71c108ab7c51.tar.gz |
Add documentation on how to use the events with asyncio
Co-authored-by: Mike Bayer <mike_mp@zzzcomputing.com>
Fixes: #6899
Change-Id: I965af321fb36d9645fe3fc2675ad9943f24e32f2
Diffstat (limited to 'lib/sqlalchemy/ext/asyncio/engine.py')
-rw-r--r-- | lib/sqlalchemy/ext/asyncio/engine.py | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/lib/sqlalchemy/ext/asyncio/engine.py b/lib/sqlalchemy/ext/asyncio/engine.py index a9e43a65f..bfaaea4d9 100644 --- a/lib/sqlalchemy/ext/asyncio/engine.py +++ b/lib/sqlalchemy/ext/asyncio/engine.py @@ -91,6 +91,29 @@ class AsyncConnection(ProxyComparable, StartableContext, AsyncConnectable): self.sync_engine = async_engine.sync_engine self.sync_connection = self._assign_proxied(sync_connection) + sync_connection: Connection + """Reference to the sync-style :class:`_engine.Connection` this + :class:`_asyncio.AsyncConnection` proxies requests towards. + + This instance can be used as an event target. + + .. seealso:: + + :ref:`asyncio_events` + """ + + sync_engine: Engine + """Reference to the sync-style :class:`_engine.Engine` this + :class:`_asyncio.AsyncConnection` is associated with via its underlying + :class:`_engine.Connection`. + + This instance can be used as an event target. + + .. seealso:: + + :ref:`asyncio_events` + """ + @classmethod def _regenerate_proxy_for_target(cls, target): return AsyncConnection( @@ -578,6 +601,17 @@ class AsyncEngine(ProxyComparable, AsyncConnectable): ) self.sync_engine = self._proxied = self._assign_proxied(sync_engine) + sync_engine: Engine + """Reference to the sync-style :class:`_engine.Engine` this + :class:`_asyncio.AsyncEngine` proxies requests towards. + + This instance can be used as an event target. + + .. seealso:: + + :ref:`asyncio_events` + """ + @classmethod def _regenerate_proxy_for_target(cls, target): return AsyncEngine(target) |