django-bulk-hooks 0.1.83__py3-none-any.whl → 0.2.100__py3-none-any.whl

django_bulk_hooks/__init__.py

@@ -1,50 +1,53 @@
-from django_bulk_hooks.constants import (
-    AFTER_CREATE,
-    AFTER_DELETE,
-    AFTER_UPDATE,
-    BEFORE_CREATE,
-    BEFORE_DELETE,
-    BEFORE_UPDATE,
-    VALIDATE_CREATE,
-    VALIDATE_DELETE,
-    VALIDATE_UPDATE,
-)
-from django_bulk_hooks.conditions import (
-    ChangesTo,
-    HasChanged,
-    IsEqual,
-    IsNotEqual,
-    WasEqual,
-    safe_get_related_object,
-    safe_get_related_attr,
-    is_field_set,
-)
-from django_bulk_hooks.decorators import hook, select_related
-from django_bulk_hooks.handler import HookHandler
-from django_bulk_hooks.models import HookModelMixin
-from django_bulk_hooks.enums import Priority
-
-__all__ = [
-    "HookHandler",
-    "HookModelMixin",
-    "BEFORE_CREATE",
-    "AFTER_CREATE",
-    "BEFORE_UPDATE",
-    "AFTER_UPDATE",
-    "BEFORE_DELETE",
-    "AFTER_DELETE",
-    "VALIDATE_CREATE",
-    "VALIDATE_UPDATE",
-    "VALIDATE_DELETE",
-    "safe_get_related_object",
-    "safe_get_related_attr",
-    "is_field_set",
-    "Priority",
-    "hook",
-    "select_related",
-    "ChangesTo",
-    "HasChanged",
-    "IsEqual",
-    "IsNotEqual",
-    "WasEqual",
-]
+import logging
+
+from django_bulk_hooks.changeset import ChangeSet
+from django_bulk_hooks.changeset import RecordChange
+from django_bulk_hooks.constants import DEFAULT_BULK_UPDATE_BATCH_SIZE
+from django_bulk_hooks.dispatcher import HookDispatcher
+from django_bulk_hooks.dispatcher import get_dispatcher
+from django_bulk_hooks.factory import clear_hook_factories
+from django_bulk_hooks.factory import configure_hook_container
+from django_bulk_hooks.factory import configure_nested_container
+from django_bulk_hooks.factory import create_hook_instance
+from django_bulk_hooks.factory import is_container_configured
+from django_bulk_hooks.factory import set_default_hook_factory
+from django_bulk_hooks.factory import set_hook_factory
+from django_bulk_hooks.handler import Hook as HookClass
+from django_bulk_hooks.helpers import build_changeset_for_create
+from django_bulk_hooks.helpers import build_changeset_for_delete
+from django_bulk_hooks.helpers import build_changeset_for_update
+from django_bulk_hooks.helpers import dispatch_hooks_for_operation
+from django_bulk_hooks.manager import BulkHookManager
+from django_bulk_hooks.operations import BulkExecutor
+
+# Service layer (NEW architecture)
+from django_bulk_hooks.operations import BulkOperationCoordinator
+from django_bulk_hooks.operations import ModelAnalyzer
+from django_bulk_hooks.operations import MTIHandler
+
+__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/changeset.py

@@ -0,0 +1,214 @@
+"""
+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()
+
+        # Import here to avoid circular dependency
+        from .operations.field_utils import get_changed_fields
+
+        model_cls = self.new_record.__class__
+        return get_changed_fields(self.old_record, self.new_record, model_cls)
+
+
+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,
+            )