inventree/InvenTree
2
0
Fork 0
mirror of https://github.com/inventree/InvenTree.git synced 2025-10-24 18:07:38 +00:00
Code Activity

enable query based filtering

Browse Source
This commit is contained in:
Matthias Mair
2025-10-17 02:37:22 +02:00
parent 1b2ce89c42
commit 037db06f27
2 changed files with 29 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
src/backend/InvenTree/InvenTree/serializers.py
View File

@@ -85,6 +85,9 @@ class FilterableSerializerMixin:
_was_filtered = False _was_filtered = False
no_filters = False no_filters = False
"""If True, do not raise an exception if no filterable fields are found."""
filter_on_query = True
"""If True, also look for filter parameters in the request query parameters."""
def __init__(self, *args, **kwargs): def __init__(self, *args, **kwargs):
"""Initialization routine for the serializer. This gathers and applies filters through kwargs.""" """Initialization routine for the serializer. This gathers and applies filters through kwargs."""
@@ -113,12 +116,24 @@ class FilterableSerializerMixin:
if getattr(a, 'is_filterable', None) if getattr(a, 'is_filterable', None)
} }
# Gather query parameters from the request context
query_params = {}
if context := kwargs.get('context', {}):
query_params = dict(getattr(context.get('request', {}), 'query_params', {}))
# Remove filter args from kwargs to avoid issues with super().__init__ # Remove filter args from kwargs to avoid issues with super().__init__
poped_kwargs = {} # store popped kwargs as a arg might be reused for multiple fields poped_kwargs = {} # store popped kwargs as a arg might be reused for multiple fields
tgs_vals: dict[str, bool] = {} tgs_vals: dict[str, bool] = {}
for k, v in self.filter_targets.items(): for k, v in self.filter_targets.items():
pop_ref = v['filter_name'] or k pop_ref = v['filter_name'] or k
val = kwargs.pop(pop_ref, poped_kwargs.get(pop_ref)) val = kwargs.pop(pop_ref, poped_kwargs.get(pop_ref))
# Optionally also look in query parameters
if val is None and self.filter_on_query:
val = query_params.pop(pop_ref, None)
if isinstance(val, list) and len(val) == 1:
val = val[0]
if val: # Save popped value for reuse if val: # Save popped value for reuse
poped_kwargs[pop_ref] = val poped_kwargs[pop_ref] = val
tgs_vals[k] = ( tgs_vals[k] = (

14
src/backend/InvenTree/InvenTree/test_serializers.py
View File

@@ -77,3 +77,17 @@ class FilteredSerializers(InvenTreeAPITestCase):
self.assertNotContains(response, 'field_b') self.assertNotContains(response, 'field_b')
self.assertContains(response, 'field_c') self.assertContains(response, 'field_c')
self.assertContains(response, 'field_d') self.assertContains(response, 'field_d')
# Request with filter for field_b
response = self.client.get(url, {'field_b': True})
self.assertContains(response, 'field_a')
self.assertContains(response, 'field_b')
self.assertContains(response, 'field_c')
self.assertContains(response, 'field_d')
# Disable field_c using custom filter name
response = self.client.get(url, {'crazy_name': 'false'})
self.assertContains(response, 'field_a')
self.assertNotContains(response, 'field_b')
self.assertNotContains(response, 'field_c')
self.assertNotContains(response, 'field_d')