django-bulk-hooks 0.2.44__py3-none-any.whl → 0.2.93__py3-none-any.whl

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.
@@ -25,9 +25,6 @@ from django_bulk_hooks.operations import BulkOperationCoordinator
25
25
  from django_bulk_hooks.operations import ModelAnalyzer
26
26
  from django_bulk_hooks.operations import MTIHandler
27
27
 
28
- # Add NullHandler to prevent logging messages if the application doesn't configure logging
29
- logging.getLogger(__name__).addHandler(logging.NullHandler())
30
-
31
28
  __all__ = [
32
29
  "BulkHookManager",
33
30
  "HookClass",
@@ -1,230 +1,214 @@
1
- """
2
- ChangeSet and RecordChange classes for Salesforce-style hook context.
3
-
4
- Provides a first-class abstraction for tracking changes in bulk operations,
5
- similar to Salesforce's Hook.new, Hook.old, and Hook.newMap.
6
- """
7
-
8
-
9
- class RecordChange:
10
- """
11
- Represents a single record change with old/new state.
12
-
13
- Similar to accessing Hook.newMap.get(id) in Salesforce, but with
14
- additional conveniences like O(1) field change detection.
15
- """
16
-
17
- def __init__(self, new_record, old_record=None, changed_fields=None):
18
- """
19
- Initialize a RecordChange.
20
-
21
- Args:
22
- new_record: The new/current state of the record
23
- old_record: The old/previous state of the record (None for creates)
24
- changed_fields: Optional pre-computed set of changed field names.
25
- If None, will be computed lazily on first access.
26
- """
27
- self.new_record = new_record
28
- self.old_record = old_record
29
- self._changed_fields = changed_fields
30
- self._pk = getattr(new_record, "pk", None) if new_record else None
31
-
32
- @property
33
- def pk(self):
34
- """Primary key of the record."""
35
- return self._pk
36
-
37
- @property
38
- def changed_fields(self):
39
- """
40
- Set of field names that have changed.
41
-
42
- Computed lazily on first access and cached for O(1) subsequent checks.
43
- """
44
- if self._changed_fields is None:
45
- self._changed_fields = self._compute_changed_fields()
46
- return self._changed_fields
47
-
48
- def has_changed(self, field_name):
49
- """
50
- O(1) check if a specific field has changed.
51
-
52
- Args:
53
- field_name: Name of the field to check
54
-
55
- Returns:
56
- True if the field value changed, False otherwise
57
- """
58
- return field_name in self.changed_fields
59
-
60
- def get_old_value(self, field_name):
61
- """
62
- Get the old value for a field.
63
-
64
- Args:
65
- field_name: Name of the field
66
-
67
- Returns:
68
- The old value, or None if no old record exists
69
- """
70
- if self.old_record is None:
71
- return None
72
- return getattr(self.old_record, field_name, None)
73
-
74
- def get_new_value(self, field_name):
75
- """
76
- Get the new value for a field.
77
-
78
- Args:
79
- field_name: Name of the field
80
-
81
- Returns:
82
- The new value
83
- """
84
- return getattr(self.new_record, field_name, None)
85
-
86
- def _compute_changed_fields(self):
87
- """
88
- Compute which fields have changed between old and new records.
89
-
90
- Uses Django's field.get_prep_value() for proper comparison that
91
- handles database-level transformations.
92
-
93
- Returns:
94
- Set of field names that have changed
95
- """
96
- if self.old_record is None:
97
- return set()
98
-
99
- changed = set()
100
- model_cls = self.new_record.__class__
101
-
102
- for field in model_cls._meta.fields:
103
- # Skip primary key - it shouldn't change
104
- if field.primary_key:
105
- continue
106
-
107
- old_val = getattr(self.old_record, field.name, None)
108
- new_val = getattr(self.new_record, field.name, None)
109
-
110
- # Use field's get_prep_value for proper comparison
111
- # This handles database-level transformations (e.g., timezone conversions)
112
- try:
113
- old_prep = field.get_prep_value(old_val)
114
- new_prep = field.get_prep_value(new_val)
115
- if old_prep != new_prep:
116
- changed.add(field.name)
117
- except Exception:
118
- # Fallback to direct comparison if get_prep_value fails
119
- if old_val != new_val:
120
- changed.add(field.name)
121
-
122
- return changed
123
-
124
-
125
- class ChangeSet:
126
- """
127
- Collection of RecordChanges for a bulk operation.
128
-
129
- Similar to Salesforce's Hook context (Hook.new, Hook.old, Hook.newMap),
130
- but enhanced for Python's bulk operations paradigm with O(1) lookups and
131
- additional metadata.
132
- """
133
-
134
- def __init__(self, model_cls, changes, operation_type, operation_meta=None):
135
- """
136
- Initialize a ChangeSet.
137
-
138
- Args:
139
- model_cls: The Django model class
140
- changes: List of RecordChange instances
141
- operation_type: Type of operation ('create', 'update', 'delete')
142
- operation_meta: Optional dict of additional metadata (e.g., update_kwargs)
143
- """
144
- self.model_cls = model_cls
145
- self.changes = changes # List[RecordChange]
146
- self.operation_type = operation_type
147
- self.operation_meta = operation_meta or {}
148
-
149
- # Build PK -> RecordChange map for O(1) lookups (like Hook.newMap)
150
- self._pk_to_change = {c.pk: c for c in changes if c.pk is not None}
151
-
152
- @property
153
- def new_records(self):
154
- """
155
- List of new/current record states.
156
-
157
- Similar to Hook.new in Salesforce.
158
- """
159
- return [c.new_record for c in self.changes if c.new_record is not None]
160
-
161
- @property
162
- def old_records(self):
163
- """
164
- List of old/previous record states.
165
-
166
- Similar to Hook.old in Salesforce.
167
- Only includes records that have old states (excludes creates).
168
- """
169
- return [c.old_record for c in self.changes if c.old_record is not None]
170
-
171
- def has_field_changed(self, pk, field_name):
172
- """
173
- O(1) check if a field changed for a specific record.
174
-
175
- Args:
176
- pk: Primary key of the record
177
- field_name: Name of the field to check
178
-
179
- Returns:
180
- True if the field changed, False otherwise
181
- """
182
- change = self._pk_to_change.get(pk)
183
- return change.has_changed(field_name) if change else False
184
-
185
- def get_old_value(self, pk, field_name):
186
- """
187
- Get the old value for a specific record and field.
188
-
189
- Args:
190
- pk: Primary key of the record
191
- field_name: Name of the field
192
-
193
- Returns:
194
- The old value, or None if not found
195
- """
196
- change = self._pk_to_change.get(pk)
197
- return change.get_old_value(field_name) if change else None
198
-
199
- def get_new_value(self, pk, field_name):
200
- """
201
- Get the new value for a specific record and field.
202
-
203
- Args:
204
- pk: Primary key of the record
205
- field_name: Name of the field
206
-
207
- Returns:
208
- The new value, or None if not found
209
- """
210
- change = self._pk_to_change.get(pk)
211
- return change.get_new_value(field_name) if change else None
212
-
213
- def chunk(self, chunk_size):
214
- """
215
- Split ChangeSet into smaller chunks for memory-efficient processing.
216
-
217
- Useful for processing very large bulk operations without loading
218
- all data into memory at once.
219
-
220
- Args:
221
- chunk_size: Number of changes per chunk
222
-
223
- Yields:
224
- ChangeSet instances, each with up to chunk_size changes
225
- """
226
- for i in range(0, len(self.changes), chunk_size):
227
- chunk_changes = self.changes[i : i + chunk_size]
228
- yield ChangeSet(
229
- self.model_cls, chunk_changes, self.operation_type, self.operation_meta,
230
- )
1
+ """
2
+ ChangeSet and RecordChange classes for Salesforce-style hook context.
3
+
4
+ Provides a first-class abstraction for tracking changes in bulk operations,
5
+ similar to Salesforce's Hook.new, Hook.old, and Hook.newMap.
6
+ """
7
+
8
+
9
+ class RecordChange:
10
+ """
11
+ Represents a single record change with old/new state.
12
+
13
+ Similar to accessing Hook.newMap.get(id) in Salesforce, but with
14
+ additional conveniences like O(1) field change detection.
15
+ """
16
+
17
+ def __init__(self, new_record, old_record=None, changed_fields=None):
18
+ """
19
+ Initialize a RecordChange.
20
+
21
+ Args:
22
+ new_record: The new/current state of the record
23
+ old_record: The old/previous state of the record (None for creates)
24
+ changed_fields: Optional pre-computed set of changed field names.
25
+ If None, will be computed lazily on first access.
26
+ """
27
+ self.new_record = new_record
28
+ self.old_record = old_record
29
+ self._changed_fields = changed_fields
30
+ self._pk = getattr(new_record, "pk", None) if new_record else None
31
+
32
+ @property
33
+ def pk(self):
34
+ """Primary key of the record."""
35
+ return self._pk
36
+
37
+ @property
38
+ def changed_fields(self):
39
+ """
40
+ Set of field names that have changed.
41
+
42
+ Computed lazily on first access and cached for O(1) subsequent checks.
43
+ """
44
+ if self._changed_fields is None:
45
+ self._changed_fields = self._compute_changed_fields()
46
+ return self._changed_fields
47
+
48
+ def has_changed(self, field_name):
49
+ """
50
+ O(1) check if a specific field has changed.
51
+
52
+ Args:
53
+ field_name: Name of the field to check
54
+
55
+ Returns:
56
+ True if the field value changed, False otherwise
57
+ """
58
+ return field_name in self.changed_fields
59
+
60
+ def get_old_value(self, field_name):
61
+ """
62
+ Get the old value for a field.
63
+
64
+ Args:
65
+ field_name: Name of the field
66
+
67
+ Returns:
68
+ The old value, or None if no old record exists
69
+ """
70
+ if self.old_record is None:
71
+ return None
72
+ return getattr(self.old_record, field_name, None)
73
+
74
+ def get_new_value(self, field_name):
75
+ """
76
+ Get the new value for a field.
77
+
78
+ Args:
79
+ field_name: Name of the field
80
+
81
+ Returns:
82
+ The new value
83
+ """
84
+ return getattr(self.new_record, field_name, None)
85
+
86
+ def _compute_changed_fields(self):
87
+ """
88
+ Compute which fields have changed between old and new records.
89
+
90
+ Uses Django's field.get_prep_value() for proper comparison that
91
+ handles database-level transformations.
92
+
93
+ Returns:
94
+ Set of field names that have changed
95
+ """
96
+ if self.old_record is None:
97
+ return set()
98
+
99
+ # Import here to avoid circular dependency
100
+ from .operations.field_utils import get_changed_fields
101
+
102
+ model_cls = self.new_record.__class__
103
+ return get_changed_fields(self.old_record, self.new_record, model_cls)
104
+
105
+
106
+ class ChangeSet:
107
+ """
108
+ Collection of RecordChanges for a bulk operation.
109
+
110
+ Similar to Salesforce's Hook context (Hook.new, Hook.old, Hook.newMap),
111
+ but enhanced for Python's bulk operations paradigm with O(1) lookups and
112
+ additional metadata.
113
+ """
114
+
115
+ def __init__(self, model_cls, changes, operation_type, operation_meta=None):
116
+ """
117
+ Initialize a ChangeSet.
118
+
119
+ Args:
120
+ model_cls: The Django model class
121
+ changes: List of RecordChange instances
122
+ operation_type: Type of operation ('create', 'update', 'delete')
123
+ operation_meta: Optional dict of additional metadata (e.g., update_kwargs)
124
+ """
125
+ self.model_cls = model_cls
126
+ self.changes = changes # List[RecordChange]
127
+ self.operation_type = operation_type
128
+ self.operation_meta = operation_meta or {}
129
+
130
+ # Build PK -> RecordChange map for O(1) lookups (like Hook.newMap)
131
+ self._pk_to_change = {c.pk: c for c in changes if c.pk is not None}
132
+
133
+ @property
134
+ def new_records(self):
135
+ """
136
+ List of new/current record states.
137
+
138
+ Similar to Hook.new in Salesforce.
139
+ """
140
+ return [c.new_record for c in self.changes if c.new_record is not None]
141
+
142
+ @property
143
+ def old_records(self):
144
+ """
145
+ List of old/previous record states.
146
+
147
+ Similar to Hook.old in Salesforce.
148
+ Only includes records that have old states (excludes creates).
149
+ """
150
+ return [c.old_record for c in self.changes if c.old_record is not None]
151
+
152
+ def has_field_changed(self, pk, field_name):
153
+ """
154
+ O(1) check if a field changed for a specific record.
155
+
156
+ Args:
157
+ pk: Primary key of the record
158
+ field_name: Name of the field to check
159
+
160
+ Returns:
161
+ True if the field changed, False otherwise
162
+ """
163
+ change = self._pk_to_change.get(pk)
164
+ return change.has_changed(field_name) if change else False
165
+
166
+ def get_old_value(self, pk, field_name):
167
+ """
168
+ Get the old value for a specific record and field.
169
+
170
+ Args:
171
+ pk: Primary key of the record
172
+ field_name: Name of the field
173
+
174
+ Returns:
175
+ The old value, or None if not found
176
+ """
177
+ change = self._pk_to_change.get(pk)
178
+ return change.get_old_value(field_name) if change else None
179
+
180
+ def get_new_value(self, pk, field_name):
181
+ """
182
+ Get the new value for a specific record and field.
183
+
184
+ Args:
185
+ pk: Primary key of the record
186
+ field_name: Name of the field
187
+
188
+ Returns:
189
+ The new value, or None if not found
190
+ """
191
+ change = self._pk_to_change.get(pk)
192
+ return change.get_new_value(field_name) if change else None
193
+
194
+ def chunk(self, chunk_size):
195
+ """
196
+ Split ChangeSet into smaller chunks for memory-efficient processing.
197
+
198
+ Useful for processing very large bulk operations without loading
199
+ all data into memory at once.
200
+
201
+ Args:
202
+ chunk_size: Number of changes per chunk
203
+
204
+ Yields:
205
+ ChangeSet instances, each with up to chunk_size changes
206
+ """
207
+ for i in range(0, len(self.changes), chunk_size):
208
+ chunk_changes = self.changes[i : i + chunk_size]
209
+ yield ChangeSet(
210
+ self.model_cls,
211
+ chunk_changes,
212
+ self.operation_type,
213
+ self.operation_meta,
214
+ )
@@ -40,7 +40,9 @@ def resolve_field_path(instance, field_path):
40
40
  if field.is_relation and not field.many_to_many:
41
41
  # Use attname for the final FK field access
42
42
  current_instance = getattr(
43
- current_instance, field.attname, None,
43
+ current_instance,
44
+ field.attname,
45
+ None,
44
46
  )
45
47
  continue
46
48
  except:
@@ -203,7 +205,8 @@ class AndCondition(HookCondition):
203
205
 
204
206
  def check(self, instance, original_instance=None):
205
207
  return self.cond1.check(instance, original_instance) and self.cond2.check(
206
- instance, original_instance,
208
+ instance,
209
+ original_instance,
207
210
  )
208
211
 
209
212
 
@@ -214,7 +217,8 @@ class OrCondition(HookCondition):
214
217
 
215
218
  def check(self, instance, original_instance=None):
216
219
  return self.cond1.check(instance, original_instance) or self.cond2.check(
217
- instance, original_instance,
220
+ instance,
221
+ original_instance,
218
222
  )
219
223
 
220
224
 
@@ -76,17 +76,11 @@ def select_related(*related_fields):
76
76
  except (FieldDoesNotExist, AttributeError):
77
77
  continue
78
78
 
79
- if (
80
- relation_field.is_relation
81
- and not relation_field.many_to_many
82
- and not relation_field.one_to_many
83
- ):
79
+ if relation_field.is_relation and not relation_field.many_to_many and not relation_field.one_to_many:
84
80
  validated_fields.append(field)
85
81
  direct_relation_fields[field] = relation_field
86
82
 
87
- unsaved_related_ids_by_field = {
88
- field: set() for field in direct_relation_fields
89
- }
83
+ unsaved_related_ids_by_field = {field: set() for field in direct_relation_fields}
90
84
 
91
85
  saved_ids_to_fetch = []
92
86
  for obj in records:
@@ -94,10 +88,7 @@ def select_related(*related_fields):
94
88
  needs_fetch = False
95
89
  if hasattr(obj, "_state") and hasattr(obj._state, "fields_cache"):
96
90
  try:
97
- needs_fetch = any(
98
- field not in obj._state.fields_cache
99
- for field in related_fields
100
- )
91
+ needs_fetch = any(field not in obj._state.fields_cache for field in related_fields)
101
92
  except (TypeError, AttributeError):
102
93
  needs_fetch = True
103
94
  else:
@@ -134,9 +125,7 @@ def select_related(*related_fields):
134
125
  except Exception:
135
126
  fetched_saved = {}
136
127
 
137
- fetched_unsaved_by_field = {
138
- field: {} for field in direct_relation_fields
139
- }
128
+ fetched_unsaved_by_field = {field: {} for field in direct_relation_fields}
140
129
 
141
130
  for field_name, relation_field in direct_relation_fields.items():
142
131
  related_ids = unsaved_related_ids_by_field[field_name]
@@ -282,6 +271,7 @@ def bulk_hook(model_cls, event, when=None, priority=None):
282
271
 
283
272
  # Check function signature to determine which format to use
284
273
  import inspect
274
+
285
275
  sig = inspect.signature(func)
286
276
  params = list(sig.parameters.keys())
287
277