Django-filter: Nomes personalizados no URL para parâmetros de consulta do filtro de intervalo?

Criado em 20 set. 2015  ·  3Comentários  ·  Fonte: carltongibson/django-filter

Eu queria saber se é possível renomear os nomes dos campos usados ​​na URL para parâmetros de consulta.
Atualmente

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

e o pedido parece

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

Isso está funcionando corretamente, mas não é muito intuitivo. Eu queria saber se existe alguma maneira de usar nomes diferentes para os campos de intervalo, por exemplo

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

Obrigado, Haki.

Comentários muito úteis

Aqui está um exemplo de subclasse MultiWidget para fazer isso; Eu usei start e end como os nomes dos campos:

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

Todos 3 comentários

Hmmm. Eu acho que a resposta aqui é _não realmente_ – a menos que você queira sujar as mãos...

A lógica para os apêndices _0, _1 vem de django.forms.widgets.MultiWidget.render . ( RangeFilter usa RangeField que usa RangeWidget que é uma subclasse MultiWidget .)

Você pode implementar render para obter a nomenclatura desejada. Você precisaria de um value_from_datadict correspondente também.

Aqui está um exemplo de subclasse MultiWidget para fazer isso; Eu usei start e end como os nomes dos campos:

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

Ei @beaugunderson , vale a pena mencionar que em alguns casos (como o meu) é mais fácil usar dois campos de data com lt / gt .

Esta página foi útil?
0 / 5 - 0 avaliações