PythonExtensionsCollection 0.2.0__py3-none-any.whl → 0.13.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (55) hide show
  1. PythonExtensionsCollection/Comparison/CComparison.py +341 -0
  2. PythonExtensionsCollection/Comparison/__init__.py +13 -0
  3. PythonExtensionsCollection/File/CFile.py +326 -106
  4. PythonExtensionsCollection/File/__init__.py +1 -1
  5. PythonExtensionsCollection/Folder/CFolder.py +460 -0
  6. PythonExtensionsCollection/Folder/__init__.py +13 -0
  7. PythonExtensionsCollection/PythonExtensionsCollection.pdf +0 -0
  8. PythonExtensionsCollection/String/CString.py +128 -344
  9. PythonExtensionsCollection/String/__init__.py +1 -1
  10. PythonExtensionsCollection/Utils/CUtils.py +77 -74
  11. PythonExtensionsCollection/Utils/__init__.py +1 -1
  12. PythonExtensionsCollection/__init__.py +1 -1
  13. PythonExtensionsCollection/version.py +23 -0
  14. {PythonExtensionsCollection-0.2.0.dist-info → PythonExtensionsCollection-0.13.0.dist-info}/METADATA +57 -44
  15. PythonExtensionsCollection-0.13.0.dist-info/RECORD +18 -0
  16. {PythonExtensionsCollection-0.2.0.dist-info → PythonExtensionsCollection-0.13.0.dist-info}/WHEEL +1 -1
  17. PythonExtensionsCollection/doc/.buildinfo +0 -4
  18. PythonExtensionsCollection/doc/File.html +0 -315
  19. PythonExtensionsCollection/doc/String.html +0 -590
  20. PythonExtensionsCollection/doc/Utils.html +0 -209
  21. PythonExtensionsCollection/doc/_modules/PythonExtensionsCollection/File/CFile.html +0 -960
  22. PythonExtensionsCollection/doc/_modules/PythonExtensionsCollection/String/CString.html +0 -1221
  23. PythonExtensionsCollection/doc/_modules/PythonExtensionsCollection/Utils/CUtils.html +0 -431
  24. PythonExtensionsCollection/doc/_modules/index.html +0 -106
  25. PythonExtensionsCollection/doc/_sources/File.rst.txt +0 -28
  26. PythonExtensionsCollection/doc/_sources/String.rst.txt +0 -28
  27. PythonExtensionsCollection/doc/_sources/Utils.rst.txt +0 -28
  28. PythonExtensionsCollection/doc/_sources/additional_doc/Introduction.rst.txt +0 -365
  29. PythonExtensionsCollection/doc/_sources/index.rst.txt +0 -27
  30. PythonExtensionsCollection/doc/_static/_sphinx_javascript_frameworks_compat.js +0 -134
  31. PythonExtensionsCollection/doc/_static/alabaster.css +0 -701
  32. PythonExtensionsCollection/doc/_static/basic.css +0 -930
  33. PythonExtensionsCollection/doc/_static/custom.css +0 -1
  34. PythonExtensionsCollection/doc/_static/doctools.js +0 -264
  35. PythonExtensionsCollection/doc/_static/documentation_options.js +0 -14
  36. PythonExtensionsCollection/doc/_static/file.png +0 -0
  37. PythonExtensionsCollection/doc/_static/jquery-3.6.0.js +0 -10881
  38. PythonExtensionsCollection/doc/_static/jquery.js +0 -2
  39. PythonExtensionsCollection/doc/_static/language_data.js +0 -199
  40. PythonExtensionsCollection/doc/_static/minus.png +0 -0
  41. PythonExtensionsCollection/doc/_static/plus.png +0 -0
  42. PythonExtensionsCollection/doc/_static/pygments.css +0 -82
  43. PythonExtensionsCollection/doc/_static/searchtools.js +0 -531
  44. PythonExtensionsCollection/doc/_static/underscore-1.13.1.js +0 -2042
  45. PythonExtensionsCollection/doc/_static/underscore.js +0 -6
  46. PythonExtensionsCollection/doc/additional_doc/Introduction.html +0 -365
  47. PythonExtensionsCollection/doc/genindex.html +0 -292
  48. PythonExtensionsCollection/doc/index.html +0 -123
  49. PythonExtensionsCollection/doc/objects.inv +0 -0
  50. PythonExtensionsCollection/doc/py-modindex.html +0 -138
  51. PythonExtensionsCollection/doc/search.html +0 -127
  52. PythonExtensionsCollection/doc/searchindex.js +0 -1
  53. PythonExtensionsCollection-0.2.0.dist-info/RECORD +0 -48
  54. {PythonExtensionsCollection-0.2.0.dist-info → PythonExtensionsCollection-0.13.0.dist-info}/LICENSE +0 -0
  55. {PythonExtensionsCollection-0.2.0.dist-info → PythonExtensionsCollection-0.13.0.dist-info}/top_level.txt +0 -0
PythonExtensionsCollection/doc/Utils.html DELETED
@@ -1,209 +0,0 @@
1
-
2
- <!DOCTYPE html>
3
-
4
- <html lang="en">
5
- <head>
6
- <meta charset="utf-8" />
7
- <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
8
-
9
- <title>4. CUtils module &#8212; Python Extensions Collection documentation</title>
10
- <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
11
- <link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
12
- <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
13
- <script src="_static/jquery.js"></script>
14
- <script src="_static/underscore.js"></script>
15
- <script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
16
- <script src="_static/doctools.js"></script>
17
- <link rel="index" title="Index" href="genindex.html" />
18
- <link rel="search" title="Search" href="search.html" />
19
- <link rel="next" title="5. CFile module" href="File.html" />
20
- <link rel="prev" title="3. CString module" href="String.html" />
21
-
22
- <link rel="stylesheet" href="_static/custom.css" type="text/css" />
23
-
24
-
25
- <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
26
-
27
- </head><body>
28
-
29
-
30
- <div class="document">
31
- <div class="documentwrapper">
32
- <div class="bodywrapper">
33
-
34
-
35
- <div class="body" role="main">
36
-
37
- <section class="dl-parameters" id="module-PythonExtensionsCollection.Utils.CUtils">
38
- <span id="cutils-module"></span><h1><span class="section-number">4. </span>CUtils module<a class="headerlink" href="#module-PythonExtensionsCollection.Utils.CUtils" title="Permalink to this heading">¶</a></h1>
39
- <dl class="py class">
40
- <dt class="sig sig-object py" id="PythonExtensionsCollection.Utils.CUtils.CTypePrint">
41
- <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">PythonExtensionsCollection.Utils.CUtils.</span></span><span class="sig-name descname"><span class="pre">CTypePrint</span></span><a class="reference internal" href="_modules/PythonExtensionsCollection/Utils/CUtils.html#CTypePrint"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#PythonExtensionsCollection.Utils.CUtils.CTypePrint" title="Permalink to this definition">¶</a></dt>
42
- <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
43
- <dl class="py method">
44
- <dt class="sig sig-object py" id="PythonExtensionsCollection.Utils.CUtils.CTypePrint.TypePrint">
45
- <span class="sig-name descname"><span class="pre">TypePrint</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">oData</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bHexFormat</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/PythonExtensionsCollection/Utils/CUtils.html#CTypePrint.TypePrint"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#PythonExtensionsCollection.Utils.CUtils.CTypePrint.TypePrint" title="Permalink to this definition">¶</a></dt>
46
- <dd></dd></dl>
47
-
48
- </dd></dl>
49
-
50
- <dl class="py function">
51
- <dt class="sig sig-object py" id="PythonExtensionsCollection.Utils.CUtils.PrettyPrint">
52
- <span class="sig-prename descclassname"><span class="pre">PythonExtensionsCollection.Utils.CUtils.</span></span><span class="sig-name descname"><span class="pre">PrettyPrint</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">oData</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hOutputFile</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bToConsole</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nIndent</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sPrefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bHexFormat</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/PythonExtensionsCollection/Utils/CUtils.html#PrettyPrint"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#PythonExtensionsCollection.Utils.CUtils.PrettyPrint" title="Permalink to this definition">¶</a></dt>
53
- <dd><div class="line-block">
54
- <div class="line"><br /></div>
55
- </div>
56
- <p><strong>Function:</strong></p>
57
- <p><strong>PrettyPrint</strong></p>
58
- <blockquote>
59
- <div><p>Wrapper function to create and use a <code class="docutils literal notranslate"><span class="pre">CTypePrint</span></code> object. This wrapper function is responsible for
60
- printing out the content to console and to a file (depending on input parameter).</p>
61
- <p>The content itself is prepared by the method <code class="docutils literal notranslate"><span class="pre">TypePrint</span></code> of class <code class="docutils literal notranslate"><span class="pre">CTypePrint</span></code>. This happens <code class="docutils literal notranslate"><span class="pre">PrettyPrint</span></code> internally.</p>
62
- <p>The idea behind the <code class="docutils literal notranslate"><span class="pre">PrettyPrint</span></code> function is to resolve also the content of composite data types and provide for every parameter inside:</p>
63
- <ul class="simple">
64
- <li><p>the type</p></li>
65
- <li><p>the total number of elements inside (e.g. the number of keys inside a dictionary)</p></li>
66
- <li><p>the counter number of the current element</p></li>
67
- <li><p>the value</p></li>
68
- </ul>
69
- <p>Example call:</p>
70
- <p><code class="docutils literal notranslate"><span class="pre">PrettyPrint(oData)</span></code> (<em>with oData is a Python variable of any type</em>)</p>
71
- <p>The output can e.g. look like this:</p>
72
- <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="p">[</span><span class="n">DICT</span><span class="p">]</span> <span class="p">(</span><span class="mi">3</span><span class="o">/</span><span class="mi">1</span><span class="p">)</span> <span class="o">&gt;</span> <span class="p">{</span><span class="n">K1</span><span class="p">}</span> <span class="p">[</span><span class="n">STR</span><span class="p">]</span> <span class="p">:</span> <span class="s1">&#39;Val1&#39;</span>
73
- <span class="p">[</span><span class="n">DICT</span><span class="p">]</span> <span class="p">(</span><span class="mi">3</span><span class="o">/</span><span class="mi">2</span><span class="p">)</span> <span class="o">&gt;</span> <span class="p">{</span><span class="n">K2</span><span class="p">}</span> <span class="p">[</span><span class="n">LIST</span><span class="p">]</span> <span class="p">(</span><span class="mi">4</span><span class="o">/</span><span class="mi">1</span><span class="p">)</span> <span class="o">&gt;</span> <span class="p">[</span><span class="n">INT</span><span class="p">]</span> <span class="p">:</span> <span class="mi">1</span>
74
- <span class="p">[</span><span class="n">DICT</span><span class="p">]</span> <span class="p">(</span><span class="mi">3</span><span class="o">/</span><span class="mi">2</span><span class="p">)</span> <span class="o">&gt;</span> <span class="p">{</span><span class="n">K2</span><span class="p">}</span> <span class="p">[</span><span class="n">LIST</span><span class="p">]</span> <span class="p">(</span><span class="mi">4</span><span class="o">/</span><span class="mi">2</span><span class="p">)</span> <span class="o">&gt;</span> <span class="p">[</span><span class="n">STR</span><span class="p">]</span> <span class="p">:</span> <span class="s1">&#39;A&#39;</span>
75
- <span class="p">[</span><span class="n">DICT</span><span class="p">]</span> <span class="p">(</span><span class="mi">3</span><span class="o">/</span><span class="mi">2</span><span class="p">)</span> <span class="o">&gt;</span> <span class="p">{</span><span class="n">K2</span><span class="p">}</span> <span class="p">[</span><span class="n">LIST</span><span class="p">]</span> <span class="p">(</span><span class="mi">4</span><span class="o">/</span><span class="mi">3</span><span class="p">)</span> <span class="o">&gt;</span> <span class="p">[</span><span class="n">INT</span><span class="p">]</span> <span class="p">:</span> <span class="mi">2</span>
76
- <span class="p">[</span><span class="n">DICT</span><span class="p">]</span> <span class="p">(</span><span class="mi">3</span><span class="o">/</span><span class="mi">2</span><span class="p">)</span> <span class="o">&gt;</span> <span class="p">{</span><span class="n">K2</span><span class="p">}</span> <span class="p">[</span><span class="n">LIST</span><span class="p">]</span> <span class="p">(</span><span class="mi">4</span><span class="o">/</span><span class="mi">4</span><span class="p">)</span> <span class="o">&gt;</span> <span class="p">[</span><span class="n">TUPLE</span><span class="p">]</span> <span class="p">(</span><span class="mi">2</span><span class="o">/</span><span class="mi">1</span><span class="p">)</span> <span class="o">&gt;</span> <span class="p">[</span><span class="n">INT</span><span class="p">]</span> <span class="p">:</span> <span class="mi">9</span>
77
- <span class="p">[</span><span class="n">DICT</span><span class="p">]</span> <span class="p">(</span><span class="mi">3</span><span class="o">/</span><span class="mi">2</span><span class="p">)</span> <span class="o">&gt;</span> <span class="p">{</span><span class="n">K2</span><span class="p">}</span> <span class="p">[</span><span class="n">LIST</span><span class="p">]</span> <span class="p">(</span><span class="mi">4</span><span class="o">/</span><span class="mi">4</span><span class="p">)</span> <span class="o">&gt;</span> <span class="p">[</span><span class="n">TUPLE</span><span class="p">]</span> <span class="p">(</span><span class="mi">2</span><span class="o">/</span><span class="mi">2</span><span class="p">)</span> <span class="o">&gt;</span> <span class="p">[</span><span class="n">STR</span><span class="p">]</span> <span class="p">:</span> <span class="s1">&#39;Z&#39;</span>
78
- <span class="p">[</span><span class="n">DICT</span><span class="p">]</span> <span class="p">(</span><span class="mi">3</span><span class="o">/</span><span class="mi">3</span><span class="p">)</span> <span class="o">&gt;</span> <span class="p">{</span><span class="n">K3</span><span class="p">}</span> <span class="p">[</span><span class="n">INT</span><span class="p">]</span> <span class="p">:</span> <span class="mi">5</span>
79
- </pre></div>
80
- </div>
81
- <p>Every line of output has to be interpreted strictly from left to right.</p>
82
- <p>For example the meaning of the fifth line of output</p>
83
- <p><code class="docutils literal notranslate"><span class="pre">[DICT]</span> <span class="pre">(3/2)</span> <span class="pre">&gt;</span> <span class="pre">{K2}</span> <span class="pre">[LIST]</span> <span class="pre">(4/4)</span> <span class="pre">&gt;</span> <span class="pre">[TUPLE]</span> <span class="pre">(2/1)</span> <span class="pre">&gt;</span> <span class="pre">[INT]</span>&#160; <span class="pre">:</span>&#160; <span class="pre">9</span></code></p>
84
- <p>is:</p>
85
- <ul class="simple">
86
- <li><p>The type of input parameter (<code class="docutils literal notranslate"><span class="pre">oData</span></code>) is <code class="docutils literal notranslate"><span class="pre">dict</span></code></p></li>
87
- <li><p>The dictionary contains 3 keys</p></li>
88
- <li><p>The current line gives information about the second key of the dictionary</p></li>
89
- <li><p>The name of the second key is ‘K2’</p></li>
90
- <li><p>The value of the second key is of type <code class="docutils literal notranslate"><span class="pre">list</span></code></p></li>
91
- <li><p>The list contains 4 elements</p></li>
92
- <li><p>The current line gives information about the fourth element of the list</p></li>
93
- <li><p>The fourth element of the list is of type <code class="docutils literal notranslate"><span class="pre">tuple</span></code></p></li>
94
- <li><p>The tuple contains 2 elements</p></li>
95
- <li><p>The current line gives information about the first element of the tuple</p></li>
96
- <li><p>The first element of the tuple is of type <code class="docutils literal notranslate"><span class="pre">int</span></code> and has the value 9</p></li>
97
- </ul>
98
- <p>Types are encapsulated in square brackets, counter in round brackets and key names are encapsulated in curly brackets.</p>
99
- </div></blockquote>
100
- <p><strong>Args:</strong></p>
101
- <p><strong>oData</strong> (<em>any Python data type</em>)</p>
102
- <blockquote>
103
- <div><p>A variable of any Python data type.</p>
104
- </div></blockquote>
105
- <p><strong>hOutputFile</strong> (<em>handle to a file opened for writing or appending; optional; default None</em>)</p>
106
- <blockquote>
107
- <div><p>If handle is not <code class="docutils literal notranslate"><span class="pre">None</span></code> the content is written to this file, otherwise not.</p>
108
- </div></blockquote>
109
- <p><strong>bToConsole</strong> (<em>bool; optional; default: True</em>)</p>
110
- <blockquote>
111
- <div><p>If <code class="docutils literal notranslate"><span class="pre">True</span></code> the content is written to console, otherwise not.</p>
112
- </div></blockquote>
113
- <p><strong>nIndent</strong> (<em>int; optional; default: 0</em>)</p>
114
- <blockquote>
115
- <div><p>Sets the number of additional blanks at the beginning of every line of output (indentation).</p>
116
- </div></blockquote>
117
- <p><strong>sPrefix</strong> (<em>str; optional; default: None</em>)</p>
118
- <blockquote>
119
- <div><p>Sets a prefix string that is added at the beginning of every line of output.</p>
120
- </div></blockquote>
121
- <p><strong>bHexFormat</strong> (<em>bool; optional; default: False</em>)</p>
122
- <blockquote>
123
- <div><p>If <code class="docutils literal notranslate"><span class="pre">True</span></code> the output is printed in hexadecimal format (but strings only).</p>
124
- </div></blockquote>
125
- <p><strong>Returns:</strong></p>
126
- <p><strong>listOutLines</strong> (<em>list</em>)</p>
127
- <blockquote>
128
- <div><p>List of lines containing the prepared output</p>
129
- </div></blockquote>
130
- <div class="line-block">
131
- <div class="line"><br /></div>
132
- </div>
133
- </dd></dl>
134
-
135
- </section>
136
-
137
-
138
- </div>
139
-
140
- </div>
141
- </div>
142
- <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
143
- <div class="sphinxsidebarwrapper">
144
- <h1 class="logo"><a href="index.html">Python Extensions Collection</a></h1>
145
-
146
-
147
-
148
-
149
-
150
-
151
-
152
-
153
- <h3>Navigation</h3>
154
- <ul class="current">
155
- <li class="toctree-l1"><a class="reference internal" href="additional_doc/Introduction.html">1. Introduction</a></li>
156
- <li class="toctree-l1"><a class="reference internal" href="additional_doc/Introduction.html#examples">2. Examples</a></li>
157
- <li class="toctree-l1"><a class="reference internal" href="String.html">3. CString module</a></li>
158
- <li class="toctree-l1 current"><a class="current reference internal" href="#">4. CUtils module</a></li>
159
- <li class="toctree-l1"><a class="reference internal" href="File.html">5. CFile module</a></li>
160
- </ul>
161
-
162
- <div class="relations">
163
- <h3>Related Topics</h3>
164
- <ul>
165
- <li><a href="index.html">Documentation overview</a><ul>
166
- <li>Previous: <a href="String.html" title="previous chapter"><span class="section-number">3. </span>CString module</a></li>
167
- <li>Next: <a href="File.html" title="next chapter"><span class="section-number">5. </span>CFile module</a></li>
168
- </ul></li>
169
- </ul>
170
- </div>
171
- <div id="searchbox" style="display: none" role="search">
172
- <h3 id="searchlabel">Quick search</h3>
173
- <div class="searchformwrapper">
174
- <form class="search" action="search.html" method="get">
175
- <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
176
- <input type="submit" value="Go" />
177
- </form>
178
- </div>
179
- </div>
180
- <script>document.getElementById('searchbox').style.display = "block"</script>
181
-
182
-
183
-
184
-
185
-
186
-
187
-
188
-
189
- </div>
190
- </div>
191
- <div class="clearer"></div>
192
- </div>
193
- <div class="footer">
194
- &copy;2022, Queckenstedt Holger (XC-CT/ECA3).
195
-
196
- |
197
- Powered by <a href="http://sphinx-doc.org/">Sphinx 5.0.0</a>
198
- &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
199
-
200
- |
201
- <a href="_sources/Utils.rst.txt"
202
- rel="nofollow">Page source</a>
203
- </div>
204
-
205
-
206
-
207
-
208
- </body>
209
- </html>