Django-filter: ¿Nombres personalizados en la URL para los parámetros de consulta del filtro de rango?

Creado en 20 sept. 2015 · 3Comentarios · Fuente: carltongibson/django-filter

Me preguntaba si es posible cambiar el nombre de los campos utilizados en la URL para los parámetros de consulta.
Actualmente

class TransactionFilter(django_filters.FilterSet):
    created = django_filters.DateFromToRangeFilter()
    class Meta:
        model = models.Transaction
        fields = ('created', )

y la solicitud parece

/api/transaction?created_0=2015-01-01&created_1=2015-01-02

Esto está funcionando correctamente, pero no es muy intuitivo. Me preguntaba si hay alguna forma en que pueda usar diferentes nombres para los campos de rango, por ejemplo

/api/transaction?created_since=2015-01-01&created_until=2015-01-02

Gracias Haki.

Fuente

hakib

❤1

Comentario más útil

Aquí hay un ejemplo de subclase MultiWidget para hacer esto; Usé start y end como nombres de campo:

from django.utils.safestring import mark_safe

from django_filters.fields import DateRangeField
from django_filters.filters import RangeFilter
from django_filters.widgets import RangeWidget


class StartEndRangeWidget(RangeWidget):
    """
    A range widget that uses 'start' and 'end' instead of '0' and '1'.
    """

    attr_names = ('start', 'end')

    def render(self, name, value, attrs=None):
        if self.is_localized:
            for widget in self.widgets:
                widget.is_localized = self.is_localized

        # value is a list of values, each corresponding to a widget
        # in self.widgets.
        if not isinstance(value, list):
            value = self.decompress(value)

        output = []
        final_attrs = self.build_attrs(attrs)
        id_ = final_attrs.get('id')

        for i, widget in enumerate(self.widgets):
            try:
                widget_value = value[i]
            except IndexError:
                widget_value = None

            if id_:
                final_attrs = dict(final_attrs,
                                   id='%s_%s' % (id_, self.attr_names[i]))

            output.append(widget.render(name + '_%s' % self.attr_names[i],
                                        widget_value, final_attrs))

        return mark_safe(self.format_output(output))

    def value_from_datadict(self, data, files, name):
        return [widget.value_from_datadict(data, files,
                                           name + '_%s' % self.attr_names[i])
                for i, widget in enumerate(self.widgets)]


class StartEndDateRangeField(DateRangeField):
    """
    A DateRangeField that uses 'start' and 'end'.
    """

    widget = StartEndRangeWidget


class StartEndDateFromToRangeFilter(RangeFilter):
    """
    A RangeFilter that uses 'start' and 'end'.
    """

    field_class = StartEndDateRangeField

beaugunderson en 20 feb. 2016

👍3

Todos 3 comentarios

Mmm. Creo que la respuesta aquí es _no realmente_, a menos que quieras ensuciarte las manos...

La lógica para los apéndices _0, _1 viene desde django.forms.widgets.MultiWidget.render . ( RangeFilter usa RangeField que usa RangeWidget que es una subclase MultiWidget ).

Eres libre de implementar render para obtener el nombre que deseas. También necesitaría value_from_datadict correspondientes.

carltongibson en 20 sept. 2015

Aquí hay un ejemplo de subclase MultiWidget para hacer esto; Usé start y end como nombres de campo:

from django.utils.safestring import mark_safe

from django_filters.fields import DateRangeField
from django_filters.filters import RangeFilter
from django_filters.widgets import RangeWidget


class StartEndRangeWidget(RangeWidget):
    """
    A range widget that uses 'start' and 'end' instead of '0' and '1'.
    """

    attr_names = ('start', 'end')

    def render(self, name, value, attrs=None):
        if self.is_localized:
            for widget in self.widgets:
                widget.is_localized = self.is_localized

        # value is a list of values, each corresponding to a widget
        # in self.widgets.
        if not isinstance(value, list):
            value = self.decompress(value)

        output = []
        final_attrs = self.build_attrs(attrs)
        id_ = final_attrs.get('id')

        for i, widget in enumerate(self.widgets):
            try:
                widget_value = value[i]
            except IndexError:
                widget_value = None

            if id_:
                final_attrs = dict(final_attrs,
                                   id='%s_%s' % (id_, self.attr_names[i]))

            output.append(widget.render(name + '_%s' % self.attr_names[i],
                                        widget_value, final_attrs))

        return mark_safe(self.format_output(output))

    def value_from_datadict(self, data, files, name):
        return [widget.value_from_datadict(data, files,
                                           name + '_%s' % self.attr_names[i])
                for i, widget in enumerate(self.widgets)]


class StartEndDateRangeField(DateRangeField):
    """
    A DateRangeField that uses 'start' and 'end'.
    """

    widget = StartEndRangeWidget


class StartEndDateFromToRangeFilter(RangeFilter):
    """
    A RangeFilter that uses 'start' and 'end'.
    """

    field_class = StartEndDateRangeField

beaugunderson en 20 feb. 2016

👍3

Hola @beaugunderson , vale la pena mencionar que en algunos casos (como el mío) es más fácil usar dos campos de fecha con lt / gt.

hakib en 20 feb. 2016

¿Fue útil esta página

0 / 5 - 0 calificaciones