django_ufilter.integrations.drf module

class django_ufilter.integrations.drf.DRFFilterBackend

Bases: rest_framework.filters.BaseFilterBackend

DRF filter backend which integrates with django-ufilter

This integration backend can be specified in global DRF settings:

# settings.py
REST_FRAMEWORK = {
    'DEFAULT_FILTER_BACKENDS': [
        'django_ufilter.integrations.drf.DRFFilterBackend',
    ]
}

Alternatively filter backend can be specified per view/viewset bases:

class MyViewSet(ModelViewSet):
    queryset = MyModel.objects.all()
    filter_backends = [DRFFilterBackend]
    filter_fields = ['field1', 'field2']

The following attributes can be specified on the view:

• filter_class - explicit filter (FilterSet to be specific) class which should be used for filtering. When this attribute is supplied, this filterset will be used and all other attributes described below will are ignored.

• filter_fields - list of strings which should be names of fields which should be included in the generated FilterSet. This is equivalent:

  class MyFilterSet(ModelFilterSet):
      class Meta(object):
          model = MyModel
          fields = ['fields1', ...]
  

• filter_class_meta_kwargs - additional kwargs which should be passed in Meta for the generated FilterSet.

• filter_class_default - base class to use while creating a new FilterSet. This is primarily useful when using non-Django data-sources. By default default_filter_set is used.

default_filter_set

alias of django_ufilter.filtersets.django.ModelFilterSet

filter_queryset(request, queryset, view)

Main method for filtering query object

Parameters

• request (HttpRequest) – Request object from the view

• queryset – Query object for filtering

• view (View) – View where this filter backend is being used

Returns

Filtered query object if filtering class was determined by get_filter_class(). If not given queryset is returned.

Return type

object

get_filter_class(view, queryset=None)

Get filter class which will be used for filtering.

Parameters

• view (View) – DRF view/viewset where this filter backend is being used. Please refer to DRFFilterBackend documentation for list of attributes which can be supplied in view to customize how filterset will be determined.

• queryset – Query object for filtering

Returns

• FilterSet – FilterSet class either directly specified in the view or dynamically constructed for the queryset model.

• None – When appropriate FilterSet cannot be determined for filtering

get_filter_context(request, view)

Get context to be passed to FilterSet during initialization

Parameters

• request (HttpRequest) – Request object from the view

• view (View) – View where this filter backend is being used

Returns

Context to be passed to FilterSet

Return type

dict

django_ufilter.integrations.drf.URLFilterBackend

alias of django_ufilter.integrations.drf.DRFFilterBackend