diff options
| author | Mike Bayer <mike_mp@zzzcomputing.com> | 2021-05-02 18:31:03 -0400 |
|---|---|---|
| committer | Mike Bayer <mike_mp@zzzcomputing.com> | 2021-05-05 22:21:07 -0400 |
| commit | c5587fda7986df5851491a069830ddd4a63e01ba (patch) | |
| tree | 3cbc7f7eb5a1c477032e20ace015a7502d5c2823 /lib/sqlalchemy/engine/base.py | |
| parent | ee7a82d71783bf71f3a95550624740e908d178a0 (diff) | |
| download | sqlalchemy-c5587fda7986df5851491a069830ddd4a63e01ba.tar.gz | |
unify transactional context managers
Applied consistent behavior to the use case of
calling ``.commit()`` or ``.rollback()`` inside of an existing
``.begin()`` context manager, with the addition of potentially
emitting SQL within the block subsequent to the commit or rollback.
This change continues upon the change first added in
:ticket:`6155` where the use case of calling "rollback" inside of
a ``.begin()`` contextmanager block was proposed:
* calling ``.commit()`` or ``.rollback()`` will now be allowed
without error or warning within all scopes, including
that of legacy and future :class:`_engine.Engine`, ORM
:class:`_orm.Session`, asyncio :class:`.AsyncEngine`. Previously,
the :class:`_orm.Session` disallowed this.
* The remaining scope of the context manager is then closed;
when the block ends, a check is emitted to see if the transaction
was already ended, and if so the block returns without action.
* It will now raise **an error** if subsequent SQL of any kind
is emitted within the block, **after** ``.commit()`` or
``.rollback()`` is called. The block should be closed as
the state of the executable object would otherwise be undefined
in this state.
Fixes: #6288
Change-Id: I8b21766ae430f0fa1ac5ef689f4c0fb19fc84336
Diffstat (limited to 'lib/sqlalchemy/engine/base.py')
| -rw-r--r-- | lib/sqlalchemy/engine/base.py | 46 |
1 files changed, 25 insertions, 21 deletions
diff --git a/lib/sqlalchemy/engine/base.py b/lib/sqlalchemy/engine/base.py index 293dc21b4..663482b1f 100644 --- a/lib/sqlalchemy/engine/base.py +++ b/lib/sqlalchemy/engine/base.py @@ -13,6 +13,7 @@ from .interfaces import Connectable from .interfaces import ExceptionContext from .util import _distill_params from .util import _distill_params_20 +from .util import TransactionalContext from .. import exc from .. import inspection from .. import log @@ -60,6 +61,9 @@ class Connection(Connectable): _is_future = False _sqla_logger_namespace = "sqlalchemy.engine.Connection" + # used by sqlalchemy.engine.util.TransactionalContext + _trans_context_manager = None + def __init__( self, engine, @@ -1683,6 +1687,9 @@ class Connection(Connectable): ): self._invalid_transaction() + elif self._trans_context_manager: + TransactionalContext._trans_ctx_check(self) + if self._is_future and self._transaction is None: self._autobegin() @@ -2182,7 +2189,7 @@ class ExceptionContextImpl(ExceptionContext): self.invalidate_pool_on_disconnect = invalidate_pool_on_disconnect -class Transaction(object): +class Transaction(TransactionalContext): """Represent a database transaction in progress. The :class:`.Transaction` object is procured by @@ -2324,21 +2331,14 @@ class Transaction(object): finally: assert not self.is_active - def __enter__(self): - return self + def _get_subject(self): + return self.connection - def __exit__(self, type_, value, traceback): - if type_ is None and self.is_active: - try: - self.commit() - except: - with util.safe_reraise(): - self.rollback() - else: - if self._deactivated_from_connection: - self.close() - else: - self.rollback() + def _transaction_is_active(self): + return self.is_active + + def _transaction_is_closed(self): + return not self._deactivated_from_connection class MarkerTransaction(Transaction): @@ -2368,6 +2368,10 @@ class MarkerTransaction(Transaction): ) self.connection = connection + + if connection._trans_context_manager: + TransactionalContext._trans_ctx_check(connection) + if connection._nested_transaction is not None: self._transaction = connection._nested_transaction else: @@ -2429,6 +2433,8 @@ class RootTransaction(Transaction): def __init__(self, connection): assert connection._transaction is None + if connection._trans_context_manager: + TransactionalContext._trans_ctx_check(connection) self.connection = connection self._connection_begin_impl() connection._transaction = self @@ -2564,6 +2570,8 @@ class NestedTransaction(Transaction): def __init__(self, connection): assert connection._transaction is not None + if connection._trans_context_manager: + TransactionalContext._trans_ctx_check(connection) self.connection = connection self._savepoint = self.connection._savepoint_impl() self.is_active = True @@ -2935,16 +2943,12 @@ class Engine(Connectable, log.Identified): self.close_with_result = close_with_result def __enter__(self): + self.transaction.__enter__() return self.conn def __exit__(self, type_, value, traceback): try: - if type_ is not None: - if self.transaction.is_active: - self.transaction.rollback() - else: - if self.transaction.is_active: - self.transaction.commit() + self.transaction.__exit__(type_, value, traceback) finally: if not self.close_with_result: self.conn.close() |
