This repository has been archived by the owner on Sep 26, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathcommon.config_loader.html
346 lines (219 loc) · 13.9 KB
/
common.config_loader.html
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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>common.config_loader — pyton-teos documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="common.cryptographer" href="common.cryptographer.html" />
<link rel="prev" title="common.appointment" href="common.appointment.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home" alt="Documentation Home"> pyton-teos
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="teos.html">teos package</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="common.html">common package</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="common.html#submodules">Submodules</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="common.appointment.html">common.appointment</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">common.config_loader</a></li>
<li class="toctree-l3"><a class="reference internal" href="common.cryptographer.html">common.cryptographer</a></li>
<li class="toctree-l3"><a class="reference internal" href="common.db_manager.html">common.db_manager</a></li>
<li class="toctree-l3"><a class="reference internal" href="common.exceptions.html">common.exceptions</a></li>
<li class="toctree-l3"><a class="reference internal" href="common.receipts.html">common.receipts</a></li>
<li class="toctree-l3"><a class="reference internal" href="common.tools.html">common.tools</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="contrib.html">contrib package</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">pyton-teos</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> »</li>
<li><a href="common.html">common package</a> »</li>
<li>common.config_loader</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/common.config_loader.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="module-common.config_loader">
<span id="common-config-loader"></span><h1>common.config_loader<a class="headerlink" href="#module-common.config_loader" title="Permalink to this headline">¶</a></h1>
<dl class="py class">
<dt id="common.config_loader.ConfigLoader">
<em class="property">class </em><code class="sig-name descname">ConfigLoader</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data_dir</span></em>, <em class="sig-param"><span class="n">conf_file_name</span></em>, <em class="sig-param"><span class="n">default_conf</span></em>, <em class="sig-param"><span class="n">command_line_conf</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/common/config_loader.html#ConfigLoader"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#common.config_loader.ConfigLoader" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<blockquote>
<div><p>The <a class="reference internal" href="#common.config_loader.ConfigLoader" title="common.config_loader.ConfigLoader"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigLoader</span></code></a> class is in charge of loading all the configuration parameters to create a config dict
that can be used to set all configurable parameters of the system.</p>
</div></blockquote>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>data_dir</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code>) – the path to the data directory where the configuration file may be found.</p></li>
<li><p><strong>default_conf</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">dict</span></code>) – <p>a dictionary populated with the default configuration params and the expected types.
The format is as follows:</p>
<p><code class="docutils literal notranslate"><span class="pre">{"field0":</span> <span class="pre">{"value":</span> <span class="pre">value_from_conf_file,</span> <span class="pre">"type":</span> <span class="pre">expected_type,</span> <span class="pre">...}}</span></code></p>
</p></li>
<li><p><strong>command_line_conf</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">dict</span></code>) – a dictionary containing the command line parameters that may replace the
ones in default / config file.</p></li>
</ul>
</dd>
</dl>
<dl class="py attribute">
<dt id="common.config_loader.ConfigLoader.data_dir">
<code class="sig-name descname">data_dir</code><a class="headerlink" href="#common.config_loader.ConfigLoader.data_dir" title="Permalink to this definition">¶</a></dt>
<dd><p>The path to the data directory where the configuration file may be found.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt id="common.config_loader.ConfigLoader.conf_file_path">
<code class="sig-name descname">conf_file_path</code><a class="headerlink" href="#common.config_loader.ConfigLoader.conf_file_path" title="Permalink to this definition">¶</a></dt>
<dd><p>The path to the config file (the file may not exist).</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt id="common.config_loader.ConfigLoader.conf_fields">
<code class="sig-name descname">conf_fields</code><a class="headerlink" href="#common.config_loader.ConfigLoader.conf_fields" title="Permalink to this definition">¶</a></dt>
<dd><p>A dictionary populated with the configuration params and the expected types.
It follows the same format as <code class="docutils literal notranslate"><span class="pre">default_conf</span></code>.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">dict</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt id="common.config_loader.ConfigLoader.command_line_conf">
<code class="sig-name descname">command_line_conf</code><a class="headerlink" href="#common.config_loader.ConfigLoader.command_line_conf" title="Permalink to this definition">¶</a></dt>
<dd><p>A dictionary containing the command line parameters that may replace the
ones in default / config file.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">dict</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="common.config_loader.ConfigLoader.build_config">
<code class="sig-name descname">build_config</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/common/config_loader.html#ConfigLoader.build_config"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#common.config_loader.ConfigLoader.build_config" title="Permalink to this definition">¶</a></dt>
<dd><p>Builds a config dictionary from command line, config file and default configuration parameters.</p>
<dl class="simple">
<dt>The priority is as follows:</dt><dd><ul class="simple">
<li><p>command line</p></li>
<li><p>config file</p></li>
<li><p>defaults</p></li>
</ul>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>A dictionary containing all the configuration parameters.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">dict</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="common.config_loader.ConfigLoader.create_config_dict">
<code class="sig-name descname">create_config_dict</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/common/config_loader.html#ConfigLoader.create_config_dict"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#common.config_loader.ConfigLoader.create_config_dict" title="Permalink to this definition">¶</a></dt>
<dd><p>Checks that the configuration fields (<code class="docutils literal notranslate"><span class="pre">self.conf_fields</span></code>) have the right type and creates a config dict if so.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>A dictionary with the same keys as the provided one, but containing only the “value” field as
value if the provided <code class="docutils literal notranslate"><span class="pre">conf_fields</span></code> are correct.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">dict</span></code></p>
</dd>
<dt class="field-odd">Raises</dt>
<dd class="field-odd"><p><strong>ValueError</strong> – If any of the dictionary elements does not have the expected type.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="common.config_loader.ConfigLoader.extend_paths">
<code class="sig-name descname">extend_paths</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/common/config_loader.html#ConfigLoader.extend_paths"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#common.config_loader.ConfigLoader.extend_paths" title="Permalink to this definition">¶</a></dt>
<dd><p>Extends the relative paths of the <code class="docutils literal notranslate"><span class="pre">conf_fields</span></code> dictionary with <code class="docutils literal notranslate"><span class="pre">data_dir</span></code>.</p>
<p>If an absolute path is given, it will remain the same.</p>
<p>If the config contains a BTC_NETWORK field whose value is not “mainnet”, it is also appended to the path.</p>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="common.cryptographer.html" class="btn btn-neutral float-right" title="common.cryptographer" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="common.appointment.html" class="btn btn-neutral float-left" title="common.appointment" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2019, Talaia Labs
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>