Chatbot à expressions régulières

Les expressions régulières

Les expressions régulières (regex) sont des séquences de caractères qui définissent un motif de recherche dans un texte.

Apprendre la syntaxe des expressions régulières dépasse le cadre de ce sujet. On va se concentrer sur les expressions que jq fournit pour utiliser les regex.

Les variantes de regex

Les différents outils implémentent des versions différentes des expressions régulières. jq intègre la bibliothèque regex Oniguruma, largement compatible avec les expressions régulières de Perl v5.8.

La syntaxe précise utilisée par jq se trouve dans le dépôt GitHub d'Oniguruma.

Les fonctions de regex

Les expressions régulières dans jq se limitent à un ensemble de filtres.

La correspondance simple

Quand tu as besoin de savoir si une string correspond à un motif, utilise le filtre test.

STRING | test(REGEX)
STRING | test(REGEX; FLAGS)
STRING | test([REGEX, FLAGS])

Ce filtre produit un résultat booléen.

"Hello World!" | test("W")    # => true
"Goodbye Mars" | test("W")    # => false

Les informations sur la correspondance

Quand tu as besoin d'extraire la sous-chaîne qui correspond effectivement au motif, utilise le filtre match.

STRING | match(REGEX)
STRING | match(REGEX; FLAGS)
STRING | match([REGEX, FLAGS])

Ce filtre produit :

• rien s'il n'y a pas de correspondance, ou
• un objet contenant diverses propriétés s'il y a une correspondance.

Cet exemple recherche deux voyelles identiques consécutives en utilisant la syntaxe de référence arrière, \1.

"Hello World!" | match("([aeiou])\\1")
# => empty

"Goodbye Mars" | match("([aeiou])\\1")
# => {
#      "offset": 1,
#      "length": 2,
#      "string": "oo",
#      "captures": [
#        {
#          "offset": 1,
#          "length": 1,
#          "string": "o",
#          "name": null
#        }
#      ]
#    }

Le filtre match renvoie un objet pour chaque correspondance. Cet exemple montre le drapeau "g" en action pour trouver toutes les voyelles.

"Goodbye Mars" | match("[aeiou]"; "g")
# => { "offset": 1, "length": 1, "string": "o", "captures": [] }
#    { "offset": 2, "length": 1, "string": "o", "captures": [] }
#    { "offset": 6, "length": 1, "string": "e", "captures": [] }
#    { "offset": 9, "length": 1, "string": "a", "captures": [] }

Les sous-chaînes capturées

Semblable au filtre match, le filtre capture renvoie un objet s'il y a une correspondance.

STRING | capture(REGEX)
STRING | capture(REGEX; FLAGS)
STRING | capture([REGEX, FLAGS])

L'objet renvoyé est une association des captures nommées.

"JIRAISSUE-1234" | capture("(?<project>\\w+)-(?<issue_num>\\d+)")
# => {
#      "project": "JIRAISSUE",
#      "issue_num": "1234"
#    }

Rien que les sous-chaînes

Le filtre scan est semblable à match avec le drapeau "g".

STRING | scan(REGEX)
STRING | scan(REGEX; FLAGS)

scan produit un flux de sous-chaînes.

"Goodbye Mars" | scan("[aeiou]")
# => "o"
#    "o"
#    "e"
#    "a"

Utilise le constructeur de tableau [...] pour capturer les sous-chaînes.

"Goodbye Mars" | [ scan("[aeiou]") ]
# => ["o", "o", "e", "a"]

Découper une string

Si tu connais les parties de la string que tu veux garder, utilise match ou scan. Si tu connais les parties que tu veux écarter, utilise split.

STRING | split(REGEX; FLAGS)

Un exemple qui découpe une string sur des espaces arbitraires.

"first   second           third fourth" | split("\\s+"; "")
# => ["first", "second", "third", "fourth"]

Les substitutions

Les filtres sub et gsub peuvent transformer la chaîne d'entrée, en remplaçant les portions correspondantes de l'entrée par une chaîne de remplacement.

Pour ne remplacer que la première correspondance, utilise sub. Pour remplacer toutes les correspondances, utilise gsub.

STRING | sub(REGEX; REPLACEMENT)
STRING | sub(REGEX; REPLACEMENT; FLAGS)
STRING | gsub(REGEX; REPLACEMENT)
STRING | gsub(REGEX; REPLACEMENT; FLAGS)

"Goodnight kittens. Goodnight mittens." | sub("night"; " morning")
# => "Good morning kittens. Goodnight mittens."

"Goodnight kittens. Goodnight mittens." | gsub("night"; " morning")
# => "Good morning kittens. Good morning mittens."

Le texte de remplacement peut faire référence aux sous-chaînes correspondantes ; utilise des captures nommées et l'interpolation de chaînes.

"Some 3-letter acronyms: gnu, csv, png"
| gsub( "\\b(?<tla>[[:alpha:]]{3})\\b";     # find words 3 letters long
        "\(.tla | ascii_upcase)" )          # upper-case the match
# => "Some 3-letter acronyms: GNU, CSV, PNG"

Les drapeaux

Dans tous les filtres ci-dessus, FLAGS est une chaîne composée de zéro ou plusieurs des drapeaux pris en charge.

• g - Recherche globale (trouve toutes les correspondances, pas seulement la première)
• i - Recherche insensible à la casse
• m - Mode multiligne ('.' correspond aux sauts de ligne)
• n - Ignore les correspondances vides
• p - Les modes s et m sont tous les deux activés
• s - Mode monoligne ('^' -> '\A', '$' -> '\Z')
• l - Trouve les correspondances les plus longues possibles
• x - Format d'expression régulière étendu (ignore les espaces et les commentaires)

Par exemple

"JIRAISSUE-1234" | capture("(?<project>\\w+)-(?<issue_num>\\d+)")

# or with Extended formatting

"JIRAISSUE-1234" | capture("
                     (?<project>   \\w+ )  # the Jira project
                     -                     # followed by a hyphen
                     (?<issue_num> \\d+ )  # followed by digits
                   "; "x")