Aunsiels / pyformlang

A python library to manipulate formal languages and various automata
https://pypi.org/project/pyformlang/
MIT License
43 stars 10 forks source link

Bug with braces and brackets in character ranges in PythonRegex #19

Closed aldogunsing-rl closed 8 months ago

aldogunsing-rl commented 8 months ago

Character ranges work incorrectly when braces or brackets are used inside them. Starting with braces, the expressions r"[{}]" and r"[\{\}]" work correctly, e.g.

from pyformlang.regular_expression import PythonRegex
PythonRegex(r"[{}]").accepts(["{"])

returns True. However, using r"[{-}]" raises an error and r"[\{-\}]" works incorrectly as the expression does not accept |.

Using brackets does not really work at all. The expressions r"[\[]", r"[Z-\[]", r"[\[-a]" and r"[\[-\]]" do not accept anything and r"[\]]", r"[Z-\]]" and r"[\]-a]" raise errors.

Aunsiels commented 8 months ago

Thank you for your feedback. There were three different issues:

  1. "-" denotes a range, but if the range contains escaped characters (like "|"), we need to really escape them when unfolding the range.
  2. "[" and "]" were not able to be escaped inside a "[...]"
  3. (not mentioned here but appeared) r"a[ab\\]" had a weird behavior. In some cases, we need to ignore the escaping of the last "]" (I am not quite sure what the rule is; if there is an odd number of "\", the re module in Python raises an error).

Thank you again for your help in finding bug :) I added your examples to the tests, and they should be working now. A new version was pushed on Pypi.

aldogunsing-rl commented 8 months ago

Thanks for the quick fix! However, I think ranges where the ending character is escaped still do not work correctly. r"[{-}]" correctly accepts {, | and }. However, r"[{-\}]" only accepts { and }, but not |. Escaping the first { does not change the behavior. Similar for the brackets: r"[\[-\]]" only accepts [ and ], but not \.

(Also, it looks like you added the test self._test_compare(r"[{-}]", "-"), but r"[{-}]" should, and does not, accept - and should, and does, accept |. Shouldn't the automated test fail?)

Aunsiels commented 8 months ago

Thanks again.

Ultimately, I had to work harder to understand what Python is actually doing and how escaping works (https://docs.python.org/3/reference/lexical_analysis.html#escape-sequences). I am not quite sure I mimic exactly the behavior of Python re in all edge cases, but it should be closer now.

I discovered weird things. For example, the three following regexes seem to have the same behavior:

r = re.compile("\\x10")
r = re.compile("\x10")
r = re.compile(r"\x10")

To recognize the string \x10 (not hexadecimal equivalent), we have to escape twice:

r = re.compile("\\\\x10")

At this point, I am not sure anybody is writing such regex...

Anyway, it should work better now. A new version was pushed. Tell me if you find other hard cases!

Aunsiels commented 8 months ago

(and regarding your last question, self._test_compare only tests that PythonRegex has the same behavior as re. It does not assume the word is accepted or not. In your example, both modules return False, which is good)

aldogunsing-rl commented 8 months ago

Thanks! It looks like it works correctly now.

aldogunsing-rl commented 8 months ago

I have found some new hard cases! It looks like the escaping of a dot with backslashes in front does not behave correctly:

from pyformlang.regular_expression import PythonRegex
PythonRegex(r"\.").accepts(["a"]) # Returns False
PythonRegex(r"\.").accepts(["."]) # Returns True
PythonRegex(r"\\.").accepts(["\\a"]) # Returns False, should be True
PythonRegex(r"\\.").accepts(["\\."]) # Returns False, should be True
PythonRegex(r"\\\.").accepts(["\\a"]) # Returns False
PythonRegex(r"\\\.").accepts(["\\."]) # Returns False, should be True
Aunsiels commented 8 months ago

Thank you again! I quickly found the bug and corrected it.

aldogunsing-rl commented 8 months ago

Thanks for quick response, but it doesn't seem to be fixed? When I install version 1.0.7, I get the same results in my example as before?

Aunsiels commented 8 months ago

In your examples, you have to remove the square brackets. Otherwise, Pyformlang understands that "\\a" is a single symbol/letter (because Pyformlang is more general in a way than Python re).

aldogunsing-rl commented 8 months ago

Ah yes, I forgot about that part. Thanks, it works now! Then my examples were also incorrect as the last one did already return True, but 'luckily' the middle two were indeed wrong...