django-bulk-hooks 0.1.78__tar.gz → 0.1.79__tar.gz

{django_bulk_hooks-0.1.78 → django_bulk_hooks-0.1.79}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: django-bulk-hooks
-Version: 0.1.78
+Version: 0.1.79
 Summary: Hook-style hooks for Django bulk operations like bulk_create and bulk_update.
 License: MIT
 Keywords: django,bulk,hooks
@@ -58,7 +58,7 @@ from django_bulk_hooks import hook, AFTER_UPDATE, Hook
 from django_bulk_hooks.conditions import WhenFieldHasChanged
 from .models import Account
 
-class AccountHooks(Hook):
+class AccountHooks(HookHandler):
     @hook(AFTER_UPDATE, model=Account, condition=WhenFieldHasChanged("balance"))
     def log_balance_change(self, new_records, old_records):
         print("Accounts updated:", [a.pk for a in new_records])
@@ -74,99 +74,10 @@ class AccountHooks(Hook):
         print("Accounts deleted:", [a.pk for a in old_records])
 ```
 
-## 🛠 Supported Hook Events
-
-- `BEFORE_CREATE`, `AFTER_CREATE`
-- `BEFORE_UPDATE`, `AFTER_UPDATE`
-- `BEFORE_DELETE`, `AFTER_DELETE`
-
-## 🔄 Lifecycle Events
-
-### Individual Model Operations
-
-The `HookModelMixin` automatically triggers hooks for individual model operations:
-
-```python
-# These will trigger 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
-account.balance = 200.00
-account.save()  # for existing instances
-
-# This will trigger BEFORE_DELETE and AFTER_DELETE hooks
-account.delete()
-```
-
-### Bulk Operations
-
-Bulk operations also trigger the same hooks:
-
-```python
-# Bulk create - triggers 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
-for account in accounts:
-    account.balance *= 1.1
-Account.objects.bulk_update(accounts, ['balance'])
-
-# Bulk delete - triggers BEFORE_DELETE and AFTER_DELETE hooks
-Account.objects.bulk_delete(accounts)
-```
-
-### Queryset Operations
-
-Queryset operations are also supported:
-
-```python
-# Queryset update - triggers BEFORE_UPDATE and AFTER_UPDATE hooks
-Account.objects.update(balance=0.00)
-
-# Queryset delete - triggers BEFORE_DELETE and AFTER_DELETE hooks
-Account.objects.delete()
-```
-
-## 🧠 Why?
-
-Django's `bulk_` methods bypass signals and `save()`. This package fills that gap with:
-
-- Hooks that behave consistently across creates/updates/deletes
-- **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
-
-## 📦 Usage Examples
-
-### Individual Model Operations
-
-```python
-# These automatically trigger hooks
-account = Account.objects.create(balance=100.00)
-account.balance = 200.00
-account.save()
-account.delete()
-```
-
-### Bulk Operations
-
-```python
-# These also trigger hooks
-Account.objects.bulk_create(accounts)
-Account.objects.bulk_update(accounts, ['balance'])
-Account.objects.bulk_delete(accounts)
-```
-
 ### Advanced Hook Usage
 
 ```python
-class AdvancedAccountHooks(Hook):
+class AdvancedAccountHooks(HookHandler):
     @hook(BEFORE_UPDATE, model=Account, condition=WhenFieldHasChanged("balance"))
     def validate_balance_change(self, new_records, old_records):
         for new_account, old_account in zip(new_records, old_records):
@@ -179,17 +90,3 @@ class AdvancedAccountHooks(Hook):
             # Send welcome email logic here
             pass
 ```
-
-## 🧩 Integration with Queryable Properties
-
-You can extend from `BulkHookManager` to support formula fields or property querying.
-
-```python
-class MyManager(BulkHookManager, QueryablePropertiesManager):
-    pass
-```
-
-## 📝 License
-
-MIT © 2024 Augend / Konrad Beck
-

django_bulk_hooks-0.1.79/README.md

@@ -0,0 +1,73 @@
+
+# django-bulk-hooks
+
+⚡ Bulk hooks for Django bulk operations and individual model lifecycle events.
+
+`django-bulk-hooks` brings a declarative, hook-like experience to Django's `bulk_create`, `bulk_update`, and `bulk_delete` — including support for `BEFORE_` and `AFTER_` hooks, conditions, batching, and transactional safety. It also provides comprehensive lifecycle hooks for individual model operations.
+
+## ✨ Features
+
+- Declarative hook system: `@hook(AFTER_UPDATE, condition=...)`
+- BEFORE/AFTER hooks for create, update, delete
+- Hook-aware manager that wraps Django's `bulk_` operations
+- **NEW**: `HookModelMixin` for individual model lifecycle events
+- Hook chaining, hook deduplication, and atomicity
+- Class-based hook handlers with DI support
+- Support for both bulk and individual model operations
+
+## 🚀 Quickstart
+
+```bash
+pip install django-bulk-hooks
+```
+
+### Define Your Model
+
+```python
+from django.db import models
+from django_bulk_hooks.models import HookModelMixin
+
+class Account(HookModelMixin):
+    balance = models.DecimalField(max_digits=10, decimal_places=2)
+    # The HookModelMixin automatically provides BulkHookManager
+```
+
+### Create a Hook Handler
+
+```python
+from django_bulk_hooks import hook, AFTER_UPDATE, Hook
+from django_bulk_hooks.conditions import WhenFieldHasChanged
+from .models import Account
+
+class AccountHooks(HookHandler):
+    @hook(AFTER_UPDATE, model=Account, condition=WhenFieldHasChanged("balance"))
+    def log_balance_change(self, new_records, old_records):
+        print("Accounts updated:", [a.pk for a in new_records])
+    
+    @hook(BEFORE_CREATE, model=Account)
+    def before_create(self, new_records, old_records):
+        for account in new_records:
+            if account.balance < 0:
+                raise ValueError("Account cannot have negative balance")
+    
+    @hook(AFTER_DELETE, model=Account)
+    def after_delete(self, new_records, old_records):
+        print("Accounts deleted:", [a.pk for a in old_records])
+```
+
+### Advanced Hook Usage
+
+```python
+class AdvancedAccountHooks(HookHandler):
+    @hook(BEFORE_UPDATE, model=Account, condition=WhenFieldHasChanged("balance"))
+    def validate_balance_change(self, new_records, old_records):
+        for new_account, old_account in zip(new_records, old_records):
+            if new_account.balance < 0 and old_account.balance >= 0:
+                raise ValueError("Cannot set negative balance")
+    
+    @hook(AFTER_CREATE, model=Account)
+    def send_welcome_email(self, new_records, old_records):
+        for account in new_records:
+            # Send welcome email logic here
+            pass
+```

{django_bulk_hooks-0.1.78 → django_bulk_hooks-0.1.79}/django_bulk_hooks/__init__.py

@@ -12,6 +12,7 @@ from django_bulk_hooks.constants import (
 from django_bulk_hooks.engine import safe_get_related_object, safe_get_related_attr
 from django_bulk_hooks.handler import HookHandler
 from django_bulk_hooks.models import HookModelMixin
+from django_bulk_hooks.enums import Priority
 
 __all__ = [
     "HookHandler",
@@ -27,4 +28,5 @@ __all__ = [
     "VALIDATE_DELETE",
     "safe_get_related_object",
     "safe_get_related_attr",
+    "Priority",
 ]

{django_bulk_hooks-0.1.78 → django_bulk_hooks-0.1.79}/django_bulk_hooks/conditions.py

@@ -1,4 +1,32 @@
-from django_bulk_hooks.engine import safe_get_related_object
+from django.db import models
+
+
+def safe_get_related_object(instance, field_name):
+    """
+    Safely get a related object without raising RelatedObjectDoesNotExist.
+    Returns None if the foreign key field is None or the related object doesn't exist.
+    """
+    if not hasattr(instance, field_name):
+        return None
+    
+    # Get the foreign key field
+    try:
+        field = instance._meta.get_field(field_name)
+        if not field.is_relation or field.many_to_many or field.one_to_many:
+            return getattr(instance, field_name, None)
+    except models.FieldDoesNotExist:
+        return getattr(instance, field_name, None)
+    
+    # Check if the foreign key field is None
+    fk_field_name = f"{field_name}_id"
+    if hasattr(instance, fk_field_name) and getattr(instance, fk_field_name) is None:
+        return None
+    
+    # Try to get the related object, but catch RelatedObjectDoesNotExist
+    try:
+        return getattr(instance, field_name)
+    except field.related_model.RelatedObjectDoesNotExist:
+        return None
 
 
 def resolve_dotted_attr(instance, dotted_path):

{django_bulk_hooks-0.1.78 → django_bulk_hooks-0.1.79}/django_bulk_hooks/engine.py

@@ -3,38 +3,11 @@ import logging
 from django.core.exceptions import ValidationError
 from django.db import models
 from django_bulk_hooks.registry import get_hooks
+from django_bulk_hooks.conditions import safe_get_related_object
 
 logger = logging.getLogger(__name__)
 
 
-def safe_get_related_object(instance, field_name):
-    """
-    Safely get a related object without raising RelatedObjectDoesNotExist.
-    Returns None if the foreign key field is None or the related object doesn't exist.
-    """
-    if not hasattr(instance, field_name):
-        return None
-    
-    # Get the foreign key field
-    try:
-        field = instance._meta.get_field(field_name)
-        if not field.is_relation or field.many_to_many or field.one_to_many:
-            return getattr(instance, field_name, None)
-    except models.FieldDoesNotExist:
-        return getattr(instance, field_name, None)
-    
-    # Check if the foreign key field is None
-    fk_field_name = f"{field_name}_id"
-    if hasattr(instance, fk_field_name) and getattr(instance, fk_field_name) is None:
-        return None
-    
-    # Try to get the related object, but catch RelatedObjectDoesNotExist
-    try:
-        return getattr(instance, field_name)
-    except field.related_model.RelatedObjectDoesNotExist:
-        return None
-
-
 def safe_get_related_attr(instance, field_name, attr_name=None):
     """
     Safely get a related object or its attribute without raising RelatedObjectDoesNotExist.

{django_bulk_hooks-0.1.78 → django_bulk_hooks-0.1.79}/django_bulk_hooks/handler.py

@@ -86,7 +86,7 @@ class HookMeta(type):
         return cls
 
 
-class Hook(metaclass=HookMeta):
+class HookHandler(metaclass=HookMeta):
     @classmethod
     def handle(
         cls,

{django_bulk_hooks-0.1.78 → django_bulk_hooks-0.1.79}/django_bulk_hooks/registry.py

@@ -1,7 +1,7 @@
 from collections.abc import Callable
 from typing import Union
 
-from django_bulk_hooks.priority import Priority
+from django_bulk_hooks.enums import Priority
 
 _hooks: dict[tuple[type, str], list[tuple[type, str, Callable, int]]] = {}
 
@@ -17,8 +17,7 @@ def register_hook(
 
 
 def get_hooks(model, event):
-    hooks = _hooks.get((model, event), [])
-    return hooks
+    return _hooks.get((model, event), [])
 
 
 def list_all_hooks():

{django_bulk_hooks-0.1.78 → django_bulk_hooks-0.1.79}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "django-bulk-hooks"
-version = "0.1.78"
+version = "0.1.79"
 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"

django_bulk_hooks-0.1.78/README.md

@@ -1,175 +0,0 @@
-
-# django-bulk-hooks
-
-⚡ Bulk hooks for Django bulk operations and individual model lifecycle events.
-
-`django-bulk-hooks` brings a declarative, hook-like experience to Django's `bulk_create`, `bulk_update`, and `bulk_delete` — including support for `BEFORE_` and `AFTER_` hooks, conditions, batching, and transactional safety. It also provides comprehensive lifecycle hooks for individual model operations.
-
-## ✨ Features
-
-- Declarative hook system: `@hook(AFTER_UPDATE, condition=...)`
-- BEFORE/AFTER hooks for create, update, delete
-- Hook-aware manager that wraps Django's `bulk_` operations
-- **NEW**: `HookModelMixin` for individual model lifecycle events
-- Hook chaining, hook deduplication, and atomicity
-- Class-based hook handlers with DI support
-- Support for both bulk and individual model operations
-
-## 🚀 Quickstart
-
-```bash
-pip install django-bulk-hooks
-```
-
-### Define Your Model
-
-```python
-from django.db import models
-from django_bulk_hooks.models import HookModelMixin
-
-class Account(HookModelMixin):
-    balance = models.DecimalField(max_digits=10, decimal_places=2)
-    # The HookModelMixin automatically provides BulkHookManager
-```
-
-### Create a Hook Handler
-
-```python
-from django_bulk_hooks import hook, AFTER_UPDATE, Hook
-from django_bulk_hooks.conditions import WhenFieldHasChanged
-from .models import Account
-
-class AccountHooks(Hook):
-    @hook(AFTER_UPDATE, model=Account, condition=WhenFieldHasChanged("balance"))
-    def log_balance_change(self, new_records, old_records):
-        print("Accounts updated:", [a.pk for a in new_records])
-    
-    @hook(BEFORE_CREATE, model=Account)
-    def before_create(self, new_records, old_records):
-        for account in new_records:
-            if account.balance < 0:
-                raise ValueError("Account cannot have negative balance")
-    
-    @hook(AFTER_DELETE, model=Account)
-    def after_delete(self, new_records, old_records):
-        print("Accounts deleted:", [a.pk for a in old_records])
-```
-
-## 🛠 Supported Hook Events
-
-- `BEFORE_CREATE`, `AFTER_CREATE`
-- `BEFORE_UPDATE`, `AFTER_UPDATE`
-- `BEFORE_DELETE`, `AFTER_DELETE`
-
-## 🔄 Lifecycle Events
-
-### Individual Model Operations
-
-The `HookModelMixin` automatically triggers hooks for individual model operations:
-
-```python
-# These will trigger 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
-account.balance = 200.00
-account.save()  # for existing instances
-
-# This will trigger BEFORE_DELETE and AFTER_DELETE hooks
-account.delete()
-```
-
-### Bulk Operations
-
-Bulk operations also trigger the same hooks:
-
-```python
-# Bulk create - triggers 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
-for account in accounts:
-    account.balance *= 1.1
-Account.objects.bulk_update(accounts, ['balance'])
-
-# Bulk delete - triggers BEFORE_DELETE and AFTER_DELETE hooks
-Account.objects.bulk_delete(accounts)
-```
-
-### Queryset Operations
-
-Queryset operations are also supported:
-
-```python
-# Queryset update - triggers BEFORE_UPDATE and AFTER_UPDATE hooks
-Account.objects.update(balance=0.00)
-
-# Queryset delete - triggers BEFORE_DELETE and AFTER_DELETE hooks
-Account.objects.delete()
-```
-
-## 🧠 Why?
-
-Django's `bulk_` methods bypass signals and `save()`. This package fills that gap with:
-
-- Hooks that behave consistently across creates/updates/deletes
-- **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
-
-## 📦 Usage Examples
-
-### Individual Model Operations
-
-```python
-# These automatically trigger hooks
-account = Account.objects.create(balance=100.00)
-account.balance = 200.00
-account.save()
-account.delete()
-```
-
-### Bulk Operations
-
-```python
-# These also trigger hooks
-Account.objects.bulk_create(accounts)
-Account.objects.bulk_update(accounts, ['balance'])
-Account.objects.bulk_delete(accounts)
-```
-
-### Advanced Hook Usage
-
-```python
-class AdvancedAccountHooks(Hook):
-    @hook(BEFORE_UPDATE, model=Account, condition=WhenFieldHasChanged("balance"))
-    def validate_balance_change(self, new_records, old_records):
-        for new_account, old_account in zip(new_records, old_records):
-            if new_account.balance < 0 and old_account.balance >= 0:
-                raise ValueError("Cannot set negative balance")
-    
-    @hook(AFTER_CREATE, model=Account)
-    def send_welcome_email(self, new_records, old_records):
-        for account in new_records:
-            # Send welcome email logic here
-            pass
-```
-
-## 🧩 Integration with Queryable Properties
-
-You can extend from `BulkHookManager` to support formula fields or property querying.
-
-```python
-class MyManager(BulkHookManager, QueryablePropertiesManager):
-    pass
-```
-
-## 📝 License
-
-MIT © 2024 Augend / Konrad Beck

django_bulk_hooks-0.1.78/django_bulk_hooks/priority.py

@@ -1,16 +0,0 @@
-from enum import IntEnum
-
-
-class Priority(IntEnum):
-    """
-    Named priorities for django-bulk-hooks hooks.
-
-    Lower values run earlier (higher priority).
-    Hooks are sorted in ascending order.
-    """
-
-    HIGHEST = 0  # runs first
-    HIGH = 25  # runs early
-    NORMAL = 50  # default ordering
-    LOW = 75  # runs later
-    LOWEST = 100  # runs last