Part 3 — Calculations
If your V1 project uses ConditionalUpdateMixin for on-demand calculations, this part walks you through migrating to CalculationModel. The new system is simpler — you write less code and get more features.
What Changes
Aspect | V1 ( | Current ( |
|---|---|---|
Base class |
|
|
Method name |
|
|
Decorator |
| Not needed |
State field | Boolean | Enum with 5 states |
Recursion guard | Manual | Automatic |
Error handling | Manual | Automatic |
Save | Manual | Automatic |
Step-by-Step Conversion
1. Change the Base Class
# Before
from generic_app.generic_models.upload_model import ConditionalUpdateMixin
class CalculateNAV(ConditionalUpdateMixin):
pass# After
from lex.core.models.CalculationModel import CalculationModel
class CalculateNAV(CalculationModel):
pass2. Rename update() to calculate()
# Before
@ConditionalUpdateMixin.conditional_calculation
def update(self):
# ... business logic ...
self.save()# After
def calculate(self):
# ... business logic ...
# No self.save() needed — the framework does it3. Remove the Decorator
The @conditional_calculation decorator is no longer needed. CalculationModel handles the state transitions internally via @hook(AFTER_UPDATE).
4. Remove the Recursion Guard
# Before
def update(self):
self.dont_update = True
self.nav_value = self.compute_nav()
self.save()
self.dont_update = False# After
def calculate(self):
self.nav_value = self.compute_nav()
# No recursion guard, no save — both are automatic5. Remove Manual Error Handling (Optional)
V1 required you to wrap your logic in try/catch blocks. The framework now catches exceptions automatically and stores the error in calculation_error_message:
# Before
def update(self):
try:
self.nav_value = self.compute_nav()
except Exception as e:
self.error_message = str(e)
self.save()
raise# After
def calculate(self):
self.nav_value = self.compute_nav()
# If this raises, the framework sets is_calculated = "ERROR"
# and stores the traceback in calculation_error_messageYou can still add custom error handling if you want to log specific messages via LexLogger before the exception propagates.
Full Before/After Example
Before (V1)
from generic_app.generic_models.upload_model import ConditionalUpdateMixin, IsCalculatedField, CalculateField
from generic_app.submodels.CalculationLog import CalculationLog
class CalculateNAV(ConditionalUpdateMixin):
quarter = models.ForeignKey('Quarter', on_delete=models.CASCADE)
is_calculated = IsCalculatedField(default=False)
calculate = CalculateField()
dont_update = False
nav_value = models.DecimalField(max_digits=19, decimal_places=2, null=True)
error_message = models.TextField(null=True, blank=True)
@ConditionalUpdateMixin.conditional_calculation
def update(self):
try:
self.dont_update = True
investments = Investment.objects.filter(quarter=self.quarter)
total = sum(inv.market_value for inv in investments)
self.nav_value = total
CalculationLog.create(
f"NAV calculated: {total}",
calculation_object=self
)
self.save()
except Exception as e:
self.error_message = str(e)
self.save()
raise
finally:
self.dont_update = FalseAfter (Current)
from lex.core.models.CalculationModel import CalculationModel
from lex.audit_logging.handlers.LexLogger import LexLogger
from django.db import models
class CalculateNAV(CalculationModel):
quarter = models.ForeignKey('Quarter', on_delete=models.CASCADE)
nav_value = models.DecimalField(max_digits=19, decimal_places=2, null=True)
def calculate(self):
investments = Investment.objects.filter(quarter=self.quarter)
total = sum(inv.market_value for inv in investments)
self.nav_value = total
LexLogger().add_text(f"NAV calculated: {total}").log()That's 14 lines instead of 27 lines, with better error handling, state tracking, and logging.
Fields You Can Remove
After converting, remove these fields from your model — they're now inherited:
is_calculated = IsCalculatedField(...)calculate = CalculateField()dont_update = Falseerror_messagefields (replaced bycalculation_error_message)
The New State Machine
V1's is_calculated was a simple boolean (true/false). The current system uses a 5-state enum:
stateDiagram-v2
[*] --> NOT_CALCULATED
NOT_CALCULATED --> IN_PROGRESS : Calculate clicked
IN_PROGRESS --> SUCCESS : Completed
IN_PROGRESS --> ERROR : Exception
IN_PROGRESS --> ABORTED : Cancelled
ERROR --> IN_PROGRESS : Retry
SUCCESS --> IN_PROGRESS : Recalculate
ABORTED --> IN_PROGRESS : RetryThis gives you proper progress tracking, retry capability, and clear error states. See Calculations for the full details.
Checkpoint
All
ConditionalUpdateMixinclasses converted toCalculationModelupdate()methods renamed tocalculate()@conditional_calculationdecorators removeddont_updateflags removedManual
self.save()calls insidecalculate()removedIsCalculatedFieldandCalculateFielddefinitions removedLogging calls updated from
CalculationLogtoLexLogger(detail in Part 5)
Next: Part 4 — Lifecycle Hooks.
Was this helpful?
Your feedback shapes what we write next.
