/
read_template.html
188 lines (168 loc) · 15.7 KB
/
read_template.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
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>gen_coap_service.pro.read_template — gen_coap_service https://github.com/vroncevic/gen_coap_service/releases documentation</title>
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/classic.css" />
<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
<script src="../../../_static/jquery.js"></script>
<script src="../../../_static/underscore.js"></script>
<script src="../../../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="../../../_static/doctools.js"></script>
<script src="../../../_static/sphinx_highlight.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">gen_coap_service https://github.com/vroncevic/gen_coap_service/releases documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> »</li>
<li class="nav-item nav-item-2"><a href="../../gen_coap_service.html" >gen_coap_service</a> »</li>
<li class="nav-item nav-item-3"><a href="../pro.html" accesskey="U">gen_coap_service.pro</a> »</li>
<li class="nav-item nav-item-this"><a href="">gen_coap_service.pro.read_template</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<h1>Source code for gen_coap_service.pro.read_template</h1><div class="highlight"><pre>
<span></span><span class="c1"># -*- coding: UTF-8 -*-</span>
<span class="sd">'''</span>
<span class="sd">Module</span>
<span class="sd"> read_template.py</span>
<span class="sd">Copyright</span>
<span class="sd"> Copyright (C) 2020 - 2024 Vladimir Roncevic <elektron.ronca@gmail.com></span>
<span class="sd"> gen_coap_service is free software: you can redistribute it and/or modify</span>
<span class="sd"> it under the terms of the GNU General Public License as published by the</span>
<span class="sd"> Free Software Foundation, either version 3 of the License, or</span>
<span class="sd"> (at your option) any later version.</span>
<span class="sd"> gen_coap_service is distributed in the hope that it will be useful, but</span>
<span class="sd"> WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<span class="sd"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</span>
<span class="sd"> See the GNU General Public License for more details.</span>
<span class="sd"> You should have received a copy of the GNU General Public License along</span>
<span class="sd"> with this program. If not, see <http://www.gnu.org/licenses/>.</span>
<span class="sd">Info</span>
<span class="sd"> Defines class ReadTemplate with attribute(s) and method(s).</span>
<span class="sd"> Reads a template.</span>
<span class="sd">'''</span>
<span class="kn">import</span> <span class="nn">sys</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">List</span>
<span class="k">try</span><span class="p">:</span>
<span class="kn">from</span> <span class="nn">ats_utilities.config_io.file_check</span> <span class="kn">import</span> <span class="n">FileCheck</span>
<span class="kn">from</span> <span class="nn">ats_utilities.console_io.verbose</span> <span class="kn">import</span> <span class="n">verbose_message</span>
<span class="kn">from</span> <span class="nn">ats_utilities.exceptions.ats_type_error</span> <span class="kn">import</span> <span class="n">ATSTypeError</span>
<span class="kn">from</span> <span class="nn">ats_utilities.exceptions.ats_value_error</span> <span class="kn">import</span> <span class="n">ATSValueError</span>
<span class="k">except</span> <span class="ne">ImportError</span> <span class="k">as</span> <span class="n">ats_error_message</span><span class="p">:</span>
<span class="c1"># Force close python ATS ##################################################</span>
<span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="sa">f</span><span class="s1">'</span><span class="se">\n</span><span class="si">{</span><span class="vm">__file__</span><span class="si">}</span><span class="se">\n</span><span class="si">{</span><span class="n">ats_error_message</span><span class="si">}</span><span class="se">\n</span><span class="s1">'</span><span class="p">)</span>
<span class="n">__author__</span> <span class="o">=</span> <span class="s1">'Vladimir Roncevic'</span>
<span class="n">__copyright__</span> <span class="o">=</span> <span class="s1">'(C) 2024, https://vroncevic.github.io/gen_coap_service'</span>
<span class="n">__credits__</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'Vladimir Roncevic'</span><span class="p">,</span> <span class="s1">'Python Software Foundation'</span><span class="p">]</span>
<span class="n">__license__</span> <span class="o">=</span> <span class="s1">'https://github.com/vroncevic/gen_coap_service/blob/dev/LICENSE'</span>
<span class="n">__version__</span> <span class="o">=</span> <span class="s1">'1.1.2'</span>
<span class="n">__maintainer__</span> <span class="o">=</span> <span class="s1">'Vladimir Roncevic'</span>
<span class="n">__email__</span> <span class="o">=</span> <span class="s1">'elektron.ronca@gmail.com'</span>
<span class="n">__status__</span> <span class="o">=</span> <span class="s1">'Updated'</span>
<div class="viewcode-block" id="ReadTemplate"><a class="viewcode-back" href="../../../gen_coap_service.pro.read_template.html#gen_coap_service.pro.read_template.ReadTemplate">[docs]</a><span class="k">class</span> <span class="nc">ReadTemplate</span><span class="p">(</span><span class="n">FileCheck</span><span class="p">):</span>
<span class="w"> </span><span class="sd">'''</span>
<span class="sd"> Defines class ReadTemplate with attribute(s) and method(s).</span>
<span class="sd"> Reads a template.</span>
<span class="sd"> It Definess:</span>
<span class="sd"> :attributes:</span>
<span class="sd"> | _GEN_VERBOSE - Console text indicator for process-phase.</span>
<span class="sd"> :methods:</span>
<span class="sd"> | __init__ - Initials ReadTemplate constructor.</span>
<span class="sd"> | read - Reads a template.</span>
<span class="sd"> '''</span>
<span class="n">_GEN_VERBOSE</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s1">'GEN_AUTOCONF::PRO::READ_TEMPLATE'</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">verbose</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
<span class="w"> </span><span class="sd">'''</span>
<span class="sd"> Initials ReadTemplate constructor.</span>
<span class="sd"> :param verbose: Enable/disable verbose option</span>
<span class="sd"> :type verbose: <bool></span>
<span class="sd"> :exceptions: None</span>
<span class="sd"> '''</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">verbose</span><span class="p">)</span>
<span class="n">verbose_message</span><span class="p">(</span><span class="n">verbose</span><span class="p">,</span> <span class="p">[</span><span class="sa">f</span><span class="s1">'</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">_GEN_VERBOSE</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span><span class="si">}</span><span class="s1"> init reader'</span><span class="p">])</span>
<div class="viewcode-block" id="ReadTemplate.read"><a class="viewcode-back" href="../../../gen_coap_service.pro.read_template.html#gen_coap_service.pro.read_template.ReadTemplate.read">[docs]</a> <span class="k">def</span> <span class="nf">read</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span> <span class="n">template</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n">verbose</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span>
<span class="p">)</span> <span class="o">-></span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
<span class="w"> </span><span class="sd">'''</span>
<span class="sd"> Reads a template.</span>
<span class="sd"> :param template: Template file name | None</span>
<span class="sd"> :type template: <str> | <NoneType></span>
<span class="sd"> :param verbose: Enable/disable verbose option</span>
<span class="sd"> :type verbose: <bool></span>
<span class="sd"> :return: Template content | None</span>
<span class="sd"> :rtype: <str> | <NoneType></span>
<span class="sd"> :exceptions: ATSTypeError | ATSValueError</span>
<span class="sd"> '''</span>
<span class="n">error_msg</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">error_id</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">error_msg</span><span class="p">,</span> <span class="n">error_id</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">check_params</span><span class="p">([(</span><span class="s1">'str:template'</span><span class="p">,</span> <span class="n">template</span><span class="p">)])</span>
<span class="k">if</span> <span class="n">error_id</span> <span class="o">==</span> <span class="bp">self</span><span class="o">.</span><span class="n">TYPE_ERROR</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">ATSTypeError</span><span class="p">(</span><span class="n">error_msg</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">bool</span><span class="p">(</span><span class="n">template</span><span class="p">):</span>
<span class="k">raise</span> <span class="n">ATSValueError</span><span class="p">(</span><span class="s1">'missing template'</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">check_path</span><span class="p">(</span><span class="n">template</span><span class="p">,</span> <span class="n">verbose</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">check_mode</span><span class="p">(</span><span class="s1">'r'</span><span class="p">,</span> <span class="n">verbose</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">check_format</span><span class="p">(</span><span class="n">template</span><span class="p">,</span> <span class="s1">'template'</span><span class="p">,</span> <span class="n">verbose</span><span class="p">)</span>
<span class="n">template_content</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_file_ok</span><span class="p">():</span>
<span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">template</span><span class="p">,</span> <span class="s1">'r'</span><span class="p">,</span> <span class="n">encoding</span><span class="o">=</span><span class="s1">'utf-8'</span><span class="p">)</span> <span class="k">as</span> <span class="n">file_template</span><span class="p">:</span>
<span class="n">template_content</span> <span class="o">=</span> <span class="n">file_template</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>
<span class="k">return</span> <span class="n">template_content</span></div></div>
</pre></div>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../../../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
</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">gen_coap_service https://github.com/vroncevic/gen_coap_service/releases documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> »</li>
<li class="nav-item nav-item-2"><a href="../../gen_coap_service.html" >gen_coap_service</a> »</li>
<li class="nav-item nav-item-3"><a href="../pro.html" >gen_coap_service.pro</a> »</li>
<li class="nav-item nav-item-this"><a href="">gen_coap_service.pro.read_template</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2024, Vladimir Roncevic <elektron.ronca@gmail.com>.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
</div>
</body>
</html>