NeoAnd/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2025-07-25 01:48:38 -06:00
Code Issues Actions 9 Packages Projects Releases Wiki Activity

Fix filtering by custom field value

Browse Source
This commit is contained in:
Jeremy Stretch 2020-08-25 16:21:54 -04:00
parent a9086b0679
commit 378c0ac259
1 changed files with 15 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
netbox/extras/filters.py
View File

@ -21,15 +21,20 @@ __all__ = (
'TagFilterSet', 'TagFilterSet',
) )
EXACT_FILTER_TYPES = (
CustomFieldTypeChoices.TYPE_BOOLEAN,
CustomFieldTypeChoices.TYPE_DATE,
CustomFieldTypeChoices.TYPE_INTEGER,
CustomFieldTypeChoices.TYPE_SELECT,
)
class CustomFieldFilter(django_filters.Filter): class CustomFieldFilter(django_filters.Filter):
""" """
Filter objects by the presence of a CustomFieldValue. The filter's name is used as the CustomField name. Filter objects by the presence of a CustomFieldValue. The filter's name is used as the CustomField name.
""" """
def __init__(self, custom_field, *args, **kwargs): def __init__(self, custom_field, *args, **kwargs):
self.cf_type = custom_field.type self.custom_field = custom_field
self.filter_logic = custom_field.filter_logic
super().__init__(*args, **kwargs) super().__init__(*args, **kwargs)
def filter(self, queryset, value): def filter(self, queryset, value):
@ -38,44 +43,22 @@ class CustomFieldFilter(django_filters.Filter):
if value is None or not value.strip(): if value is None or not value.strip():
return queryset return queryset
# Selection fields get special treatment (values must be integers)
if self.cf_type == CustomFieldTypeChoices.TYPE_SELECT:
try:
# Treat 0 as None
if int(value) == 0:
return queryset.exclude(
custom_field_values__field__name=self.field_name,
)
# Match on exact CustomFieldChoice PK
else:
return queryset.filter(
custom_field_values__field__name=self.field_name,
custom_field_values__serialized_value=value,
)
except ValueError:
return queryset.none()
# Apply the assigned filter logic (exact or loose) # Apply the assigned filter logic (exact or loose)
if (self.cf_type == CustomFieldTypeChoices.TYPE_BOOLEAN or if (
self.filter_logic == CustomFieldFilterLogicChoices.FILTER_EXACT): self.custom_field.type in EXACT_FILTER_TYPES or
queryset = queryset.filter( self.custom_field.filter_logic == CustomFieldFilterLogicChoices.FILTER_EXACT
custom_field_values__field__name=self.field_name, ):
custom_field_values__serialized_value=value kwargs = {f'custom_field_data__{self.field_name}': value}
)
else: else:
queryset = queryset.filter( kwargs = {f'custom_field_data__{self.field_name}__icontains': value}
custom_field_values__field__name=self.field_name,
custom_field_values__serialized_value__icontains=value
)
return queryset return queryset.filter(**kwargs)
class CustomFieldFilterSet(django_filters.FilterSet): class CustomFieldFilterSet(django_filters.FilterSet):
""" """
Dynamically add a Filter for each CustomField applicable to the parent model. Dynamically add a Filter for each CustomField applicable to the parent model.
""" """
def __init__(self, *args, **kwargs): def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs) super().__init__(*args, **kwargs)