Salut @loganknecht. Je dois dire, merci pour ce merveilleux rapport de problème. Cela commence bien et s'améliore. Tellement clair. Alors merci.

Tout d'abord : il semble que vous ayez défini le SchoolOrderingFilter avec le nom de champ o :

o = SchoolOrderingFilter(...)

Alors quand tu dis :

La demande que je fais ressemble à ça
{{API_URL}}/api/v1/schools/?offset=5&limit=3&ordering=learner_enrolled_count

Je m'attends à ce que le paramètre de chaîne de requête soit également o . Est-ce que ça marche : {{API_URL}}/api/v1/schools/?offset=5&limit=3&o=learner_enrolled_count ?

Ensuite (le peu dont je ne suis pas sûr dans votre rapport) vous dites que c'est un _champ calculé_ -- que voulez-vous dire exactement ? c'est-à-dire est-ce un champ qui apparaît sur le modèle, ou est-ce une propriété Python disons ?

Une autre façon de demander (une partie de) est-ce que order_by() sur le jeu de requêtes fonctionne avec ce champ ? c'est-à-dire est-ce que ça marche:

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

@carltongibson C'est assez intéressant ! Je ne m'attendais pas à ce que o soit le paramètre ordering défini ! Je n'ai pas compris ça dans la documentation

Utilisation du paramètre o

Ce qui est intéressant, c'est si j'utilise la requête
{{API_URL}}/api/v1/schools/?offset=5&limit=3&o=learner_enrolled_count

J'obtiens ces résultats :

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

La partie intéressante à ce sujet est maintenant que l'école que je veux être classée en haut n'est pas dans ce résultat de recherche. Ce qui signifie que cela a probablement été commandé mais que la pagination compense toujours les résultats. Cependant, lorsque j'ai utilisé learner_enrolled_count c'est à la dernière place.
{{API_URL}}/api/v1/schools/?limit=3&o=learner_enrolled_count

Je l'ai donc testé en utilisant le -learner_enrolled_count (en supprimant le décalage et en triant par ordre décroissant)
{{API_URL}}/api/v1/schools/?limit=3&o=-learner_enrolled_count
et j'ai eu cette réponse

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

On dirait que ça a marché !

Champ calculé

learner_enrolled_count n'existe pas sur le modèle lui-même. J'ai utilisé une annotation pour calculer cela et l'injecter dans les résultats.

Au risque de trop plonger dans le modèle de données, ce point de terminaison est censé être un point d'entrée unique pour filtrer et ordonner les requêtes pour une liste d'écoles.

Je dois optimiser ce point de terminaison en utilisant la récupération de modèle comme ceci :

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

Le bit calculated field est dans la variable query_set_to_return . Il prend le count du total des apprenants inscrits et le annotates dans le champ learner_enrolled_count . Je ne sais pas si c'est la bonne façon d'y parvenir, mais cela semble fonctionner

Suggestion

Une suggestion que je ferais est de clarifier dans la documentation, soit en utilisant des exemples d'URL réels pour les demandes, soit du texte simple et d'expliquer que le o dans les exemples est ce qui est exposé comme paramètre de commande.

Conclusion

Cela semble fonctionner correctement maintenant que vous avez clarifié le paramètre o auquel le filtre de classement est affecté !

Si le querysets que je fournis pour le filter déjà un champ annoté - il semble, d'après mes tests, que je ne suis pas obligé de créer mon propre OrderingFilter .

Donc, à cause de cela, je pense que je peux simplement utiliser un simple OrderingFilter place !

Corrigez-moi si j'ai tort, s'il-vous plait!

Je crois que cela résout ma confusion! Merci!

Salut @loganknecht. Super, on dirait que ça marche. ??

Si vous utilisez une annotation, vous devriez pouvoir filtrer et ordonner celle-ci avec la classe standard yes.

Je vais faire un tweak à la doc.

Merci pour votre contribution.

@carltongibson et tous les autres, merci pour l'incroyable bibliothèque !