--- a/src/eric7/Documentation/Source/eric7.Utilities.__init__.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.Utilities.__init__.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,28 +7,32 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Utilities.__init__</h1>
-
<p>
Package implementing various functions/classes needed everywhere within eric.
</p>
+
<h3>Global Attributes</h3>
-
<table>
-<tr><td>_escape</td></tr><tr><td>_escape_map</td></tr><tr><td>_slashmap</td></tr><tr><td>_uescape</td></tr><tr><td>_uunescape</td></tr><tr><td>codingBytes_regexps</td></tr><tr><td>coding_regexps</td></tr><tr><td>supportedCodecs</td></tr>
+<tr><td>_escape</td></tr>
+<tr><td>_escape_map</td></tr>
+<tr><td>_slashmap</td></tr>
+<tr><td>_uescape</td></tr>
+<tr><td>_uunescape</td></tr>
+<tr><td>codingBytes_regexps</td></tr>
+<tr><td>coding_regexps</td></tr>
+<tr><td>supportedCodecs</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#CodingError">CodingError</a></td>
<td>Class implementing an exception, which is raised, if a given coding is incorrect.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
-
<tr>
<td><a href="#__showwarning">__showwarning</a></td>
<td>Module function to raise a SyntaxError for a SyntaxWarning.</td>
@@ -194,31 +198,30 @@
<td>Function to write a file with properly encoded text.</td>
</tr>
</table>
+
<hr />
<hr />
<a NAME="CodingError" ID="CodingError"></a>
<h2>CodingError</h2>
-
<p>
Class implementing an exception, which is raised, if a given coding is
incorrect.
</p>
+
<h3>Derived from</h3>
Exception
<h3>Class Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#CodingError.__init__">CodingError</a></td>
<td>Constructor</td>
@@ -232,19 +235,20 @@
<td>Special method returning a string representation of the exception.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="CodingError.__init__" ID="CodingError.__init__"></a>
<h4>CodingError (Constructor)</h4>
<b>CodingError</b>(<i>coding</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>coding</i> (str)</dt>
@@ -255,10 +259,10 @@
<a NAME="CodingError.__repr__" ID="CodingError.__repr__"></a>
<h4>CodingError.__repr__</h4>
<b>__repr__</b>(<i></i>)
-
<p>
Special method returning a representation of the exception.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -274,10 +278,10 @@
<a NAME="CodingError.__str__" ID="CodingError.__str__"></a>
<h4>CodingError.__str__</h4>
<b>__str__</b>(<i></i>)
-
<p>
Special method returning a string representation of the exception.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -296,10 +300,10 @@
<a NAME="__showwarning" ID="__showwarning"></a>
<h2>__showwarning</h2>
<b>__showwarning</b>(<i>message, category, filename, lineno, file=None, line=""</i>)
-
<p>
Module function to raise a SyntaxError for a SyntaxWarning.
</p>
+
<dl>
<dt><i>message</i> (Class)</dt>
@@ -340,10 +344,10 @@
<a NAME="_percentReplacementFunc" ID="_percentReplacementFunc"></a>
<h2>_percentReplacementFunc</h2>
<b>_percentReplacementFunc</b>(<i>matchobj</i>)
-
<p>
Protected function called for replacing % codes.
</p>
+
<dl>
<dt><i>matchobj</i> (re.Match)</dt>
@@ -369,10 +373,10 @@
<a NAME="convertLineEnds" ID="convertLineEnds"></a>
<h2>convertLineEnds</h2>
<b>convertLineEnds</b>(<i>text, eol</i>)
-
<p>
Function to convert the end of line characters.
</p>
+
<dl>
<dt><i>text</i> (str)</dt>
@@ -402,10 +406,10 @@
<a NAME="decode" ID="decode"></a>
<h2>decode</h2>
<b>decode</b>(<i>text</i>)
-
<p>
Function to decode some byte text into a string.
</p>
+
<dl>
<dt><i>text</i> (bytes)</dt>
@@ -431,10 +435,10 @@
<a NAME="decodeBytes" ID="decodeBytes"></a>
<h2>decodeBytes</h2>
<b>decodeBytes</b>(<i>buffer</i>)
-
<p>
Function to decode some byte text into a string.
</p>
+
<dl>
<dt><i>buffer</i> (bytes)</dt>
@@ -460,10 +464,10 @@
<a NAME="decodeString" ID="decodeString"></a>
<h2>decodeString</h2>
<b>decodeString</b>(<i>text</i>)
-
<p>
Function to decode a string containing Unicode encoded characters.
</p>
+
<dl>
<dt><i>text</i> (str)</dt>
@@ -489,10 +493,10 @@
<a NAME="encode" ID="encode"></a>
<h2>encode</h2>
<b>encode</b>(<i>text, origEncoding, forcedEncoding=""</i>)
-
<p>
Function to encode text into a byte text.
</p>
+
<dl>
<dt><i>text</i> (str)</dt>
@@ -534,10 +538,10 @@
<a NAME="escape_entities" ID="escape_entities"></a>
<h2>escape_entities</h2>
<b>escape_entities</b>(<i>m, escmap=_escape_map</i>)
-
<p>
Function to encode html entities.
</p>
+
<dl>
<dt><i>m</i> (re.Match)</dt>
@@ -567,10 +571,10 @@
<a NAME="escape_uentities" ID="escape_uentities"></a>
<h2>escape_uentities</h2>
<b>escape_uentities</b>(<i>m</i>)
-
<p>
Function to encode html entities.
</p>
+
<dl>
<dt><i>m</i> (re.Match)</dt>
@@ -596,7 +600,6 @@
<a NAME="extractFlags" ID="extractFlags"></a>
<h2>extractFlags</h2>
<b>extractFlags</b>(<i>text</i>)
-
<p>
Function to extract eric specific flags out of the given text.
</p>
@@ -609,6 +612,7 @@
at the very end of a file. The search is ended, if a line without
the 'eflag:' marker is found.
</p>
+
<dl>
<dt><i>text</i> (str)</dt>
@@ -634,10 +638,10 @@
<a NAME="extractFlagsFromFile" ID="extractFlagsFromFile"></a>
<h2>extractFlagsFromFile</h2>
<b>extractFlagsFromFile</b>(<i>filename</i>)
-
<p>
Function to extract eric specific flags out of the given file.
</p>
+
<dl>
<dt><i>filename</i> (str)</dt>
@@ -663,11 +667,11 @@
<a NAME="extractLineFlags" ID="extractLineFlags"></a>
<h2>extractLineFlags</h2>
<b>extractLineFlags</b>(<i>line, startComment="</i>)
-
<p>
Function to extract flags starting and ending with '__' from a line
comment.
</p>
+
<dl>
<dt><i>line</i> (str)</dt>
@@ -705,10 +709,10 @@
<a NAME="filterAnsiSequences" ID="filterAnsiSequences"></a>
<h2>filterAnsiSequences</h2>
<b>filterAnsiSequences</b>(<i>txt</i>)
-
<p>
Function to filter out ANSI escape sequences (color only).
</p>
+
<dl>
<dt><i>txt</i> (str)</dt>
@@ -734,10 +738,10 @@
<a NAME="generateDistroInfo" ID="generateDistroInfo"></a>
<h2>generateDistroInfo</h2>
<b>generateDistroInfo</b>(<i>linesep="\n"</i>)
-
<p>
Module function to generate a string with distribution infos.
</p>
+
<dl>
<dt><i>linesep</i> (str)</dt>
@@ -763,10 +767,10 @@
<a NAME="generatePluginsVersionInfo" ID="generatePluginsVersionInfo"></a>
<h2>generatePluginsVersionInfo</h2>
<b>generatePluginsVersionInfo</b>(<i>linesep="\n"</i>)
-
<p>
Module function to generate a string with plugins version infos.
</p>
+
<dl>
<dt><i>linesep</i> (str)</dt>
@@ -792,10 +796,10 @@
<a NAME="generateVersionInfo" ID="generateVersionInfo"></a>
<h2>generateVersionInfo</h2>
<b>generateVersionInfo</b>(<i>linesep="\n"</i>)
-
<p>
Module function to generate a string with various version infos.
</p>
+
<dl>
<dt><i>linesep</i> (str)</dt>
@@ -821,10 +825,10 @@
<a NAME="getCoverageFileName" ID="getCoverageFileName"></a>
<h2>getCoverageFileName</h2>
<b>getCoverageFileName</b>(<i>fn, mustExist=True</i>)
-
<p>
Function to build a file name for a coverage data file.
</p>
+
<dl>
<dt><i>fn</i> (str)</dt>
@@ -855,10 +859,10 @@
<a NAME="getCoverageFileNames" ID="getCoverageFileNames"></a>
<h2>getCoverageFileNames</h2>
<b>getCoverageFileNames</b>(<i>fn</i>)
-
<p>
Function to build a list of coverage data file names.
</p>
+
<dl>
<dt><i>fn</i> (str)</dt>
@@ -884,10 +888,10 @@
<a NAME="getPercentReplacement" ID="getPercentReplacement"></a>
<h2>getPercentReplacement</h2>
<b>getPercentReplacement</b>(<i>code</i>)
-
<p>
Function to get the replacement for code.
</p>
+
<dl>
<dt><i>code</i> (str)</dt>
@@ -913,10 +917,10 @@
<a NAME="getPercentReplacementHelp" ID="getPercentReplacementHelp"></a>
<h2>getPercentReplacementHelp</h2>
<b>getPercentReplacementHelp</b>(<i></i>)
-
<p>
Function to get the help text for the supported %-codes.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -935,10 +939,10 @@
<a NAME="getProfileFileName" ID="getProfileFileName"></a>
<h2>getProfileFileName</h2>
<b>getProfileFileName</b>(<i>fn, mustExist=True</i>)
-
<p>
Function to build a file name for a profile data file.
</p>
+
<dl>
<dt><i>fn</i> (str)</dt>
@@ -969,10 +973,10 @@
<a NAME="getProfileFileNames" ID="getProfileFileNames"></a>
<h2>getProfileFileNames</h2>
<b>getProfileFileNames</b>(<i>fn</i>)
-
<p>
Function to build a list of profile data file names.
</p>
+
<dl>
<dt><i>fn</i> (str)</dt>
@@ -998,11 +1002,11 @@
<a NAME="getSysPath" ID="getSysPath"></a>
<h2>getSysPath</h2>
<b>getSysPath</b>(<i>interpreter</i>)
-
<p>
Module function to get the Python path (sys.path) of a specific
interpreter.
</p>
+
<dl>
<dt><i>interpreter</i> (str)</dt>
@@ -1029,7 +1033,6 @@
<a NAME="getTestFileNames" ID="getTestFileNames"></a>
<h2>getTestFileNames</h2>
<b>getTestFileNames</b>(<i>fn</i>)
-
<p>
Function to build the potential file names of a test file.
</p>
@@ -1038,6 +1041,7 @@
"test" and "test_" to the file name passed into this function and
by appending the string "_test".
</p>
+
<dl>
<dt><i>fn</i> (str)</dt>
@@ -1063,10 +1067,10 @@
<a NAME="get_coding" ID="get_coding"></a>
<h2>get_coding</h2>
<b>get_coding</b>(<i>text</i>)
-
<p>
Function to get the coding of a text.
</p>
+
<dl>
<dt><i>text</i> (str)</dt>
@@ -1092,10 +1096,10 @@
<a NAME="get_codingBytes" ID="get_codingBytes"></a>
<h2>get_codingBytes</h2>
<b>get_codingBytes</b>(<i>text</i>)
-
<p>
Function to get the coding of a bytes text.
</p>
+
<dl>
<dt><i>text</i> (bytes)</dt>
@@ -1121,10 +1125,10 @@
<a NAME="html_encode" ID="html_encode"></a>
<h2>html_encode</h2>
<b>html_encode</b>(<i>text, pattern=_escape</i>)
-
<p>
Function to correctly encode a text for html.
</p>
+
<dl>
<dt><i>text</i> (str)</dt>
@@ -1154,10 +1158,10 @@
<a NAME="html_udecode" ID="html_udecode"></a>
<h2>html_udecode</h2>
<b>html_udecode</b>(<i>text, pattern=_uunescape</i>)
-
<p>
Function to correctly decode a html text to a unicode text.
</p>
+
<dl>
<dt><i>text</i> (str)</dt>
@@ -1187,10 +1191,10 @@
<a NAME="html_uencode" ID="html_uencode"></a>
<h2>html_uencode</h2>
<b>html_uencode</b>(<i>text, pattern=_uescape</i>)
-
<p>
Function to correctly encode a unicode text for html.
</p>
+
<dl>
<dt><i>text</i> (str)</dt>
@@ -1220,10 +1224,10 @@
<a NAME="linesep" ID="linesep"></a>
<h2>linesep</h2>
<b>linesep</b>(<i></i>)
-
<p>
Function to return the line separator used by the editor.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1242,10 +1246,10 @@
<a NAME="normalizeCode" ID="normalizeCode"></a>
<h2>normalizeCode</h2>
<b>normalizeCode</b>(<i>codestring</i>)
-
<p>
Function to normalize the given code.
</p>
+
<dl>
<dt><i>codestring</i> (str)</dt>
@@ -1271,10 +1275,10 @@
<a NAME="parseOptionString" ID="parseOptionString"></a>
<h2>parseOptionString</h2>
<b>parseOptionString</b>(<i>s</i>)
-
<p>
Function used to convert an option string into a list of options.
</p>
+
<dl>
<dt><i>s</i> (str)</dt>
@@ -1300,10 +1304,10 @@
<a NAME="readEncodedFile" ID="readEncodedFile"></a>
<h2>readEncodedFile</h2>
<b>readEncodedFile</b>(<i>filename</i>)
-
<p>
Function to read a file and decode its contents into proper text.
</p>
+
<dl>
<dt><i>filename</i> (str)</dt>
@@ -1329,10 +1333,10 @@
<a NAME="readEncodedFileWithEncoding" ID="readEncodedFileWithEncoding"></a>
<h2>readEncodedFileWithEncoding</h2>
<b>readEncodedFileWithEncoding</b>(<i>filename, encoding</i>)
-
<p>
Function to read a file and decode its contents into proper text.
</p>
+
<dl>
<dt><i>filename</i> (str)</dt>
@@ -1362,11 +1366,11 @@
<a NAME="readEncodedFileWithHash" ID="readEncodedFileWithHash"></a>
<h2>readEncodedFileWithHash</h2>
<b>readEncodedFileWithHash</b>(<i>filename</i>)
-
<p>
Function to read a file, calculate a hash value and decode its contents
into proper text.
</p>
+
<dl>
<dt><i>filename</i> (str)</dt>
@@ -1392,10 +1396,10 @@
<a NAME="readStringFromStream" ID="readStringFromStream"></a>
<h2>readStringFromStream</h2>
<b>readStringFromStream</b>(<i>stream</i>)
-
<p>
Module function to read a string from the given stream.
</p>
+
<dl>
<dt><i>stream</i> (QDataStream)</dt>
@@ -1421,11 +1425,11 @@
<a NAME="rxIndex" ID="rxIndex"></a>
<h2>rxIndex</h2>
<b>rxIndex</b>(<i>rx, txt</i>)
-
<p>
Function to get the index (start position) of a regular expression match
within some text.
</p>
+
<dl>
<dt><i>rx</i> (re.Pattern)</dt>
@@ -1455,13 +1459,13 @@
<a NAME="slash" ID="slash"></a>
<h2>slash</h2>
<b>slash</b>(<i>txt</i>)
-
<p>
Function to convert an escaped string to a string containing escape codes.
</p>
<p>
Note: This is the reverse of 'unslash()'.
</p>
+
<dl>
<dt><i>txt</i> (str)</dt>
@@ -1487,10 +1491,10 @@
<a NAME="unescape_uentities" ID="unescape_uentities"></a>
<h2>unescape_uentities</h2>
<b>unescape_uentities</b>(<i>m</i>)
-
<p>
Function to decode html entities.
</p>
+
<dl>
<dt><i>m</i> (re.Match)</dt>
@@ -1516,10 +1520,10 @@
<a NAME="unslash" ID="unslash"></a>
<h2>unslash</h2>
<b>unslash</b>(<i>txt</i>)
-
<p>
Function to convert a string containing escape codes to an escaped string.
</p>
+
<dl>
<dt><i>txt</i> (str)</dt>
@@ -1545,10 +1549,10 @@
<a NAME="writeEncodedFile" ID="writeEncodedFile"></a>
<h2>writeEncodedFile</h2>
<b>writeEncodedFile</b>(<i>filename, text, origEncoding, forcedEncoding=""</i>)
-
<p>
Function to write a file with properly encoded text.
</p>
+
<dl>
<dt><i>filename</i> (str)</dt>
@@ -1583,4 +1587,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
