Django-filter: Benutzerdefinierte Namen in der URL für Abfrageparameter des Bereichsfilters?

Erstellt am 20. Sept. 2015  ·  3Kommentare  ·  Quelle: carltongibson/django-filter

Ich habe mich gefragt, ob es möglich ist, die in der URL verwendeten Feldnamen für Abfrageparameter umzubenennen.
Zur Zeit

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

und die Anfrage sieht aus wie

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

Das funktioniert einwandfrei, ist aber nicht sehr intuitiv. Ich habe mich gefragt, ob ich zum Beispiel verschiedene Namen für die Bereichsfelder verwenden kann

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

Danke Haki.

Hilfreichster Kommentar

Hier ist ein Beispiel für die Unterklassen von MultiWidget , um dies zu tun; Als Feldnamen habe ich start und end verwendet:

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

Alle 3 Kommentare

Hmmm. Ich denke, die Antwort hier ist _nicht wirklich_ – es sei denn, Sie wollen sich die Hände schmutzig machen …

Die Logik für die Anhänge _0, _1 stammt vollständig von django.forms.widgets.MultiWidget.render . ( RangeFilter verwendet RangeField , das RangeWidget verwendet, was eine Unterklasse MultiWidget ist.)

Es steht Ihnen frei, render zu implementieren, um die gewünschte Benennung zu erhalten. Sie benötigen auch ein passendes value_from_datadict .

Hier ist ein Beispiel für die Unterklassen von MultiWidget , um dies zu tun; Als Feldnamen habe ich start und end verwendet:

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

Hey @beaugunderson , erwähnenswert ist, dass es in einigen Fällen (wie in meinem) einfacher ist, zwei Datumsfelder mit lt / gt zu verwenden.

War diese Seite hilfreich?
0 / 5 - 0 Bewertungen