Hai @loganknecht. Saya harus mengatakan, terima kasih atas laporan masalah yang luar biasa. Ini dimulai dengan baik, dan menjadi lebih baik. Hanya begitu jelas. Jadi terima kasih.

Pertama: sepertinya Anda mendefinisikan SchoolOrderingFilter dengan nama bidang o :

o = SchoolOrderingFilter(...)

Jadi ketika Anda mengatakan:

Permintaan yang saya buat terlihat seperti ini
{{API_URL}}/api/v1/schools/?offset=5&limit=3&ordering=learner_enrolled_count

Saya mengharapkan parameter string kueri menjadi o juga. Apakah ini berfungsi: {{API_URL}}/api/v1/schools/?offset=5&limit=3&o=learner_enrolled_count ?

Kemudian (sedikit yang saya tidak yakin dalam laporan Anda) Anda mengatakan itu _bidang yang dihitung_ -- apa sebenarnya yang Anda maksud? yaitu apakah itu bidang yang muncul pada model, atau apakah itu properti Python?

Cara bertanya lain (bagian dari) yaitu apakah order_by() pada queryset berfungsi dengan bidang ini? yaitu apakah ini bekerja:

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

@carltongibson Itu cukup menarik! Saya tidak berharap o menjadi parameter ordering ditentukan! Saya tidak mengerti itu dari dokumentasi 😂

Menggunakan parameter o

Yang menarik adalah jika saya menggunakan kueri
{{API_URL}}/api/v1/schools/?offset=5&limit=3&o=learner_enrolled_count

Saya mendapatkan hasil ini:

{
    "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
        }
    ]
}

Yang menarik dari ini, sekarang sekolah yang ingin saya urutkan paling atas tidak ada di hasil pencarian ini. Yang berarti bahwa ini mungkin dipesan tetapi pagination masih mengimbangi hasilnya. Namun ketika saya menggunakan learner_enrolled_count itu di tempat terakhir.
{{API_URL}}/api/v1/schools/?limit=3&o=learner_enrolled_count

Jadi saya menggunakan mengujinya menggunakan -learner_enrolled_count (menghapus offset dan mengurutkan dengan turun)
{{API_URL}}/api/v1/schools/?limit=3&o=-learner_enrolled_count
dan mendapat tanggapan ini

{
    "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
        }
    ]
}

Sepertinya itu berhasil!

Bidang Komputasi

learner_enrolled_count tidak ada pada model itu sendiri. Saya menggunakan anotasi untuk menghitung ini dan memasukkannya ke dalam hasil.

Dengan risiko menyelami model data terlalu banyak, titik akhir ini dimaksudkan sebagai titik masuk tunggal untuk memfilter dan memesan kueri untuk daftar sekolah.

Saya harus mengoptimalkan titik akhir ini menggunakan pengambilan model seperti ini:

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

The calculated field bit adalah di query_set_to_return variabel. Apa yang dilakukannya adalah mengambil count dari total pelajar yang terdaftar dan annotates ke bidang learner_enrolled_count . Saya tidak tahu apakah ini cara yang benar untuk mencapai ini, tetapi tampaknya berhasil 😂

Saran

Satu saran yang akan saya buat adalah mengklarifikasi dalam dokumentasi, baik menggunakan contoh url aktual untuk permintaan atau teks sederhana dan menjelaskan bahwa o dalam contoh adalah apa yang diekspos sebagai parameter untuk pemesanan.

Kesimpulan

Tampaknya berfungsi dengan benar sekarang setelah Anda mengklarifikasi parameter o adalah apa yang ditugaskan oleh filter pemesanan!

Jika querysets saya sediakan untuk filter sudah memiliki bidang beranotasi di dalamnya - tampaknya, dari pengujian saya, saya tidak berkewajiban membuat OrderingFilter kustom saya sendiri

Jadi karena itu saya pikir saya bisa menggunakan OrderingFilter saja!

Tolong koreksi saya jika saya salah!

Saya percaya itu memecahkan kebingungan saya! Terima kasih!

Hai @loganknecht. Super, sepertinya Anda berhasil. 💃

Jika Anda menggunakan anotasi maka Anda harus dapat memfilter dan memesannya dengan kelas standar ya.

Saya akan membuat tweak ke dokumen.

Terima kasih atas masukan Anda.

@carltongibson dan semua orang, terima kasih untuk perpustakaan yang luar biasa!