Variables
Rappelle-toi qu'un programme jq est un pipeline d'expressions.
L'affectation de variable suit cette règle : une affectation de variable est une expression qui ressemble à :
... | expr as $varname | ...
Le filtre renvoie l'entrée
Comme l'expression d'identité ., la sortie de l'affectation de variable est identique à son entrée.
Définir la valeur de la variable est un effet de bord.
Exemple qui montre que . après l'affectation est identique à l'entrée initiale :
$ jq -c -n '42 | (. * 2) as $double | [., $double]'
[42,84]
La portée des variables
La portée de la variable est « lexicale » : la variable reste dans la portée pour le reste du pipeline.
Les variables définies dans des fonctions (on verra les fonctions plus tard) sont « locales » à la fonction.
Les noms de variables
Le nom de la variable doit commencer par $.
Le reste du nom de la variable est un identifiant : il commence par une lettre ou un tiret bas, suivi de lettres, de chiffres ou de tirets bas.
L'affectation par déstructuration
D'après le manuel :
On peut déclarer plusieurs variables avec une seule expression as en fournissant un motif qui correspond à la structure de l'entrée (c'est ce qu'on appelle la « déstructuration »).
Exemples :
[1, 2, 3] as [$a, $b, $c]
| [$a, $b, $c] # => [1, 2, 3]
{"foo": "bar", "len": [10, 20]} as {foo: $f, len: [$h, $w]}
| [$f, $h, $w] # => ["bar", 10, 20]
Faire correspondre le nom de la variable à la clé de l'objet offre un raccourci :
{"x": 4, "y": 7} as {$x, $y}
| [$x, $y] # => [4, 7]
{"foo": "bar", "len": [10, 20]} as {$foo, $len}
| [$foo, $len] # => ["bar", [10, 20]]
Le même raccourci fonctionne dans le sens inverse pour la construction d'objets
4 as $x | 7 as $y | {$x, $y} # => {"x":4, "y": 7}
Les constantes
Comme le montre l'exemple ci-dessus, les variables sont pratiques pour stocker des constantes.
Il vaut mieux donner un nom aux constantes plutôt que de laisser des « nombres magiques » apparaître dans le code.
Souvent, les variables ne sont pas nécessaires
Il est souvent plus lisible d'omettre les variables.
Prenons le calcul de la moyenne d'un tableau de nombres
[2, 4, 8, 7]
| add as $sum
| length as $len
| $sum / $len
comparé à
[2, 4, 8, 7] | add / length
Cela met en évidence l'un des aspects les plus puissants de jq : l'entrée d'un filtre est fournie à chaque sous-expression :
- le tableau d'entrée
[2,4,8,7] est transmis à add (qui additionne les nombres en appliquant l'opérateur + à tous les éléments)
-
en parallèle,
[2,4,8,7] est aussi transmis à length
- quand ces sous-expressions se terminent, leurs résultats sont ensuite divisés, ce qui renvoie la moyenne des nombres du tableau d'entrée.
Les opérateurs jq dont tu auras besoin pour l'exercice d'apprentissage
L'opérateur alternatif : //
L'expression a // b renvoie b si a vaut false ou null, sinon elle renvoie a.
Dans le contexte de l'affectation d'une variable, c'est très pratique pour fournir une valeur par défaut :
(.input.theAnswer // 42) as $answer | ...
Les opérateurs arithmétiques
-
+, - et * sont les opérateurs habituels d'addition, de soustraction et de multiplication numériques.
Exercice d'apprentissage
