@@ -67,11 +67,18 @@ <h1>Source code for celpy.evaluation</h1><div class="highlight"><pre>
6767< span class ="sd "> The :py:class:`Resut` type hint is a union of the various values that are encountered</ span >
6868< span class ="sd "> during evaluation. It's a union of the :py:class:`celpy.celtypes.CELTypes` type and the</ span >
6969< span class ="sd "> :exc:`CELEvalError` exception.</ span >
70+
71+ < span class ="sd "> .. important:: Debugging</ span >
72+
73+ < span class ="sd "> If the os environment variable ``CEL_TRACE`` is set, then detailed tracing of methods is made available.</ span >
74+ < span class ="sd "> To see the trace, set the logging level for ``celpy.Evaluator`` to ``logging.DEBUG``.</ span >
75+
7076< span class ="sd "> """</ span >
7177
7278< span class ="kn "> import</ span > < span class ="w "> </ span > < span class ="nn "> collections</ span >
7379< span class ="kn "> import</ span > < span class ="w "> </ span > < span class ="nn "> logging</ span >
7480< span class ="kn "> import</ span > < span class ="w "> </ span > < span class ="nn "> operator</ span >
81+ < span class ="kn "> import</ span > < span class ="w "> </ span > < span class ="nn "> os</ span >
7582< span class ="kn "> import</ span > < span class ="w "> </ span > < span class ="nn "> re</ span >
7683< span class ="kn "> import</ span > < span class ="w "> </ span > < span class ="nn "> sys</ span >
7784< span class ="kn "> from</ span > < span class ="w "> </ span > < span class ="nn "> functools</ span > < span class ="w "> </ span > < span class ="kn "> import</ span > < span class ="n "> reduce</ span > < span class ="p "> ,</ span > < span class ="n "> wraps</ span >
@@ -100,11 +107,11 @@ <h1>Source code for celpy.evaluation</h1><div class="highlight"><pre>
100107< span class ="kn "> import</ span > < span class ="w "> </ span > < span class ="nn "> celpy.celtypes</ span >
101108< span class ="kn "> from</ span > < span class ="w "> </ span > < span class ="nn "> celpy.celparser</ span > < span class ="w "> </ span > < span class ="kn "> import</ span > < span class ="n "> tree_dump</ span >
102109
103- < span class ="n "> _USE_RE2</ span > < span class ="o "> =</ span > < span class ="kc "> False</ span >
110+ < span class ="n "> _USE_RE2</ span > < span class ="o "> =</ span > < span class ="kc "> False</ span > < span class =" c1 " > # Used by the test suite. </ span >
104111< span class ="k "> try</ span > < span class ="p "> :</ span >
105112 < span class ="kn "> import</ span > < span class ="w "> </ span > < span class ="nn "> re2</ span >
106113
107- < span class ="n "> _USE_RE2</ span > < span class ="o "> =</ span > < span class ="kc "> True</ span >
114+ < span class ="n "> _USE_RE2</ span > < span class ="o "> =</ span > < span class ="kc "> True</ span > < span class =" c1 " > # Used by the test suite. </ span >
108115
109116 < span class ="k "> def</ span > < span class ="w "> </ span > < span class ="nf "> function_matches</ span > < span class ="p "> (</ span > < span class ="n "> text</ span > < span class ="p "> :</ span > < span class ="nb "> str</ span > < span class ="p "> ,</ span > < span class ="n "> pattern</ span > < span class ="p "> :</ span > < span class ="nb "> str</ span > < span class ="p "> )</ span > < span class ="o "> -></ span > < span class ="s2 "> "Result"</ span > < span class ="p "> :</ span >
110117 < span class ="k "> try</ span > < span class ="p "> :</ span >
@@ -128,8 +135,7 @@ <h1>Source code for celpy.evaluation</h1><div class="highlight"><pre>
128135
129136
130137
131- < span class ="c1 "> # A CEL type annotation. Used in an environment to describe objects as well as functions.</ span >
132- < span class ="c1 "> # This is a list of types, plus Callable for conversion functions.</ span >
138+ < span class ="c1 "> # This annotation describes a union of types, functions, and function types.</ span >
133139< span class ="n "> Annotation</ span > < span class ="o "> =</ span > < span class ="n "> Union</ span > < span class ="p "> [</ span >
134140 < span class ="n "> celpy</ span > < span class ="o "> .</ span > < span class ="n "> celtypes</ span > < span class ="o "> .</ span > < span class ="n "> CELType</ span > < span class ="p "> ,</ span >
135141 < span class ="n "> Callable</ span > < span class ="p "> [</ span >
@@ -330,9 +336,9 @@ <h1>Source code for celpy.evaluation</h1><div class="highlight"><pre>
330336
331337
332338
333- < span class ="c1 "> # The interim results extends celtypes to include itermediate CELEvalError exception objects.</ span >
339+ < span class ="c1 "> # The interim results extend `` celtypes`` to include itermediate `` CELEvalError`` exception objects.</ span >
334340< span class ="c1 "> # These can be deferred as part of commutative logical_and and logical_or operations.</ span >
335- < span class ="c1 "> # It includes the responses to type() queries, also.</ span >
341+ < span class ="c1 "> # It includes the responses to `` type()`` queries, also.</ span >
336342< span class ="n "> Result</ span > < span class ="o "> =</ span > < span class ="n "> Union</ span > < span class ="p "> [</ span >
337343 < span class ="n "> celpy</ span > < span class ="o "> .</ span > < span class ="n "> celtypes</ span > < span class ="o "> .</ span > < span class ="n "> Value</ span > < span class ="p "> ,</ span >
338344 < span class ="n "> CELEvalError</ span > < span class ="p "> ,</ span >
@@ -1310,18 +1316,22 @@ <h1>Source code for celpy.evaluation</h1><div class="highlight"><pre>
13101316< span class ="p "> )</ span > < span class ="o "> -></ span > < span class ="n "> Callable</ span > < span class ="p "> [[</ span > < span class ="s2 "> "Evaluator"</ span > < span class ="p "> ,</ span > < span class ="n "> lark</ span > < span class ="o "> .</ span > < span class ="n "> Tree</ span > < span class ="p "> ],</ span > < span class ="n "> Any</ span > < span class ="p "> ]:</ span >
13111317< span class ="w "> </ span > < span class ="sd "> """</ span >
13121318< span class ="sd "> Decorator to create consistent evaluation trace logging.</ span >
1313- < span class ="sd "> This only works for a class with a ``level`` attribute.</ span >
1314- < span class ="sd "> This is generally applied to the methods matching rule names.</ span >
1319+ < span class ="sd "> This is generally applied to the methods matching parse rule names.</ span >
1320+
1321+ < span class ="sd "> This only works for a class with a ``level`` attribute, like :py:class:`Evaluator`.</ span >
13151322< span class ="sd "> """</ span >
13161323
13171324 < span class ="nd "> @wraps</ span > < span class ="p "> (</ span > < span class ="n "> method</ span > < span class ="p "> )</ span >
13181325 < span class ="k "> def</ span > < span class ="w "> </ span > < span class ="nf "> concrete_method</ span > < span class ="p "> (</ span > < span class ="bp "> self</ span > < span class ="p "> :</ span > < span class ="s2 "> "Evaluator"</ span > < span class ="p "> ,</ span > < span class ="n "> tree</ span > < span class ="p "> :</ span > < span class ="n "> lark</ span > < span class ="o "> .</ span > < span class ="n "> Tree</ span > < span class ="p "> )</ span > < span class ="o "> -></ span > < span class ="n "> Any</ span > < span class ="p "> :</ span >
1319- < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> logger</ span > < span class ="o "> .</ span > < span class ="n "> info </ span > < span class ="p "> (</ span > < span class ="s2 "> "</ span > < span class ="si "> %s%r</ span > < span class ="s2 "> "</ span > < span class ="p "> ,</ span > < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> level</ span > < span class ="o "> *</ span > < span class ="s2 "> "| "</ span > < span class ="p "> ,</ span > < span class ="n "> tree</ span > < span class ="p "> )</ span >
1326+ < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> logger</ span > < span class ="o "> .</ span > < span class ="n "> debug </ span > < span class ="p "> (</ span > < span class ="s2 "> "</ span > < span class ="si "> %s%r</ span > < span class ="s2 "> "</ span > < span class ="p "> ,</ span > < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> level</ span > < span class ="o "> *</ span > < span class ="s2 "> "| "</ span > < span class ="p "> ,</ span > < span class ="n "> tree</ span > < span class ="p "> )</ span >
13201327 < span class ="n "> result</ span > < span class ="o "> =</ span > < span class ="n "> method</ span > < span class ="p "> (</ span > < span class ="bp "> self</ span > < span class ="p "> ,</ span > < span class ="n "> tree</ span > < span class ="p "> )</ span >
1321- < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> logger</ span > < span class ="o "> .</ span > < span class ="n "> info </ span > < span class ="p "> (</ span > < span class ="s2 "> "</ span > < span class ="si "> %s%s</ span > < span class ="s2 "> -> </ span > < span class ="si "> %r</ span > < span class ="s2 "> "</ span > < span class ="p "> ,</ span > < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> level</ span > < span class ="o "> *</ span > < span class ="s2 "> "| "</ span > < span class ="p "> ,</ span > < span class ="n "> tree</ span > < span class ="o "> .</ span > < span class ="n "> data</ span > < span class ="p "> ,</ span > < span class ="n "> result</ span > < span class ="p "> )</ span >
1328+ < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> logger</ span > < span class ="o "> .</ span > < span class ="n "> debug </ span > < span class ="p "> (</ span > < span class ="s2 "> "</ span > < span class ="si "> %s%s</ span > < span class ="s2 "> -> </ span > < span class ="si "> %r</ span > < span class ="s2 "> "</ span > < span class ="p "> ,</ span > < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> level</ span > < span class ="o "> *</ span > < span class ="s2 "> "| "</ span > < span class ="p "> ,</ span > < span class ="n "> tree</ span > < span class ="o "> .</ span > < span class ="n "> data</ span > < span class ="p "> ,</ span > < span class ="n "> result</ span > < span class ="p "> )</ span >
13221329 < span class ="k "> return</ span > < span class ="n "> result</ span >
13231330
1324- < span class ="k "> return</ span > < span class ="n "> concrete_method</ span > </ div >
1331+ < span class ="k "> if</ span > < span class ="n "> os</ span > < span class ="o "> .</ span > < span class ="n "> environ</ span > < span class ="o "> .</ span > < span class ="n "> get</ span > < span class ="p "> (</ span > < span class ="s2 "> "CEL_TRACE"</ span > < span class ="p "> ):</ span >
1332+ < span class ="k "> return</ span > < span class ="n "> concrete_method</ span >
1333+ < span class ="k "> else</ span > < span class ="p "> :</ span >
1334+ < span class ="k "> return</ span > < span class ="n "> method</ span > </ div >
13251335
13261336
13271337
0 commit comments