Skip to content

Commit 2b7eafa

Browse files
authored
Address issue #106 (#108)
Use an environment variable to enable the trace debug messages. Performance benchmark time Compile: 8.9293 ms Prepare: 0.0004 ms Convert: 0.0073 ms Evaluate: 5.8606 ms The evaluation time for the benchmark expression moves from 7.3 ms to 5.9 ms. About 20% less time.
1 parent 3331648 commit 2b7eafa

17 files changed

Lines changed: 545 additions & 39 deletions

‎MANIFEST.in‎

Lines changed: 0 additions & 8 deletions
This file was deleted.

‎Makefile‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,3 +59,4 @@ clean:
5959

6060
benchmarks:
6161
PYTHONPATH=src python benches/large_resource_set.py TagAssetBenchmark
62+
PYTHONPATH=src python benches/complex_expression.py

‎benches/complex_expression.py‎

Lines changed: 457 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/build/doctrees/api.doctree‎

1.72 KB
Binary file not shown.
2.51 KB
Binary file not shown.
2.64 KB
Binary file not shown.

‎docs/build/html/_modules/celpy/__init__.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,7 @@ <h1>Source code for celpy.__init__</h1><div class="highlight"><pre>
236236
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
237237
<span class="sd"> Python compiled expression evaluator. Uses Python byte code and :py:func:`eval`.</span>
238238

239-
<span class="sd"> Given an AST, this evauates the AST in the context of a specific activation.</span>
239+
<span class="sd"> Given an AST, this evaluates the AST in the context of a specific activation.</span>
240240

241241
<span class="sd"> Transform the AST into Python, uses :py:func:`compile` to create a code object.</span>
242242
<span class="sd"> Uses :py:func:`eval` to evaluate.</span>

‎docs/build/html/_modules/celpy/evaluation.html‎

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -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&#39;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">&quot;&quot;&quot;</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">-&gt;</span> <span class="s2">&quot;Result&quot;</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">-&gt;</span> <span class="n">Callable</span><span class="p">[[</span><span class="s2">&quot;Evaluator&quot;</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">&quot;&quot;&quot;</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"> &quot;&quot;&quot;</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">&quot;Evaluator&quot;</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">-&gt;</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">&quot;</span><span class="si">%s%r</span><span class="s2">&quot;</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">&quot;| &quot;</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">&quot;</span><span class="si">%s%r</span><span class="s2">&quot;</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">&quot;| &quot;</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">&quot;</span><span class="si">%s%s</span><span class="s2"> -&gt; </span><span class="si">%r</span><span class="s2">&quot;</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">&quot;| &quot;</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">&quot;</span><span class="si">%s%s</span><span class="s2"> -&gt; </span><span class="si">%r</span><span class="s2">&quot;</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">&quot;| &quot;</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">&quot;CEL_TRACE&quot;</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

‎docs/build/html/_sources/configuration.rst.txt‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,3 +39,12 @@ This paragraph can contain the parameters for logging configuration.
3939
[logging.handlers.console]
4040
class = "logging.StreamHandler"
4141
formatter = "console"
42+
43+
To enable very detailed debugging, do the following:
44+
45+
- Set the ``CEL_TRACE`` environment variable to some non-empty value, like ``"true"``.
46+
This enables a ``@trace`` decorator on some evaluation methods.
47+
48+
- In a ``[logging.loggers.celpy.Evaluator]`` paragraph, set ``level = "DEBUG"``.
49+
50+
- Set the ``[logging]`` paragraph, set ``root.level = "DEBUG"``.

0 commit comments

Comments
 (0)