django-bulk-hooks 0.2.8__tar.gz → 0.2.10__tar.gz

{django_bulk_hooks-0.2.8 → django_bulk_hooks-0.2.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: django-bulk-hooks
-Version: 0.2.8
+Version: 0.2.10
 Summary: Hook-style hooks for Django bulk operations like bulk_create and bulk_update.
 License: MIT
 Keywords: django,bulk,hooks

{django_bulk_hooks-0.2.8 → django_bulk_hooks-0.2.10}/django_bulk_hooks/decorators.py

@@ -1,4 +1,5 @@
 import inspect
+import logging
 from functools import wraps
 
 from django.core.exceptions import FieldDoesNotExist
@@ -6,6 +7,8 @@ from django.core.exceptions import FieldDoesNotExist
 from django_bulk_hooks.enums import DEFAULT_PRIORITY
 from django_bulk_hooks.registry import register_hook
 
+logger = logging.getLogger(__name__)
+
 
 def hook(event, *, model, condition=None, priority=DEFAULT_PRIORITY):
     """
@@ -35,7 +38,7 @@ def select_related(*related_fields):
     def decorator(func):
         sig = inspect.signature(func)
 
-        def preload_related(records, *, model_cls=None):
+        def preload_related(records, *, model_cls=None, skip_fields=None):
             if not isinstance(records, list):
                 raise TypeError(
                     f"@select_related expects a list of model instances, got {type(records)}"
@@ -47,6 +50,9 @@ def select_related(*related_fields):
             if model_cls is None:
                 model_cls = records[0].__class__
 
+            if skip_fields is None:
+                skip_fields = set()
+
             # Validate field notation upfront
             for field in related_fields:
                 if "." in field:
@@ -161,6 +167,10 @@ def select_related(*related_fields):
                         continue
 
                     for field in related_fields:
+                        # Skip preloading if this relationship conflicts with FK field being updated
+                        if field in skip_fields:
+                            continue
+
                         if fields_cache is not None and field in fields_cache:
                             continue
 
@@ -179,6 +189,10 @@ def select_related(*related_fields):
                     continue
 
                 for field_name, relation_field in direct_relation_fields.items():
+                    # Skip preloading if this relationship conflicts with FK field being updated
+                    if field_name in skip_fields:
+                        continue
+
                     if fields_cache is not None and field_name in fields_cache:
                         continue
 
@@ -198,6 +212,12 @@ def select_related(*related_fields):
                     if fields_cache is not None:
                         fields_cache[field_name] = rel_obj
 
+        def preload_with_skip_fields(records, *, model_cls=None, skip_fields=None):
+            """Wrapper that applies skip_fields logic to the preload function"""
+            if skip_fields is None:
+                skip_fields = set()
+            return preload_related(records, model_cls=model_cls, skip_fields=skip_fields)
+
         @wraps(func)
         def wrapper(*args, **kwargs):
             bound = sig.bind_partial(*args, **kwargs)
@@ -210,13 +230,27 @@ def select_related(*related_fields):
 
             new_records = bound.arguments["new_records"]
 
-            model_cls_override = bound.arguments.get("model_cls")
+            if not isinstance(new_records, list):
+                raise TypeError(
+                    f"@select_related expects a list of model instances, got {type(new_records)}"
+                )
+
+            if not new_records:
+                # Empty list, nothing to preload
+                return func(*args, **kwargs)
 
-            preload_related(new_records, model_cls=model_cls_override)
+            # Validate field notation upfront (same as in preload_related)
+            for field in related_fields:
+                if "." in field:
+                    raise ValueError(
+                        f"Invalid field notation '{field}'. Use Django ORM __ notation (e.g., 'parent__field')"
+                    )
 
-            return func(*bound.args, **bound.kwargs)
+            # Don't preload here - let the dispatcher handle it
+            # The dispatcher will call the preload function with skip_fields
+            return func(*args, **kwargs)
 
-        wrapper._select_related_preload = preload_related
+        wrapper._select_related_preload = preload_with_skip_fields
         wrapper._select_related_fields = related_fields
 
         return wrapper
@@ -241,8 +275,22 @@ def bulk_hook(model_cls, event, when=None, priority=None):
             def __init__(self):
                 self.func = func
 
-            def handle(self, new_records=None, old_records=None, **kwargs):
-                return self.func(new_records, old_records, **kwargs)
+            def handle(self, changeset=None, new_records=None, old_records=None, **kwargs):
+                # Support both old and new hook signatures for backward compatibility
+                # Old signature: def hook(self, new_records, old_records, **kwargs)
+                # New signature: def hook(self, changeset, new_records, old_records, **kwargs)
+
+                # Check function signature to determine which format to use
+                import inspect
+                sig = inspect.signature(func)
+                params = list(sig.parameters.keys())
+
+                if 'changeset' in params:
+                    # New signature with changeset
+                    return self.func(changeset, new_records, old_records, **kwargs)
+                else:
+                    # Old signature without changeset
+                    return self.func(new_records, old_records, **kwargs)
 
         # Register the hook using the registry
         register_hook(

{django_bulk_hooks-0.2.8 → django_bulk_hooks-0.2.10}/django_bulk_hooks/dispatcher.py

@@ -159,6 +159,9 @@ class HookDispatcher:
             try:
                 model_cls_override = getattr(handler, "model_cls", None)
 
+                # Get FK fields being updated to avoid preloading conflicting relationships
+                skip_fields = changeset.operation_meta.get('fk_fields_being_updated', set())
+
                 # Preload for new_records
                 if filtered_changeset.new_records:
                     logger.debug(
@@ -166,7 +169,9 @@ class HookDispatcher:
                         f"new_records for {handler_cls.__name__}.{method_name}"
                     )
                     preload_func(
-                        filtered_changeset.new_records, model_cls=model_cls_override
+                        filtered_changeset.new_records,
+                        model_cls=model_cls_override,
+                        skip_fields=skip_fields
                     )
 
                 # Also preload for old_records (for conditions that check previous values)
@@ -176,7 +181,9 @@ class HookDispatcher:
                         f"old_records for {handler_cls.__name__}.{method_name}"
                     )
                     preload_func(
-                        filtered_changeset.old_records, model_cls=model_cls_override
+                        filtered_changeset.old_records,
+                        model_cls=model_cls_override,
+                        skip_fields=skip_fields
                     )
             except Exception:
                 logger.debug(

{django_bulk_hooks-0.2.8 → django_bulk_hooks-0.2.10}/django_bulk_hooks/operations/coordinator.py

@@ -276,6 +276,9 @@ class BulkOperationCoordinator:
         # Fetch old records for comparison (single bulk query)
         old_records_map = self.analyzer.fetch_old_records_map(instances)
 
+        # Detect FK fields being updated to prevent @select_related conflicts
+        fk_fields_being_updated = self._get_fk_fields_being_updated(update_kwargs)
+
         # Build changeset for VALIDATE and BEFORE hooks
         # instances now have the "intended" values from update_kwargs
         changeset = build_changeset_for_update(
@@ -285,6 +288,10 @@ class BulkOperationCoordinator:
             old_records_map=old_records_map,
         )
 
+        # Add FK field info to changeset meta for dispatcher to use
+        if fk_fields_being_updated:
+            changeset.operation_meta['fk_fields_being_updated'] = fk_fields_being_updated
+
         # Execute VALIDATE and BEFORE hooks
         # Hooks can now modify the instances and changes will persist
         if not bypass_validation:
@@ -470,3 +477,35 @@ class BulkOperationCoordinator:
             self.dispatcher.dispatch(model_changeset, f"after_{event_prefix}", bypass_hooks=False)
 
         return result
+
+    def _get_fk_fields_being_updated(self, update_kwargs):
+        """
+        Get the relationship names for FK fields being updated.
+
+        This helps @select_related avoid preloading relationships that are
+        being modified, which can cause cache conflicts.
+
+        Args:
+            update_kwargs: Dict of fields being updated
+
+        Returns:
+            Set of relationship names (e.g., {'business'}) for FK fields being updated
+        """
+        fk_relationships = set()
+
+        for field_name in update_kwargs.keys():
+            try:
+                field = self.model_cls._meta.get_field(field_name)
+                if (field.is_relation and
+                    not field.many_to_many and
+                    not field.one_to_many and
+                    hasattr(field, 'attname') and
+                    field.attname == field_name):
+                    # This is a FK field being updated by its attname (e.g., business_id)
+                    # Add the relationship name (e.g., 'business') to skip list
+                    fk_relationships.add(field.name)
+            except Exception:
+                # If field lookup fails, skip it
+                continue
+
+        return fk_relationships

{django_bulk_hooks-0.2.8 → django_bulk_hooks-0.2.10}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "django-bulk-hooks"
-version = "0.2.8"
+version = "0.2.10"
 description = "Hook-style hooks for Django bulk operations like bulk_create and bulk_update."
 authors = ["Konrad Beck <konrad.beck@merchantcapital.co.za>"]
 readme = "README.md"