Les classes documentées ci-dessous permettent d’exploiter dans Django les fonctions fournies par la base de données sous-jacente telles que les annotations, les agrégations ou les filtres. Les fonctions sont également des expressions, elles peuvent donc être utilisées et combinées avec d’autres expressions comme les fonctions d’agrégation.
\nNous allons utiliser le modèle suivant dans les exemples de chaque fonction :
\nclass Author(models.Model):\n name = models.CharField(max_length=50)\n age = models.PositiveIntegerField(null=True, blank=True)\n alias = models.CharField(max_length=50, null=True, blank=True)\n goes_by = models.CharField(max_length=50, null=True, blank=True)\nNous ne recommandons généralement pas de définir null=True pour les champs CharField car cela permet au champ de posséder deux valeurs « vides » différentes, mais nous l’utilisons ici pour l’exemple Coalesce ci-dessous.
CastLien vers cette rubrique#Force le type de résultat de expression à celui de output_field.
Exemple d’utilisation :
\n>>> from django.db.models import FloatField\n>>> from django.db.models.functions import Cast\n>>> Value.objects.create(integer=4)\n>>> value = Value.objects.annotate(as_float=Cast('integer', FloatField())).get()\n>>> print(value.as_float)\n4.0\nCoalesceLien vers cette rubrique#Accepte une liste d’au moins deux noms de champ ou expressions et renvoie la première valeur non nulle (notez qu’une chaîne vide n’est pas considérée comme une valeur nulle). Chaque paramètre doit être d’un type similaire ; si vous mélangez des textes et des nombres, la base de données produira une erreur.
\nExemples d’utilisation :
\n>>> # Get a screen name from least to most public\n>>> from django.db.models import Sum, Value as V\n>>> from django.db.models.functions import Coalesce\n>>> Author.objects.create(name='Margaret Smith', goes_by='Maggie')\n>>> author = Author.objects.annotate(\n... screen_name=Coalesce('alias', 'goes_by', 'name')).get()\n>>> print(author.screen_name)\nMaggie\n\n>>> # Prevent an aggregate Sum() from returning None\n>>> aggregated = Author.objects.aggregate(\n... combined_age=Coalesce(Sum('age'), V(0)),\n... combined_age_default=Sum('age'))\n>>> print(aggregated['combined_age'])\n0\n>>> print(aggregated['combined_age_default'])\nNone\nConcatLien vers cette rubrique#Accepte une liste d’au moins deux champs textes ou expressions et renvoie la concaténation de ces paramètres. Chaque paramètre doit être de type texte ou caractère. Si vous voulez concaténer un champ TextField() avec un champ CharField(), prenez alors la précaution d’indiquer à Django que le résultat output_field sera un champ TextField(). C’est aussi nécessaire lors de la concaténation avec une valeur Value comme dans l’exemple ci-dessous.
Le résultat de cette fonction n’est jamais nul. Pour les moteurs où un paramètre nul aboutit à ce que toute l’expression devienne nulle, Django s’assure que chaque partie nulle est préalablement convertie en chaîne vide.
\nExemple d’utilisation :
\n>>> # Get the display name as "name (goes_by)"\n>>> from django.db.models import CharField, Value as V\n>>> from django.db.models.functions import Concat\n>>> Author.objects.create(name='Margaret Smith', goes_by='Maggie')\n>>> author = Author.objects.annotate(\n... screen_name=Concat('name', V(' ('), 'goes_by', V(')'),\n... output_field=CharField())).get()\n>>> print(author.screen_name)\nMargaret Smith (Maggie)\nGreatestLien vers cette rubrique#Accepte une liste d’au moins deux noms de champ ou expressions et renvoie la plus grande valeur. Chaque paramètre doit être d’un type similaire ; si vous mélangez des textes et des nombres, la base de données produira une erreur.
\nExemple d’utilisation :
\nclass Blog(models.Model):\n body = models.TextField()\n modified = models.DateTimeField(auto_now=True)\n\nclass Comment(models.Model):\n body = models.TextField()\n modified = models.DateTimeField(auto_now=True)\n blog = models.ForeignKey(Blog, on_delete=models.CASCADE)\n\n>>> from django.db.models.functions import Greatest\n>>> blog = Blog.objects.create(body='Greatest is the best.')\n>>> comment = Comment.objects.create(body='No, Least is better.', blog=blog)\n>>> comments = Comment.objects.annotate(last_updated=Greatest('modified', 'blog__modified'))\n>>> annotated_comment = comments.get()\nannotated_comment.last_updated sera la valeur la plus récente entre blog.modified et comment.modified.
LeastLien vers cette rubrique#Accepte une liste d’au moins deux noms de champ ou expressions et renvoie la plus petite valeur. Chaque paramètre doit être d’un type similaire ; si vous mélangez des textes et des nombres, la base de données produira une erreur.
\n\nLengthLien vers cette rubrique#Accepte un champ texte ou une expression unique et renvoie le nombre de caractères de la valeur. Si l’expression est nulle, la longueur renvoyée sera également nulle.
\nExemple d’utilisation :
\n>>> # Get the length of the name and goes_by fields\n>>> from django.db.models.functions import Length\n>>> Author.objects.create(name='Margaret Smith')\n>>> author = Author.objects.annotate(\n... name_length=Length('name'),\n... goes_by_length=Length('goes_by')).get()\n>>> print(author.name_length, author.goes_by_length)\n(14, None)\nCette expression peut aussi être inscrite comme transformation. Par exemple :
\n>>> from django.db.models import CharField\n>>> from django.db.models.functions import Length\n>>> CharField.register_lookup(Length, 'length')\n>>> # Get authors whose name is longer than 7 characters\n>>> authors = Author.objects.filter(name__length__gt=7)\nLowerLien vers cette rubrique#Accepte un champ texte ou une expression unique et renvoie sa représentation en minuscules.
\nCette expression peut aussi être inscrite comme transformation comme expliqué pour Length.
Exemple d’utilisation :
\n>>> from django.db.models.functions import Lower\n>>> Author.objects.create(name='Margaret Smith')\n>>> author = Author.objects.annotate(name_lower=Lower('name')).get()\n>>> print(author.name_lower)\nmargaret smith\nNowLien vers cette rubrique#Renvoie la date et l’heure courante du serveur de base de données au moment où la requête est exécutée, typiquement en utilisant le code SQL CURRENT_TIMESTAMP.
Exemple d’utilisation :
\n>>> from django.db.models.functions import Now\n>>> Article.objects.filter(published__lte=Now())\n<QuerySet [<Article: How to Django>]>\nSubstrLien vers cette rubrique#Renvoie une sous-chaîne de longueur length extraite du champ ou de l’expression à partir de la position pos. L’indice de position commence à 1, il doit donc être plus grand que 0. Si length vaut None, tout le reste de la chaîne est renvoyé comme résultat.
Exemple d’utilisation :
\n>>> # Set the alias to the first 5 characters of the name as lowercase\n>>> from django.db.models.functions import Substr, Lower\n>>> Author.objects.create(name='Margaret Smith')\n>>> Author.objects.update(alias=Lower(Substr('name', 1, 5)))\n1\n>>> print(Author.objects.get(name='Margaret Smith').alias)\nmarga\nUpperLien vers cette rubrique#Accepte un champ texte ou une expression unique et renvoie sa représentation en majuscules.
\nCette expression peut aussi être inscrite comme transformation comme expliqué pour Length.
Exemple d’utilisation :
\n>>> from django.db.models.functions import Upper\n>>> Author.objects.create(name='Margaret Smith')\n>>> author = Author.objects.annotate(name_upper=Upper('name')).get()\n>>> print(author.name_upper)\nMARGARET SMITH\nNous allons utiliser le modèle suivant dans les exemples de chaque fonction :
\nclass Experiment(models.Model):\n start_datetime = models.DateTimeField()\n start_date = models.DateField(null=True, blank=True)\n end_datetime = models.DateTimeField(null=True, blank=True)\n end_date = models.DateField(null=True, blank=True)\nExtractLien vers cette rubrique#Extrait un composant de date sous forme de nombre.
\nAccepte une expression représentant un champ DateField ou DateTimeField ainsi qu’un nom d’expression lookup_name, et renvoie la partie de date référencée par lookup_name sous forme de champ IntegerField. Django utilise habituellement la fonction d’extraction des bases de données, il est donc possible d’utiliser n’importe quel nom lookup_name pris en charge par la base de données en cours. Il est possible de passer aussi une sous-classe de tzinfo, habituellement fournie par pytz, pour extraire une valeur dans un fuseau horaire spécifique.
Étant donnée la date/heure 2015-06-15 23:30:01.000321+00:00, les valeurs lookup_name possibles renvoient :
« year » (année) : 2015
« month » (mois) : 6
« day » (jour) : 15
« week_day » (jour de semaine) : 2
« hour » (heure) : 23
« minute »: 30
« second »: 1
Si un fuseau horaire différent comme Australia/Melbourne est actif dans Django, la date/heure est convertie dans le fuseau avant que la valeur soit extraite. Le décalage horaire de Melbourne dans la date d’exemple ci-dessus est +10:00. Les valeurs renvoyées lorsque ce fuseau est actif seront les mêmes que ci-dessus, à l’exception de :
« day »: 16
« week_day »: 3
« hour »: 9
Chaque valeur lookup_name ci-dessus possède une sous-classe de Extract correspondante (énumérées ci-dessous) qui devrait être utilisée au lieu de l’équivalent plus bavard, c’est-à-dire ExtractYear(...) au lieu de Extract(..., lookup_name='year').
Exemple d’utilisation :
\n>>> from datetime import datetime\n>>> from django.db.models.functions import Extract\n>>> start = datetime(2015, 6, 15)\n>>> end = datetime(2015, 7, 2)\n>>> Experiment.objects.create(\n... start_datetime=start, start_date=start.date(),\n... end_datetime=end, end_date=end.date())\n>>> # Add the experiment start year as a field in the QuerySet.\n>>> experiment = Experiment.objects.annotate(\n... start_year=Extract('start_datetime', 'year')).get()\n>>> experiment.start_year\n2015\n>>> # How many experiments completed in the same year in which they started?\n>>> Experiment.objects.filter(\n... start_datetime__year=Extract('end_datetime', 'year')).count()\n1\nDateFieldLien vers cette rubrique#Il s’agit d’équivalents logiques à Extract('champ_date', lookup_name). Chaque classe est aussi une classe Transform inscrite pour les champs DateField et DateTimeField comme __(lookup_name), par ex. __year.
Comme les champs DateField n’ont pas de composant d’heure, seules les sous-classes de Extract qui s’appliquent aux parties de date peuvent être utilisées avec DateField:
>>> from datetime import datetime\n>>> from django.utils import timezone\n>>> from django.db.models.functions import (\n... ExtractYear, ExtractMonth, ExtractDay, ExtractWeekDay\n... )\n>>> start_2015 = datetime(2015, 6, 15, 23, 30, 1, tzinfo=timezone.utc)\n>>> end_2015 = datetime(2015, 6, 16, 13, 11, 27, tzinfo=timezone.utc)\n>>> Experiment.objects.create(\n... start_datetime=start_2015, start_date=start_2015.date(),\n... end_datetime=end_2015, end_date=end_2015.date())\n>>> Experiment.objects.annotate(\n... year=ExtractYear('start_date'),\n... month=ExtractMonth('start_date'),\n... day=ExtractDay('start_date'),\n... weekday=ExtractWeekDay('start_date'),\n... ).values('year', 'month', 'day', 'weekday').get(\n... end_date__year=ExtractYear('start_date'),\n... )\n{'year': 2015, 'month': 6, 'day': 15, 'weekday': 2}\nDateTimeFieldLien vers cette rubrique#En plus de ce qui suit, toutes les extractions pour DateField énumérées ci-dessus peuvent aussi être utilisées pour DateTimeField.
Il s’agit d’équivalents logiques à Extract('champ_datetime', lookup_name). Chaque classe est aussi une classe Transform inscrite pour le champ DateTimeField comme __(lookup_name), par ex. __minute.
Exemples DateTimeField:
>>> from datetime import datetime\n>>> from django.utils import timezone\n>>> from django.db.models.functions import (\n... ExtractYear, ExtractMonth, ExtractDay, ExtractWeekDay,\n... ExtractHour, ExtractMinute, ExtractSecond,\n... )\n>>> start_2015 = datetime(2015, 6, 15, 23, 30, 1, tzinfo=timezone.utc)\n>>> end_2015 = datetime(2015, 6, 16, 13, 11, 27, tzinfo=timezone.utc)\n>>> Experiment.objects.create(\n... start_datetime=start_2015, start_date=start_2015.date(),\n... end_datetime=end_2015, end_date=end_2015.date())\n>>> Experiment.objects.annotate(\n... year=ExtractYear('start_datetime'),\n... month=ExtractMonth('start_datetime'),\n... day=ExtractDay('start_datetime'),\n... weekday=ExtractWeekDay('start_datetime'),\n... hour=ExtractHour('start_datetime'),\n... minute=ExtractMinute('start_datetime'),\n... second=ExtractSecond('start_datetime'),\n... ).values(\n... 'year', 'month', 'day', 'weekday', 'hour', 'minute', 'second',\n... ).get(end_datetime__year=ExtractYear('start_datetime'))\n{'year': 2015, 'month': 6, 'day': 15, 'weekday': 2, 'hour': 23, 'minute': 30, 'second': 1}\nLorsque USE_TZ vaut True, les dates/heures sont stockées en UTC dans la base de données. Si un autre fuseau horaire est actif dans Django, la date/heure est convertie dans ce fuseau avant que la valeur soit extraite. L’exemple ci-dessous convertit dans le fuseau horaire de Melbourne (UTC +10:00), ce qui modifie les valeurs du jour, du jour de la semaine et de l’heure qui sont renvoyées :
>>> import pytz\n>>> melb = pytz.timezone('Australia/Melbourne') # UTC+10:00\n>>> with timezone.override(melb):\n... Experiment.objects.annotate(\n... day=ExtractDay('start_datetime'),\n... weekday=ExtractWeekDay('start_datetime'),\n... hour=ExtractHour('start_datetime'),\n... ).values('day', 'weekday', 'hour').get(\n... end_datetime__year=ExtractYear('start_datetime'),\n... )\n{'day': 16, 'weekday': 3, 'hour': 9}\nLe passage explicite du fuseau horaire à la fonction Extract fonctionne de la même manière et prend la priorité sur le fuseau horaire actif :
>>> import pytz\n>>> melb = pytz.timezone('Australia/Melbourne')\n>>> Experiment.objects.annotate(\n... day=ExtractDay('start_datetime', tzinfo=melb),\n... weekday=ExtractWeekDay('start_datetime', tzinfo=melb),\n... hour=ExtractHour('start_datetime', tzinfo=melb),\n... ).values('day', 'weekday', 'hour').get(\n... end_datetime__year=ExtractYear('start_datetime'),\n... )\n{'day': 16, 'weekday': 3, 'hour': 9}\nTruncLien vers cette rubrique#Tronque une date jusqu’à un composant significatif.
\nLorsque vous ne voulez que savoir si quelque chose s’est produit durant une année, une heure ou un jour particulier, mais pas à quelle seconde, Trunc (et ses sous-classes) peut être utile pour filtrer ou agréger vos données. Par exemple, vous pouvez utiliser Trunc pour calculer le nombre de ventes par jour.
Trunc accepte une seule expression, représentant un champ DateField ou DateTimeField, une variable kind représentant une partie de date et un champ output_field qui vaut DateTimeField() ou DateField(). Elle renvoie un date ou une date/heure en fonction de output_field, avec les champs jusqu’à kind définis à leur valeur minimale. Si output_field est omis, la valeur par défaut sera le type output_field de expression. Il est possible de passer aussi une sous-classe de tzinfo, habituellement fournie par pytz, pour tronquer une valeur dans un fuseau horaire spécifique.
Étant donnée la date/heure 2015-06-15 14:30:50.000321+00:00, les valeurs kind possibles renvoient :
« year »: 2015-01-01 00:00:00+00:00
« month »: 2015-06-01 00:00:00+00:00
« day »: 2015-06-15 00:00:00+00:00
« hour »: 2015-06-15 14:00:00+00:00
« minute »: 2015-06-15 14:30:00+00:00
« second »: 2015-06-15 14:30:50+00:00
Si un fuseau horaire différent comme Australia/Melbourne est actif dans Django, la date/heure est convertie dans le nouveau fuseau avant que la valeur soit tronquée. Le décalage horaire de Melbourne dans la date d’exemple ci-dessus est +10:00. Les valeurs renvoyées lorsque ce fuseau est actif seront :
« year »: 2015-01-01 00:00:00+11:00
« month »: 2015-06-01 00:00:00+10:00
« day »: 2015-06-16 00:00:00+10:00
« hour »: 2015-06-16 00:00:00+10:00
« minute »: 2015-06-16 00:30:00+10:00
« second »: 2015-06-16 00:30:50+10:00
L’année présente un décalage de +11:00 parce que le résultat traverse un passage à l’heure d’été.
\nChaque valeur kind ci-dessus possède une sous-classe de Trunc correspondante (énumérées ci-dessous) qui devrait être utilisée au lieu de l’équivalent plus bavard, c’est-à-dire TruncYear(...) au lieu de Trunc(..., kind='year').
Les sous-classes sont toutes définies comme des transformations, mais elles ne sont inscrites pour aucun champ, car les noms de requête qui s’imposent sont déjà réservés par les sous-classes de Extract.
Exemple d’utilisation :
\n>>> from datetime import datetime\n>>> from django.db.models import Count, DateTimeField\n>>> from django.db.models.functions import Trunc\n>>> Experiment.objects.create(start_datetime=datetime(2015, 6, 15, 14, 30, 50, 321))\n>>> Experiment.objects.create(start_datetime=datetime(2015, 6, 15, 14, 40, 2, 123))\n>>> Experiment.objects.create(start_datetime=datetime(2015, 12, 25, 10, 5, 27, 999))\n>>> experiments_per_day = Experiment.objects.annotate(\n... start_day=Trunc('start_datetime', 'day', output_field=DateTimeField())\n... ).values('start_day').annotate(experiments=Count('id'))\n>>> for exp in experiments_per_day:\n... print(exp['start_day'], exp['experiments'])\n...\n2015-06-15 00:00:00 2\n2015-12-25 00:00:00 1\n>>> experiments = Experiment.objects.annotate(\n... start_day=Trunc('start_datetime', 'day', output_field=DateTimeField())\n... ).filter(start_day=datetime(2015, 6, 15))\n>>> for exp in experiments:\n... print(exp.start_datetime)\n...\n2015-06-15 14:30:50.000321\n2015-06-15 14:40:02.000123\nDateFieldLien vers cette rubrique#Ce sont des équivalences logiques à Trunc('champ_date', kind). Elles tronquent toutes les parties de la date jusqu’à kind, ce qui permet de grouper ou de filtrer des dates avec une plus faible précision. expression peut avoir une valeur output_field de DateField ou de DateTimeField.
Comme les champs DateField n’ont pas de composant d’heure, seules les sous-classes de Trunc qui s’appliquent aux parties de date peuvent être utilisées avec DateField:
>>> from datetime import datetime\n>>> from django.db.models import Count\n>>> from django.db.models.functions import TruncMonth, TruncYear\n>>> from django.utils import timezone\n>>> start1 = datetime(2014, 6, 15, 14, 30, 50, 321, tzinfo=timezone.utc)\n>>> start2 = datetime(2015, 6, 15, 14, 40, 2, 123, tzinfo=timezone.utc)\n>>> start3 = datetime(2015, 12, 31, 17, 5, 27, 999, tzinfo=timezone.utc)\n>>> Experiment.objects.create(start_datetime=start1, start_date=start1.date())\n>>> Experiment.objects.create(start_datetime=start2, start_date=start2.date())\n>>> Experiment.objects.create(start_datetime=start3, start_date=start3.date())\n>>> experiments_per_year = Experiment.objects.annotate(\n... year=TruncYear('start_date')).values('year').annotate(\n... experiments=Count('id'))\n>>> for exp in experiments_per_year:\n... print(exp['year'], exp['experiments'])\n...\n2014-01-01 1\n2015-01-01 2\n\n>>> import pytz\n>>> melb = pytz.timezone('Australia/Melbourne')\n>>> experiments_per_month = Experiment.objects.annotate(\n... month=TruncMonth('start_datetime', tzinfo=melb)).values('month').annotate(\n... experiments=Count('id'))\n>>> for exp in experiments_per_month:\n... print(exp['month'], exp['experiments'])\n...\n2015-06-01 00:00:00+10:00 1\n2016-01-01 00:00:00+11:00 1\n2014-06-01 00:00:00+10:00 1\nDateTimeFieldLien vers cette rubrique#TruncDate force le type de expression à une date plutôt que d’utiliser l’instruction SQL de troncature. Elle est aussi inscrite comme transformation pour DateTimeField sous la forme __date.
Ce sont des équivalences logiques à Trunc('champ_dateheure', kind). Elles tronquent toutes les parties de la date jusqu’à kind, ce qui permet de grouper ou de filtrer des dates/heures avec une plus faible précision. expression doit avoir une valeur output_field de DateTimeField.
Exemple d’utilisation :
\n>>> from datetime import date, datetime\n>>> from django.db.models import Count\n>>> from django.db.models.functions import (\n... TruncDate, TruncDay, TruncHour, TruncMinute, TruncSecond,\n... )\n>>> from django.utils import timezone\n>>> import pytz\n>>> start1 = datetime(2014, 6, 15, 14, 30, 50, 321, tzinfo=timezone.utc)\n>>> Experiment.objects.create(start_datetime=start1, start_date=start1.date())\n>>> melb = pytz.timezone('Australia/Melbourne')\n>>> Experiment.objects.annotate(\n... date=TruncDate('start_datetime'),\n... day=TruncDay('start_datetime', tzinfo=melb),\n... hour=TruncHour('start_datetime', tzinfo=melb),\n... minute=TruncMinute('start_datetime'),\n... second=TruncSecond('start_datetime'),\n... ).values('date', 'day', 'hour', 'minute', 'second').get()\n{'date': datetime.date(2014, 6, 15),\n 'day': datetime.datetime(2014, 6, 16, 0, 0, tzinfo=<DstTzInfo 'Australia/Melbourne' AEST+10:00:00 STD>),\n 'hour': datetime.datetime(2014, 6, 16, 0, 0, tzinfo=<DstTzInfo 'Australia/Melbourne' AEST+10:00:00 STD>),\n 'minute': 'minute': datetime.datetime(2014, 6, 15, 14, 30, tzinfo=<UTC>),\n 'second': datetime.datetime(2014, 6, 15, 14, 30, 50, tzinfo=<UTC>)\n}\n