Skip to content

cleanup: remove unused sanitize_encrypted param from diff function #958

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
VedantMadane wants to merge 1 commit into
base: devel
Choose a base branch
from
+6 −11
Open

cleanup: remove unused sanitize_encrypted param from diff function #958

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
17 changes: 6 additions & 11 deletions ansible_base/lib/utils/models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ def is_encrypted_field(model, field_name):
return field_name in getattr(model, 'encrypted_fields', [])


def _sanitize_value(instance, model, field_name, value, sanitize_encrypted):
def _sanitize_value(instance, model, field_name, value):
"""Return *value* unchanged or ``ENCRYPTED_STRING`` if the field is sensitive.

Extends the class-level ``is_encrypted_field`` check with two additional
Expand All @@ -181,8 +181,6 @@ def _sanitize_value(instance, model, field_name, value, sanitize_encrypted):
2. **Value prefix** -- if the string value starts with the well-known
``$encrypted$`` marker, it is replaced regardless of field metadata.
"""
if not sanitize_encrypted:
return value
if is_encrypted_field(model, field_name):
return ENCRYPTED_STRING
if instance is not None and field_name in getattr(instance, '_encrypted_field_names', set()):
Expand Down Expand Up @@ -216,7 +214,6 @@ def diff(
include_m2m=False,
exclude_fields=[],
limit_fields=[],
sanitize_encrypted=True,
all_values_as_strings=False,
):
"""
Expand All @@ -241,11 +238,9 @@ def diff(
useful, for example, when update_fields is passed to a model's save
method and you only want to diff the fields that were updated.
(default: [])
:param sanitize_encrypted: If True, encrypted fields will be replaced with
a constant value (ENCRYPTED_STRING) in the diff. (default: True)
:param all_values_as_strings: If True, all values will be converted to
strings after diffing, using Field.value_to_string. (default: False)
:return: A dictionary with the following
:return: A ModelDiff object with the following attributes
- added_fields: A dictionary of fields that were added between old and
new. Importantly, if old and new are the same type of model, this
should always be empty. An "added field" does not mean that the field
Expand Down Expand Up @@ -317,21 +312,21 @@ def diff(

# Get any removed fields from the old_fields - new_fields
for field in old_fields_set - new_fields_set:
model_diff.removed_fields[field] = _sanitize_value(old, old_model, field, fields['old'][field], sanitize_encrypted)
model_diff.removed_fields[field] = _sanitize_value(old, old_model, field, fields['old'][field])

# Get any new fields from the new_fields - old_fields
for field in new_fields_set - old_fields_set:
val = fields['new'][field]
model_diff.added_fields[field] = _sanitize_value(new, new_model, field, val, sanitize_encrypted)
model_diff.added_fields[field] = _sanitize_value(new, new_model, field, val)

# Find any modified fields from the union of the sets
for field in new_fields_set & old_fields_set:
if fields['old'][field] != fields['new'][field]:
old_val = fields['old'][field]
new_val = fields['new'][field]
model_diff.changed_fields[field] = (
_sanitize_value(old, old_model, field, old_val, sanitize_encrypted),
_sanitize_value(new, new_model, field, new_val, sanitize_encrypted),
_sanitize_value(old, old_model, field, old_val),
_sanitize_value(new, new_model, field, new_val),
)

return model_diff
Loading