Reguläre Ausdrücke
Reguläre Ausdrücke (Regexes) sind Zeichenfolgen, die ein Suchmuster in einem Text beschreiben.
Die Syntax regulärer Ausdrücke zu lernen, geht über den Rahmen dieses Themas hinaus.
Wir konzentrieren uns auf die Ausdrücke, die jq bereitstellt, um Regexes zu nutzen.
Regex-Variante
Verschiedene Werkzeuge implementieren unterschiedliche Versionen regulärer Ausdrücke.
jq verwendet die Regex-Bibliothek Oniguruma, die weitgehend mit den regulären Ausdrücken von Perl v5.8 kompatibel ist.
Die konkrete Syntax, die jq verwendet, findest du im Oniguruma-Repository auf GitHub.
jq hat keine besondere Syntax für reguläre Ausdrücke.
Sie werden einfach als Strings ausgedrückt.
Das bedeutet, dass alle Backslashes im regulären Ausdruck im String escapt werden müssen.
Zum Beispiel muss die Zeichenklasse für Ziffern (\d) als "\\d" geschrieben werden.
Regex-Funktionen
Reguläre Ausdrücke in jq sind auf eine Reihe von Filtern beschränkt.
Einfaches Abgleichen
Wenn du wissen möchtest, ob ein String zu einem Muster passt, verwendest du den test-Filter.
STRING | test(REGEX)
STRING | test(REGEX; FLAGS)
STRING | test([REGEX, FLAGS])
Dieser Filter gibt ein boolesches Ergebnis aus.
"Hello World!" | test("W") # => true
"Goodbye Mars" | test("W") # => false
Wenn du den Teilstring extrahieren möchtest, der tatsächlich zum Muster gepasst hat, verwendest du den match-Filter.
STRING | match(REGEX)
STRING | match(REGEX; FLAGS)
STRING | match([REGEX, FLAGS])
Dieser Filter gibt aus:
- nichts, wenn es keinen Treffer gab, oder
- ein Objekt mit verschiedenen Eigenschaften, wenn es einen Treffer gab.
Dieses Beispiel sucht mit der Backref-Syntax \1 nach zwei aufeinanderfolgenden gleichen Vokalen.
"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
# }
# ]
# }
Der match-Filter gibt für jeden Treffer ein Objekt zurück.
Dieses Beispiel zeigt das Flag "g" in Aktion, um alle Vokale zu finden.
"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": [] }
Erfasste Teilstrings
Ähnlich wie der match-Filter gibt der capture-Filter ein Objekt zurück, wenn es einen Treffer gab.
STRING | capture(REGEX)
STRING | capture(REGEX; FLAGS)
STRING | capture([REGEX, FLAGS])
Das zurückgegebene Objekt ist eine Zuordnung der benannten Captures.
"JIRAISSUE-1234" | capture("(?<project>\\w+)-(?<issue_num>\\d+)")
# => {
# "project": "JIRAISSUE",
# "issue_num": "1234"
# }
Nur die Teilstrings
Der scan-Filter ähnelt match mit dem Flag "g".
STRING | scan(REGEX)
STRING | scan(REGEX; FLAGS)
scan gibt einen Stream von Teilstrings aus.
"Goodbye Mars" | scan("[aeiou]")
# => "o"
# "o"
# "e"
# "a"
Verwende den Array-Konstruktor [...], um die Teilstrings zu erfassen.
"Goodbye Mars" | [ scan("[aeiou]") ]
# => ["o", "o", "e", "a"]
Einen String aufteilen
Wenn du die Teile des Strings kennst, die du behalten möchtest, verwende match oder scan.
Wenn du die Teile kennst, die du verwerfen möchtest, verwende split.
STRING | split(REGEX; FLAGS)
Der split-Filter mit einem Argument (1-arity) behandelt sein Argument als festen String.
Um mit split einen regulären Ausdruck zu verwenden, musst du das zweite Argument angeben; eine leere Zeichenkette ist in Ordnung.
Ein Beispiel, das einen String an beliebigem Leerraum aufteilt.
"first second third fourth" | split("\\s+"; "")
# => ["first", "second", "third", "fourth"]
Ersetzungen
Die Filter sub und gsub können den Eingabe-String umwandeln, indem sie die übereinstimmenden Teile der Eingabe durch einen Ersatz-String ersetzen.
Um nur den ersten Treffer zu ersetzen, verwende sub.
Um alle Treffer zu ersetzen, verwende 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."
Der Ersatztext kann sich auf die übereinstimmenden Teilstrings beziehen; verwende benannte Captures und String-Interpolation.
"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"
Flags
In allen oben genannten Filtern ist FLAGS ein String, der aus null oder mehr der unterstützten Flags besteht.
-
g - Globale Suche (alle Treffer finden, nicht nur den ersten)
-
i - Suche ohne Beachtung der Groß-/Kleinschreibung
-
m - Mehrzeilenmodus ('.' passt auch auf Zeilenumbrüche)
-
n - Leere Treffer ignorieren
-
p - Sowohl der s- als auch der m-Modus sind aktiviert
-
s - Einzeilenmodus ('^' -> '\A', '$' -> '\Z')
-
l - Die längstmöglichen Treffer finden
-
x - Erweitertes Regex-Format (Leerraum und Kommentare ignorieren)
Zum Beispiel
"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")
Lernübung
