django-bulk-hooks 0.1.281__tar.gz → 0.2.1__tar.gz

{django_bulk_hooks-0.1.281 → django_bulk_hooks-0.2.1}/PKG-INFO

@@ -1,8 +1,7 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: django-bulk-hooks
-Version: 0.1.281
+Version: 0.2.1
 Summary: Hook-style hooks for Django bulk operations like bulk_create and bulk_update.
-Home-page: https://github.com/AugendLimited/django-bulk-hooks
 License: MIT
 Keywords: django,bulk,hooks
 Author: Konrad Beck
@@ -14,6 +13,7 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Requires-Dist: django (>=5.2.0,<6.0.0)
+Project-URL: Homepage, https://github.com/AugendLimited/django-bulk-hooks
 Project-URL: Repository, https://github.com/AugendLimited/django-bulk-hooks
 Description-Content-Type: text/markdown
 
@@ -84,39 +84,39 @@ class AccountHooks(Hook):
 
 ### Individual Model Operations
 
-The `HookModelMixin` automatically triggers hooks for individual model operations:
+The `HookModelMixin` automatically hooks hooks for individual model operations:
 
 ```python
-# These will trigger BEFORE_CREATE and AFTER_CREATE hooks
+# These will hook BEFORE_CREATE and AFTER_CREATE hooks
 account = Account.objects.create(balance=100.00)
 account.save()  # for new instances
 
-# These will trigger BEFORE_UPDATE and AFTER_UPDATE hooks
+# These will hook BEFORE_UPDATE and AFTER_UPDATE hooks
 account.balance = 200.00
 account.save()  # for existing instances
 
-# This will trigger BEFORE_DELETE and AFTER_DELETE hooks
+# This will hook BEFORE_DELETE and AFTER_DELETE hooks
 account.delete()
 ```
 
 ### Bulk Operations
 
-Bulk operations also trigger the same hooks:
+Bulk operations also hook the same hooks:
 
 ```python
-# Bulk create - triggers BEFORE_CREATE and AFTER_CREATE hooks
+# Bulk create - hooks BEFORE_CREATE and AFTER_CREATE hooks
 accounts = [
     Account(balance=100.00),
     Account(balance=200.00),
 ]
 Account.objects.bulk_create(accounts)
 
-# Bulk update - triggers BEFORE_UPDATE and AFTER_UPDATE hooks
+# Bulk update - hooks BEFORE_UPDATE and AFTER_UPDATE hooks
 for account in accounts:
     account.balance *= 1.1
 Account.objects.bulk_update(accounts)  # fields are auto-detected
 
-# Bulk delete - triggers BEFORE_DELETE and AFTER_DELETE hooks
+# Bulk delete - hooks BEFORE_DELETE and AFTER_DELETE hooks
 Account.objects.bulk_delete(accounts)
 ```
 
@@ -125,10 +125,10 @@ Account.objects.bulk_delete(accounts)
 Queryset operations are also supported:
 
 ```python
-# Queryset update - triggers BEFORE_UPDATE and AFTER_UPDATE hooks
+# Queryset update - hooks BEFORE_UPDATE and AFTER_UPDATE hooks
 Account.objects.update(balance=0.00)
 
-# Queryset delete - triggers BEFORE_DELETE and AFTER_DELETE hooks
+# Queryset delete - hooks BEFORE_DELETE and AFTER_DELETE hooks
 Account.objects.delete()
 ```
 
@@ -180,7 +180,7 @@ Django's `bulk_` methods bypass signals and `save()`. This package fills that ga
 - **NEW**: Individual model lifecycle hooks that work with `save()` and `delete()`
 - Scalable performance via chunking (default 200)
 - Support for `@hook` decorators and centralized hook classes
-- **NEW**: Automatic hook triggering for admin operations and other Django features
+- **NEW**: Automatic hook hooking for admin operations and other Django features
 - **NEW**: Proper ordering guarantees for old/new record pairing in hooks (Salesforce-like behavior)
 
 ## 📦 Usage Examples
@@ -188,7 +188,7 @@ Django's `bulk_` methods bypass signals and `save()`. This package fills that ga
 ### Individual Model Operations
 
 ```python
-# These automatically trigger hooks
+# These automatically hook hooks
 account = Account.objects.create(balance=100.00)
 account.balance = 200.00
 account.save()
@@ -198,7 +198,7 @@ account.delete()
 ### Bulk Operations
 
 ```python
-# These also trigger hooks
+# These also hook hooks
 Account.objects.bulk_create(accounts)
 Account.objects.bulk_update(accounts)  # fields are auto-detected
 Account.objects.bulk_delete(accounts)
@@ -256,6 +256,13 @@ class MyManager(BulkHookManager, QueryablePropertiesManager):
 
 This approach uses the industry-standard injection pattern, similar to how `QueryablePropertiesManager` works, ensuring both functionalities work seamlessly together without any framework-specific knowledge.
 
+Framework needs to:
+Register these methods
+Know when to execute them (BEFORE_UPDATE, AFTER_UPDATE)
+Execute them in priority order
+Pass ChangeSet to them
+Handle errors (rollback on failure)
+
 ## 📝 License
 
 MIT © 2024 Augend / Konrad Beck

{django_bulk_hooks-0.1.281 → django_bulk_hooks-0.2.1}/README.md

@@ -65,39 +65,39 @@ class AccountHooks(Hook):
 
 ### Individual Model Operations
 
-The `HookModelMixin` automatically triggers hooks for individual model operations:
+The `HookModelMixin` automatically hooks hooks for individual model operations:
 
 ```python
-# These will trigger BEFORE_CREATE and AFTER_CREATE hooks
+# These will hook BEFORE_CREATE and AFTER_CREATE hooks
 account = Account.objects.create(balance=100.00)
 account.save()  # for new instances
 
-# These will trigger BEFORE_UPDATE and AFTER_UPDATE hooks
+# These will hook BEFORE_UPDATE and AFTER_UPDATE hooks
 account.balance = 200.00
 account.save()  # for existing instances
 
-# This will trigger BEFORE_DELETE and AFTER_DELETE hooks
+# This will hook BEFORE_DELETE and AFTER_DELETE hooks
 account.delete()
 ```
 
 ### Bulk Operations
 
-Bulk operations also trigger the same hooks:
+Bulk operations also hook the same hooks:
 
 ```python
-# Bulk create - triggers BEFORE_CREATE and AFTER_CREATE hooks
+# Bulk create - hooks BEFORE_CREATE and AFTER_CREATE hooks
 accounts = [
     Account(balance=100.00),
     Account(balance=200.00),
 ]
 Account.objects.bulk_create(accounts)
 
-# Bulk update - triggers BEFORE_UPDATE and AFTER_UPDATE hooks
+# Bulk update - hooks BEFORE_UPDATE and AFTER_UPDATE hooks
 for account in accounts:
     account.balance *= 1.1
 Account.objects.bulk_update(accounts)  # fields are auto-detected
 
-# Bulk delete - triggers BEFORE_DELETE and AFTER_DELETE hooks
+# Bulk delete - hooks BEFORE_DELETE and AFTER_DELETE hooks
 Account.objects.bulk_delete(accounts)
 ```
 
@@ -106,10 +106,10 @@ Account.objects.bulk_delete(accounts)
 Queryset operations are also supported:
 
 ```python
-# Queryset update - triggers BEFORE_UPDATE and AFTER_UPDATE hooks
+# Queryset update - hooks BEFORE_UPDATE and AFTER_UPDATE hooks
 Account.objects.update(balance=0.00)
 
-# Queryset delete - triggers BEFORE_DELETE and AFTER_DELETE hooks
+# Queryset delete - hooks BEFORE_DELETE and AFTER_DELETE hooks
 Account.objects.delete()
 ```
 
@@ -161,7 +161,7 @@ Django's `bulk_` methods bypass signals and `save()`. This package fills that ga
 - **NEW**: Individual model lifecycle hooks that work with `save()` and `delete()`
 - Scalable performance via chunking (default 200)
 - Support for `@hook` decorators and centralized hook classes
-- **NEW**: Automatic hook triggering for admin operations and other Django features
+- **NEW**: Automatic hook hooking for admin operations and other Django features
 - **NEW**: Proper ordering guarantees for old/new record pairing in hooks (Salesforce-like behavior)
 
 ## 📦 Usage Examples
@@ -169,7 +169,7 @@ Django's `bulk_` methods bypass signals and `save()`. This package fills that ga
 ### Individual Model Operations
 
 ```python
-# These automatically trigger hooks
+# These automatically hook hooks
 account = Account.objects.create(balance=100.00)
 account.balance = 200.00
 account.save()
@@ -179,7 +179,7 @@ account.delete()
 ### Bulk Operations
 
 ```python
-# These also trigger hooks
+# These also hook hooks
 Account.objects.bulk_create(accounts)
 Account.objects.bulk_update(accounts)  # fields are auto-detected
 Account.objects.bulk_delete(accounts)
@@ -237,6 +237,13 @@ class MyManager(BulkHookManager, QueryablePropertiesManager):
 
 This approach uses the industry-standard injection pattern, similar to how `QueryablePropertiesManager` works, ensuring both functionalities work seamlessly together without any framework-specific knowledge.
 
+Framework needs to:
+Register these methods
+Know when to execute them (BEFORE_UPDATE, AFTER_UPDATE)
+Execute them in priority order
+Pass ChangeSet to them
+Handle errors (rollback on failure)
+
 ## 📝 License
 
 MIT © 2024 Augend / Konrad Beck

django_bulk_hooks-0.2.1/django_bulk_hooks/__init__.py

@@ -0,0 +1,60 @@
+import logging
+
+from django_bulk_hooks.handler import Hook as HookClass
+from django_bulk_hooks.manager import BulkHookManager
+from django_bulk_hooks.factory import (
+    set_hook_factory,
+    set_default_hook_factory,
+    configure_hook_container,
+    configure_nested_container,
+    clear_hook_factories,
+    create_hook_instance,
+    is_container_configured,
+)
+from django_bulk_hooks.constants import DEFAULT_BULK_UPDATE_BATCH_SIZE
+from django_bulk_hooks.changeset import ChangeSet, RecordChange
+from django_bulk_hooks.dispatcher import get_dispatcher, HookDispatcher
+from django_bulk_hooks.helpers import (
+    build_changeset_for_create,
+    build_changeset_for_update,
+    build_changeset_for_delete,
+    dispatch_hooks_for_operation,
+)
+
+# Service layer (NEW architecture)
+from django_bulk_hooks.operations import (
+    BulkOperationCoordinator,
+    ModelAnalyzer,
+    BulkExecutor,
+    MTIHandler,
+)
+
+# Add NullHandler to prevent logging messages if the application doesn't configure logging
+logging.getLogger(__name__).addHandler(logging.NullHandler())
+
+__all__ = [
+    "BulkHookManager",
+    "HookClass",
+    "set_hook_factory",
+    "set_default_hook_factory",
+    "configure_hook_container",
+    "configure_nested_container",
+    "clear_hook_factories",
+    "create_hook_instance",
+    "is_container_configured",
+    "DEFAULT_BULK_UPDATE_BATCH_SIZE",
+    # Dispatcher-centric architecture
+    "ChangeSet",
+    "RecordChange",
+    "get_dispatcher",
+    "HookDispatcher",
+    "build_changeset_for_create",
+    "build_changeset_for_update",
+    "build_changeset_for_delete",
+    "dispatch_hooks_for_operation",
+    # Service layer (composition-based architecture)
+    "BulkOperationCoordinator",
+    "ModelAnalyzer",
+    "BulkExecutor",
+    "MTIHandler",
+]

django_bulk_hooks-0.2.1/django_bulk_hooks/changeset.py

@@ -0,0 +1,230 @@
+"""
+ChangeSet and RecordChange classes for Salesforce-style hook context.
+
+Provides a first-class abstraction for tracking changes in bulk operations,
+similar to Salesforce's Hook.new, Hook.old, and Hook.newMap.
+"""
+
+
+class RecordChange:
+    """
+    Represents a single record change with old/new state.
+
+    Similar to accessing Hook.newMap.get(id) in Salesforce, but with
+    additional conveniences like O(1) field change detection.
+    """
+
+    def __init__(self, new_record, old_record=None, changed_fields=None):
+        """
+        Initialize a RecordChange.
+
+        Args:
+            new_record: The new/current state of the record
+            old_record: The old/previous state of the record (None for creates)
+            changed_fields: Optional pre-computed set of changed field names.
+                          If None, will be computed lazily on first access.
+        """
+        self.new_record = new_record
+        self.old_record = old_record
+        self._changed_fields = changed_fields
+        self._pk = getattr(new_record, "pk", None) if new_record else None
+
+    @property
+    def pk(self):
+        """Primary key of the record."""
+        return self._pk
+
+    @property
+    def changed_fields(self):
+        """
+        Set of field names that have changed.
+
+        Computed lazily on first access and cached for O(1) subsequent checks.
+        """
+        if self._changed_fields is None:
+            self._changed_fields = self._compute_changed_fields()
+        return self._changed_fields
+
+    def has_changed(self, field_name):
+        """
+        O(1) check if a specific field has changed.
+
+        Args:
+            field_name: Name of the field to check
+
+        Returns:
+            True if the field value changed, False otherwise
+        """
+        return field_name in self.changed_fields
+
+    def get_old_value(self, field_name):
+        """
+        Get the old value for a field.
+
+        Args:
+            field_name: Name of the field
+
+        Returns:
+            The old value, or None if no old record exists
+        """
+        if self.old_record is None:
+            return None
+        return getattr(self.old_record, field_name, None)
+
+    def get_new_value(self, field_name):
+        """
+        Get the new value for a field.
+
+        Args:
+            field_name: Name of the field
+
+        Returns:
+            The new value
+        """
+        return getattr(self.new_record, field_name, None)
+
+    def _compute_changed_fields(self):
+        """
+        Compute which fields have changed between old and new records.
+
+        Uses Django's field.get_prep_value() for proper comparison that
+        handles database-level transformations.
+
+        Returns:
+            Set of field names that have changed
+        """
+        if self.old_record is None:
+            return set()
+
+        changed = set()
+        model_cls = self.new_record.__class__
+
+        for field in model_cls._meta.fields:
+            # Skip primary key - it shouldn't change
+            if field.primary_key:
+                continue
+
+            old_val = getattr(self.old_record, field.name, None)
+            new_val = getattr(self.new_record, field.name, None)
+
+            # Use field's get_prep_value for proper comparison
+            # This handles database-level transformations (e.g., timezone conversions)
+            try:
+                old_prep = field.get_prep_value(old_val)
+                new_prep = field.get_prep_value(new_val)
+                if old_prep != new_prep:
+                    changed.add(field.name)
+            except Exception:
+                # Fallback to direct comparison if get_prep_value fails
+                if old_val != new_val:
+                    changed.add(field.name)
+
+        return changed
+
+
+class ChangeSet:
+    """
+    Collection of RecordChanges for a bulk operation.
+
+    Similar to Salesforce's Hook context (Hook.new, Hook.old, Hook.newMap),
+    but enhanced for Python's bulk operations paradigm with O(1) lookups and
+    additional metadata.
+    """
+
+    def __init__(self, model_cls, changes, operation_type, operation_meta=None):
+        """
+        Initialize a ChangeSet.
+
+        Args:
+            model_cls: The Django model class
+            changes: List of RecordChange instances
+            operation_type: Type of operation ('create', 'update', 'delete')
+            operation_meta: Optional dict of additional metadata (e.g., update_kwargs)
+        """
+        self.model_cls = model_cls
+        self.changes = changes  # List[RecordChange]
+        self.operation_type = operation_type
+        self.operation_meta = operation_meta or {}
+
+        # Build PK -> RecordChange map for O(1) lookups (like Hook.newMap)
+        self._pk_to_change = {c.pk: c for c in changes if c.pk is not None}
+
+    @property
+    def new_records(self):
+        """
+        List of new/current record states.
+
+        Similar to Hook.new in Salesforce.
+        """
+        return [c.new_record for c in self.changes if c.new_record is not None]
+
+    @property
+    def old_records(self):
+        """
+        List of old/previous record states.
+
+        Similar to Hook.old in Salesforce.
+        Only includes records that have old states (excludes creates).
+        """
+        return [c.old_record for c in self.changes if c.old_record is not None]
+
+    def has_field_changed(self, pk, field_name):
+        """
+        O(1) check if a field changed for a specific record.
+
+        Args:
+            pk: Primary key of the record
+            field_name: Name of the field to check
+
+        Returns:
+            True if the field changed, False otherwise
+        """
+        change = self._pk_to_change.get(pk)
+        return change.has_changed(field_name) if change else False
+
+    def get_old_value(self, pk, field_name):
+        """
+        Get the old value for a specific record and field.
+
+        Args:
+            pk: Primary key of the record
+            field_name: Name of the field
+
+        Returns:
+            The old value, or None if not found
+        """
+        change = self._pk_to_change.get(pk)
+        return change.get_old_value(field_name) if change else None
+
+    def get_new_value(self, pk, field_name):
+        """
+        Get the new value for a specific record and field.
+
+        Args:
+            pk: Primary key of the record
+            field_name: Name of the field
+
+        Returns:
+            The new value, or None if not found
+        """
+        change = self._pk_to_change.get(pk)
+        return change.get_new_value(field_name) if change else None
+
+    def chunk(self, chunk_size):
+        """
+        Split ChangeSet into smaller chunks for memory-efficient processing.
+
+        Useful for processing very large bulk operations without loading
+        all data into memory at once.
+
+        Args:
+            chunk_size: Number of changes per chunk
+
+        Yields:
+            ChangeSet instances, each with up to chunk_size changes
+        """
+        for i in range(0, len(self.changes), chunk_size):
+            chunk_changes = self.changes[i : i + chunk_size]
+            yield ChangeSet(
+                self.model_cls, chunk_changes, self.operation_type, self.operation_meta
+            )

{django_bulk_hooks-0.1.281 → django_bulk_hooks-0.2.1}/django_bulk_hooks/conditions.py

@@ -6,12 +6,53 @@ logger = logging.getLogger(__name__)
 def resolve_dotted_attr(instance, dotted_path):
     """
     Recursively resolve a dotted attribute path, e.g., "type.category".
+
+    CRITICAL: For foreign key fields, uses attname to access the ID directly
+    to avoid hooking Django's descriptor protocol which causes N+1 queries.
     """
-    for attr in dotted_path.split("."):
-        if instance is None:
+    # For simple field access (no dots), use optimized field access
+    if "." not in dotted_path:
+        try:
+            # Get the field from the model's meta to check if it's a foreign key
+            field = instance._meta.get_field(dotted_path)
+            if field.is_relation and not field.many_to_many:
+                # For foreign key fields, use attname to get the ID directly
+                # This avoids hooking Django's descriptor protocol
+                return getattr(instance, field.attname, None)
+            else:
+                # For regular fields, use normal getattr
+                return getattr(instance, dotted_path, None)
+        except Exception:
+            # If field lookup fails, fall back to normal getattr
+            return getattr(instance, dotted_path, None)
+
+    # For dotted paths, traverse the relationship chain with FK optimization
+    current_instance = instance
+    for i, attr in enumerate(dotted_path.split(".")):
+        if current_instance is None:
             return None
-        instance = getattr(instance, attr, None)
-    return instance
+
+        try:
+            # Check if this is the last attribute and if it's a FK field
+            is_last_attr = i == len(dotted_path.split(".")) - 1
+            if is_last_attr and hasattr(current_instance, "_meta"):
+                try:
+                    field = current_instance._meta.get_field(attr)
+                    if field.is_relation and not field.many_to_many:
+                        # Use attname for the final FK field access
+                        current_instance = getattr(
+                            current_instance, field.attname, None
+                        )
+                        continue
+                except:
+                    pass  # Fall through to normal getattr
+
+            # Normal getattr for non-FK fields or when FK optimization fails
+            current_instance = getattr(current_instance, attr, None)
+        except Exception:
+            current_instance = None
+
+    return current_instance
 
 
 class HookCondition:
@@ -56,6 +97,7 @@ class IsEqual(HookCondition):
 
     def check(self, instance, original_instance=None):
         current = resolve_dotted_attr(instance, self.field)
+
         if self.only_on_change:
             if original_instance is None:
                 return False
@@ -73,15 +115,11 @@ class HasChanged(HookCondition):
     def check(self, instance, original_instance=None):
         if not original_instance:
             return False
-        
+
         current = resolve_dotted_attr(instance, self.field)
         previous = resolve_dotted_attr(original_instance, self.field)
-        
-        result = (current != previous) == self.has_changed
-        # Only log when there's an actual change to reduce noise
-        if result:
-            logger.debug(f"HasChanged {self.field} detected change on instance {getattr(instance, 'pk', 'No PK')}")
-        return result
+
+        return (current != previous) == self.has_changed
 
 
 class WasEqual(HookCondition):

{django_bulk_hooks-0.1.281 → django_bulk_hooks-0.2.1}/django_bulk_hooks/constants.py

@@ -7,3 +7,7 @@ AFTER_DELETE = "after_delete"
 VALIDATE_CREATE = "validate_create"
 VALIDATE_UPDATE = "validate_update"
 VALIDATE_DELETE = "validate_delete"
+
+# Default batch size for bulk_update operations to prevent massive SQL statements
+# This prevents PostgreSQL from crashing when updating large datasets with hooks
+DEFAULT_BULK_UPDATE_BATCH_SIZE = 1000

django_bulk_hooks-0.2.1/django_bulk_hooks/context.py

@@ -0,0 +1,56 @@
+"""
+Thread-local context management for bulk operations.
+
+This module provides thread-safe storage for operation state like
+bypass_hooks flags and bulk update metadata.
+"""
+
+import threading
+
+_hook_context = threading.local()
+
+
+def set_bypass_hooks(bypass_hooks):
+    """Set the current bypass_hooks state for the current thread."""
+    _hook_context.bypass_hooks = bypass_hooks
+
+
+def get_bypass_hooks():
+    """Get the current bypass_hooks state for the current thread."""
+    return getattr(_hook_context, "bypass_hooks", False)
+
+
+# Thread-local storage for passing per-object field values from bulk_update -> update
+def set_bulk_update_value_map(value_map):
+    """Store a mapping of {pk: {field_name: value}} for the current thread.
+
+    This allows the internal update() call (hooked by Django's bulk_update)
+    to populate in-memory instances with the concrete values that will be
+    written to the database, instead of Django expression objects like Case/Cast.
+    """
+    _hook_context.bulk_update_value_map = value_map
+
+
+def get_bulk_update_value_map():
+    """Retrieve the mapping {pk: {field_name: value}} for the current thread, if any."""
+    return getattr(_hook_context, "bulk_update_value_map", None)
+
+
+def set_bulk_update_active(active):
+    """Set whether we're currently in a bulk_update operation."""
+    _hook_context.bulk_update_active = active
+
+
+def get_bulk_update_active():
+    """Get whether we're currently in a bulk_update operation."""
+    return getattr(_hook_context, "bulk_update_active", False)
+
+
+def set_bulk_update_batch_size(batch_size):
+    """Store the batch_size for the current bulk_update operation."""
+    _hook_context.bulk_update_batch_size = batch_size
+
+
+def get_bulk_update_batch_size():
+    """Get the batch_size for the current bulk_update operation."""
+    return getattr(_hook_context, "bulk_update_batch_size", None)