Dans Django, comment filtrer un QuerySet avec des recherches de champs dynamiques ?

Question

Étant donné une classe :

from django.db import models

class Person(models.Model):
    name = models.CharField(max_length=20)

Est-il possible, et si oui comment, d'avoir un QuerySet qui filtre sur la base d'arguments dynamiques ? Par exemple :

 # Instead of:
 Person.objects.filter(name__startswith='B')
 # ... and:
 Person.objects.filter(name__endswith='B')

 # ... is there some way, given:
 filter_by = '{0}__{1}'.format('name', 'startswith')
 filter_value = 'B'

 # ... that you can run the equivalent of this?
 Person.objects.filter(filter_by=filter_value)
 # ... which will throw an exception, since `filter_by` is not
 # an attribute of `Person`.

Answer 1

L'expansion des arguments de Python peut être utilisée pour résoudre ce problème :

kwargs = {
    '{0}__{1}'.format('name', 'startswith'): 'A',
    '{0}__{1}'.format('name', 'endswith'): 'Z'
}

Person.objects.filter(**kwargs)

Il s'agit d'un idiome Python très courant et utile.

Answer 2

Un exemple simplifié :

Dans une application de sondage Django, je voulais une liste de sélection HTML montrant les utilisateurs enregistrés. Mais comme nous avons 5000 utilisateurs enregistrés, j'avais besoin d'un moyen de filtrer cette liste en fonction de critères de requête (par exemple, seulement les personnes qui ont terminé un certain atelier). Pour que l'élément d'enquête soit réutilisable, il fallait que la personne créant la question d'enquête puisse attacher ces critères à cette question (je ne voulais pas coder en dur la requête dans l'application).

La solution que j'ai trouvée n'est pas entièrement conviviale (elle nécessite l'aide d'un technicien pour créer la requête), mais elle résout le problème. Lors de la création de la question, l'éditeur peut entrer un dictionnaire dans un champ personnalisé, par ex :

{'is_staff':True,'last_name__startswith':'A',}

Cette chaîne est stockée dans la base de données. Dans le code de la vue, elle revient en tant que self.question.custom_query . La valeur de cela est une chaîne de caractères qui mira comme un dictionnaire. Nous le transformons en un réel avec eval() et ensuite l'insérer dans le queryset avec **kwargs :

kwargs = eval(self.question.custom_query)
user_list = User.objects.filter(**kwargs).order_by("last_name")

Answer 3

En plus de la réponse qui a fait quelques demandes pour d'autres éléments de code, j'en ajoute un que j'utilise dans mon code en utilisant Q. Disons que dans ma demande je peux avoir ou non des champs comme :

publisher_id
date_from
date_until

Ces champs peuvent apparaître dans la requête mais ils peuvent aussi être manqués. Voici comment je construis des filtres basés sur ces champs dans une requête agrégée qui ne peut pas être filtrée davantage après l'exécution de la requête initiale :

# prepare filters to apply to queryset
filters = {}
if publisher_id:
    filters['publisher_id'] = publisher_id
if date_from:
    filters['metric_date__gte'] = date_from
if date_until:
    filters['metric_date__lte'] = date_until

filter_q = Q(**filters)

queryset = Something.objects.filter(filter_q)...

J'espère que cela vous aidera, car j'ai passé pas mal de temps à déterrer tout ça.

Answer 4

Django.db.models.Q est exactement ce que vous voulez à la manière de Django.

Answer 5

Un formulaire de recherche très complexe indique généralement qu'un modèle plus simple tente de s'échapper.

Comment, exactement, pensez-vous obtenir les valeurs du nom de la colonne et de l'opération ? Où obtenez-vous les valeurs de 'name' un 'startswith' ?

 filter_by = '%s__%s' % ('name', 'startswith')

1. Un formulaire de "recherche" ? Vous allez quoi ? choisir le nom dans une liste de noms ? Choisir l'opération dans une liste d'opérations ? Bien qu'il soit ouvert, la plupart des gens trouvent cela déroutant et difficile à utiliser.

   Combien de colonnes disposent de tels filtres ? 6 ? 12 ? 18 ?

   • Quelques-uns ? Une liste de sélection complexe n'a pas de sens. Quelques champs et quelques instructions "si" suffisent.
   • Un grand nombre ? Votre modèle ne semble pas correct. Il semble que le "champ" soit en fait une clé pour une ligne d'une autre table, et non une colonne.
2. Boutons de filtre spécifiques. Attendez... C'est comme ça que fonctionne l'administration de Django. Les filtres spécifiques sont transformés en boutons. Et la même analyse que ci-dessus s'applique. Quelques filtres ont du sens. Un grand nombre de filtres signifie généralement une sorte de violation de la première forme normale.

Un grand nombre de champs similaires signifie souvent qu'il aurait dû y avoir plus de rangées et moins de champs.