چت‌بات باقاعده

عبارات باقاعده

عبارات باقاعده (رجکس‌ها) دنباله‌هایی از نویسه‌ها هستند که یک الگوی جست‌وجو در متن را مشخص می‌کنند.

یادگیری نحوه‌ی نگارش عبارات باقاعده فراتر از محدوده‌ی این مبحث است. ما روی عباراتی تمرکز می‌کنیم که jq برای استفاده از عبارات باقاعده فراهم می‌کند.

گونه‌ی عبارات باقاعده

ابزارهای مختلف نسخه‌های متفاوتی از عبارات باقاعده را پیاده‌سازی می‌کنند. jq کتابخانه‌ی عبارات باقاعده‌ی Oniguruma را به کار می‌گیرد که تا حد زیادی با عبارات باقاعده‌ی Perl v5.8 سازگار است.

نحوه‌ی نگارش خاصی که jq استفاده می‌کند را می‌توان در مخزن GitHub Oniguruma یافت.

توابع عبارات باقاعده

عبارات باقاعده در jq محدود به مجموعه‌ای از فیلترها هستند.

تطبیق ساده

وقتی می‌خواهید بدانید آیا رشته‌ای با الگویی تطبیق پیدا می‌کند، از فیلتر test استفاده کنید.

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

این فیلتر یک نتیجه‌ی منطقی تولید می‌کند.

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

اطلاعات درباره‌ی تطبیق

وقتی می‌خواهید زیررشته‌ای را استخراج کنید که واقعاً با الگو تطبیق پیدا کرده است، از فیلتر match استفاده کنید.

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

این فیلتر خروجی می‌دهد:

• اگر تطبیقی وجود نداشته باشد، هیچ نتیجه‌ای، یا
• اگر تطبیقی وجود داشته باشد، شیئی شامل ویژگی‌های مختلف.

این مثال با استفاده از نحوه‌ی نگارش ارجاع به عقب، \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
#        }
#      ]
#    }

فیلتر match برای هر تطبیق یک شیء برمی‌گرداند. این مثال کاربرد پرچم "g" را برای یافتن همه‌ی مصوت‌ها نشان می‌دهد.

"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": [] }

زیررشته‌های ثبت‌شده

مشابه فیلتر match، فیلتر capture در صورت وجود تطبیق یک شیء برمی‌گرداند.

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

شیء برگردانده‌شده نگاشتی از ثبت‌های نام‌دار است.

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

فقط زیررشته‌ها

فیلتر scan مشابه match با پرچم "g" است.

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

scan یک جریان از زیررشته‌ها خروجی می‌دهد.

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

از سازنده‌ی آرایه‌ی [...] برای ثبت زیررشته‌ها استفاده کنید.

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

تقسیم یک رشته

اگر بخش‌هایی از رشته را می‌دانید که می‌خواهید نگه دارید، از match یا scan استفاده کنید. اگر بخش‌هایی را می‌دانید که می‌خواهید دور بیندازید، از split استفاده کنید.

STRING | split(REGEX; FLAGS)

مثالی که یک رشته را بر اساس فاصله‌ی سفید دلخواه تقسیم می‌کند.

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

جانشینی‌ها

فیلترهای sub و gsub می‌توانند رشته‌ی ورودی را تغییر دهند و بخش‌های تطبیق‌یافته‌ی ورودی را با یک رشته‌ی جانشین جایگزین کنند.

برای جایگزینی فقط اولین تطبیق، از sub استفاده کنید. برای جایگزینی همه‌ی تطبیق‌ها، از 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."

متن جانشین می‌تواند به زیررشته‌های تطبیق‌یافته ارجاع دهد؛ از ثبت‌های نام‌دار و درون‌یابی رشته استفاده کنید.

"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 رشته‌ای است که از صفر یا چند مورد از پرچم‌های پشتیبانی‌شده تشکیل شده است.

• g - جست‌وجوی سراسری (همه‌ی تطبیق‌ها را پیدا کنید، نه فقط اولین تطبیق)
• i - جست‌وجوی بدون حساسیت به بزرگی و کوچکی حروف
• m - حالت چندخطی ('.' با خطوط جدید تطبیق پیدا می‌کند)
• n - تطبیق‌های خالی را نادیده بگیرید
• p - هر دو حالت s و m فعال می‌شوند
• s - حالت تک‌خطی (^ -> \A، $ -> \Z)
• l - بلندترین تطبیق‌های ممکن را پیدا کنید
• x - قالب گسترده‌ی عبارت باقاعده (فاصله‌ی سفید و کامنت‌ها را نادیده بگیرید)

برای مثال

"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")