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/File.html DELETED
@@ -1,315 +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>5. CFile 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="prev" title="4. CUtils module" href="Utils.html" />
20
-
21
- <link rel="stylesheet" href="_static/custom.css" type="text/css" />
22
-
23
-
24
- <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
25
-
26
- </head><body>
27
-
28
-
29
- <div class="document">
30
- <div class="documentwrapper">
31
- <div class="bodywrapper">
32
-
33
-
34
- <div class="body" role="main">
35
-
36
- <section class="dl-parameters" id="module-PythonExtensionsCollection.File.CFile">
37
- <span id="cfile-module"></span><h1><span class="section-number">5. </span>CFile module<a class="headerlink" href="#module-PythonExtensionsCollection.File.CFile" title="Permalink to this heading">¶</a></h1>
38
- <dl class="py class">
39
- <dt class="sig sig-object py" id="PythonExtensionsCollection.File.CFile.CFile">
40
- <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">PythonExtensionsCollection.File.CFile.</span></span><span class="sig-name descname"><span class="pre">CFile</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sFile</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/PythonExtensionsCollection/File/CFile.html#CFile"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#PythonExtensionsCollection.File.CFile.CFile" title="Permalink to this definition">¶</a></dt>
41
- <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
42
- <div class="line-block">
43
- <div class="line"><br /></div>
44
- </div>
45
- <p>The class <code class="docutils literal notranslate"><span class="pre">CFile</span></code> provides a small set of file functions with extended parametrization (like switches
46
- defining if a file is allowed to be overwritten or not).</p>
47
- <p>Most of the functions at least returns <code class="docutils literal notranslate"><span class="pre">bSuccess</span></code> and <code class="docutils literal notranslate"><span class="pre">sResult</span></code>.</p>
48
- <ul class="simple">
49
- <li><p><code class="docutils literal notranslate"><span class="pre">bSuccess</span></code> is <code class="docutils literal notranslate"><span class="pre">True</span></code> in case of no error occurred.</p></li>
50
- <li><p><code class="docutils literal notranslate"><span class="pre">bSuccess</span></code> is <code class="docutils literal notranslate"><span class="pre">False</span></code> in case of an error occurred.</p></li>
51
- <li><p><code class="docutils literal notranslate"><span class="pre">bSuccess</span></code> is <code class="docutils literal notranslate"><span class="pre">None</span></code> in case of a very fatal error occurred (exceptions).</p></li>
52
- <li><p><code class="docutils literal notranslate"><span class="pre">sResult</span></code> contains details about what happens during computation.</p></li>
53
- </ul>
54
- <p>Every instance of CFile handles one single file only and forces exclusive access to this file.</p>
55
- <p>It is not possible to create an instance of this class with a file that is already in use by another instance.</p>
56
- <p>It is also not possible to use <code class="docutils literal notranslate"><span class="pre">CopyTo</span></code> or <code class="docutils literal notranslate"><span class="pre">MoveTo</span></code> to overwrite files that are already in use by another instance.
57
- This makes the file handling more save against access violations.</p>
58
- <div class="line-block">
59
- <div class="line"><br /></div>
60
- </div>
61
- <dl class="py method">
62
- <dt class="sig sig-object py" id="PythonExtensionsCollection.File.CFile.CFile.Append">
63
- <span class="sig-name descname"><span class="pre">Append</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">Content</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nVSpaceAfter</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">bToScreen</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/File/CFile.html#CFile.Append"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#PythonExtensionsCollection.File.CFile.CFile.Append" title="Permalink to this definition">¶</a></dt>
64
- <dd><div class="line-block">
65
- <div class="line"><br /></div>
66
- </div>
67
- <p>Appends the content of a variable <code class="docutils literal notranslate"><span class="pre">Content</span></code> to file.</p>
68
- <p>If <code class="docutils literal notranslate"><span class="pre">Content</span></code> is not a string, the <code class="docutils literal notranslate"><span class="pre">Write</span></code> method resolves the data structure (therefore <code class="docutils literal notranslate"><span class="pre">Content</span></code> can also be of type
69
- <code class="docutils literal notranslate"><span class="pre">list</span></code>, <code class="docutils literal notranslate"><span class="pre">tuple</span></code>, <code class="docutils literal notranslate"><span class="pre">set</span></code>, <code class="docutils literal notranslate"><span class="pre">dict</span></code>, <code class="docutils literal notranslate"><span class="pre">dotdict</span></code>).</p>
70
- <p>Adds vertical space <code class="docutils literal notranslate"><span class="pre">nVSpaceAfter</span></code> (= number of blank lines) after <code class="docutils literal notranslate"><span class="pre">Content</span></code>.</p>
71
- <p>Prints <code class="docutils literal notranslate"><span class="pre">Content</span></code> also to screen in case of <code class="docutils literal notranslate"><span class="pre">bToScreen</span></code> is <code class="docutils literal notranslate"><span class="pre">True</span></code> (default: <code class="docutils literal notranslate"><span class="pre">False</span></code>).</p>
72
- <p>Returns <code class="docutils literal notranslate"><span class="pre">bSuccess</span></code> and <code class="docutils literal notranslate"><span class="pre">sResult</span></code> (feedback).</p>
73
- <div class="line-block">
74
- <div class="line"><br /></div>
75
- </div>
76
- </dd></dl>
77
-
78
- <dl class="py method">
79
- <dt class="sig sig-object py" id="PythonExtensionsCollection.File.CFile.CFile.Close">
80
- <span class="sig-name descname"><span class="pre">Close</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/PythonExtensionsCollection/File/CFile.html#CFile.Close"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#PythonExtensionsCollection.File.CFile.CFile.Close" title="Permalink to this definition">¶</a></dt>
81
- <dd><div class="line-block">
82
- <div class="line"><br /></div>
83
- </div>
84
- <p>Closes the opened file.</p>
85
- <p>Returns <code class="docutils literal notranslate"><span class="pre">bSuccess</span></code> and <code class="docutils literal notranslate"><span class="pre">sResult</span></code> (feedback).</p>
86
- <div class="line-block">
87
- <div class="line"><br /></div>
88
- </div>
89
- </dd></dl>
90
-
91
- <dl class="py method">
92
- <dt class="sig sig-object py" id="PythonExtensionsCollection.File.CFile.CFile.CopyTo">
93
- <span class="sig-name descname"><span class="pre">CopyTo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sDestination</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">bOverwrite</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/File/CFile.html#CFile.CopyTo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#PythonExtensionsCollection.File.CFile.CFile.CopyTo" title="Permalink to this definition">¶</a></dt>
94
- <dd><div class="line-block">
95
- <div class="line"><br /></div>
96
- </div>
97
- <p>Copies the current file to <code class="docutils literal notranslate"><span class="pre">sDestination</span></code>, that can either be a path without file name or a path together with a file name.</p>
98
- <p>In case of the destination file already exists and <code class="docutils literal notranslate"><span class="pre">bOverwrite</span></code> is <code class="docutils literal notranslate"><span class="pre">True</span></code>, than the destination file will be overwritten.</p>
99
- <p>In case of the destination file already exists and <code class="docutils literal notranslate"><span class="pre">bOverwrite</span></code> is <code class="docutils literal notranslate"><span class="pre">False</span></code> (default), than the destination file will not be overwritten
100
- and <code class="docutils literal notranslate"><span class="pre">CopyTo</span></code> returns <code class="docutils literal notranslate"><span class="pre">bSuccess</span> <span class="pre">=</span> <span class="pre">False</span></code>.</p>
101
- <p>Returns <code class="docutils literal notranslate"><span class="pre">bSuccess</span></code> and <code class="docutils literal notranslate"><span class="pre">sResult</span></code> (feedback).</p>
102
- <div class="line-block">
103
- <div class="line"><br /></div>
104
- </div>
105
- </dd></dl>
106
-
107
- <dl class="py method">
108
- <dt class="sig sig-object py" id="PythonExtensionsCollection.File.CFile.CFile.Delete">
109
- <span class="sig-name descname"><span class="pre">Delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bConfirmDelete</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/PythonExtensionsCollection/File/CFile.html#CFile.Delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#PythonExtensionsCollection.File.CFile.CFile.Delete" title="Permalink to this definition">¶</a></dt>
110
- <dd><div class="line-block">
111
- <div class="line"><br /></div>
112
- </div>
113
- <p>Deletes the current file.</p>
114
- <p><strong>bConfirmDelete</strong></p>
115
- <blockquote>
116
- <div><p>Defines if it will be handled as error if the file does not exist.</p>
117
- <p>If <code class="docutils literal notranslate"><span class="pre">True</span></code>: If the file does not exist, the method indicates an error (<code class="docutils literal notranslate"><span class="pre">bSuccess</span> <span class="pre">=</span> <span class="pre">False</span></code>).</p>
118
- <p>If <code class="docutils literal notranslate"><span class="pre">False</span></code>: It doesn’t matter if the file exists or not.</p>
119
- </div></blockquote>
120
- <p>Returns <code class="docutils literal notranslate"><span class="pre">bSuccess</span></code> and <code class="docutils literal notranslate"><span class="pre">sResult</span></code> (feedback).</p>
121
- <div class="line-block">
122
- <div class="line"><br /></div>
123
- </div>
124
- </dd></dl>
125
-
126
- <dl class="py method">
127
- <dt class="sig sig-object py" id="PythonExtensionsCollection.File.CFile.CFile.GetFileInfo">
128
- <span class="sig-name descname"><span class="pre">GetFileInfo</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/PythonExtensionsCollection/File/CFile.html#CFile.GetFileInfo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#PythonExtensionsCollection.File.CFile.CFile.GetFileInfo" title="Permalink to this definition">¶</a></dt>
129
- <dd><div class="line-block">
130
- <div class="line"><br /></div>
131
- </div>
132
- <p>Returns the following informations about the file (encapsulated within a dictionary):</p>
133
- <p>Key <strong>sFile</strong></p>
134
- <blockquote>
135
- <div><p>Path and name of current file</p>
136
- </div></blockquote>
137
- <p>Key <strong>bFileIsExisting</strong></p>
138
- <blockquote>
139
- <div><p><code class="docutils literal notranslate"><span class="pre">True</span></code> if file is existing, otherwise not</p>
140
- </div></blockquote>
141
- <p>Key <strong>sFileName</strong></p>
142
- <blockquote>
143
- <div><p>The name of the current file (incl. extension)</p>
144
- </div></blockquote>
145
- <p>Key <strong>sFileExtension</strong></p>
146
- <blockquote>
147
- <div><p>The extension of the current file</p>
148
- </div></blockquote>
149
- <p>Key <strong>sFileNameOnly</strong></p>
150
- <blockquote>
151
- <div><p>The pure name of the current file (without extension)</p>
152
- </div></blockquote>
153
- <p>Key <strong>sFilePath</strong></p>
154
- <blockquote>
155
- <div><p>The the path to current file</p>
156
- </div></blockquote>
157
- <p>Key <strong>bFilePathIsExisting</strong></p>
158
- <blockquote>
159
- <div><p><code class="docutils literal notranslate"><span class="pre">True</span></code> if file path is existing, otherwise not</p>
160
- </div></blockquote>
161
- <div class="line-block">
162
- <div class="line"><br /></div>
163
- </div>
164
- </dd></dl>
165
-
166
- <dl class="py method">
167
- <dt class="sig sig-object py" id="PythonExtensionsCollection.File.CFile.CFile.MoveTo">
168
- <span class="sig-name descname"><span class="pre">MoveTo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sDestination</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">bOverwrite</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/File/CFile.html#CFile.MoveTo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#PythonExtensionsCollection.File.CFile.CFile.MoveTo" title="Permalink to this definition">¶</a></dt>
169
- <dd><div class="line-block">
170
- <div class="line"><br /></div>
171
- </div>
172
- <p>Moves the current file to <code class="docutils literal notranslate"><span class="pre">sDestination</span></code>, that can either be a path without file name or a path together with a file name.</p>
173
- <p>In case of the destination file already exists and <code class="docutils literal notranslate"><span class="pre">bOverwrite</span></code> is <code class="docutils literal notranslate"><span class="pre">True</span></code>, than the destination file will be overwritten.</p>
174
- <p>In case of the destination file already exists and <code class="docutils literal notranslate"><span class="pre">bOverwrite</span></code> is <code class="docutils literal notranslate"><span class="pre">False</span></code> (default), than the destination file will not be overwritten
175
- and <code class="docutils literal notranslate"><span class="pre">CopyTo</span></code> returns <code class="docutils literal notranslate"><span class="pre">bSuccess</span> <span class="pre">=</span> <span class="pre">False</span></code>.</p>
176
- <p>Returns <code class="docutils literal notranslate"><span class="pre">bSuccess</span></code> and <code class="docutils literal notranslate"><span class="pre">sResult</span></code> (feedback).</p>
177
- <div class="line-block">
178
- <div class="line"><br /></div>
179
- </div>
180
- </dd></dl>
181
-
182
- <dl class="py method">
183
- <dt class="sig sig-object py" id="PythonExtensionsCollection.File.CFile.CFile.ReadLines">
184
- <span class="sig-name descname"><span class="pre">ReadLines</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bCaseSensitive</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">bSkipBlankLines</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sComment</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">sStartsWith</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">sEndsWith</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">sStartsNotWith</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">sEndsNotWith</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">sContains</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">sContainsNot</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">sInclRegEx</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">sExclRegEx</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">bLStrip</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bRStrip</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">bToScreen</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/File/CFile.html#CFile.ReadLines"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#PythonExtensionsCollection.File.CFile.CFile.ReadLines" title="Permalink to this definition">¶</a></dt>
185
- <dd><div class="line-block">
186
- <div class="line"><br /></div>
187
- </div>
188
- <p>Reads content from current file. Returns an array of lines together with <code class="docutils literal notranslate"><span class="pre">bSuccess</span></code> and <code class="docutils literal notranslate"><span class="pre">sResult</span></code> (feedback).</p>
189
- <p>The method takes care of opening and closing the file. The complete file content is read by <code class="docutils literal notranslate"><span class="pre">ReadLines</span></code> in one step,
190
- but with the help of further parameters it is possible to reduce the content by including and excluding lines.</p>
191
- <p>T.B.C.</p>
192
- <div class="line-block">
193
- <div class="line"><br /></div>
194
- </div>
195
- </dd></dl>
196
-
197
- <dl class="py method">
198
- <dt class="sig sig-object py" id="PythonExtensionsCollection.File.CFile.CFile.Write">
199
- <span class="sig-name descname"><span class="pre">Write</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">Content</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nVSpaceAfter</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">bToScreen</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/File/CFile.html#CFile.Write"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#PythonExtensionsCollection.File.CFile.CFile.Write" title="Permalink to this definition">¶</a></dt>
200
- <dd><div class="line-block">
201
- <div class="line"><br /></div>
202
- </div>
203
- <p>Writes the content of a variable <code class="docutils literal notranslate"><span class="pre">Content</span></code> to file.</p>
204
- <p>If <code class="docutils literal notranslate"><span class="pre">Content</span></code> is not a string, the <code class="docutils literal notranslate"><span class="pre">Write</span></code> method resolves the data structure (therefore <code class="docutils literal notranslate"><span class="pre">Content</span></code> can also be of type
205
- <code class="docutils literal notranslate"><span class="pre">list</span></code>, <code class="docutils literal notranslate"><span class="pre">tuple</span></code>, <code class="docutils literal notranslate"><span class="pre">set</span></code>, <code class="docutils literal notranslate"><span class="pre">dict</span></code>, <code class="docutils literal notranslate"><span class="pre">dotdict</span></code>).</p>
206
- <p>Adds vertical space <code class="docutils literal notranslate"><span class="pre">nVSpaceAfter</span></code> (= number of blank lines) after <code class="docutils literal notranslate"><span class="pre">Content</span></code>.</p>
207
- <p>Prints <code class="docutils literal notranslate"><span class="pre">Content</span></code> also to screen in case of <code class="docutils literal notranslate"><span class="pre">bToScreen</span></code> is <code class="docutils literal notranslate"><span class="pre">True</span></code> (default: <code class="docutils literal notranslate"><span class="pre">False</span></code>).</p>
208
- <p>Returns <code class="docutils literal notranslate"><span class="pre">bSuccess</span></code> and <code class="docutils literal notranslate"><span class="pre">sResult</span></code> (feedback).</p>
209
- <div class="line-block">
210
- <div class="line"><br /></div>
211
- </div>
212
- </dd></dl>
213
-
214
- </dd></dl>
215
-
216
- <dl class="py class">
217
- <dt class="sig sig-object py" id="PythonExtensionsCollection.File.CFile.enFileStatiType">
218
- <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">PythonExtensionsCollection.File.CFile.</span></span><span class="sig-name descname"><span class="pre">enFileStatiType</span></span><a class="reference internal" href="_modules/PythonExtensionsCollection/File/CFile.html#enFileStatiType"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#PythonExtensionsCollection.File.CFile.enFileStatiType" title="Permalink to this definition">¶</a></dt>
219
- <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
220
- <dl class="py attribute">
221
- <dt class="sig sig-object py" id="PythonExtensionsCollection.File.CFile.enFileStatiType.closed">
222
- <span class="sig-name descname"><span class="pre">closed</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'closed'</span></em><a class="headerlink" href="#PythonExtensionsCollection.File.CFile.enFileStatiType.closed" title="Permalink to this definition">¶</a></dt>
223
- <dd></dd></dl>
224
-
225
- <dl class="py attribute">
226
- <dt class="sig sig-object py" id="PythonExtensionsCollection.File.CFile.enFileStatiType.openedforappending">
227
- <span class="sig-name descname"><span class="pre">openedforappending</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'openedforappending'</span></em><a class="headerlink" href="#PythonExtensionsCollection.File.CFile.enFileStatiType.openedforappending" title="Permalink to this definition">¶</a></dt>
228
- <dd></dd></dl>
229
-
230
- <dl class="py attribute">
231
- <dt class="sig sig-object py" id="PythonExtensionsCollection.File.CFile.enFileStatiType.openedforreading">
232
- <span class="sig-name descname"><span class="pre">openedforreading</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'openedforreading'</span></em><a class="headerlink" href="#PythonExtensionsCollection.File.CFile.enFileStatiType.openedforreading" title="Permalink to this definition">¶</a></dt>
233
- <dd></dd></dl>
234
-
235
- <dl class="py attribute">
236
- <dt class="sig sig-object py" id="PythonExtensionsCollection.File.CFile.enFileStatiType.openedforwriting">
237
- <span class="sig-name descname"><span class="pre">openedforwriting</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'openedforwriting'</span></em><a class="headerlink" href="#PythonExtensionsCollection.File.CFile.enFileStatiType.openedforwriting" title="Permalink to this definition">¶</a></dt>
238
- <dd></dd></dl>
239
-
240
- </dd></dl>
241
-
242
- </section>
243
-
244
-
245
- </div>
246
-
247
- </div>
248
- </div>
249
- <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
250
- <div class="sphinxsidebarwrapper">
251
- <h1 class="logo"><a href="index.html">Python Extensions Collection</a></h1>
252
-
253
-
254
-
255
-
256
-
257
-
258
-
259
-
260
- <h3>Navigation</h3>
261
- <ul class="current">
262
- <li class="toctree-l1"><a class="reference internal" href="additional_doc/Introduction.html">1. Introduction</a></li>
263
- <li class="toctree-l1"><a class="reference internal" href="additional_doc/Introduction.html#examples">2. Examples</a></li>
264
- <li class="toctree-l1"><a class="reference internal" href="String.html">3. CString module</a></li>
265
- <li class="toctree-l1"><a class="reference internal" href="Utils.html">4. CUtils module</a></li>
266
- <li class="toctree-l1 current"><a class="current reference internal" href="#">5. CFile module</a></li>
267
- </ul>
268
-
269
- <div class="relations">
270
- <h3>Related Topics</h3>
271
- <ul>
272
- <li><a href="index.html">Documentation overview</a><ul>
273
- <li>Previous: <a href="Utils.html" title="previous chapter"><span class="section-number">4. </span>CUtils module</a></li>
274
- </ul></li>
275
- </ul>
276
- </div>
277
- <div id="searchbox" style="display: none" role="search">
278
- <h3 id="searchlabel">Quick search</h3>
279
- <div class="searchformwrapper">
280
- <form class="search" action="search.html" method="get">
281
- <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
282
- <input type="submit" value="Go" />
283
- </form>
284
- </div>
285
- </div>
286
- <script>document.getElementById('searchbox').style.display = "block"</script>
287
-
288
-
289
-
290
-
291
-
292
-
293
-
294
-
295
- </div>
296
- </div>
297
- <div class="clearer"></div>
298
- </div>
299
- <div class="footer">
300
- &copy;2022, Queckenstedt Holger (XC-CT/ECA3).
301
-
302
- |
303
- Powered by <a href="http://sphinx-doc.org/">Sphinx 5.0.0</a>
304
- &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
305
-
306
- |
307
- <a href="_sources/File.rst.txt"
308
- rel="nofollow">Page source</a>
309
- </div>
310
-
311
-
312
-
313
-
314
- </body>
315
- </html>