Skip to content

Commit

Permalink
Use re2 instead of re for match expressions
Browse files Browse the repository at this point in the history
CEL specifies that match should use re2 pattern matching and not re
semantics.
  • Loading branch information
ddn0 committed Jun 6, 2024
1 parent a27498e commit 2f76a8d
Show file tree
Hide file tree
Showing 5 changed files with 139 additions and 6 deletions.
15 changes: 15 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,21 @@ Installation

You now have the CEL run-time available to Python-based applications.


re2
---

CEL specifies that regular expressions use re2 syntax,
https://github.com/google/re2/wiki/Syntax. To keep its dependencies minimal and
this implementation easily embeddable, cel-python uses the Python standard
library ``re`` syntax by default. If a ``re2`` package is installed or the
``re2`` extra is provided, cel-python will use ``re2`` syntax instead.

::

pip install cel-python[re2]


Command Line
============

Expand Down
82 changes: 79 additions & 3 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 5 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,10 @@ python-dateutil = "^2.9.0.post0"
pyyaml = "^6.0.1"
types-pyyaml = "^6.0.12.20240311"
types-python-dateutil = "^2.9.0.20240316"
google-re2 = { version = "^1.0", optional = true }

[tool.poetry.extras]
re2 = ["google-re2"]

[tool.poetry.group.dev.dependencies]
behave = "^1.2.6"
Expand All @@ -55,6 +59,7 @@ pytest-cov = "^5.0.0"
sphinx = "^6.0"
tox = "^4.15.0"
pre-commit = "^3.5"
google-re2-stubs = "^0.1.0"

[build-system]
requires = ["poetry-core"]
Expand Down
36 changes: 33 additions & 3 deletions src/celpy/evaluation.py
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,14 @@
import celpy.celtypes
from celpy.celparser import tree_dump

_USE_RE2 = False
try:
import re2
except ImportError:
pass
else:
_USE_RE2 = True

# A CEL type annotation. Used in an environment to describe objects as well as functions.
# This is a list of types, plus Callable for conversion functions.
Annotation = Union[
Expand All @@ -59,10 +67,8 @@
Type[celpy.celtypes.FunctionType], # Concrete class for annotations
]


logger = logging.getLogger("evaluation")


class CELSyntaxError(Exception):
"""CEL Syntax error -- the AST did not have the expected structure."""
def __init__(self, arg: Any, line: Optional[int] = None, column: Optional[int] = None) -> None:
Expand Down Expand Up @@ -293,6 +299,30 @@ def operator_in(item: Result, container: Result) -> Result:
return result


def _function_matches_re(text: str, pattern: str) -> Result:
try:
m = re.search(pattern, text)
except re.error as ex:
return CELEvalError("match error", ex.__class__, ex.args)

return celpy.celtypes.BoolType(m is not None)


def _function_matches_re2(text: str, pattern: str) -> Result:
try:
m = re2.search(pattern, text)
except re2.error as ex:
return CELEvalError("match error", ex.__class__, ex.args)

return celpy.celtypes.BoolType(m is not None)


def function_matches(text: str, pattern: str) -> Result:
if _USE_RE2:
return _function_matches_re2(text, pattern)
return _function_matches_re(text, pattern)


def function_size(container: Result) -> Result:
"""
The size() function applied to a Value. Delegate to Python's :py:func:`len`.
Expand Down Expand Up @@ -340,7 +370,7 @@ def function_size(container: Result) -> Result:
# StringType methods
"endsWith": lambda s, text: celpy.celtypes.BoolType(s.endswith(text)),
"startsWith": lambda s, text: celpy.celtypes.BoolType(s.startswith(text)),
"matches": lambda s, pattern: celpy.celtypes.BoolType(re.search(pattern, s) is not None),
"matches": function_matches,
"contains": lambda s, text: celpy.celtypes.BoolType(text in s),
# TimestampType methods. Type details are redundant, but required because of the lambdas
"getDate": lambda ts, tz_name=None: celpy.celtypes.IntType(ts.getDate(tz_name)),
Expand Down
7 changes: 7 additions & 0 deletions tests/test_evaluation.py
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,13 @@ def test_operator_in():
assert isinstance(operator_in(celtypes.IntType(-1), container_2), CELEvalError)


def test_function_matches():
empty_string = celtypes.StringType("")
# re2-specific patterns which behave differently than standard re
assert function_matches(empty_string, "^\\z")
assert isinstance(function_matches(empty_string, "^\\Z"), CELEvalError)


def test_function_size():
container_1 = celtypes.ListType([
celtypes.IntType(42),
Expand Down

0 comments on commit 2f76a8d

Please sign in to comment.