Utiliser les filtres Django pour manipuler les données

Introduction aux filtres Django

Les filtres permettent de transformer ou de manipuler les données dans Publik. Ils sont utilisés directement dans les gabarits Django via le symbole |, appelé pipe (prononcé païpe).

Syntaxe générale :
form_var_chose|nom_du_filtre

Exemple simple

Si vous souhaitez convertir une valeur en minuscules :
{{ form_var_titre|lower }}

Combinaison de filtres

Les filtres peuvent être chaînés :
{{ form_var_title|first|lower }}
Cela extrait le premier caractère de form_var_title et le convertit en minuscule.

Filtres avec paramètres

Certains filtres acceptent des paramètres :
form_var_chose|nom_du_filtre:parametre

Le paramètre peut être un nombre (sans guillemets) :
form_var_chose|add:2

Le paramètre peut être une chaîne de caractères (encadrée par des guillemets) :
form_var_chose|startswith:"toto"

En savoir plus

Filtres standards

Cette page ne détaille que les filtres classiquement utilisés avec Publik. La façon la plus complète de comprendre l'utilisation des filtres et de regarder la documentation Django en la matière Link: https://docs.djangoproject.com/fr/4.2/ref/templates/builtins/ Link: https://docs.djangoproject.com/fr/3.2/ref/templates/builtins/ .

Il existe une page spécifique de la documentation Publik pour les filtres de requête.

Types de données

form_var_chose|nom_du_filtre

{{ form_var_titre|lower }}

{{ form_var_title|first|lower }}

Cela va prendre le premier caractère et le passer en minuscule.

Certains filtres acceptent des paramètres, qu'on précise ainsi :

form_var_chose|nom_du_filtre:parametre

Types de données

• d’affichage. Pour cela, on utilise des filtres. Voici les principaux types de données gérés par Publik :
• chaîne de caractères: type par défaut pour toutes les données de Publik ;
date: utilisé pour les champs de type d'affichage. On va utiliser les filtres pour cela.Publik gère quelques type de données :
• chaîne de caractère, c'est le type par défaut pour toutes les données de Publik
date: date, c'est le type pour les champs « date »  ;
• decimal: nombre à virgule, utile (à virgule), à utiliser pour les comparaisons de nombre et les calculs de tarifs 
• ;datetime: combinaison de la date et de l’heure, utilisée notamment
datetime: date et heure, à utiliser pour la gestion des rendez-vous  ;
• time: heure seule.

  Conversion de types

  seule

La syntaxe pour convertir une variable est la suivante  une conversion de form_var_chose est  :
form_var_chose|<type>

<type>

pouvant être : date, decimal, datetime ou time.Lorsque

Exemples pratiques

• form_var_date|date --> transforme la valeur en date

• form_var_date|datetime --> transforme la valeur même chose, mais en transformant en date + heure

• form_var_tarif|decimal --> transforme

  la valeur en nombrePrécision sur les nombres, le filtre |decimal:2

Attention,

form_var_tarif|decimal:2

Manipuler et formater les dates

Modifier le format d'affichage

Filtres sur les dates

Format d'affichage

• 07/01/2025

  Calculs d'âge

  Les filtres suivants calculent l'âge d'une date par rapport à aujourd'hui :

  En jours : form_var_date|age_in_days --> le
  25/02/2019

  On pourra souhaiter ne récupérer que :

  • L'année : today|date:"Y"

  • Le mois: today|date:"m"

  • Le jour : today|date:"d"

  Calcul d'âge

  Il est souvent intéressant, pour une date d'évaluer sa distance (son âge) par rapport à la date du jour. On va pour cela utiliser les filtres suivants :

  form_var_date|age_in_days : donne l'âge d'un évènement qui se produit à la date form_var_date, en jours. Le résultat est un nombre, qui est négatif quand l'évènement est dans le

• futur

• En jours ouvrés : form_var_date|age_in_working_days

• En jours ouvrés, samedi inclus : form_var_date|age_in_working_days_with_saturday

• En mois : form_var_date|age_in_months

• En années : form_var_date|age_in_years

En heures : form_var_date|age_in_hours --> fonctionne également avec une variable au format datetime. Cela permet
futur.
• form_var_date|age_in_working_days et form_var_date|age_in_working_days_with_saturday sont également possibles pour tenir compte des jours ouvrés (en incluant le samedi en tant que jour ouvré, si souhaité)
• form_var_date|age_in_years : même chose avec le nombre d'années
• form_var_date|age_in_months : même chose avec le nombre de mois
form_var_date|age_in_hours : même chose avec le nombre d'heure, et fonctionne aussi quand xxx est une datetime. Permet par exemple de déclencher l'envoi d'un courriel faire un mail exactement 48 heures avant un

rendez-vous.

Les filtres age_in_* ci-dessus permettent de calculer l'âge en fonction de la date du jour. Il est également possible de calculer le nombre d’heures, de jours, de mois ou d’années entre deux dates. Pour réaliser ces calculs, utilisez la syntaxe suivante :
form_var_date1|age_in_years:form_var_date2 --> ici calcule le nombre d'années, years pouvant être remplacé selon l'unité voulue

Exemples pratiques

Dans une condition Django Link: https://doc-publik.entrouvert.com/admin-fonctionnel/parametrage-avance/expressions/
rendez-vousExemple d'usage dans une condition Link: https://doc-publik.entrouvert.com/admin-fonctionnel/parametrage-avance/expressions/ Django 

Dans Exemple d'usage dans ungabarit:
Vous avez aujourd'hui {{ form_var_datenaissance|age_in_years }} ans. {% if form_var_datenaissance|age_in_years >= 18

%}Vous êtes majeur·e.{% endif %}

Ajout de jours ou d'heures à une date

form_var_date2|age_in_<unité>:form_var_date1

Ajout de jours / heures / minutes

• form_var_date|add_days:3 --> ajoute 3 jours à form_var_date

• form_var_date|add_hours:-6 --> retranche 6 heures à form_var_date

• form_var_date|add_minutes:15 --> ajoute 15 minutes à form_var_date

Un nombre négatif permet

de retirer des jours, des heures ou des minutes.

Ajout de jours ouvrés

• form_var_date|add_working_days:5 --> ajoute 5 jours ouvrés à form_var_date

• form_var_date|add_working_days_with_saturday:5 --> ajoute 5 jours ouvrés en incluant le samedi à form_var_date

  Ajustement des jours ouvrés

D'autres filtres permettent de travailler avec d'ajuster les jours ouvrés :

• form_var_date|is_working_day --> indique si la date permet de dire si le jour est un jour ouvré

• form_var_date|is_working_day_with_saturday -->

• indique si la date est un jour ouvré, samedi inclusform_var_date|adjust_to_working_day --> affiche

permet de dire si le jour est un jour ouvré en incluant le samedi comme jour ouvré form_var_date|adjust_to_working_day --> prend le prochain jour ouvré

• form_var_date|adjust_to_working_day_with_saturday --> affiche form_var_date|adjust_to_working_day_with_saturday --> prend le prochain jour ouvré en incluant le samedi

Comparer deux dates

Utilisez les opérateurs standards pour comparer deux

form_var_date1 == form_var_date2

• form_var_date1 != form_var_date2 --> Les deux les dates sont différentes

• form_var_date1 > form_var_date2 --> date1 est strictement après date2

• form_var_date1 < form_var_date2 --> date1 est strictement avant date2 form_var_date1 >= form_var_date2 --> date1 est après date2, ou égal à date2 form_var_date1 <= form_var_date2 --> date1 est avant date2, ou égal à date2

Attention : Si cela ne fonctionne pas, vérifiez que vos variables sont bien des dates et utilisez si nécessaire si ça ne fonctionne pas c’est peut-être que vous utilisez une variable qui n’est pas une date, utilisez le filtre |date pour les convertir.

form_var_date1|date > form_var_date2|date

Filtres sur les chaînes de caractère

xxx|decimal > 2 --> effectue la comparaison
xxx|add:2       --> ajoute 2 à xxx xxx|subtract:2  --> retranche 2 à xxx xxx|multiply:2  --> multiplie xxx par 2 xxx|divide:2    --> divise xxx par 2
xxx|modulo:yyy  --> extrait le reste de la division de xxx par yyy

"2"|add:xxx     --> ajoute xxx à 2 xxx|add:yyy     --> ajoute yyy à xxx 

xxx|divide:0    --> (vide)

form_var_prix1|add:form_var_prix2|multiply:1.2|decimal:2 --> additionne deux prix et applique dessus le calcul de la TVA

{% with var1=prix1|multiply:1.2 var2=prix2|multiply:1.055 %} {{ var1|add:var2|decimal:2 }} {% endwith %} --> ajoute deux prix TTC issus de deux TVA différentes

xxx|ceil        --> nombre entier directement supérieur ou égal à xxx xxx|floor       --> nombre entier directement inférieur ou égal à xxx

xxx|abs           --> valeur absolue (toujours positive) de xxx

Comparer

des nombresUtilisez les opérateurs standards pour comparer deux nombres  deux nombres

form_var_nombre1 == form_var_nombre2. 

form_var_nombre1 != form_var_nombre2 # Les deux --> les nombres sont différents
form_var_nombre1 > form_var_nombre2 # --> nombre1 est strictement supérieur à nombre2 form_var_nombre1 <= form_var_nombre2 # < form_var_nombre2 --> nombre1 est strictement inférieur à nombre2 form_var_nombre1 >= form_var_nombre2 --> nombre1 est supérieur ou égal à nombre2 form_var_nombre1 <= form_var_nombre2 --> nombre1 est inférieur ou égal à nombre2

Attention : Si cela ne fonctionne pas, vérifiez que vos variables sont bien des nombres et utilisez si nécessaire si ça ne fonctionne pas c’est peut-être que vous utilisez une variable qui n’est pas une nombre, utilisez le filtre |decimal . pour la convertir.Il est conseillé d'être «explicite», y compris pour les champs de type Nombre et d'utiliser une syntaxe telle que :

form_var_nombre1|decimal > form_var_nombre2|decimal

Transformer un nombre en jours/heures

Il est possible d'afficher une durée exprimée en minutes sous forme de texte, en jours, heures et minutes, avec le filtre |duration :

{{ form_var_mon_nombre|duration }} => renvoie quelque chose comme 2h05
{{ form_var_mon_nombre|duration:"long" }} => renvoie quelque chose comme 2 heures et 5 minutes

Filtres sur les blocs de champs

Renvoyer la liste des valeurs d'un champ

Le filtre |getlist permet d'afficher les valeurs d'un champ précis d'un bloc de champ. L'exemple suivant renvoie les valeurs du champ nom intégré dans un bloc de champs nommé monbloc:

form_var_monbloc|getlist:"nom"

Faire la somme des valeurs d'un champ dans un bloc de champs ou une liste

le filtre |sum permet d'additionner les valeurs d'un champ intégré à un bloc de champs. L'exemple suivant renvoie la somme des valeurs du champ montant intégré dans un bloc de champs nommé monbloc:

form_var_monbloc|getlist:"montant"|sum

le filtre |sum fonctionne aussi pour faire la somme des éléments d'une liste de nombres. Par exemple pour un filtre de requête récupérant la liste des montants dans le champ "montant" d'un modèle de fiche nommé subventions :

cards|objects:"subventions"|getlist:"montant"|sum

Autres filtres spécifiques

• |splitconstruit une liste depuis la variable, en considérant que le séparateur est l'espace. Par exemple « un deux trois » va donner la liste ["un", "deux", "trois"]. On peut spécifier un autre séparateur que l'espace, par exemple la virgule : xxx|split:",";
• |has_role:"..." permet de voir si un utilisateur dispose d'un rôle particulier, par ex : session_user|has_role:"Agent".
• |rename_file pour modifier le nom d’un fichier.  (le paramètre ".$ext" permet de récupérer l'extension du fichier source. On peut reformater le nom d'un fichier pour qu'il respecte des règles de nommage. Des exemples ci-dessous :

  {{form_var_fichierarenommer|rename_file:"RIB.$ext" }}
  
  {% with nom_fichier="dutexte"|add:form_var_votrechamp|add:"-"|add:form_var_autrechamp|add:".$ext" %}{{form_var_fichierarenommer|rename_file:nom_fichier }}{% endwith %}

• |convert_image_format pour convertir un fichier d’image d’un format à un autre; les formats pris en charge sont JPEG, PDF et PNG.

  {{ form_var_image|convert_image_format:"jpeg" }}
  {{ form_url|qrcode|convert_image_format:"pdf" }}
  

• |as_template pour demander l’interprétation d’une variable sous forme de gabarit.
• |check_no_duplicates pour vérifier qu'il n'y a pas de doublon dans une liste, exemple :

  {% if forms|objects:"slug_formulaire"|filter_by:"un_champ"|filter_value:unevaleur|getlist:"un_champ"|check_no_duplicates %}
    pas de doublon (on vérifie si des doublons existe)
  {% else %}
  {{forms|objects:"slug_formulaire"|filter_by:"un_champ"|filter_value:unevaleur|getlist:"un_champ"|join:","}} (pour renvoyer la liste des doublons)
  {% endif %}
  

• |housenumber_number permet d’isoler la partie numérique d’un numéro de rue, permet par exemple d’obtenir "42" à partir du texte "42bis".
• |housenumber_btq permet à l’inverse d’isoler la partie non-numérique d’un numéro de rue, par exemple donc d’obtenir "bis" à partir du texte "42bis".
• |strip_emoji permet de retirer les émojis d’un texte.
• |repeat:n permet de répéter la valeur un  certain nombre de fois, exemple "hello"|repeat:3 donnera "hellohellohello".