django-bulk-hooks 0.1.53__tar.gz → 0.1.55__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of django-bulk-hooks might be problematic. Click here for more details.

Files changed (19) hide show
  1. {django_bulk_hooks-0.1.53 → django_bulk_hooks-0.1.55}/PKG-INFO +1 -1
  2. django_bulk_hooks-0.1.55/django_bulk_hooks/context.py +16 -0
  3. django_bulk_hooks-0.1.55/django_bulk_hooks/handler.py +157 -0
  4. {django_bulk_hooks-0.1.53 → django_bulk_hooks-0.1.55}/django_bulk_hooks/queryset.py +0 -1
  5. {django_bulk_hooks-0.1.53 → django_bulk_hooks-0.1.55}/pyproject.toml +1 -1
  6. django_bulk_hooks-0.1.53/django_bulk_hooks/context.py +0 -4
  7. django_bulk_hooks-0.1.53/django_bulk_hooks/handler.py +0 -208
  8. {django_bulk_hooks-0.1.53 → django_bulk_hooks-0.1.55}/LICENSE +0 -0
  9. {django_bulk_hooks-0.1.53 → django_bulk_hooks-0.1.55}/README.md +0 -0
  10. {django_bulk_hooks-0.1.53 → django_bulk_hooks-0.1.55}/django_bulk_hooks/__init__.py +0 -0
  11. {django_bulk_hooks-0.1.53 → django_bulk_hooks-0.1.55}/django_bulk_hooks/conditions.py +0 -0
  12. {django_bulk_hooks-0.1.53 → django_bulk_hooks-0.1.55}/django_bulk_hooks/constants.py +0 -0
  13. {django_bulk_hooks-0.1.53 → django_bulk_hooks-0.1.55}/django_bulk_hooks/decorators.py +0 -0
  14. {django_bulk_hooks-0.1.53 → django_bulk_hooks-0.1.55}/django_bulk_hooks/engine.py +0 -0
  15. {django_bulk_hooks-0.1.53 → django_bulk_hooks-0.1.55}/django_bulk_hooks/enums.py +0 -0
  16. {django_bulk_hooks-0.1.53 → django_bulk_hooks-0.1.55}/django_bulk_hooks/manager.py +0 -0
  17. {django_bulk_hooks-0.1.53 → django_bulk_hooks-0.1.55}/django_bulk_hooks/models.py +0 -0
  18. {django_bulk_hooks-0.1.53 → django_bulk_hooks-0.1.55}/django_bulk_hooks/priority.py +0 -0
  19. {django_bulk_hooks-0.1.53 → django_bulk_hooks-0.1.55}/django_bulk_hooks/registry.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: django-bulk-hooks
3
- Version: 0.1.53
3
+ Version: 0.1.55
4
4
  Summary: Lifecycle-style hooks for Django bulk operations like bulk_create and bulk_update.
5
5
  Home-page: https://github.com/AugendLimited/django-bulk-hooks
6
6
  License: MIT
@@ -0,0 +1,16 @@
1
+ import threading
2
+ from collections import deque
3
+
4
+ _hook_context = threading.local()
5
+
6
+
7
+ def get_hook_queue():
8
+ if not hasattr(_hook_context, "queue"):
9
+ _hook_context.queue = deque()
10
+ return _hook_context.queue
11
+
12
+
13
+ class TriggerContext:
14
+ def __init__(self, model_cls, metadata=None):
15
+ self.model_cls = model_cls
16
+ self.metadata = metadata or {}
@@ -0,0 +1,157 @@
1
+ import logging
2
+ import threading
3
+ from collections import deque
4
+
5
+ from django.db import transaction
6
+ from django_bulk_hooks.registry import get_hooks, register_hook
7
+
8
+ logger = logging.getLogger(__name__)
9
+
10
+ # Thread-local hook context and trigger state
11
+ class TriggerVars(threading.local):
12
+ def __init__(self):
13
+ self.new = None
14
+ self.old = None
15
+ self.event = None
16
+ self.model = None
17
+ self.depth = 0
18
+
19
+ trigger = TriggerVars()
20
+
21
+ # Hook queue per thread
22
+ _hook_context = threading.local()
23
+
24
+ def get_hook_queue():
25
+ if not hasattr(_hook_context, "queue"):
26
+ _hook_context.queue = deque()
27
+ return _hook_context.queue
28
+
29
+ class TriggerContextState:
30
+ @property
31
+ def is_before(self):
32
+ return trigger.event.startswith("before_") if trigger.event else False
33
+
34
+ @property
35
+ def is_after(self):
36
+ return trigger.event.startswith("after_") if trigger.event else False
37
+
38
+ @property
39
+ def is_create(self):
40
+ return "create" in trigger.event if trigger.event else False
41
+
42
+ @property
43
+ def is_update(self):
44
+ return "update" in trigger.event if trigger.event else False
45
+
46
+ @property
47
+ def new(self):
48
+ return trigger.new
49
+
50
+ @property
51
+ def old(self):
52
+ return trigger.old
53
+
54
+ @property
55
+ def model(self):
56
+ return trigger.model
57
+
58
+ Trigger = TriggerContextState()
59
+
60
+ class TriggerHandlerMeta(type):
61
+ _registered = set()
62
+
63
+ def __new__(mcs, name, bases, namespace):
64
+ cls = super().__new__(mcs, name, bases, namespace)
65
+ for method_name, method in namespace.items():
66
+ if hasattr(method, "hooks_hooks"):
67
+ for model_cls, event, condition, priority in method.hooks_hooks:
68
+ key = (model_cls, event, cls, method_name)
69
+ if key not in TriggerHandlerMeta._registered:
70
+ register_hook(
71
+ model=model_cls,
72
+ event=event,
73
+ handler_cls=cls,
74
+ method_name=method_name,
75
+ condition=condition,
76
+ priority=priority,
77
+ )
78
+ TriggerHandlerMeta._registered.add(key)
79
+ return cls
80
+
81
+ class TriggerHandler(metaclass=TriggerHandlerMeta):
82
+ @classmethod
83
+ def handle(
84
+ cls,
85
+ event: str,
86
+ model: type,
87
+ *,
88
+ new_records: list = None,
89
+ old_records: list = None,
90
+ **kwargs,
91
+ ) -> None:
92
+ queue = get_hook_queue()
93
+ queue.append((cls, event, model, new_records, old_records, kwargs))
94
+
95
+ if len(queue) > 1:
96
+ return # nested call, will be processed by outermost
97
+
98
+ # only outermost handle will process the queue
99
+ while queue:
100
+ cls_, event_, model_, new_, old_, kw_ = queue.popleft()
101
+ cls_._process(event_, model_, new_, old_, **kw_)
102
+
103
+ @classmethod
104
+ def _process(
105
+ cls,
106
+ event,
107
+ model,
108
+ new_records,
109
+ old_records,
110
+ **kwargs,
111
+ ):
112
+ trigger.depth += 1
113
+ trigger.new = new_records
114
+ trigger.old = old_records
115
+ trigger.event = event
116
+ trigger.model = model
117
+
118
+ hooks = sorted(get_hooks(model, event), key=lambda x: x[3])
119
+ logger.debug("Processing %d hooks for %s.%s", len(hooks), model.__name__, event)
120
+
121
+ def _execute():
122
+ new_local = new_records or []
123
+ old_local = old_records or []
124
+ if len(old_local) < len(new_local):
125
+ old_local += [None] * (len(new_local) - len(old_local))
126
+
127
+ for handler_cls, method_name, condition, priority in hooks:
128
+ if condition is not None:
129
+ checks = [condition.check(n, o) for n, o in zip(new_local, old_local)]
130
+ if not any(checks):
131
+ continue
132
+
133
+ handler = handler_cls()
134
+ method = getattr(handler, method_name)
135
+
136
+ logger.info("Running hook %s.%s on %d items", handler_cls.__name__, method_name, len(new_local))
137
+ try:
138
+ method(
139
+ new_records=new_local,
140
+ old_records=old_local,
141
+ **kwargs,
142
+ )
143
+ except Exception:
144
+ logger.exception("Error in hook %s.%s", handler_cls.__name__, method_name)
145
+
146
+ conn = transaction.get_connection()
147
+ try:
148
+ if conn.in_atomic_block and event.startswith("after_"):
149
+ transaction.on_commit(_execute)
150
+ else:
151
+ _execute()
152
+ finally:
153
+ trigger.new = None
154
+ trigger.old = None
155
+ trigger.event = None
156
+ trigger.model = None
157
+ trigger.depth -= 1
@@ -1,5 +1,4 @@
1
1
  from django.db import models, transaction
2
- from django.db.models.manager import BaseManager
3
2
 
4
3
 
5
4
  class LifecycleQuerySet(models.QuerySet):
@@ -1,6 +1,6 @@
1
1
  [tool.poetry]
2
2
  name = "django-bulk-hooks"
3
- version = "0.1.53"
3
+ version = "0.1.55"
4
4
  description = "Lifecycle-style hooks for Django bulk operations like bulk_create and bulk_update."
5
5
  authors = ["Konrad Beck <konrad.beck@merchantcapital.co.za>"]
6
6
  readme = "README.md"
@@ -1,4 +0,0 @@
1
- class TriggerContext:
2
- def __init__(self, model_cls, metadata=None):
3
- self.model_cls = model_cls
4
- self.metadata = metadata or {}
@@ -1,208 +0,0 @@
1
- import logging
2
-
3
- from django.db import transaction
4
- from django_bulk_hooks.conditions import HookCondition
5
- from django_bulk_hooks.registry import get_hooks, register_hook
6
-
7
- logger = logging.getLogger(__name__)
8
-
9
-
10
- class TriggerHandlerMeta(type):
11
- _registered = set()
12
-
13
- def __new__(mcs, name, bases, namespace):
14
- cls = super().__new__(mcs, name, bases, namespace)
15
- for method_name, method in namespace.items():
16
- if hasattr(method, "hooks_hooks"):
17
- for model_cls, event, condition, priority in method.hooks_hooks:
18
- key = (model_cls, event, cls, method_name)
19
- if key in TriggerHandlerMeta._registered:
20
- logger.debug(
21
- "Skipping duplicate registration for %s.%s on %s.%s",
22
- cls.__name__,
23
- method_name,
24
- model_cls.__name__,
25
- event,
26
- )
27
- else:
28
- register_hook(
29
- model=model_cls,
30
- event=event,
31
- handler_cls=cls,
32
- method_name=method_name,
33
- condition=condition,
34
- priority=priority,
35
- )
36
- TriggerHandlerMeta._registered.add(key)
37
- logger.debug(
38
- "Registered hook %s.%s → %s.%s (cond=%r, prio=%s)",
39
- model_cls.__name__,
40
- event,
41
- cls.__name__,
42
- method_name,
43
- condition,
44
- priority,
45
- )
46
- return cls
47
-
48
-
49
- class TriggerHandler(metaclass=TriggerHandlerMeta):
50
- @classmethod
51
- def handle(
52
- cls,
53
- event: str,
54
- model: type,
55
- *,
56
- new_records: list = None,
57
- old_records: list = None,
58
- **kwargs,
59
- ) -> None:
60
- # Prepare hook list and log names
61
- hooks = get_hooks(model, event)
62
-
63
- # Sort hooks by priority (ascending: lower number = higher priority)
64
- hooks = sorted(hooks, key=lambda x: x[3])
65
-
66
- hook_names = [f"{h.__name__}.{m}" for h, m, _, _ in hooks]
67
- logger.debug(
68
- "Found %d hooks for %s.%s: %s",
69
- len(hooks),
70
- model.__name__,
71
- event,
72
- hook_names,
73
- )
74
-
75
- def _process():
76
- # Ensure new_records is a list
77
- new_records_local = new_records or []
78
-
79
- # Normalize old_records: ensure list and pad with None
80
- old_records_local = list(old_records) if old_records else []
81
- if len(old_records_local) < len(new_records_local):
82
- old_records_local += [None] * (
83
- len(new_records_local) - len(old_records_local)
84
- )
85
-
86
- logger.debug(
87
- "ℹ️ bulk_hooks.handle() start: model=%s event=%s new_count=%d old_count=%d",
88
- model.__name__,
89
- event,
90
- len(new_records_local),
91
- len(old_records_local),
92
- )
93
-
94
- for handler_cls, method_name, condition, priority in hooks:
95
- logger.debug(
96
- "→ evaluating hook %s.%s (cond=%r, prio=%s)",
97
- handler_cls.__name__,
98
- method_name,
99
- condition,
100
- priority,
101
- )
102
-
103
- # Evaluate condition
104
- passed = True
105
- if condition is not None:
106
- if isinstance(condition, HookCondition):
107
- cond_info = getattr(condition, "__dict__", str(condition))
108
- logger.debug(
109
- " [cond-info] %s.%s → %r",
110
- handler_cls.__name__,
111
- method_name,
112
- cond_info,
113
- )
114
-
115
- checks = []
116
- for new, old in zip(new_records_local, old_records_local):
117
- field_name = getattr(condition, "field", None) or getattr(
118
- condition, "field_name", None
119
- )
120
- if field_name:
121
- actual_val = getattr(new, field_name, None)
122
- expected = getattr(condition, "value", None) or getattr(
123
- condition, "value", None
124
- )
125
- logger.debug(
126
- " [field-lookup] %s.%s → field=%r actual=%r expected=%r",
127
- handler_cls.__name__,
128
- method_name,
129
- field_name,
130
- actual_val,
131
- expected,
132
- )
133
- result = condition.check(new, old)
134
- checks.append(result)
135
- logger.debug(
136
- " [cond-check] %s.%s → new=%r old=%r => %s",
137
- handler_cls.__name__,
138
- method_name,
139
- new,
140
- old,
141
- result,
142
- )
143
- passed = any(checks)
144
- logger.debug(
145
- " [cond-summary] %s.%s any-passed=%s",
146
- handler_cls.__name__,
147
- method_name,
148
- passed,
149
- )
150
- else:
151
- # Legacy callable conditions
152
- passed = condition(
153
- new_records=new_records_local,
154
- old_records=old_records_local,
155
- )
156
- logger.debug(
157
- " [legacy-cond] %s.%s → full-list => %s",
158
- handler_cls.__name__,
159
- method_name,
160
- passed,
161
- )
162
-
163
- if not passed:
164
- logger.debug(
165
- "↳ skipping %s.%s (condition not met)",
166
- handler_cls.__name__,
167
- method_name,
168
- )
169
- continue
170
-
171
- # Instantiate & invoke handler method
172
- handler = handler_cls()
173
- method = getattr(handler, method_name)
174
- logger.info(
175
- "✨ invoking %s.%s on %d record(s)",
176
- handler_cls.__name__,
177
- method_name,
178
- len(new_records_local),
179
- )
180
- try:
181
- method(
182
- new_records=new_records_local,
183
- old_records=old_records_local,
184
- **kwargs,
185
- )
186
- except Exception:
187
- logger.exception(
188
- "❌ exception in %s.%s",
189
- handler_cls.__name__,
190
- method_name,
191
- )
192
-
193
- logger.debug(
194
- "✔️ bulk_hooks.handle() complete for %s.%s",
195
- model.__name__,
196
- event,
197
- )
198
-
199
- # Defer if in atomic block and event is after_*
200
- conn = transaction.get_connection()
201
- if conn.in_atomic_block and event.startswith("after_"):
202
- logger.debug(
203
- "Deferring hook execution until after transaction commit for event '%s'",
204
- event,
205
- )
206
- transaction.on_commit(_process)
207
- else:
208
- _process()