Do you want to pick up from where you left of?
Take me there

Sigils

Utilisation et création de sigils.

Table of Contents

Vue d’ensemble des sigils

Elixir fournit une syntaxe alternative pour représenter et travailler avec des valeurs littérales. Un sigil (la traduction française serait sceau mais nous garderons sigil dans la suite) commence avec un tilde ~ suivi par un caractère. Elixir fournit de base un certain nombre de sigils, et il est aussi possible d’en créer soi-même quand il est nécessaire d’étendre le langage.

La liste des sigils disponibles inclut :

La liste des délimiteurs inclut :

Listes de caractères

Les sigils ~c et ~C génèrent des listes de caractères. Par exemple :

iex> ~c/2 + 7 = #{2 + 7}/
'2 + 7 = 9'

iex> ~C/2 + 7 = #{2 + 7}/
'2 + 7 = \#{2 + 7}'

On peut voir que le ~c en minuscule interpole le calcul, au contraire du ~C majuscule. Nous verrons que ce comportement majuscule / minuscule est commun pour tous les sigils pré-définis.

Expressions régulières

Les sigils ~r et ~R sont utilisés pour représenter des Expressions Régulières. Nous les créons soit à la volée, soit pour une utilisation avec les fonctions du module Regex. Par exemple :

iex> re = ~r/elixir/
~r/elixir/

iex> "Elixir" =~ re
false

iex> "elixir" =~ re
true

Nous pouvons constaterdans le premier test d’égalité, que Elixir n’a pas de correspondance avec l’expression régulière. C’est parce que le mot est capitalisé. Parce qu’Elixir supporte les Expressions Régulières Compatibles de Perl (ou PCRE - “Perl Compatible Regular Expressions” en anglais), nous pouvons ajouter i à la fin de l’expression régulière de notre sigil pour désactiver la sensibilité à la casse:

iex> re = ~r/elixir/i
~r/elixir/i

iex> "Elixir" =~ re
true

iex> "elixir" =~ re
true

De plus, Elixir fournit l’API Regex construite sur la bibliothèque d’expressions régulières d’Erlang. Utilisons Regex.split/2 avec un sigil regex :

iex> string = "100_000_000"
"100_000_000"

iex> Regex.split(~r/_/, string)
["100", "000", "000"]

Comme nous pouvons le voir, la chaîne de caractères "100_000_000" est séparé à chaque blanc souligné (underscore en anglais), grâce au sigil ~r/_/. La fonction Regex.split retourne une liste.

Chaînes de caractères

Les sigils ~s et ~S sont utilisés pour générer des chaînes de caractères. Par exemple :

iex> ~s/the cat in the hat on the mat/
"the cat in the hat on the mat"

iex> ~S/the cat in the hat on the mat/
"the cat in the hat on the mat"

Mais quelle est la différence ? La différence est similaire à celle du sigil de liste de caractères que nous avons déjà vu. La réponse est l’interpolation et l’utilisation des séquences échappées. Si nous prenons un autre exemple :

iex> ~s/welcome to elixir #{String.downcase "SCHOOL"}/
"welcome to elixir school"

iex> ~S/welcome to elixir #{String.downcase "SCHOOL"}/
"welcome to elixir \#{String.downcase \"SCHOOL\"}"

Listes de mots

Le sigil de liste de mots peut quelquefois être fort pratique. Il peut et sauver du temps et des frappes au clavier, et sans doute réduire la complexité du code. Prenez l’exemple suivant:

iex> ~w/i love elixir school/
["i", "love", "elixir", "school"]

iex> ~W/i love elixir school/
["i", "love", "elixir", "school"]

Nous pouvons voir que ce qui est tapé entre les délimiteurs est séparé par des espaces et mis dans une liste. Pourtant, il n’y a pas de différence entre ces deux exemples. Encore une fois, la différence vient de l’interpolation et de l’échappement des séquences. Prenez l’exemple suivant :

iex> ~w/i love #{'e'}lixir school/
["i", "love", "elixir", "school"]

iex> ~W/i love #{'e'}lixir school/
["i", "love", "\#{'e'}lixir", "school"]

NaiveDateTime

Un NaiveDateTime peut être utile pour créer rapidement une struct représentant un DateTime sans fuseau horaire.

La plupart du temps, nous devrions éviter de créer une struct NaiveDateTime directement. C’est cependant utile pour le pattern matching. Par exemple :

iex> NaiveDateTime.from_iso8601("2015-01-23 23:50:07") == {:ok, ~N[2015-01-23 23:50:07]}

DateTime

Un DateTime peut être utile pour créer rapidement une struct pour représenter une DateTime avec un fuseau horaire UTC (Coordinated Universal Time). Puisque c’est dans un fuseau horaire UTC et que votre chaîne de caractères pourrait représenter un autre fuseau, un troisième élément représentant le décalage en seconde est retourné.

Par exemple :

iex> DateTime.from_iso8601("2015-01-23 23:50:07Z") == {:ok, ~U[2015-01-23 23:50:07Z], 0}
iex> DateTime.from_iso8601("2015-01-23 23:50:07-0600") == {:ok, ~U[2015-01-24 05:50:07Z], -21600}

Création de sigils

Un des objectifs d’Elixir est d’être un langage de programmation extensible. C’est donc sans surprise qu’il est possible de créer facilement nos propres sigils. Dans cet exemple, nous créerons un sigil pour passer une chaîne de caractères en majuscules. Comme il existe déjà une fonction pour cela dans la bibliothèque standard d’Elixir (String.upcase/1), nous allons créer notre sigil autour de cette fonction :


iex> defmodule MySigils do
...>   def sigil_p(string, []), do: String.upcase(string)
...> end

iex> import MySigils
nil

iex> ~p/elixir school/
ELIXIR SCHOOL

Tout d’abord, nous définissons premièrement un module appelé MySigils, et dans celui-ci nous avons créé une fonction nommée sigil_p Comme il n’y a jusque-là pas de sigil ~p parmi ceux existants, nous allons le créer. Le _p indique que nous souhaitons utiliser p comme le caractère après le tilde. La définition de la fonction doit prendre deux arguments, une donnée d’entrée et une liste de caractères pour les options passées (telle que le i utilisé avec les expressions régulières).

Caught a mistake or want to contribute to the lesson? Edit this lesson on GitHub!
Previous Lesson

Mix

Avant de plonger dans les profondeurs d’Elixir, nous devons d’abord apprendre Mix.

Next Lesson

Documentation

Documentation du code Elixir.