Merge pull request #22 from zopefoundation/path_expr_with_configurabl…

…e_builtins

Support (some) builtins in path expressions

CHANGES.rst

@@ -5,7 +5,8 @@
 5.0.3 (unreleased)
 ==================
 
-- Nothing changed yet.
+- Improve `PathExpr` reusability
+  Provide customizable support for the use of builtins in path expressions
 
 
 5.0.2 (2020-03-27)

src/zope/tales/expressions.py

@@ -60,6 +60,8 @@ class SubPathExpr(object):
     Implementation of a single path expression.
     """
 
+    ALLOWED_BUILTINS = {}
+
     def __init__(self, path, traverser, engine):
         self._traverser = traverser
         self._engine = engine
@@ -137,7 +139,12 @@ def _eval(self, econtext,
         if base == 'CONTEXTS' or not base:  # Special base name
             ob = econtext.contexts
         else:
-            ob = vars[base]
+            try:
+                ob = vars[base]
+            except KeyError:
+                ob = self.ALLOWED_BUILTINS.get(base, _marker)
+                if ob is _marker:
+                    raise
         if isinstance(ob, DeferWrapper):
             ob = ob()
 
@@ -177,6 +184,8 @@ class PathExpr(object):
         'nocall',
     )
 
+    SUBEXPR_FACTORY = SubPathExpr
+
     def __init__(self, name, expr, engine, traverser=simpleTraverse):
         self._s = expr
         self._name = name
@@ -192,7 +201,7 @@ def __init__(self, name, expr, engine, traverser=simpleTraverse):
                 add(engine.compile('|'.join(paths[i:]).lstrip()))
                 self._hybrid = True
                 break
-            add(SubPathExpr(path, traverser, engine)._eval)
+            add(self.SUBEXPR_FACTORY(path, traverser, engine)._eval)
 
     def _exists(self, econtext):
         for expr in self._subexprs:

src/zope/tales/tests/test_expressions.py

@@ -387,6 +387,29 @@ def test_bad_initial_name_subexpr(self):
             "Invalid variable name"
         )
 
+    def test_builtins_in_path(self):
+        from ..tales import ExpressionEngine
+        from ..expressions import PathExpr, SubPathExpr
+
+        class MySubPathExpr(SubPathExpr):
+            ALLOWED_BUILTINS = {'True': True, 'False': False, 'x': None}
+
+        class MyPathExpr(PathExpr):
+            SUBEXPR_FACTORY = MySubPathExpr
+
+        engine = ExpressionEngine()
+        for pt in MyPathExpr._default_type_names:
+            engine.registerType(pt, MyPathExpr)
+
+        def eval(expr):
+            return engine.compile(expr)(self.context)
+
+        self.assertTrue(eval("True"))
+        self.assertFalse(eval("False"))
+        with self.assertRaises(KeyError):
+            eval("None")
+        self.assertIsNotNone(eval("x"))  # variable before builtin
+
 
 class FunctionTests(ExpressionTestBase):