안녕하세요 @loganknecht입니다. 이렇게 멋진 문제 보고서에 감사드립니다. 그것은 잘 시작하고 점점 좋아집니다. 너무 명확합니다. 감사합니다.

먼저 SchoolOrderingFilter 필드 이름을 o 정의한 것 같습니다.

o = SchoolOrderingFilter(...)

그래서 당신이 말할 때 :

내가 만드는 요청은 다음과 같습니다
{{API_URL}}/api/v1/schools/?offset=5&limit=3&ordering=learner_enrolled_count

쿼리 문자열 매개변수도 o 것으로 예상합니다. 이것이 작동합니까: {{API_URL}}/api/v1/schools/?offset=5&limit=3&o=learner_enrolled_count ?

그런 다음 (당신의 보고서에서 내가 확신할 수 없는 부분) 당신은 그것이 _계산된 필드_라고 말합니다 -- 정확히 무엇을 의미합니까? 즉, 모델에 나타나는 필드입니까, 아니면 Python 속성이 말하는 것입니까?

쿼리 세트의 order_by() 가 이 필드에서 작동하는지 묻는 (일부) 다른 방법은 무엇입니까? 즉, 이 작업을 수행합니다.

SchoolModel.objects.filter(...).order_by(learner_enrolled_count)

@carltongibson 꽤 흥미 o 이 정의된 ordering 매개변수가 될 것이라고 예상하지 못했습니다! 나는 문서에서 그것을 이해하지 못했습니다 😂

o 매개변수 사용

흥미로운 점은 쿼리를 사용하면
{{API_URL}}/api/v1/schools/?offset=5&limit=3&o=learner_enrolled_count

나는 다음과 같은 결과를 얻습니다.

{
    "schools": [
        {
            "id": 6,
            "name": "Piano Gym Six",
            "courses": [
                # ...
            ],
            "learner_enrolled_count": 0
        },
        {
            "id": 8,
            "name": "Piano Gym Eight",
            "courses": [
                # ...
            ],
            "learner_enrolled_count": 0
        },
        {
            "id": 9,
            "name": "Piano Gym Nine",
            "courses": [
                # ...
            ],
            "learner_enrolled_count": 0
        }
    ]
}

이것에 대한 흥미로운 부분은 이제 내가 맨 위에 주문하고 싶은 학교가 이 검색 결과에 없다는 것입니다. 이것은 이것이 주문되었을 가능성이 있지만 페이지 매김이 결과를 여전히 상쇄하고 있음을 의미합니다. 그러나 learner_enrolled_count 사용했을 때 마지막 지점에 있습니다.
{{API_URL}}/api/v1/schools/?limit=3&o=learner_enrolled_count

그래서 -learner_enrolled_count (오프셋 제거 및 내림차순 정렬)를 사용하여 테스트했습니다.
{{API_URL}}/api/v1/schools/?limit=3&o=-learner_enrolled_count
그리고 이 응답을 받았습니다

{
    "schools": [
        {
            "id": 7,
            "name": "Piano Gym Seven",
            "courses": [
                # ...
            ],
            "learner_enrolled_count": 1
        },
        {
            "id": 1,
            "name": "Piano Gym",
            "courses": [
                # ...
            ],
            "learner_enrolled_count": 0
        },
        {
            "id": 2,
            "name": "Piano Gym Two",
            "courses": [
                # ...
            ],
            "learner_enrolled_count": 0
        }
    ]
}

효과가 있었던 것 같습니다!

계산된 필드

learner_enrolled_count 은(는) 모델 자체에 존재하지 않습니다. 주석을 사용하여 이것을 계산하고 결과에 삽입했습니다.

데이터 모델을 너무 많이 다룰 위험이 있는 이 끝점은 학교 목록에 대한 쿼리를 필터링하고 정렬하기 위한 단일 진입점입니다.

다음과 같은 모델 검색을 사용하여 이 끝점을 최적화해야 합니다.

class SchoolModelManager(Manager):
    def getBrowseSchoolsData(self, *args, **kwargs):
        """Return all Schools that contain lessons with flash card sets.

        Does not exclude empty sets, just requires that the school has something
        to enroll in
        """
        # WARNING: This MUST be imported here otherwise the compilation fails
        #          because of circular dependencies
        from piano_gym_api.versions.v1.models.flash_card_model import FlashCardModel
        # from piano_gym_api.versions.v1.models.flash_card_model import PlaySheetMusicFlashCardModel
        # from piano_gym_api.versions.v1.models.flash_card_model import TrueOrFalseFlashCardModel
        # from piano_gym_api.versions.v1.models.flash_card_set_model import FlashCardSetModel
        from piano_gym_api.versions.v1.models.sheet_music_model import SheetMusicModel
        # import pdb
        # pdb.set_trace()

        # --------------------
        sheet_music_query_set = (SheetMusicModel.objects.all()
                                 .select_related("school"))
        play_sheet_music_flash_card_sheet_music_prefetch = Prefetch("playsheetmusicflashcardmodel__sheet_music",
                                                                    sheet_music_query_set)
        # --------------------
        flash_card_query_set = (FlashCardModel.objects.all()
                                .select_related("flash_card_set",
                                                "playsheetmusicflashcardmodel",
                                                "school",
                                                "trueorfalseflashcardmodel")
                                .prefetch_related(play_sheet_music_flash_card_sheet_music_prefetch))
        flash_card_prefetch = Prefetch("flash_card_set__flash_card", flash_card_query_set)
        # --------------------
        school_lesson_query_set = (SchoolLessonModel.objects.all()
                                   .select_related("course",
                                                   "flash_card_set",
                                                   "school")
                                   .prefetch_related(flash_card_prefetch))
        school_lesson_prefetch = Prefetch("school_lesson", school_lesson_query_set)
        # --------------------
        school_course_query_set = (SchoolCourseModel.objects.all()
                                   .select_related("school")
                                   .prefetch_related(school_lesson_prefetch))
        school_course_prefetch = Prefetch("school_course", school_course_query_set)
        # --------------------
        query_set_to_return = (SchoolModel.objects.filter(school_lesson__flash_card_set__isnull=False)
                               .distinct()
                               # .annotate(learner_enrolled_count=Count("learner_enrolled_school", distinct=True))
                               .annotate(learner_enrolled_count=Case(
                                   When(learner_enrolled_school__learner_enrolled_course__learner_enrolled_lesson__is_enrolled=True,
                                        then=1),
                                   default=0,
                                   output_field=IntegerField())
        ).prefetch_related(school_course_prefetch))

        return query_set_to_return

calculated field 비트는 query_set_to_return 변수에 있습니다. 그것이 하는 일은 등록된 총 학습자 중 count 를 annotates learner_enrolled_count 필드로 가져오는 것입니다. 이것이 이것을 달성하는 올바른 방법인지 모르겠지만 작동하는 것 같습니다 😂

제안

내가 제안하는 한 가지 제안은 요청에 대한 실제 URL 예제나 간단한 텍스트를 사용하여 문서에서 명확히 하고 예제의 o 가 주문을 위한 매개변수로 노출되는 것임을 설명하는 것입니다.

결론

o 매개변수가 순서 지정 필터가 할당되는 매개변수임을 명확히 했기 때문에 이제 올바르게 작동하는 것으로 보입니다!

querysets 대해 제공하는 filter 이미 주석 필드가 있는 경우 - 테스트 결과, 나만의 사용자 정의 OrderingFilter 를 만들 의무가 없는 것으로 보입니다

그래서 저는 대신 간단한 OrderingFilter 를 사용할 수 있다고 생각합니다!

내가 틀렸다면 지적해주세요!

나는 그것이 내 혼란을 해결한다고 믿습니다! 감사합니다!

안녕하세요 @loganknecht입니다. 슈퍼, 작동하는 것 같습니다. 💃

주석을 사용하는 경우 표준 클래스 yes를 사용하여 주석을 필터링하고 정렬할 수 있어야 합니다.

문서를 수정하겠습니다.

입력해 주셔서 감사합니다.

@carltongibson 과 다른 모든 사람들, 놀라운 라이브러리에 감사드립니다!