{"id":695,"date":"2018-08-14T00:21:17","date_gmt":"2018-08-14T08:21:17","guid":{"rendered":"https:\/\/blogs.msdn.microsoft.com\/koryt\/?p=695"},"modified":"2019-10-09T05:27:34","modified_gmt":"2019-10-09T13:27:34","slug":"regular-expressions-regex-grouping-regex","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/scripting\/regular-expressions-regex-grouping-regex\/","title":{"rendered":"Regular Expressions (REGEX): Grouping & [RegEx]"},"content":{"rendered":"

Welcome back to the RegEx crash course. Last time we talked about the basic symbols<\/a> we plan to use as our foundation. This week, we will be learning a new way to leverage our patterns for data extraction and how to rip our extracted data into pieces we care about.<\/p>\n

[RegEx]<\/h3>\n

The [Regex]<\/code>\u00a0data type has some cool static members,\u00a0 but we’re mostly going to play with the plural method\u00a0matches(<data>,<pattern>)<\/code> if you don’t know what static members are you can check this post<\/a> or this help data<\/a>.<\/p>\n

A lot of the time, when we work with RegEx we are using it to extract everything<\/em> that matches our pattern in a large amount of data. Using $matches<\/code>\u00a0like we did in the previous posts means we have to write a lot of looping and if statements. With [regex]::matches()<\/code>we can condense all that and it could work on a big blob of text instead of just a list of individual lines. This means that if there is more than 1 match per line we can still get it!<\/p>\n

If we take a look at some sample data that it returns, we can see that we actually get a pretty rich match object:<\/p>\n

Groups : {0}\r\nSuccess : True\r\nName : 0\r\nCaptures : {0}\r\nIndex : 3534\r\nLength : 23\r\nValue : ecowpland1d@myspace.com<\/pre>\n
The thing we care about is the\u00a0value<\/code>\u00a0property, but you’ll notice it even tells you the starting character and how many characters long it is.<\/p>\n
Let’s take a look at how we might modify the email match from the earlier post to use this:<\/p>\n
#grab our data as one big blob (-raw)\r\n$file = get-content \"$PSScriptRoot\\MOCK_DATA.txt\" -raw\r\n\r\n#make our pattern\r\n$regex = \"\\w+@\\w+\\.\\w+\"\r\n\r\n#extract all matches and display the value property\r\n[RegEx]::Matches($file,$regex).value\r\n<\/pre>\n
Now it all looks a lot sleeker, go [RegEx]!<\/p>\n
Grouping<\/h4>\n
Grouping is a way that we can logically break up our extraction. I use this for 2 main reasons:<\/p>\n
    \n
  1. The data I want isn’t unique on its own, but the data around it is. Now I can match the unique<\/em> piece and rip out what I want<\/em> to use.<\/li>\n
  2. The data I want is all there, but I plan to use pieces of it for different things<\/li>\n<\/ol>\n
    Grouping can be done by wrapping sections of your pattern in parenthesis. The full pattern will always match as group 0<\/code>, which is why we were typing $matches[0]<\/code>\u00a0to start. Each individual group then gets pulled out in numerical order.<\/p>\n
    Maybe we grab some data by copy\/pasting out of outlook and it looks like this: Brenda Seamon <bseamon0@bbc.co.uk><\/code>\u00a0If its in a large block of text we might want to use RegEx to extract it like we have before. This time, we want to grab the First, Last, and Email to use for things. They’re all in our data, and we can use grouping to pull them out individually.<\/p>\n
    Let’s start by finding a pattern that gets all of our data. I used this one: $pattern = \"\\w+\\s+\\w+\\s+<\\w+@\\w+\\.\\w+>\"<\/code><\/p>\n
      \n
    1. 1+ word characters (first name)<\/li>\n
    2. 1+ space characters<\/li>\n
    3. 1+ word characters (last name)<\/li>\n
    4. 1+ space characters<\/li>\n
    5. <<\/li>\n
    6. The rest of our email pattern, like we used before.<\/li>\n
    7. ><\/li>\n<\/ol>\n
      We can see that words with our test:<\/p>\n
      $data = \"Brenda Seamon <bseamon0@bbc.co>\"\r\n$pattern = \"\\w+\\s+\\w+\\s+<\\w+@\\w+\\.\\w+>\"\r\n$data -match $pattern\r\n$matches[0]<\/pre>\n
      Now that we know it works, lets try grouping up the pieces we want by putting parens around the first, last and email sections: $pattern = \"(\\w+)\\s+(\\w+)\\s+\"<\/code><\/p>\n
      $data = \"Brenda Seamon <bseamon0@bbc.co>\"\r\n$pattern = \"(\\w+)\\s+(\\w+)\\s<(\\w+@\\w+\\.\\w+)>\"\r\n$data -match $pattern\r\n$matches[0]\r\n\r\n\"All match: {0}\r\nFirst name: {1}\r\nLast name: {2}\r\nEmail: {3}\r\n\" -f $matches[0],$matches[1],$matches[2],$matches[3]<\/pre>\n
      All match: Brenda Seamon &amp;amp;amp;lt;bseamon0@bbc.co&amp;amp;amp;gt;\r\nFirst name: Brenda\r\nLast: name Seamon\r\nEmail: bseamon0@bbc.co\r\n<\/pre>\n
      We can also name these groups using ?<NAME><\/code>inside of the parens. This makes our pattern start to look really bananas if we saw it without context $pattern = \"(?<first>\\w+)\\s+(?<last>\\w+)\\s+<(?<email>\\w+@\\w+\\.\\w+)>\"<\/code><\/p>\n
      $data = \"Brenda Seamon <bseamon0@bbc.co>\"\r\n$pattern = \"(?<first>\\w+)\\s+(?<last>\\w+)\\s+<(?<email>\\w+@\\w+\\.\\w+)>\"\r\n$data -match $pattern\r\n$matches[0]\r\n\r\n\"All match: {0}\r\nFirst name: {1}\r\nLast name: {2}\r\nEmail: {3}\r\n\" -f $matches[0],$matches[\"first\"],$matches[\"last\"],$matches[\"email\"]<\/pre>\n
      Notice $matches<\/code>\u00a0is a hash table, and our group names become the keys. Let’s try grabbing the groups using [RegEx]<\/p>\n
      $data = \"Brenda Seamon <bseamon0@bbc.co>\"\r\n$pattern = \"(?<first>\\w+)\\s+(?<last>\\w+)\\s+<(?<email>\\w+@\\w+\\.\\w+)>\"\r\n$results = [Regex]::Matches($data,$Pattern)\r\n$results[0].groups[\"email\"].value<\/pre>\n
      Its a bit more work, since we need to keep track of which result we are on in a group of matches. This scales nicely for looping though!<\/p>\n
      $data = \"Brenda Seamon <bseamon0@bbc.co>, Joeann Brotherwood <jbrotherwood1@house.gov>, Jake Duffan <jduffan2@google.ru>\"\r\n$pattern = \"(?<first>\\w+)\\s+(?<last>\\w+)\\s+<(?<email>\\w+@\\w+\\.\\w+)>\"\r\n$results = [Regex]::Matches($data,$Pattern)\r\n$people = @()\r\n\r\nforeach($person in $results)\r\n{\r\n$obj = [pscustomobject]@{\r\n\"First Name\" = $person.Groups[\"first\"].value\r\n\"Last Name\" = $person.Groups[\"last\"].value\r\nEmail = $person.Groups[\"email\"].value\r\n}\r\n\r\n$people += $obj\r\n}\r\n\r\n$People<\/pre>\n
      First Name Last Name Email\r\n---------- --------- -----\r\nBrenda Seamon bseamon0@bbc.co\r\nJoeann Brotherwood jbrotherwood1@house.gov\r\nJake Duffan jduffan2@google.ru\r\n<\/pre>\n
      Hopefully you’ve had fun playing with RegEx so far. We will take a look at some other symbols and some little tricks we can use grouping and ?<\/code>for in future posts!<\/p>\n
      As always, don’t forget to rate, comment and share! Let me know what you think of the content and what topics you’d like to see me blog about in the future.<\/p>\n","protected":false},"excerpt":{"rendered":"
      Welcome back to the RegEx crash course. Last time we talked about the basic symbols we plan to use as our foundation. This week, we will be learning a new way to leverage our patterns for data extraction and how to rip our extracted data into pieces we care about. [RegEx] The [Regex]\u00a0data type has […]<\/p>\n","protected":false},"author":7300,"featured_media":87096,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[1738],"tags":[2221,2125,377,174],"class_list":["post-695","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-powershell","tag-kory-thacher","tag-koryt","tag-powershell","tag-regular-expressions"],"acf":[],"blog_post_summary":"
      Welcome back to the RegEx crash course. Last time we talked about the basic symbols we plan to use as our foundation. This week, we will be learning a new way to leverage our patterns for data extraction and how to rip our extracted data into pieces we care about. [RegEx] The [Regex]\u00a0data type has […]<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/posts\/695","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/users\/7300"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/comments?post=695"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/posts\/695\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/media\/87096"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/media?parent=695"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/categories?post=695"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/tags?post=695"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}