Django-filter: Не удается отфильтровать обратный внешний ключ

Созданный на 22 июн. 2020  ·  10Комментарии  ·  Источник: carltongibson/django-filter

Введение

Привет! Большое спасибо за эту библиотеку! Было так приятно протестировать его с моим текущим API!

Текущая цель

У меня есть две модели: School и SchoolCourse . SchoolCourse имеет обратное отношение «многие к одному» к School .

Я хочу иметь возможность фильтровать объект School на основе name объекта SchoolCourse

Кроме того, в качестве дополнительной цели я хотел бы иметь возможность в конечном итоге фильтровать по SchoolLesson .

Модель данных

Школьная модель

class SchoolModel(Model):
    name = CharField(max_length=24, unique=True)

    REQUIRED_FIELDS = ["name"]

    class Meta:
        ordering = ("id",)

    def get_courses(self):
        school_courses = SchoolCourseModel.objects.filter(school=self)
        return school_courses

Школьный курс

class SchoolCourseModel(Model):
    description = CharField(default="", max_length=200)
    name = CharField(max_length=50)
    school = ForeignKey(SchoolModel,
                        related_name="school_course",
                        on_delete=CASCADE)

    REQUIRED_FIELDS = ["school", "name"]

    class Meta:
        ordering = ("id",)
        unique_together = ("school", "name",)

    def get_lessons(self):
        school_lessons = SchoolLessonModel.objects.filter(course=self)
        return school_lessons

Что - если вы поиграете с этими моделями в представлении отладки, вы увидите это

all_school_models[50].school_course
(Pdb++) <django.db.models.fields.related_descriptors.create_reverse_many_to_one_manager.<locals>.RelatedManager object at 0x10a8177d0>
all_school_models[50].school_course.all()
(Pdb++) <QuerySet [<SchoolCourseModel: SchoolCourseModel object (151)>, <SchoolCourseModel: SchoolCourseModel object (152)>, <SchoolCourseModel: SchoolCourseModel object (153)>]>
all_school_models[50].school_course.all()[0]
(Pdb++) <SchoolCourseModel: SchoolCourseModel object (151)>
all_school_models[50].school_course.all()[0].name
(Pdb++) 'Nihongo Course One'

Конфигурация фильтра

Фильтр, который я сделал, кажется довольно простым.

class SchoolFilter(FilterSet):
    school_name = CharFilter(field_name="name",
                             lookup_expr="icontains")
    # ---
    course_name = CharFilter(field_name="school_course__name",
                             lookup_expr="icontains")
    course_description = CharFilter(field_name="school_course__description",
                                    lookup_expr="icontains")

    class Meta:
        model = SchoolModel
        fields = [
            "school_name",
            # ---
            "course_name",
            "course_description"
        ]

Проблема

Однако это не работает. Если я сделаю этот запрос:
{{API_URL}}/api/v1/schools/?course_name=Nihongo

Я получаю это обратно в качестве ответа

{
    "schools": []
}

Вопросы

Что я здесь делаю неправильно?

Я неправильно истолковываю фильтры django? Я неправильно понимаю, как подключить модели данных?

Любое руководство приветствуется!

Самый полезный комментарий

Я предполагаю, что это связано с данным смещением. В отфильтрованном наборе запросов есть только 1 объект, но запрос указывает пагинатору пропустить первые 49 элементов. Если бы вы проверили

print(filtered_school_models[49:])

Я предполагаю, что вы получите <QuerySet []> .

Закрытие, так как это похоже на проблему с нумерацией страниц.

Все 10 Комментарий

Привет @loganknecht. Можете ли вы проверить правильность своего URL-адреса в качестве проверки работоспособности? В вашем примере URL-адреса строка запроса начинается с / вместо ? .

Ах, @rpkilby - извиняюсь, это была моя оплошность из-за копирования и вставки из Postman . URL-адрес на самом деле {{API_URL}}/api/v1/schools/?offset=49&course_name=Nihongo , но я удалил offset , чтобы не запутаться, и мне удалось сделать наоборот 😂

Ваш пример не вызывает у меня никаких очевидных проблем. Я думаю, что есть проблема с представлением API. Вы добавили DjangoFilterBackend в свои настройки/представление filter_backends ? И вы установили filterset_class = SchoolFilter (обратите внимание, что раньше это было filter_class )?

Привет @rpkilby

Вот код просмотра, который у меня есть

class SchoolViewSet(ViewSet):
    http_method_names = ["get", "post"]

    def list(self, request):
        all_school_models = SchoolModel.objects.all()

        filtered_school_models = SchoolFilter(request.GET, queryset=all_school_models)
        # import pdb
        # pdb.set_trace()

        paginator = HeaderLinkPagination()
        current_page_results = paginator.paginate_queryset(filtered_school_models.qs,
                                                           request)

        all_schools_serializer = SchoolSerializer(current_page_results,
                                                  many=True)
        response_data = {
            "schools": all_schools_serializer.data
        }

        response_to_return = paginator.get_paginated_response(response_data)
        return response_to_return

В pdb.set_trace() я разместил вышеупомянутый допрос.

Я не устанавливал DjangoFilterBackend , так как предполагал, что это глобальная конфигурация, и я тестирую ее только на одной конечной точке.

Кроме того, я не устанавливал это для класса по той же причине.

Важно знать, что я МОГУ использовать этот фильтр по имени SchoolModel , но когда я фильтрую по обратному внешнему ключу school_course , он не работает.

Попался - так что вы создаете набор фильтров непосредственно в представлении. В этом случае, да, вам не нужно будет устанавливать класс бэкенда/набора фильтров.

Вы можете проверить, правильно ли выглядят данные, есть ли какие-либо ошибки или правильно ли сформирован SQL-запрос. Пытаться:

filtered_school_models = SchoolFilter(request.GET, queryset=all_school_models)
print(filtered_school_models.data)
print(filtered_school_models.errors)
print(filtered_school_models.qs)
print(str(filtered_school_models.qs.query))

@rpkilby Вот что я вижу

<QueryDict: {'offset': ['49'], 'course_name': ['Nihongo']}>

<QuerySet [<SchoolModel: SchoolModel object (51)>]>
SELECT "piano_gym_api_schoolmodel"."id", "piano_gym_api_schoolmodel"."name", "piano_gym_api_schoolmodel"."school_board_id" FROM "piano_gym_api_schoolmodel" INNER JOIN "piano_gym_api_schoolcoursemodel" ON ("piano_gym_api_schoolmodel"."id" = "piano_gym_api_schoolcoursemodel"."school_id") WHERE UPPER("piano_gym_api_schoolcoursemodel"."name"::text) LIKE UPPER(%Nihongo%) ORDER BY "piano_gym_api_schoolmodel"."id" ASC

@rpkilby Похоже, это проблема с моей реализацией пагинатора, которая выглядит так

class HeaderLinkPagination(LimitOffsetPagination):
    default_limit = settings.DEFAULT_LIMIT
    max_limit = settings.DEFAULT_MAX_LIMIT
    min_limit = settings.DEFAULT_MIN_LIMIT
    min_offset = settings.DEFAULT_MIN_OFFSET
    max_offset = settings.DEFAULT_MAX_OFFSET

    def get_paginated_response(self, data):
        next_url = self.get_next_link()
        previous_url = self.get_previous_link()

        links = []
        header_data = (
            (previous_url, "prev"),
            (next_url, "next"),
        )
        for url, label in header_data:
            if url is not None:
                links.append("<{}>; rel=\"{}\"".format(url, label))

        headers = {"Link": ", ".join(links)} if links else {}

        return Response(data, headers=headers)

    def paginate_queryset(self, queryset, request, view=None):

        limit = request.query_params.get("limit")
        offset = request.query_params.get("offset")

        if limit is None:
            limit = settings.DEFAULT_LIMIT

        if offset is None:
            offset = settings.DEFAULT_OFFSET

        limit = int(limit)
        if limit > self.max_limit:
            error_message = ("Limit should be less than or equal to {0}"
                             ).format(self.max_limit)
            errors = {"limit": [error_message]}
            raise ValidationError(errors)
        elif limit < self.min_limit:
            error_message = ("Limit should be greater than or equal to {0}"
                             ).format(self.min_limit)
            errors = {"limit": [error_message]}
            raise ValidationError(errors)

        offset = int(offset)
        if offset > self.max_offset:
            error_message = ("Offset should be less than or equal to {0}"
                             ).format(self.max_offset)
            errors = {"offset": [error_message]}
            raise ValidationError(errors)
        elif offset < self.min_offset:
            error_message = ("Offset should be greater than or equal to {0}"
                             ).format(self.min_offset)
            errors = {"offset": [error_message]}
            raise ValidationError(errors)
        import pdb
        pdb.set_trace()

        return super(self.__class__, self).paginate_queryset(queryset, request, view)

Если вы видите решение, пожалуйста, дайте мне знать. Оставайтесь с нами, пока я пытаюсь избавиться от этого.

Я предполагаю, что это связано с данным смещением. В отфильтрованном наборе запросов есть только 1 объект, но запрос указывает пагинатору пропустить первые 49 элементов. Если бы вы проверили

print(filtered_school_models[49:])

Я предполагаю, что вы получите <QuerySet []> .

Закрытие, так как это похоже на проблему с нумерацией страниц.

Привет @rpkilby

Я просто хочу сказать вам большое спасибо за то, что рассказали мне об этом. Это даже не проблема django-filter . Я просто был придурком. То, что ты уклоняешься от меня, очень ценится.

Вы потрясающие, и еще раз спасибо за эту замечательную библиотеку!

Не беспокойся. Рад помочь!

Была ли эта страница полезной?
0 / 5 - 0 рейтинги