Made transaction.managed a no-op and deprecated it.

enter_transaction_management() was nearly always followed by managed().

In three places it wasn't, but they will all be refactored eventually.
The "forced" keyword argument avoids introducing behavior changes until
then.

This is mostly backwards-compatible, except, of course, for managed
itself. There's a minor difference in _enter_transaction_management:
the top self.transaction_state now contains the new 'managed' state
rather than the previous one. Django doesn't access
self.transaction_state in _enter_transaction_management.
This commit is contained in:
Aymeric Augustin 2013-03-02 20:25:25 +01:00
parent 9cec689e6a
commit 7aacde84f2
14 changed files with 22 additions and 64 deletions

View File

@ -75,7 +75,6 @@ class Command(BaseCommand):
if commit: if commit:
transaction.commit_unless_managed(using=self.using) transaction.commit_unless_managed(using=self.using)
transaction.enter_transaction_management(using=self.using) transaction.enter_transaction_management(using=self.using)
transaction.managed(True, using=self.using)
class SingleZipReader(zipfile.ZipFile): class SingleZipReader(zipfile.ZipFile):
def __init__(self, *args, **kwargs): def __init__(self, *args, **kwargs):

View File

@ -234,7 +234,7 @@ class BaseDatabaseWrapper(object):
##### Generic transaction management methods ##### ##### Generic transaction management methods #####
def enter_transaction_management(self, managed=True): def enter_transaction_management(self, managed=True, forced=False):
""" """
Enters transaction management for a running thread. It must be balanced with Enters transaction management for a running thread. It must be balanced with
the appropriate leave_transaction_management call, since the actual state is the appropriate leave_transaction_management call, since the actual state is
@ -243,12 +243,14 @@ class BaseDatabaseWrapper(object):
The state and dirty flag are carried over from the surrounding block or The state and dirty flag are carried over from the surrounding block or
from the settings, if there is no surrounding block (dirty is always false from the settings, if there is no surrounding block (dirty is always false
when no current block is running). when no current block is running).
If you switch off transaction management and there is a pending
commit/rollback, the data will be commited, unless "forced" is True.
""" """
if self.transaction_state: self.transaction_state.append(managed)
self.transaction_state.append(self.transaction_state[-1])
else:
self.transaction_state.append(settings.TRANSACTIONS_MANAGED)
self._enter_transaction_management(managed) self._enter_transaction_management(managed)
if not managed and self.is_dirty() and not forced:
self.commit()
def leave_transaction_management(self): def leave_transaction_management(self):
""" """
@ -314,22 +316,6 @@ class BaseDatabaseWrapper(object):
return self.transaction_state[-1] return self.transaction_state[-1]
return settings.TRANSACTIONS_MANAGED return settings.TRANSACTIONS_MANAGED
def managed(self, flag=True):
"""
Puts the transaction manager into a manual state: managed transactions have
to be committed explicitly by the user. If you switch off transaction
management and there is a pending commit/rollback, the data will be
commited.
"""
top = self.transaction_state
if top:
top[-1] = flag
if not flag and self.is_dirty():
self.commit()
else:
raise TransactionManagementError("This code isn't under transaction "
"management")
def commit_unless_managed(self): def commit_unless_managed(self):
""" """
Commits changes if the system is not in managed transaction mode. Commits changes if the system is not in managed transaction mode.
@ -574,7 +560,6 @@ class BaseDatabaseFeatures(object):
# otherwise autocommit will cause the confimation to # otherwise autocommit will cause the confimation to
# fail. # fail.
self.connection.enter_transaction_management() self.connection.enter_transaction_management()
self.connection.managed(True)
cursor = self.connection.cursor() cursor = self.connection.cursor()
cursor.execute('CREATE TABLE ROLLBACK_TEST (X INT)') cursor.execute('CREATE TABLE ROLLBACK_TEST (X INT)')
self.connection.commit() self.connection.commit()

View File

@ -54,7 +54,7 @@ def force_managed(func):
@wraps(func) @wraps(func)
def decorated(self, *args, **kwargs): def decorated(self, *args, **kwargs):
if not transaction.is_managed(using=self.using): if not transaction.is_managed(using=self.using):
transaction.enter_transaction_management(using=self.using) transaction.enter_transaction_management(using=self.using, forced=True)
forced_managed = True forced_managed = True
else: else:
forced_managed = False forced_managed = False

View File

@ -443,7 +443,7 @@ class QuerySet(object):
connection = connections[self.db] connection = connections[self.db]
fields = self.model._meta.local_fields fields = self.model._meta.local_fields
if not transaction.is_managed(using=self.db): if not transaction.is_managed(using=self.db):
transaction.enter_transaction_management(using=self.db) transaction.enter_transaction_management(using=self.db, forced=True)
forced_managed = True forced_managed = True
else: else:
forced_managed = False forced_managed = False
@ -582,7 +582,7 @@ class QuerySet(object):
query = self.query.clone(sql.UpdateQuery) query = self.query.clone(sql.UpdateQuery)
query.add_update_values(kwargs) query.add_update_values(kwargs)
if not transaction.is_managed(using=self.db): if not transaction.is_managed(using=self.db):
transaction.enter_transaction_management(using=self.db) transaction.enter_transaction_management(using=self.db, forced=True)
forced_managed = True forced_managed = True
else: else:
forced_managed = False forced_managed = False

View File

@ -12,6 +12,8 @@ Managed transactions don't do those commits, but will need some kind of manual
or implicit commits or rollbacks. or implicit commits or rollbacks.
""" """
import warnings
from functools import wraps from functools import wraps
from django.db import connections, DEFAULT_DB_ALIAS from django.db import connections, DEFAULT_DB_ALIAS
@ -49,7 +51,7 @@ def abort(using=None):
""" """
get_connection(using).abort() get_connection(using).abort()
def enter_transaction_management(managed=True, using=None): def enter_transaction_management(managed=True, using=None, forced=False):
""" """
Enters transaction management for a running thread. It must be balanced with Enters transaction management for a running thread. It must be balanced with
the appropriate leave_transaction_management call, since the actual state is the appropriate leave_transaction_management call, since the actual state is
@ -59,7 +61,7 @@ def enter_transaction_management(managed=True, using=None):
from the settings, if there is no surrounding block (dirty is always false from the settings, if there is no surrounding block (dirty is always false
when no current block is running). when no current block is running).
""" """
get_connection(using).enter_transaction_management(managed) get_connection(using).enter_transaction_management(managed, forced)
def leave_transaction_management(using=None): def leave_transaction_management(using=None):
""" """
@ -105,13 +107,8 @@ def is_managed(using=None):
return get_connection(using).is_managed() return get_connection(using).is_managed()
def managed(flag=True, using=None): def managed(flag=True, using=None):
""" warnings.warn("'managed' no longer serves a purpose.",
Puts the transaction manager into a manual state: managed transactions have PendingDeprecationWarning, stacklevel=2)
to be committed explicitly by the user. If you switch off transaction
management and there is a pending commit/rollback, the data will be
commited.
"""
get_connection(using).managed(flag)
def commit_unless_managed(using=None): def commit_unless_managed(using=None):
""" """
@ -224,7 +221,6 @@ def autocommit(using=None):
""" """
def entering(using): def entering(using):
enter_transaction_management(managed=False, using=using) enter_transaction_management(managed=False, using=using)
managed(False, using=using)
def exiting(exc_value, using): def exiting(exc_value, using):
leave_transaction_management(using=using) leave_transaction_management(using=using)
@ -240,7 +236,6 @@ def commit_on_success(using=None):
""" """
def entering(using): def entering(using):
enter_transaction_management(using=using) enter_transaction_management(using=using)
managed(True, using=using)
def exiting(exc_value, using): def exiting(exc_value, using):
try: try:
@ -268,7 +263,6 @@ def commit_manually(using=None):
""" """
def entering(using): def entering(using):
enter_transaction_management(using=using) enter_transaction_management(using=using)
managed(True, using=using)
def exiting(exc_value, using): def exiting(exc_value, using):
leave_transaction_management(using=using) leave_transaction_management(using=using)

View File

@ -10,7 +10,6 @@ class TransactionMiddleware(object):
def process_request(self, request): def process_request(self, request):
"""Enters transaction management""" """Enters transaction management"""
transaction.enter_transaction_management() transaction.enter_transaction_management()
transaction.managed(True)
def process_exception(self, request, exception): def process_exception(self, request, exception):
"""Rolls back the database and leaves transaction management""" """Rolls back the database and leaves transaction management"""

View File

@ -67,7 +67,6 @@ real_commit = transaction.commit
real_rollback = transaction.rollback real_rollback = transaction.rollback
real_enter_transaction_management = transaction.enter_transaction_management real_enter_transaction_management = transaction.enter_transaction_management
real_leave_transaction_management = transaction.leave_transaction_management real_leave_transaction_management = transaction.leave_transaction_management
real_managed = transaction.managed
real_abort = transaction.abort real_abort = transaction.abort
def nop(*args, **kwargs): def nop(*args, **kwargs):
@ -78,7 +77,6 @@ def disable_transaction_methods():
transaction.rollback = nop transaction.rollback = nop
transaction.enter_transaction_management = nop transaction.enter_transaction_management = nop
transaction.leave_transaction_management = nop transaction.leave_transaction_management = nop
transaction.managed = nop
transaction.abort = nop transaction.abort = nop
def restore_transaction_methods(): def restore_transaction_methods():
@ -86,7 +84,6 @@ def restore_transaction_methods():
transaction.rollback = real_rollback transaction.rollback = real_rollback
transaction.enter_transaction_management = real_enter_transaction_management transaction.enter_transaction_management = real_enter_transaction_management
transaction.leave_transaction_management = real_leave_transaction_management transaction.leave_transaction_management = real_leave_transaction_management
transaction.managed = real_managed
transaction.abort = real_abort transaction.abort = real_abort
@ -833,7 +830,6 @@ class TestCase(TransactionTestCase):
for db_name in self._databases_names(): for db_name in self._databases_names():
transaction.enter_transaction_management(using=db_name) transaction.enter_transaction_management(using=db_name)
transaction.managed(True, using=db_name)
disable_transaction_methods() disable_transaction_methods()
from django.contrib.sites.models import Site from django.contrib.sites.models import Site

View File

@ -339,8 +339,6 @@ these changes.
* ``Model._meta.module_name`` was renamed to ``model_name``. * ``Model._meta.module_name`` was renamed to ``model_name``.
* The private API ``django.db.close_connection`` will be removed.
* Remove the backward compatible shims introduced to rename ``get_query_set`` * Remove the backward compatible shims introduced to rename ``get_query_set``
and similar queryset methods. This affects the following classes: and similar queryset methods. This affects the following classes:
``BaseModelAdmin``, ``ChangeList``, ``BaseCommentNode``, ``BaseModelAdmin``, ``ChangeList``, ``BaseCommentNode``,
@ -350,6 +348,10 @@ these changes.
* Remove the backward compatible shims introduced to rename the attributes * Remove the backward compatible shims introduced to rename the attributes
``ChangeList.root_query_set`` and ``ChangeList.query_set``. ``ChangeList.root_query_set`` and ``ChangeList.query_set``.
* The private API ``django.db.close_connection`` will be removed.
* The private API ``django.transaction.managed`` will be removed.
2.0 2.0
--- ---

View File

@ -22,9 +22,7 @@ class DeleteLockingTest(TransactionTestCase):
self.conn2 = new_connections[DEFAULT_DB_ALIAS] self.conn2 = new_connections[DEFAULT_DB_ALIAS]
# Put both DB connections into managed transaction mode # Put both DB connections into managed transaction mode
transaction.enter_transaction_management() transaction.enter_transaction_management()
transaction.managed(True)
self.conn2.enter_transaction_management() self.conn2.enter_transaction_management()
self.conn2.managed(True)
def tearDown(self): def tearDown(self):
# Close down the second connection. # Close down the second connection.
@ -335,7 +333,7 @@ class Ticket19102Tests(TestCase):
).select_related('orgunit').delete() ).select_related('orgunit').delete()
self.assertFalse(Login.objects.filter(pk=self.l1.pk).exists()) self.assertFalse(Login.objects.filter(pk=self.l1.pk).exists())
self.assertTrue(Login.objects.filter(pk=self.l2.pk).exists()) self.assertTrue(Login.objects.filter(pk=self.l2.pk).exists())
@skipUnlessDBFeature("update_can_self_select") @skipUnlessDBFeature("update_can_self_select")
def test_ticket_19102_defer(self): def test_ticket_19102_defer(self):
with self.assertNumQueries(1): with self.assertNumQueries(1):

View File

@ -692,7 +692,6 @@ class TransactionMiddlewareTest(TransactionTestCase):
def test_managed_response(self): def test_managed_response(self):
transaction.enter_transaction_management() transaction.enter_transaction_management()
transaction.managed(True)
Band.objects.create(name='The Beatles') Band.objects.create(name='The Beatles')
self.assertTrue(transaction.is_dirty()) self.assertTrue(transaction.is_dirty())
TransactionMiddleware().process_response(self.request, self.response) TransactionMiddleware().process_response(self.request, self.response)
@ -700,8 +699,7 @@ class TransactionMiddlewareTest(TransactionTestCase):
self.assertEqual(Band.objects.count(), 1) self.assertEqual(Band.objects.count(), 1)
def test_unmanaged_response(self): def test_unmanaged_response(self):
transaction.enter_transaction_management() transaction.enter_transaction_management(False)
transaction.managed(False)
self.assertEqual(Band.objects.count(), 0) self.assertEqual(Band.objects.count(), 0)
TransactionMiddleware().process_response(self.request, self.response) TransactionMiddleware().process_response(self.request, self.response)
self.assertFalse(transaction.is_managed()) self.assertFalse(transaction.is_managed())
@ -711,7 +709,6 @@ class TransactionMiddlewareTest(TransactionTestCase):
def test_exception(self): def test_exception(self):
transaction.enter_transaction_management() transaction.enter_transaction_management()
transaction.managed(True)
Band.objects.create(name='The Beatles') Band.objects.create(name='The Beatles')
self.assertTrue(transaction.is_dirty()) self.assertTrue(transaction.is_dirty())
TransactionMiddleware().process_exception(self.request, None) TransactionMiddleware().process_exception(self.request, None)
@ -726,7 +723,6 @@ class TransactionMiddlewareTest(TransactionTestCase):
raise IntegrityError() raise IntegrityError()
connections[DEFAULT_DB_ALIAS].commit = raise_exception connections[DEFAULT_DB_ALIAS].commit = raise_exception
transaction.enter_transaction_management() transaction.enter_transaction_management()
transaction.managed(True)
Band.objects.create(name='The Beatles') Band.objects.create(name='The Beatles')
self.assertTrue(transaction.is_dirty()) self.assertTrue(transaction.is_dirty())
with self.assertRaises(IntegrityError): with self.assertRaises(IntegrityError):

View File

@ -576,7 +576,6 @@ class DatabaseConnectionHandlingTests(TransactionTestCase):
# Make sure there is an open connection # Make sure there is an open connection
connection.cursor() connection.cursor()
connection.enter_transaction_management() connection.enter_transaction_management()
connection.managed(True)
signals.request_finished.send(sender=response._handler_class) signals.request_finished.send(sender=response._handler_class)
self.assertEqual(len(connection.transaction_state), 0) self.assertEqual(len(connection.transaction_state), 0)
@ -585,7 +584,6 @@ class DatabaseConnectionHandlingTests(TransactionTestCase):
connection.settings_dict['CONN_MAX_AGE'] = 0 connection.settings_dict['CONN_MAX_AGE'] = 0
connection.enter_transaction_management() connection.enter_transaction_management()
connection.managed(True)
connection.set_dirty() connection.set_dirty()
# Test that the rollback doesn't succeed (for example network failure # Test that the rollback doesn't succeed (for example network failure
# could cause this). # could cause this).

View File

@ -25,7 +25,6 @@ class SelectForUpdateTests(TransactionTestCase):
def setUp(self): def setUp(self):
transaction.enter_transaction_management() transaction.enter_transaction_management()
transaction.managed(True)
self.person = Person.objects.create(name='Reinhardt') self.person = Person.objects.create(name='Reinhardt')
# We have to commit here so that code in run_select_for_update can # We have to commit here so that code in run_select_for_update can
@ -37,7 +36,6 @@ class SelectForUpdateTests(TransactionTestCase):
new_connections = ConnectionHandler(settings.DATABASES) new_connections = ConnectionHandler(settings.DATABASES)
self.new_connection = new_connections[DEFAULT_DB_ALIAS] self.new_connection = new_connections[DEFAULT_DB_ALIAS]
self.new_connection.enter_transaction_management() self.new_connection.enter_transaction_management()
self.new_connection.managed(True)
# We need to set settings.DEBUG to True so we can capture # We need to set settings.DEBUG to True so we can capture
# the output SQL to examine. # the output SQL to examine.
@ -162,7 +160,6 @@ class SelectForUpdateTests(TransactionTestCase):
# We need to enter transaction management again, as this is done on # We need to enter transaction management again, as this is done on
# per-thread basis # per-thread basis
transaction.enter_transaction_management() transaction.enter_transaction_management()
transaction.managed(True)
people = list( people = list(
Person.objects.all().select_for_update(nowait=nowait) Person.objects.all().select_for_update(nowait=nowait)
) )

View File

@ -268,7 +268,6 @@ class SerializersTransactionTestBase(object):
# within a transaction in order to test forward reference # within a transaction in order to test forward reference
# handling. # handling.
transaction.enter_transaction_management() transaction.enter_transaction_management()
transaction.managed(True)
objs = serializers.deserialize(self.serializer_name, self.fwd_ref_str) objs = serializers.deserialize(self.serializer_name, self.fwd_ref_str)
with connection.constraint_checks_disabled(): with connection.constraint_checks_disabled():
for obj in objs: for obj in objs:

View File

@ -223,7 +223,6 @@ class TestNewConnection(TransactionTestCase):
def test_commit_unless_managed_in_managed(self): def test_commit_unless_managed_in_managed(self):
cursor = connection.cursor() cursor = connection.cursor()
connection.enter_transaction_management() connection.enter_transaction_management()
transaction.managed(True)
cursor.execute("INSERT into transactions_regress_mod (fld) values (2)") cursor.execute("INSERT into transactions_regress_mod (fld) values (2)")
connection.commit_unless_managed() connection.commit_unless_managed()
self.assertTrue(connection.is_dirty()) self.assertTrue(connection.is_dirty())
@ -280,7 +279,6 @@ class TestPostgresAutocommitAndIsolation(TransactionTestCase):
def test_transaction_management(self): def test_transaction_management(self):
transaction.enter_transaction_management() transaction.enter_transaction_management()
transaction.managed(True)
self.assertEqual(connection.isolation_level, self._serializable) self.assertEqual(connection.isolation_level, self._serializable)
transaction.leave_transaction_management() transaction.leave_transaction_management()
@ -288,7 +286,6 @@ class TestPostgresAutocommitAndIsolation(TransactionTestCase):
def test_transaction_stacking(self): def test_transaction_stacking(self):
transaction.enter_transaction_management() transaction.enter_transaction_management()
transaction.managed(True)
self.assertEqual(connection.isolation_level, self._serializable) self.assertEqual(connection.isolation_level, self._serializable)
transaction.enter_transaction_management() transaction.enter_transaction_management()
@ -302,13 +299,11 @@ class TestPostgresAutocommitAndIsolation(TransactionTestCase):
def test_enter_autocommit(self): def test_enter_autocommit(self):
transaction.enter_transaction_management() transaction.enter_transaction_management()
transaction.managed(True)
self.assertEqual(connection.isolation_level, self._serializable) self.assertEqual(connection.isolation_level, self._serializable)
list(Mod.objects.all()) list(Mod.objects.all())
self.assertTrue(transaction.is_dirty()) self.assertTrue(transaction.is_dirty())
# Enter autocommit mode again. # Enter autocommit mode again.
transaction.enter_transaction_management(False) transaction.enter_transaction_management(False)
transaction.managed(False)
self.assertFalse(transaction.is_dirty()) self.assertFalse(transaction.is_dirty())
self.assertEqual( self.assertEqual(
connection.connection.get_transaction_status(), connection.connection.get_transaction_status(),