1 |
|
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
|
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|
4 |
|
5 <html xmlns="http://www.w3.org/1999/xhtml"> |
|
6 <head> |
|
7 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
|
8 <title>pyams_catalog package — PyAMS User Guide 0.1.0 documentation</title> |
|
9 <link rel="stylesheet" href="_static/pyramid.css" type="text/css" /> |
|
10 <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> |
|
11 <script type="text/javascript"> |
|
12 var DOCUMENTATION_OPTIONS = { |
|
13 URL_ROOT: './', |
|
14 VERSION: '0.1.0', |
|
15 COLLAPSE_INDEX: false, |
|
16 FILE_SUFFIX: '.html', |
|
17 HAS_SOURCE: true, |
|
18 SOURCELINK_SUFFIX: '.txt' |
|
19 }; |
|
20 </script> |
|
21 <script type="text/javascript" src="_static/jquery.js"></script> |
|
22 <script type="text/javascript" src="_static/underscore.js"></script> |
|
23 <script type="text/javascript" src="_static/doctools.js"></script> |
|
24 <link rel="index" title="Index" href="genindex.html" /> |
|
25 <link rel="search" title="Search" href="search.html" /> |
|
26 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Neuton&subset=latin" type="text/css" media="screen" charset="utf-8" /> |
|
27 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Nobile:regular,italic,bold,bolditalic&subset=latin" type="text/css" media="screen" charset="utf-8" /> |
|
28 <!--[if lte IE 6]> |
|
29 <link rel="stylesheet" href="_static/ie6.css" type="text/css" media="screen" charset="utf-8" /> |
|
30 <![endif]--> |
|
31 |
|
32 </head> |
|
33 <body> |
|
34 |
|
35 <div class="related" role="navigation" aria-label="related navigation"> |
|
36 <h3>Navigation</h3> |
|
37 <ul> |
|
38 <li class="right" style="margin-right: 10px"> |
|
39 <a href="genindex.html" title="General Index" |
|
40 accesskey="I">index</a></li> |
|
41 <li class="right" > |
|
42 <a href="py-modindex.html" title="Python Module Index" |
|
43 >modules</a> |</li> |
|
44 <li class="nav-item nav-item-0"><a href="index.html">PyAMS User Guide 0.1.0 documentation</a> »</li> |
|
45 </ul> |
|
46 </div> |
|
47 |
|
48 <div class="document"> |
|
49 <div class="documentwrapper"> |
|
50 <div class="bodywrapper"> |
|
51 <div class="body" role="main"> |
|
52 |
|
53 <div class="section" id="pyams-catalog-package"> |
|
54 <h1>pyams_catalog package<a class="headerlink" href="#pyams-catalog-package" title="Permalink to this headline">¶</a></h1> |
|
55 <div class="section" id="subpackages"> |
|
56 <h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2> |
|
57 <div class="toctree-wrapper compound"> |
|
58 <ul> |
|
59 <li class="toctree-l1"><a class="reference internal" href="pyams_catalog.interfaces.html">pyams_catalog.interfaces package</a><ul> |
|
60 <li class="toctree-l2"><a class="reference internal" href="pyams_catalog.interfaces.html#module-pyams_catalog.interfaces">Module contents</a></li> |
|
61 </ul> |
|
62 </li> |
|
63 <li class="toctree-l1"><a class="reference internal" href="pyams_catalog.tests.html">pyams_catalog.tests package</a><ul> |
|
64 <li class="toctree-l2"><a class="reference internal" href="pyams_catalog.tests.html#submodules">Submodules</a></li> |
|
65 <li class="toctree-l2"><a class="reference internal" href="pyams_catalog.tests.html#module-pyams_catalog.tests.test_utilsdocs">pyams_catalog.tests.test_utilsdocs module</a></li> |
|
66 <li class="toctree-l2"><a class="reference internal" href="pyams_catalog.tests.html#module-pyams_catalog.tests.test_utilsdocstrings">pyams_catalog.tests.test_utilsdocstrings module</a></li> |
|
67 <li class="toctree-l2"><a class="reference internal" href="pyams_catalog.tests.html#module-pyams_catalog.tests">Module contents</a></li> |
|
68 </ul> |
|
69 </li> |
|
70 <li class="toctree-l1"><a class="reference internal" href="pyams_catalog.zmi.html">pyams_catalog.zmi package</a><ul> |
|
71 <li class="toctree-l2"><a class="reference internal" href="pyams_catalog.zmi.html#submodules">Submodules</a></li> |
|
72 <li class="toctree-l2"><a class="reference internal" href="pyams_catalog.zmi.html#module-pyams_catalog.zmi.catalog">pyams_catalog.zmi.catalog module</a></li> |
|
73 <li class="toctree-l2"><a class="reference internal" href="pyams_catalog.zmi.html#module-pyams_catalog.zmi">Module contents</a></li> |
|
74 </ul> |
|
75 </li> |
|
76 </ul> |
|
77 </div> |
|
78 </div> |
|
79 <div class="section" id="submodules"> |
|
80 <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2> |
|
81 </div> |
|
82 <div class="section" id="module-pyams_catalog.include"> |
|
83 <span id="pyams-catalog-include-module"></span><h2>pyams_catalog.include module<a class="headerlink" href="#module-pyams_catalog.include" title="Permalink to this headline">¶</a></h2> |
|
84 <dl class="function"> |
|
85 <dt id="pyams_catalog.include.include_package"> |
|
86 <code class="descclassname">pyams_catalog.include.</code><code class="descname">include_package</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_catalog.include.include_package" title="Permalink to this definition">¶</a></dt> |
|
87 <dd><p>Pyramid include</p> |
|
88 </dd></dl> |
|
89 |
|
90 </div> |
|
91 <div class="section" id="module-pyams_catalog.index"> |
|
92 <span id="pyams-catalog-index-module"></span><h2>pyams_catalog.index module<a class="headerlink" href="#module-pyams_catalog.index" title="Permalink to this headline">¶</a></h2> |
|
93 <dl class="class"> |
|
94 <dt id="pyams_catalog.index.DatetimeIndexWithInterface"> |
|
95 <em class="property">class </em><code class="descclassname">pyams_catalog.index.</code><code class="descname">DatetimeIndexWithInterface</code><span class="sig-paren">(</span><em>interface</em>, <em>discriminator</em>, <em>resolution=2</em>, <em>family=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_catalog.index.DatetimeIndexWithInterface" title="Permalink to this definition">¶</a></dt> |
|
96 <dd><p>Bases: <a class="reference internal" href="#pyams_catalog.index.FieldIndexWithInterface" title="pyams_catalog.index.FieldIndexWithInterface"><code class="xref py py-class docutils literal"><span class="pre">pyams_catalog.index.FieldIndexWithInterface</span></code></a></p> |
|
97 <p>Normalized datetime index with interface support</p> |
|
98 <dl class="method"> |
|
99 <dt id="pyams_catalog.index.DatetimeIndexWithInterface.discriminate"> |
|
100 <code class="descname">discriminate</code><span class="sig-paren">(</span><em>obj</em>, <em>default</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_catalog.index.DatetimeIndexWithInterface.discriminate" title="Permalink to this definition">¶</a></dt> |
|
101 <dd></dd></dl> |
|
102 |
|
103 </dd></dl> |
|
104 |
|
105 <dl class="class"> |
|
106 <dt id="pyams_catalog.index.FacetIndexWithInterface"> |
|
107 <em class="property">class </em><code class="descclassname">pyams_catalog.index.</code><code class="descname">FacetIndexWithInterface</code><span class="sig-paren">(</span><em>interface</em>, <em>discriminator</em>, <em>facets</em>, <em>family=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_catalog.index.FacetIndexWithInterface" title="Permalink to this definition">¶</a></dt> |
|
108 <dd><p>Bases: <a class="reference internal" href="#pyams_catalog.index.InterfaceSupportIndexMixin" title="pyams_catalog.index.InterfaceSupportIndexMixin"><code class="xref py py-class docutils literal"><span class="pre">pyams_catalog.index.InterfaceSupportIndexMixin</span></code></a>, <code class="xref py py-class docutils literal"><span class="pre">hypatia.facet.FacetIndex</span></code></p> |
|
109 <p>Facet index with interface support</p> |
|
110 </dd></dl> |
|
111 |
|
112 <dl class="class"> |
|
113 <dt id="pyams_catalog.index.FieldIndexWithInterface"> |
|
114 <em class="property">class </em><code class="descclassname">pyams_catalog.index.</code><code class="descname">FieldIndexWithInterface</code><span class="sig-paren">(</span><em>interface</em>, <em>discriminator</em>, <em>family=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_catalog.index.FieldIndexWithInterface" title="Permalink to this definition">¶</a></dt> |
|
115 <dd><p>Bases: <a class="reference internal" href="#pyams_catalog.index.InterfaceSupportIndexMixin" title="pyams_catalog.index.InterfaceSupportIndexMixin"><code class="xref py py-class docutils literal"><span class="pre">pyams_catalog.index.InterfaceSupportIndexMixin</span></code></a>, <code class="xref py py-class docutils literal"><span class="pre">hypatia.field.FieldIndex</span></code></p> |
|
116 <p>Field index with interface support</p> |
|
117 </dd></dl> |
|
118 |
|
119 <dl class="class"> |
|
120 <dt id="pyams_catalog.index.InterfaceSupportIndexMixin"> |
|
121 <em class="property">class </em><code class="descclassname">pyams_catalog.index.</code><code class="descname">InterfaceSupportIndexMixin</code><span class="sig-paren">(</span><em>interface</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_catalog.index.InterfaceSupportIndexMixin" title="Permalink to this definition">¶</a></dt> |
|
122 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">hypatia.util.BaseIndexMixin</span></code></p> |
|
123 <p>Custom index mixin handling objects interfaces</p> |
|
124 <dl class="method"> |
|
125 <dt id="pyams_catalog.index.InterfaceSupportIndexMixin.discriminate"> |
|
126 <code class="descname">discriminate</code><span class="sig-paren">(</span><em>obj</em>, <em>default</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_catalog.index.InterfaceSupportIndexMixin.discriminate" title="Permalink to this definition">¶</a></dt> |
|
127 <dd><p>See interface IIndexInjection</p> |
|
128 </dd></dl> |
|
129 |
|
130 </dd></dl> |
|
131 |
|
132 <dl class="class"> |
|
133 <dt id="pyams_catalog.index.KeywordIndexWithInterface"> |
|
134 <em class="property">class </em><code class="descclassname">pyams_catalog.index.</code><code class="descname">KeywordIndexWithInterface</code><span class="sig-paren">(</span><em>interface</em>, <em>discriminator</em>, <em>family=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_catalog.index.KeywordIndexWithInterface" title="Permalink to this definition">¶</a></dt> |
|
135 <dd><p>Bases: <a class="reference internal" href="#pyams_catalog.index.InterfaceSupportIndexMixin" title="pyams_catalog.index.InterfaceSupportIndexMixin"><code class="xref py py-class docutils literal"><span class="pre">pyams_catalog.index.InterfaceSupportIndexMixin</span></code></a>, <code class="xref py py-class docutils literal"><span class="pre">hypatia.keyword.KeywordIndex</span></code></p> |
|
136 <p>Keyword index with interface support</p> |
|
137 </dd></dl> |
|
138 |
|
139 <dl class="class"> |
|
140 <dt id="pyams_catalog.index.TextIndexWithInterface"> |
|
141 <em class="property">class </em><code class="descclassname">pyams_catalog.index.</code><code class="descname">TextIndexWithInterface</code><span class="sig-paren">(</span><em>interface</em>, <em>discriminator</em>, <em>lexicon=None</em>, <em>language='english'</em>, <em>index=None</em>, <em>family=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_catalog.index.TextIndexWithInterface" title="Permalink to this definition">¶</a></dt> |
|
142 <dd><p>Bases: <a class="reference internal" href="#pyams_catalog.index.InterfaceSupportIndexMixin" title="pyams_catalog.index.InterfaceSupportIndexMixin"><code class="xref py py-class docutils literal"><span class="pre">pyams_catalog.index.InterfaceSupportIndexMixin</span></code></a>, <code class="xref py py-class docutils literal"><span class="pre">hypatia.text.TextIndex</span></code></p> |
|
143 <p>Text index with interface support</p> |
|
144 </dd></dl> |
|
145 |
|
146 <dl class="function"> |
|
147 <dt id="pyams_catalog.index.get_resolution"> |
|
148 <code class="descclassname">pyams_catalog.index.</code><code class="descname">get_resolution</code><span class="sig-paren">(</span><em>value</em>, <em>resolution</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_catalog.index.get_resolution" title="Permalink to this definition">¶</a></dt> |
|
149 <dd><p>Set resolution of given date or datetime</p> |
|
150 <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">pyams_catalog.interfaces</span> <span class="k">import</span> <span class="o">*</span> |
|
151 <span class="gp">>>> </span><span class="kn">from</span> <span class="nn">pyams_catalog.index</span> <span class="k">import</span> <span class="n">get_resolution</span> |
|
152 <span class="gp">>>> </span><span class="kn">from</span> <span class="nn">datetime</span> <span class="k">import</span> <span class="n">date</span><span class="p">,</span> <span class="n">datetime</span> |
|
153 </pre></div> |
|
154 </div> |
|
155 <p>Starting with dates:</p> |
|
156 <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">today</span> <span class="o">=</span> <span class="n">date</span><span class="p">(</span><span class="mi">2017</span><span class="p">,</span> <span class="mi">7</span><span class="p">,</span> <span class="mi">11</span><span class="p">)</span> |
|
157 <span class="gp">>>> </span><span class="n">get_resolution</span><span class="p">(</span><span class="n">today</span><span class="p">,</span> <span class="n">YEAR_RESOLUTION</span><span class="p">)</span> |
|
158 <span class="go">datetime.date(2017, 1, 1)</span> |
|
159 <span class="gp">>>> </span><span class="n">get_resolution</span><span class="p">(</span><span class="n">today</span><span class="p">,</span> <span class="n">MONTH_RESOLUTION</span><span class="p">)</span> |
|
160 <span class="go">datetime.date(2017, 7, 1)</span> |
|
161 <span class="gp">>>> </span><span class="n">get_resolution</span><span class="p">(</span><span class="n">today</span><span class="p">,</span> <span class="n">DATE_RESOLUTION</span><span class="p">)</span> |
|
162 <span class="go">datetime.date(2017, 7, 11)</span> |
|
163 </pre></div> |
|
164 </div> |
|
165 <p>Asking for a resolution higher than DATE with a date input only returns date:</p> |
|
166 <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">get_resolution</span><span class="p">(</span><span class="n">today</span><span class="p">,</span> <span class="n">MINUTE_RESOLUTION</span><span class="p">)</span> |
|
167 <span class="go">datetime.date(2017, 7, 11)</span> |
|
168 </pre></div> |
|
169 </div> |
|
170 <p>Same examples with datetimes:</p> |
|
171 <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">now</span> <span class="o">=</span> <span class="n">datetime</span><span class="p">(</span><span class="mi">2017</span><span class="p">,</span> <span class="mi">7</span><span class="p">,</span> <span class="mi">11</span><span class="p">,</span> <span class="mi">13</span><span class="p">,</span> <span class="mi">22</span><span class="p">,</span> <span class="mi">10</span><span class="p">)</span> |
|
172 <span class="gp">>>> </span><span class="n">get_resolution</span><span class="p">(</span><span class="n">now</span><span class="p">,</span> <span class="n">YEAR_RESOLUTION</span><span class="p">)</span> |
|
173 <span class="go">datetime.datetime(2017, 1, 1, 0, 0)</span> |
|
174 <span class="gp">>>> </span><span class="n">get_resolution</span><span class="p">(</span><span class="n">now</span><span class="p">,</span> <span class="n">MONTH_RESOLUTION</span><span class="p">)</span> |
|
175 <span class="go">datetime.datetime(2017, 7, 1, 0, 0)</span> |
|
176 <span class="gp">>>> </span><span class="n">get_resolution</span><span class="p">(</span><span class="n">now</span><span class="p">,</span> <span class="n">DATE_RESOLUTION</span><span class="p">)</span> |
|
177 <span class="go">datetime.datetime(2017, 7, 11, 0, 0)</span> |
|
178 <span class="gp">>>> </span><span class="n">get_resolution</span><span class="p">(</span><span class="n">now</span><span class="p">,</span> <span class="n">HOUR_RESOLUTION</span><span class="p">)</span> |
|
179 <span class="go">datetime.datetime(2017, 7, 11, 13, 0)</span> |
|
180 <span class="gp">>>> </span><span class="n">get_resolution</span><span class="p">(</span><span class="n">now</span><span class="p">,</span> <span class="n">MINUTE_RESOLUTION</span><span class="p">)</span> |
|
181 <span class="go">datetime.datetime(2017, 7, 11, 13, 22)</span> |
|
182 <span class="gp">>>> </span><span class="n">get_resolution</span><span class="p">(</span><span class="n">now</span><span class="p">,</span> <span class="n">SECOND_RESOLUTION</span><span class="p">)</span> |
|
183 <span class="go">datetime.datetime(2017, 7, 11, 13, 22, 10)</span> |
|
184 </pre></div> |
|
185 </div> |
|
186 </dd></dl> |
|
187 |
|
188 </div> |
|
189 <div class="section" id="module-pyams_catalog.nltk"> |
|
190 <span id="pyams-catalog-nltk-module"></span><h2>pyams_catalog.nltk module<a class="headerlink" href="#module-pyams_catalog.nltk" title="Permalink to this headline">¶</a></h2> |
|
191 <dl class="class"> |
|
192 <dt id="pyams_catalog.nltk.NltkFullTextProcessor"> |
|
193 <em class="property">class </em><code class="descclassname">pyams_catalog.nltk.</code><code class="descname">NltkFullTextProcessor</code><span class="sig-paren">(</span><em>language='english'</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_catalog.nltk.NltkFullTextProcessor" title="Permalink to this definition">¶</a></dt> |
|
194 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p> |
|
195 <p>NLTK based full text processor</p> |
|
196 <dl class="method"> |
|
197 <dt id="pyams_catalog.nltk.NltkFullTextProcessor.process"> |
|
198 <code class="descname">process</code><span class="sig-paren">(</span><em>lst</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_catalog.nltk.NltkFullTextProcessor.process" title="Permalink to this definition">¶</a></dt> |
|
199 <dd></dd></dl> |
|
200 |
|
201 <dl class="method"> |
|
202 <dt id="pyams_catalog.nltk.NltkFullTextProcessor.processGlob"> |
|
203 <code class="descname">processGlob</code><span class="sig-paren">(</span><em>lst</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_catalog.nltk.NltkFullTextProcessor.processGlob" title="Permalink to this definition">¶</a></dt> |
|
204 <dd></dd></dl> |
|
205 |
|
206 </dd></dl> |
|
207 |
|
208 <dl class="class"> |
|
209 <dt id="pyams_catalog.nltk.NltkStemmedTextProcessor"> |
|
210 <em class="property">class </em><code class="descclassname">pyams_catalog.nltk.</code><code class="descname">NltkStemmedTextProcessor</code><span class="sig-paren">(</span><em>language='english'</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_catalog.nltk.NltkStemmedTextProcessor" title="Permalink to this definition">¶</a></dt> |
|
211 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p> |
|
212 <p>NLTK based text processor using stemmer</p> |
|
213 <dl class="method"> |
|
214 <dt id="pyams_catalog.nltk.NltkStemmedTextProcessor.process"> |
|
215 <code class="descname">process</code><span class="sig-paren">(</span><em>lst</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_catalog.nltk.NltkStemmedTextProcessor.process" title="Permalink to this definition">¶</a></dt> |
|
216 <dd></dd></dl> |
|
217 |
|
218 <dl class="method"> |
|
219 <dt id="pyams_catalog.nltk.NltkStemmedTextProcessor.processGlob"> |
|
220 <code class="descname">processGlob</code><span class="sig-paren">(</span><em>lst</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_catalog.nltk.NltkStemmedTextProcessor.processGlob" title="Permalink to this definition">¶</a></dt> |
|
221 <dd></dd></dl> |
|
222 |
|
223 </dd></dl> |
|
224 |
|
225 </div> |
|
226 <div class="section" id="module-pyams_catalog.query"> |
|
227 <span id="pyams-catalog-query-module"></span><h2>pyams_catalog.query module<a class="headerlink" href="#module-pyams_catalog.query" title="Permalink to this headline">¶</a></h2> |
|
228 <dl class="class"> |
|
229 <dt id="pyams_catalog.query.CatalogResultSet"> |
|
230 <em class="property">class </em><code class="descclassname">pyams_catalog.query.</code><code class="descname">CatalogResultSet</code><span class="sig-paren">(</span><em>query</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_catalog.query.CatalogResultSet" title="Permalink to this definition">¶</a></dt> |
|
231 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p> |
|
232 <p>Catalog query result set wrapper</p> |
|
233 <dl class="method"> |
|
234 <dt id="pyams_catalog.query.CatalogResultSet.append"> |
|
235 <code class="descname">append</code><span class="sig-paren">(</span><em>items</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_catalog.query.CatalogResultSet.append" title="Permalink to this definition">¶</a></dt> |
|
236 <dd></dd></dl> |
|
237 |
|
238 <dl class="method"> |
|
239 <dt id="pyams_catalog.query.CatalogResultSet.prepend"> |
|
240 <code class="descname">prepend</code><span class="sig-paren">(</span><em>items</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_catalog.query.CatalogResultSet.prepend" title="Permalink to this definition">¶</a></dt> |
|
241 <dd></dd></dl> |
|
242 |
|
243 </dd></dl> |
|
244 |
|
245 <dl class="function"> |
|
246 <dt id="pyams_catalog.query.and_"> |
|
247 <code class="descclassname">pyams_catalog.query.</code><code class="descname">and_</code><span class="sig-paren">(</span><em>source</em>, <em>added</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_catalog.query.and_" title="Permalink to this definition">¶</a></dt> |
|
248 <dd><p>Combine two queries with ‘and’</p> |
|
249 </dd></dl> |
|
250 |
|
251 <dl class="function"> |
|
252 <dt id="pyams_catalog.query.or_"> |
|
253 <code class="descclassname">pyams_catalog.query.</code><code class="descname">or_</code><span class="sig-paren">(</span><em>source</em>, <em>added</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_catalog.query.or_" title="Permalink to this definition">¶</a></dt> |
|
254 <dd><p>Combine two queries with ‘or’</p> |
|
255 </dd></dl> |
|
256 |
|
257 </div> |
|
258 <div class="section" id="module-pyams_catalog.site"> |
|
259 <span id="pyams-catalog-site-module"></span><h2>pyams_catalog.site module<a class="headerlink" href="#module-pyams_catalog.site" title="Permalink to this headline">¶</a></h2> |
|
260 <dl class="class"> |
|
261 <dt id="pyams_catalog.site.CatalogGenerationsChecker"> |
|
262 <em class="property">class </em><code class="descclassname">pyams_catalog.site.</code><code class="descname">CatalogGenerationsChecker</code><a class="headerlink" href="#pyams_catalog.site.CatalogGenerationsChecker" title="Permalink to this definition">¶</a></dt> |
|
263 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p> |
|
264 <p>Catalog generations checker</p> |
|
265 <dl class="method"> |
|
266 <dt id="pyams_catalog.site.CatalogGenerationsChecker.evolve"> |
|
267 <code class="descname">evolve</code><span class="sig-paren">(</span><em>site</em>, <em>current=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_catalog.site.CatalogGenerationsChecker.evolve" title="Permalink to this definition">¶</a></dt> |
|
268 <dd><p>Check for required utilities</p> |
|
269 </dd></dl> |
|
270 |
|
271 <dl class="attribute"> |
|
272 <dt id="pyams_catalog.site.CatalogGenerationsChecker.generation"> |
|
273 <code class="descname">generation</code><em class="property"> = 1</em><a class="headerlink" href="#pyams_catalog.site.CatalogGenerationsChecker.generation" title="Permalink to this definition">¶</a></dt> |
|
274 <dd></dd></dl> |
|
275 |
|
276 </dd></dl> |
|
277 |
|
278 <dl class="function"> |
|
279 <dt id="pyams_catalog.site.check_required_indexes"> |
|
280 <code class="descclassname">pyams_catalog.site.</code><code class="descname">check_required_indexes</code><span class="sig-paren">(</span><em>site</em>, <em>indexes</em>, <em>catalog_name=''</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_catalog.site.check_required_indexes" title="Permalink to this definition">¶</a></dt> |
|
281 <dd><p>Utility function to check for required catalog indexes</p> |
|
282 <p>utilities argument is a tuple made of: |
|
283 - the index name |
|
284 - the index class |
|
285 - index factory arguments</p> |
|
286 </dd></dl> |
|
287 |
|
288 <dl class="function"> |
|
289 <dt id="pyams_catalog.site.handle_modified_object"> |
|
290 <code class="descclassname">pyams_catalog.site.</code><code class="descname">handle_modified_object</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_catalog.site.handle_modified_object" title="Permalink to this definition">¶</a></dt> |
|
291 <dd><p>Update catalog for modified object</p> |
|
292 </dd></dl> |
|
293 |
|
294 <dl class="function"> |
|
295 <dt id="pyams_catalog.site.handle_new_local_site"> |
|
296 <code class="descclassname">pyams_catalog.site.</code><code class="descname">handle_new_local_site</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_catalog.site.handle_new_local_site" title="Permalink to this definition">¶</a></dt> |
|
297 <dd><p>Create a new catalog when a site is created</p> |
|
298 </dd></dl> |
|
299 |
|
300 <dl class="function"> |
|
301 <dt id="pyams_catalog.site.handle_new_object"> |
|
302 <code class="descclassname">pyams_catalog.site.</code><code class="descname">handle_new_object</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_catalog.site.handle_new_object" title="Permalink to this definition">¶</a></dt> |
|
303 <dd><p>Index new persistent object</p> |
|
304 </dd></dl> |
|
305 |
|
306 <dl class="function"> |
|
307 <dt id="pyams_catalog.site.handle_removed_object"> |
|
308 <code class="descclassname">pyams_catalog.site.</code><code class="descname">handle_removed_object</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_catalog.site.handle_removed_object" title="Permalink to this definition">¶</a></dt> |
|
309 <dd><p>Un-index removed object</p> |
|
310 <p>Don’t use IObjectRemovedEvent to avoid objects from being already unregistered |
|
311 from IIntId utility!!!</p> |
|
312 </dd></dl> |
|
313 |
|
314 </div> |
|
315 <div class="section" id="module-pyams_catalog.utils"> |
|
316 <span id="pyams-catalog-utils-module"></span><h2>pyams_catalog.utils module<a class="headerlink" href="#module-pyams_catalog.utils" title="Permalink to this headline">¶</a></h2> |
|
317 <dl class="function"> |
|
318 <dt id="pyams_catalog.utils.catalog_key_adapter"> |
|
319 <code class="descclassname">pyams_catalog.utils.</code><code class="descname">catalog_key_adapter</code><span class="sig-paren">(</span><em>obj</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_catalog.utils.catalog_key_adapter" title="Permalink to this definition">¶</a></dt> |
|
320 <dd><p>Catalog key value adapter</p> |
|
321 </dd></dl> |
|
322 |
|
323 <dl class="function"> |
|
324 <dt id="pyams_catalog.utils.index_object"> |
|
325 <code class="descclassname">pyams_catalog.utils.</code><code class="descname">index_object</code><span class="sig-paren">(</span><em>obj</em>, <em>catalog=''</em>, <em>ignore_notyet=False</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_catalog.utils.index_object" title="Permalink to this definition">¶</a></dt> |
|
326 <dd><p>Index given object into catalog</p> |
|
327 </dd></dl> |
|
328 |
|
329 <dl class="function"> |
|
330 <dt id="pyams_catalog.utils.reindex_object"> |
|
331 <code class="descclassname">pyams_catalog.utils.</code><code class="descname">reindex_object</code><span class="sig-paren">(</span><em>obj</em>, <em>catalog=''</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_catalog.utils.reindex_object" title="Permalink to this definition">¶</a></dt> |
|
332 <dd><p>Reindex given object into catalog</p> |
|
333 </dd></dl> |
|
334 |
|
335 <dl class="function"> |
|
336 <dt id="pyams_catalog.utils.unindex_object"> |
|
337 <code class="descclassname">pyams_catalog.utils.</code><code class="descname">unindex_object</code><span class="sig-paren">(</span><em>obj</em>, <em>catalog=''</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_catalog.utils.unindex_object" title="Permalink to this definition">¶</a></dt> |
|
338 <dd><p>Unindex given object from catalog</p> |
|
339 </dd></dl> |
|
340 |
|
341 </div> |
|
342 <div class="section" id="module-pyams_catalog"> |
|
343 <span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-pyams_catalog" title="Permalink to this headline">¶</a></h2> |
|
344 <dl class="function"> |
|
345 <dt id="pyams_catalog.includeme"> |
|
346 <code class="descclassname">pyams_catalog.</code><code class="descname">includeme</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_catalog.includeme" title="Permalink to this definition">¶</a></dt> |
|
347 <dd><p>Pyramid include</p> |
|
348 </dd></dl> |
|
349 |
|
350 </div> |
|
351 </div> |
|
352 |
|
353 |
|
354 </div> |
|
355 </div> |
|
356 </div> |
|
357 <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> |
|
358 <div class="sphinxsidebarwrapper"> |
|
359 <h3><a href="index.html">Table Of Contents</a></h3> |
|
360 <ul> |
|
361 <li><a class="reference internal" href="#">pyams_catalog package</a><ul> |
|
362 <li><a class="reference internal" href="#subpackages">Subpackages</a></li> |
|
363 <li><a class="reference internal" href="#submodules">Submodules</a></li> |
|
364 <li><a class="reference internal" href="#module-pyams_catalog.include">pyams_catalog.include module</a></li> |
|
365 <li><a class="reference internal" href="#module-pyams_catalog.index">pyams_catalog.index module</a></li> |
|
366 <li><a class="reference internal" href="#module-pyams_catalog.nltk">pyams_catalog.nltk module</a></li> |
|
367 <li><a class="reference internal" href="#module-pyams_catalog.query">pyams_catalog.query module</a></li> |
|
368 <li><a class="reference internal" href="#module-pyams_catalog.site">pyams_catalog.site module</a></li> |
|
369 <li><a class="reference internal" href="#module-pyams_catalog.utils">pyams_catalog.utils module</a></li> |
|
370 <li><a class="reference internal" href="#module-pyams_catalog">Module contents</a></li> |
|
371 </ul> |
|
372 </li> |
|
373 </ul> |
|
374 |
|
375 <div id="searchbox" style="display: none" role="search"> |
|
376 <h3>Quick search</h3> |
|
377 <form class="search" action="search.html" method="get"> |
|
378 <div><input type="text" name="q" /></div> |
|
379 <div><input type="submit" value="Go" /></div> |
|
380 <input type="hidden" name="check_keywords" value="yes" /> |
|
381 <input type="hidden" name="area" value="default" /> |
|
382 </form> |
|
383 </div> |
|
384 <script type="text/javascript">$('#searchbox').show(0);</script> |
|
385 </div> |
|
386 </div> |
|
387 <div class="clearer"></div> |
|
388 </div> |
|
389 <div class="related" role="navigation" aria-label="related navigation"> |
|
390 <h3>Navigation</h3> |
|
391 <ul> |
|
392 <li class="right" style="margin-right: 10px"> |
|
393 <a href="genindex.html" title="General Index" |
|
394 >index</a></li> |
|
395 <li class="right" > |
|
396 <a href="py-modindex.html" title="Python Module Index" |
|
397 >modules</a> |</li> |
|
398 <li class="nav-item nav-item-0"><a href="index.html">PyAMS User Guide 0.1.0 documentation</a> »</li> |
|
399 </ul> |
|
400 </div> |
|
401 <div class="footer" role="contentinfo"> |
|
402 © Copyright 2017, Thierry Florac. |
|
403 Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.5. |
|
404 </div> |
|
405 </body> |
|
406 </html> |
|