summaryrefslogtreecommitdiff
path: root/docs/html/api/Cheetah.Parser.html
blob: d730e09a73f0d4d117f73ead2ad1ec4e76d35ca9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <title>Cheetah.Parser module &#8212; Cheetah3 - The Python-Powered Template Engine</title>
    <link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" />
    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '../',
        VERSION:     '3.1.0',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true,
        SOURCELINK_SUFFIX: '.txt'
      };
    </script>
    <script type="text/javascript" src="../_static/jquery.js"></script>
    <script type="text/javascript" src="../_static/underscore.js"></script>
    <script type="text/javascript" src="../_static/doctools.js"></script>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" /> 
  </head>
  <body>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="nav-item nav-item-0"><a href="../index.html">Cheetah3 - The Python-Powered Template Engine</a> &#187;</li> 
      </ul>
    </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="../_sources/api/Cheetah.Parser.rst.txt"
            rel="nofollow">Show Source</a></li>
    </ul>
   </div>
<div id="searchbox" style="display: none" role="search">
  <h3>Quick search</h3>
    <form class="search" action="../search.html" method="get">
      <div><input type="text" name="q" /></div>
      <div><input type="submit" value="Go" /></div>
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="module-Cheetah.Parser">
<span id="cheetah-parser-module"></span><h1>Cheetah.Parser module<a class="headerlink" href="#module-Cheetah.Parser" title="Permalink to this headline">¶</a></h1>
<p>Parser classes for Cheetah’s Compiler</p>
<dl class="docutils">
<dt>Classes:</dt>
<dd>ParseError( Exception )
_LowLevelParser( Cheetah.SourceReader.SourceReader ), basically a lexer
_HighLevelParser( _LowLevelParser )
Parser === _HighLevelParser (an alias)</dd>
</dl>
<dl class="class">
<dt id="Cheetah.Parser.ArgList">
<em class="property">class </em><code class="descclassname">Cheetah.Parser.</code><code class="descname">ArgList</code><a class="headerlink" href="#Cheetah.Parser.ArgList" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>Used by _LowLevelParser.getArgList()</p>
<dl class="method">
<dt id="Cheetah.Parser.ArgList.add_argument">
<code class="descname">add_argument</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#Cheetah.Parser.ArgList.add_argument" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="Cheetah.Parser.ArgList.add_default">
<code class="descname">add_default</code><span class="sig-paren">(</span><em>token</em><span class="sig-paren">)</span><a class="headerlink" href="#Cheetah.Parser.ArgList.add_default" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="Cheetah.Parser.ArgList.merge">
<code class="descname">merge</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#Cheetah.Parser.ArgList.merge" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="Cheetah.Parser.ArgList.next">
<code class="descname">next</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#Cheetah.Parser.ArgList.next" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="class">
<dt id="Cheetah.Parser.CheetahVariable">
<em class="property">class </em><code class="descclassname">Cheetah.Parser.</code><code class="descname">CheetahVariable</code><span class="sig-paren">(</span><em>nameChunks</em>, <em>useNameMapper=True</em>, <em>cacheToken=None</em>, <em>rawSource=None</em><span class="sig-paren">)</span><a class="headerlink" href="#Cheetah.Parser.CheetahVariable" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
</dd></dl>

<dl class="exception">
<dt id="Cheetah.Parser.ForbiddenDirective">
<em class="property">exception </em><code class="descclassname">Cheetah.Parser.</code><code class="descname">ForbiddenDirective</code><span class="sig-paren">(</span><em>stream</em>, <em>msg='Invalid Syntax'</em>, <em>extMsg=''</em>, <em>lineno=None</em>, <em>col=None</em><span class="sig-paren">)</span><a class="headerlink" href="#Cheetah.Parser.ForbiddenDirective" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#Cheetah.Parser.ForbiddenSyntax" title="Cheetah.Parser.ForbiddenSyntax"><code class="xref py py-class docutils literal"><span class="pre">Cheetah.Parser.ForbiddenSyntax</span></code></a></p>
</dd></dl>

<dl class="exception">
<dt id="Cheetah.Parser.ForbiddenExpression">
<em class="property">exception </em><code class="descclassname">Cheetah.Parser.</code><code class="descname">ForbiddenExpression</code><span class="sig-paren">(</span><em>stream</em>, <em>msg='Invalid Syntax'</em>, <em>extMsg=''</em>, <em>lineno=None</em>, <em>col=None</em><span class="sig-paren">)</span><a class="headerlink" href="#Cheetah.Parser.ForbiddenExpression" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#Cheetah.Parser.ForbiddenSyntax" title="Cheetah.Parser.ForbiddenSyntax"><code class="xref py py-class docutils literal"><span class="pre">Cheetah.Parser.ForbiddenSyntax</span></code></a></p>
</dd></dl>

<dl class="exception">
<dt id="Cheetah.Parser.ForbiddenSyntax">
<em class="property">exception </em><code class="descclassname">Cheetah.Parser.</code><code class="descname">ForbiddenSyntax</code><span class="sig-paren">(</span><em>stream</em>, <em>msg='Invalid Syntax'</em>, <em>extMsg=''</em>, <em>lineno=None</em>, <em>col=None</em><span class="sig-paren">)</span><a class="headerlink" href="#Cheetah.Parser.ForbiddenSyntax" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#Cheetah.Parser.ParseError" title="Cheetah.Parser.ParseError"><code class="xref py py-class docutils literal"><span class="pre">Cheetah.Parser.ParseError</span></code></a></p>
</dd></dl>

<dl class="exception">
<dt id="Cheetah.Parser.ParseError">
<em class="property">exception </em><code class="descclassname">Cheetah.Parser.</code><code class="descname">ParseError</code><span class="sig-paren">(</span><em>stream</em>, <em>msg='Invalid Syntax'</em>, <em>extMsg=''</em>, <em>lineno=None</em>, <em>col=None</em><span class="sig-paren">)</span><a class="headerlink" href="#Cheetah.Parser.ParseError" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">exceptions.ValueError</span></code></p>
<dl class="method">
<dt id="Cheetah.Parser.ParseError.report">
<code class="descname">report</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#Cheetah.Parser.ParseError.report" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="attribute">
<dt id="Cheetah.Parser.Parser">
<code class="descclassname">Cheetah.Parser.</code><code class="descname">Parser</code><a class="headerlink" href="#Cheetah.Parser.Parser" title="Permalink to this definition">¶</a></dt>
<dd><p>alias of <code class="xref py py-class docutils literal"><span class="pre">_HighLevelParser</span></code></p>
</dd></dl>

<dl class="class">
<dt id="Cheetah.Parser.Placeholder">
<em class="property">class </em><code class="descclassname">Cheetah.Parser.</code><code class="descname">Placeholder</code><span class="sig-paren">(</span><em>nameChunks</em>, <em>useNameMapper=True</em>, <em>cacheToken=None</em>, <em>rawSource=None</em><span class="sig-paren">)</span><a class="headerlink" href="#Cheetah.Parser.Placeholder" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#Cheetah.Parser.CheetahVariable" title="Cheetah.Parser.CheetahVariable"><code class="xref py py-class docutils literal"><span class="pre">Cheetah.Parser.CheetahVariable</span></code></a></p>
</dd></dl>

<dl class="function">
<dt id="Cheetah.Parser.any">
<code class="descclassname">Cheetah.Parser.</code><code class="descname">any</code><span class="sig-paren">(</span><em>*choices</em><span class="sig-paren">)</span><a class="headerlink" href="#Cheetah.Parser.any" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="Cheetah.Parser.cachedRegex">
<code class="descclassname">Cheetah.Parser.</code><code class="descname">cachedRegex</code><span class="sig-paren">(</span><em>pattern</em><span class="sig-paren">)</span><a class="headerlink" href="#Cheetah.Parser.cachedRegex" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="Cheetah.Parser.escapeRegexChars">
<code class="descclassname">Cheetah.Parser.</code><code class="descname">escapeRegexChars</code><span class="sig-paren">(</span><em>txt</em>, <em>escapeRE=&lt;_sre.SRE_Pattern object&gt;</em><span class="sig-paren">)</span><a class="headerlink" href="#Cheetah.Parser.escapeRegexChars" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a txt with all special regular expressions chars escaped.</p>
</dd></dl>

<dl class="function">
<dt id="Cheetah.Parser.group">
<code class="descclassname">Cheetah.Parser.</code><code class="descname">group</code><span class="sig-paren">(</span><em>*choices</em><span class="sig-paren">)</span><a class="headerlink" href="#Cheetah.Parser.group" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="Cheetah.Parser.makeTripleQuoteRe">
<code class="descclassname">Cheetah.Parser.</code><code class="descname">makeTripleQuoteRe</code><span class="sig-paren">(</span><em>start</em>, <em>end</em><span class="sig-paren">)</span><a class="headerlink" href="#Cheetah.Parser.makeTripleQuoteRe" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="Cheetah.Parser.maybe">
<code class="descclassname">Cheetah.Parser.</code><code class="descname">maybe</code><span class="sig-paren">(</span><em>*choices</em><span class="sig-paren">)</span><a class="headerlink" href="#Cheetah.Parser.maybe" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="Cheetah.Parser.namedGroup">
<code class="descclassname">Cheetah.Parser.</code><code class="descname">namedGroup</code><span class="sig-paren">(</span><em>name</em>, <em>*choices</em><span class="sig-paren">)</span><a class="headerlink" href="#Cheetah.Parser.namedGroup" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="Cheetah.Parser.nongroup">
<code class="descclassname">Cheetah.Parser.</code><code class="descname">nongroup</code><span class="sig-paren">(</span><em>*choices</em><span class="sig-paren">)</span><a class="headerlink" href="#Cheetah.Parser.nongroup" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</div>


          </div>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="nav-item nav-item-0"><a href="../index.html">Cheetah3 - The Python-Powered Template Engine</a> &#187;</li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
        &#169; Copyright 2017, Oleg Broytman; 2009-2012, R. Tyler Croy; 2001-2008, The Cheetah Development Team..
      Last updated on Mar 03, 2018.
      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.5.
    </div>
  </body>
</html>