Hallo @loganknecht. Ich muss sagen, vielen Dank für diesen wunderbaren Themenbericht. Es fängt gut an und wird immer besser. Einfach so klar. Also vielen Dank.

Zunächst einmal: Es sieht so aus, als ob Sie SchoolOrderingFilter mit dem Feldnamen o :

o = SchoolOrderingFilter(...)

Also wenn du sagst:

Meine Anfrage sieht so aus
{{API_URL}}/api/v1/schools/?offset=5&limit=3&ordering=learner_enrolled_count

Ich erwarte, dass der Abfragezeichenfolgenparameter auch o ist. Funktioniert das: {{API_URL}}/api/v1/schools/?offset=5&limit=3&o=learner_enrolled_count ?

Dann (wobei ich mir in Ihrem Bericht unsicher bin) sagen Sie, es sei ein _berechnetes Feld_ -- was genau meinst du? Dh ist es ein Feld, das im Modell angezeigt wird, oder ist es eine Python-Eigenschaft, sagen wir?

Eine andere Möglichkeit, (einen Teil davon) zu fragen, ist, ob order_by() im Abfragesatz mit diesem Feld funktioniert? dh funktioniert das:

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

@carltongibson Das ist ziemlich interessant! Ich habe nicht erwartet, dass o der definierte Parameter ordering ist! Das habe ich aus der Dokumentation nicht verstanden 😂

Verwenden des Parameters o

Interessant ist, wenn ich die Abfrage verwende
{{API_URL}}/api/v1/schools/?offset=5&limit=3&o=learner_enrolled_count

Ich bekomme diese Ergebnisse:

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

Das Interessante daran ist, dass jetzt die eine Schule, die ich ganz oben ordnen möchte, nicht in diesem Suchergebnis enthalten ist. Das bedeutet, dass dies wahrscheinlich bestellt wurde, aber die Paginierung gleicht die Ergebnisse noch aus. Wenn ich jedoch learner_enrolled_count es an der letzten Stelle.
{{API_URL}}/api/v1/schools/?limit=3&o=learner_enrolled_count

Also habe ich es mit dem -learner_enrolled_count getestet (Entfernen des Offsets und Sortieren nach absteigend)
{{API_URL}}/api/v1/schools/?limit=3&o=-learner_enrolled_count
und habe diese antwort bekommen

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

Es sieht so aus, als hätte es funktioniert!

Berechnetes Feld

learner_enrolled_count existiert nicht auf dem Modell selbst. Ich habe eine Annotation verwendet, um dies zu berechnen und in die Ergebnisse einzufügen.

Da die Gefahr besteht, dass Sie zu sehr in das Datenmodell eintauchen, ist dieser Endpunkt als einzelner Einstiegspunkt zum Filtern und Ordnen von Abfragen für eine Liste von Schulen gedacht.

Ich muss diesen Endpunkt mithilfe des Modellabrufs wie folgt optimieren:

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

Das Bit calculated field befindet sich in der Variablen query_set_to_return . Es nimmt die count der gesamten eingeschriebenen Lernenden und annotates in das Feld learner_enrolled_count . Ich habe keine Ahnung, ob das der richtige Weg ist, aber es scheint zu funktionieren 😂

Anregung

Ein Vorschlag, den ich machen würde, besteht darin, dies in der Dokumentation klarzustellen, indem Sie entweder tatsächliche URL-Beispiele für Anforderungen oder einfachen Text verwenden und erklären, dass o in den Beispielen als Parameter für die Bestellung bereitgestellt wird.

Abschluss

Es scheint jetzt richtig zu funktionieren, da Sie den Parameter o geklärt haben, dem der Sortierfilter zugewiesen wird!

Wenn die querysets ich für die filter bereitstelle, bereits ein kommentiertes Feld enthalten - aus meinen Tests sieht es so aus, dass ich nicht verpflichtet bin, meine eigenen benutzerdefinierten OrderingFilter .

Deshalb denke ich, dass ich stattdessen einfach ein einfaches OrderingFilter verwenden kann!

Bitte korrigiere mich wenn ich falsch liege!

Ich glaube, das löst meine Verwirrung! Dankeschön!

Hallo @loganknecht. Super, sieht so aus, als ob es bei dir funktioniert. 💃

Wenn Sie eine Annotation verwenden, sollten Sie diese mit der Standardklasse yes filtern und sortieren können.

Ich werde die Dokumente anpassen.

Danke für deinen Beitrag.

@carltongibson und alle anderen, danke für die tolle Bibliothek!