Skip to content

Add ignore_empty Parameter to has_changed Method #621

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add ignore_empty Parameter to has_changed Method #621

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions model_utils/tracker.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,13 +215,17 @@ def current(self, fields=None):

return {f: self.get_field_value(f) for f in fields}

def has_changed(self, field):
def has_changed(self, field, ignore_empty=True):
"""Returns ``True`` if field has changed from currently saved value"""
if field in self.fields:
# deferred fields haven't changed
if field in self.deferred_fields and field not in self.instance.__dict__:
return False
return self.previous(field) != self.get_field_value(field)
current_value = self.get_field_value(field)
previous_value = self.previous(field)
if ignore_empty and (previous_value is None and current_value == '' or previous_value == '' and current_value is None):
return False
return previous_value != current_value
else:
raise FieldError('field "%s" not tracked' % field)

Expand Down Expand Up @@ -353,12 +357,16 @@ def __get__(self, instance, owner):

class ModelInstanceTracker(FieldInstanceTracker):

def has_changed(self, field):
def has_changed(self, field, ignore_empty=True):
"""Returns ``True`` if field has changed from currently saved value"""
if not self.instance.pk:
return True
elif field in self.saved_data:
return self.previous(field) != self.get_field_value(field)
current_value = self.get_field_value(field)
previous_value = self.previous(field)
if ignore_empty and (previous_value is None and current_value == '' or previous_value == '' and current_value is None):
return False
return previous_value != current_value
else:
raise FieldError('field "%s" not tracked' % field)

Expand Down