Merge pull request #164 from ambitioninc/develop

Release v5.1.0

Author: thinkt4nk

Diff for: entity/sync.py

@@ -92,6 +92,25 @@ def defer_entity_syncing(wrapped, instance, args, kwargs):
         sync_entities.buffer = {}
 
 
+@wrapt.decorator
+def suppress_entity_syncing(wrapped, instance, args, kwargs):
+    """
+    A decorator that can be used to completely suppress syncing of entities as a result of
+    execution of the decorated method
+    """
+
+    # Suppress entity syncing for the scope of the decorated method
+    sync_entities.suppress = True
+
+    # Run the method
+    try:
+        return wrapped(*args, **kwargs)
+
+    # After we run the method return the entity sync state for future use
+    finally:
+        sync_entities.suppress = False
+
+
 def _get_super_entities_by_ctype(model_objs_by_ctype, model_ids_to_sync, sync_all):
     """
     Given model objects organized by content type and a dictionary of all model IDs that need
@@ -174,6 +193,9 @@ def sync_entities(*model_objs):
     Args:
         model_objs (List[Model]): The model objects to sync. If empty, all entities will be synced
     """
+    if sync_entities.suppress:
+        # Return false that we did not do anything
+        return False
 
     # Check if we are deferring processing
     if sync_entities.defer:
@@ -196,6 +218,8 @@ def sync_entities(*model_objs):
 # This is used by the defer_entity_syncing decorator
 sync_entities.defer = False
 sync_entities.buffer = {}
+# Add a suppress attribute to the sync entities method
+sync_entities.suppress = False
 
 
 def sync_entities_watching(instance):

Diff for: entity/tests/sync_tests.py

@@ -7,7 +7,10 @@
 from django_dynamic_fixture import G
 from entity.config import EntityRegistry
 from entity.models import Entity, EntityRelationship, EntityKind
-from entity.sync import sync_entities, defer_entity_syncing, transaction_atomic_with_retry, _get_super_entities_by_ctype
+from entity.sync import (
+    sync_entities, defer_entity_syncing, transaction_atomic_with_retry, _get_super_entities_by_ctype,
+    suppress_entity_syncing,
+)
 from entity.signal_handlers import turn_on_syncing, turn_off_syncing
 from mock import patch, MagicMock, call
 
@@ -1062,6 +1065,31 @@ def test_method(test):
             self.assertFalse(mock_sync_entities.called)
 
 
+class SuppressEntitySyncingTests(EntityTestCase):
+    """
+    Tests the suppress entity syncing decorator
+    """
+
+    def test_defer(self):
+        @suppress_entity_syncing
+        def test_method(test, count):
+            # Create some entities
+            for i in range(count):
+                Account.objects.create()
+
+            # Assert that we do not have any entities
+            test.assertEquals(Entity.objects.all().count(), 0)
+
+        # Call the test method
+        test_method(self, count=5)
+
+        # Assert that after the method was run we did sync the entities
+        self.assertEquals(Entity.objects.all().count(), 0)
+
+        # Assert that we restored the suppress flag
+        self.assertFalse(sync_entities.suppress)
+
+
 class TransactionAtomicWithRetryTests(EntityTestCase):
     """
     Test the transaction_atomic_with_retry decorator

Diff for: entity/version.py

@@ -1 +1 @@
-__version__ = '5.0.2'
+__version__ = '5.1.0'

Diff for: release_notes.md

@@ -1,5 +1,7 @@
 ## Release Notes
 
+- 5.1.0:
+    - Add decorator to suppress entity syncing
 - 5.0.2:
     - Only fetch new entities on a sync_all
 - 5.0.1: