newdev14
newdev14

Reputation: 1111

regex- capturing text between matches

In the following text, I try to match a number followed by ")" and number followed by a period. I am trying to retrieve the text between the matches.
Example:

"1) there is a dsfsdfsd and 2) there is another one and 3) yet another case"

so I am trying to output: ["there is a dsfsdfsd and", "there is another one and", yet another case"]

I've used this regex: (?:\d)|\d.) Adding a .* at the end matches the entire string, I only want it to match the words between

also in this string:

"we will give 4. there needs to be another option and 6.99 USD is a bit amount"

I want to only match the 4. and not the 6.99

Any pointers will be appreciated. Thank you. r

Upvotes: 1

Views: 2095

Answers (5)

Andrew Tweddle
Andrew Tweddle

Reputation: 21

tldr

  • Regular expressions are tricky beasts and you should avoid them if at all possible.
  • If you can't avoid them, then make sure you have lots of test cases for all the edge cases that can occur.
  • Build up your regular expression slowly and systematically, testing your assumptions at every step.
  • If this code will go intro production, then please write unit tests that explain the thinking process to the poor soul who has to maintain it one day

The long version

Regular expressions are finicky. Your best approach may be to solve the problem a different way.

For example, your language might have a library function that allows you to split up strings using a regular expression to define what comes between the numbers. That will let you get away with writing a simpler regex to match the numbers and brackets/dots.

If you still decide to use regular expressions, then you need to be very structured about how you build up your regular expressions. It's extremely easy to miss edge cases.

So let's break this down piece by piece...

  1. Set up a test environment for quickly experimenting with your regex.
    • There are lots of options here, depending on your programming language and OS. Ones I sometimes use are:
      • a Powershell window for testing .Net regexes (NB: the cli gives you a history of past attempts, so you can go back a few steps if you mess things up too badly)
      • a Python console for testing Python regexes (which are slightly different to .Net regexes in their syntax for named capture groups).
      • an html page with JavaScript to test the regex
      • an online or desktop regex tool (I still use the ancient Regular Expression Workbench from Eric Gunnerson, but I'm sure there are better alternatives these days)
    • Since you didn't specify a language or regex version, I'll assume .Net regular expressions
  2. Create a single test string for testing a wider variety of options.
    • Your goal is to include as many edge cases as you can think of. Here's what I would use: "ab 1. there is a dsfsdfsd costing $6.99 and 2) there is another one and 3. yet another case 4)5) 6)10."
    • Note that I've added a few extra cases you didn't mention:
      • empty strings between two round bracket numbers: "4)" and "5)"
      • white space string between two round bracket numbers: "5)" and "6)"
      • empty strings between a round bracket number and a dotted number: "6)" and "10."
      • empty string after the dotted number "10." at the end of the string
      • random text and empty space, which should be ignored, before the first number
    • I'm going to make a few assumptions here, which you will need to vary based on your actual requirements:
      • You DO want to capture the white space after the dot or round bracket.
      • You DO want to capture the white space before the next dotted number or round bracket number.
      • You might have numbers that go beyond 9, so I've included "10" in the test cases.
      • You want to capture empty strings at the end e.g. after the "10."
    • NOTES:
      • Thinking through this test case forces you to be more rigorous about your requirements.
      • It will also help you be more efficient while you are manually testing your regular expression.
      • HOWEVER, this is assuming you aren't following a TDD approach. If you are, then you should probably do things a little differently... create unit tests for each scenario separately and get the regex working incrementally.
      • This test string doesn't cover all cases. For example, there are no newline or tab characters in the test string. Also it can't test for an empty string following a round bracket number at the very end.
  3. First get a regex working that just captures the round brackets and dotted brackets.
    • Don't worry about the $6.99 edge case yet.
    • Drop the "(?:" non-capturing group syntax from your regex for now: "\d)|\d."
    • This doesn't even parse, because you have an unescaped round bracket.
    • The revised string is "\d\)|\d.", which parses, but which also matches "99" which you probably weren't expecting. That's because you forgot to escape the "."
    • The revised string is "\d\)|\d\.". This no longer matches "99", but it now matches "0." at the end instead of "10.". That's because it assumes that numbers will be single digit only.
    • The following string seems to work: "\d+\)|\d+\."
    • Time to deal with that pesky "$6.99" now...
  4. Modify the regex so that it doesn't capture a floating point number.
    • You need to use a negative look ahead pattern to prevent a digit being after the decimal point.
    • Result: "\d+\)|\d+\.(?!\d)"
    • Count how many matches this produces. You're going to use this number for checking later results.
    • Hint: Save the regex pattern somewhere. You want to be able to go back to it any time you mess up your regex pattern beyond repair.
    • If you found a string splitting function, then you should use it now and avoid the complexity that follows. [I've included an example of this at the end.]
    • Simple is better, but I'm going to continue with the longer solution in the interests of showing an approach to staying in control of regex'es that start getting horribly complicated
  5. Decide how to exclude that pattern
    • You used the non-capture group pattern in your question i.e. "(?:"
    • That approach can work. But it's a bit cumbersome, because you need to have a capturing group after it that you will look for instead.
    • It would be much nicer if your entire pattern matched what you are looking for.
    • So wrap the number pattern inside a zero-width positive look behind pattern (if your language supports it) i.e. "(?<=".
    • This checks for the pattern, but doesn't include it in what gets captured.
    • So now your regex looks like this: "(?<=\d+\)|\d+\.(?!\d))"
  6. Test it!
    • It might seem silly to test this on its own - all the matches are empty strings.
    • Do it anyway. You want to sanity check every step of the way.
    • Make sure that it still produces the same number of matches as in step 4.
  7. Decide how to match the text in between the numbers.
    • You rightly mention that ".*" will match the entire string, not just the parts in between.
    • There's a neat trick that allows you to reuse the pattern from step 5 to get the text in between.
    • Start by just matching the next character
    • The trick is that you want to match any character unless it's the start of the next number
    • That sounds like a negative look ahead pattern again: "(?!"
    • Let X be the pattern you saved in step 4. Matching a single character will look like this: "(?!X)."
    • You want to match lots of those characters. So put that pattern into a non-capturing group and repeat it: "(?:(?!X).)*"
      • This assumes you want to capture empty text.
      • If you're not, then change the "*" to a "+".
      • Hint: This is such a common pattern that you will want to reuse it in future pasting in different patterns in place of X
      • I used a non-capturing group instead of a normal group so that you can also embed this pattern in regexes where you do care about the capturing groups
    • Resulting pattern: "(?:(?!\d+\)|\d+\.(?!\d)).)*"
      • I suggest testing this pattern on its own to see what it does
  8. Now put parts 5 and 7 together: "(?<=\d+\)|\d+\.(?!\d))(?:(?!\d+\)|\d+\.(?!\d)).)*"
    • Test it!
  9. Unit tests!
    • If this is going into production, then please write lots of unit tests that will explain each step of this thought process
    • Have pity on the poor soul who has to maintain your regex in future!
    • By rights that person should be you
    • I suggest putting a note in your calendar to return to this code in 6 months' time and make sure you can still understand it from the unit tests alone!
  10. Refactor
    • In six months' time, if you can't understand the code any more, use your newfound insight (and incentive) to solve the problem without using regular expressions (or only very simple ones)

Addendum

As an example of using a string splitting function to get away with a simpler regex, here's a solution in Powershell:

$string = 'ab   1. there is a dsfsdfsd costing $6.99 and 2) there is another one and 3. yet another case 4)5)   6)10.'
$pattern = [regex] '\d+\)|\d+\.(?!\d)'
$string -split $pattern | select-object -skip 1

Upvotes: 2

mchackam
mchackam

Reputation: 81

import re


s = "1) there is a dsfsdfsd and 2) there is another one and 3) yet another case"
s1 = "we will give 4. there needs to be another option and 6.99 USD is a bit amount"

regex = re.compile("\d\)\s.*?|\s\d\.\D.*?")


print ([x for x in regex.split(s) if x])
print regex.split(s1)

Output:

['there is a dsfsdfsd and ', 'there is another one and ', 'yet another case']
['we will give', 'there needs to be another option and 6.99 USD is a bit amount']

Upvotes: 0

Wiktor Stribiżew
Wiktor Stribiżew

Reputation: 626699

Judging by the task you have, it might be easier to match the delimiters and use re.split (as also pointed out by bobblebubble in the comments).

I dsuggest a mere

\d+[.)]\B\s*

See it in action (demo)

It matches 1 or more digits, then a . or a ), then it makes sure there is no word letter (digit, letter or underscore) after it and then matches zero or more whitespace.

Python demo:

import re
rx = r'\d+[.)]\B\s*'
test_str = "1) there is a dsfsdfsd and 2) there is another one and 3) yet another case\n\"we will give 4. there needs to be another option and 6.99 USD is a bit amount"
print([x for x in re.split(rx,test_str) if x])

Upvotes: 1

Chaz
Chaz

Reputation: 1

I used this pattern:

(?<=\d.\s)(.*?)(?=\d.\s)

demo

This looks for the contents between any digit, any character, then a space.

Edit: Updated pattern to handle the currency issue and line ends better:

This is with flag 'g'

(?<=[0-9].\s)(.*?)(?=\s[0-9].\s|\n|\r)

Demo 2

Upvotes: 0

Martin Konecny
Martin Konecny

Reputation: 59591

Try the following regex with the g modifier:

([A-Za-z\s\-_]+|\d(?!(\)|\.)\D)|\.\d)

Example: https://regex101.com/r/kB1xI0/3

[A-Za-z\s\-_]+ automatically matches all alphabetical characters + whitespace

\d(?!(\)|\.)\D) match any numeric sequence of digits not followed by a closing parenthesis ) or decimal value (.99)

\.\d match any period followed by numeric digit.

Upvotes: 0

Related Questions