Mercurial Repositories > eric / annotate

eric6/Documentation/Source/eric6.Utilities.__init__.html@44998fccbf6f (annotated)

eric6/Documentation/Source/eric6.Utilities.__init__.html

Wed, 27 May 2020 19:02:07 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Wed, 27 May 2020 19:02:07 +0200
changeset 7602
44998fccbf6f
parent 7586
9ca5907d5ed3
child 7635
0cdead130a81
permissions
-rw-r--r--

Updated source docu.

3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
1 <!DOCTYPE html>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
2 <html><head>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
3 <title>eric6.Utilities.__init__</title>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
4 <meta charset="UTF-8">
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
5 <style>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
6 body {
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
7 background: #EDECE6;
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
8 margin: 0em 1em 10em 1em;
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
9 color: black;
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
10 }
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
11
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
12 h1 { color: white; background: #85774A; }
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
13 h2 { color: white; background: #85774A; }
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
14 h3 { color: white; background: #9D936E; }
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
15 h4 { color: white; background: #9D936E; }
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
16
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
17 a { color: #BA6D36; }
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
18
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
19 </style>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
20 </head>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
21 <body>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
22 <a NAME="top" ID="top"></a>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
23 <h1>eric6.Utilities.__init__</h1>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
24
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
25 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
26 Package implementing various functions/classes needed everywhere within eric6.
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
27 </p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
28 <h3>Global Attributes</h3>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
29
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
30 <table>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
31 <tr><td>_escape</td></tr><tr><td>_escape_map</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>configDir</td></tr><tr><td>supportedCodecs</td></tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
32 </table>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
33 <h3>Classes</h3>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
34
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
35 <table>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
36
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
37 <tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
38 <td><a href="#CodingError">CodingError</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
39 <td>Class implementing an exception, which is raised, if a given coding is incorrect.</td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
40 </tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
41 </table>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
42 <h3>Functions</h3>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
43
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
44 <table>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
45
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
46 <tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
47 <td><a href="#__showwarning">__showwarning</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
48 <td>Module function to raise a SyntaxError for a SyntaxWarning.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
49 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
50 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
51 <td><a href="#_percentReplacementFunc">_percentReplacementFunc</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
52 <td>Protected function called for replacing % codes.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
53 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
54 <tr>
3834
e465278aa177 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
55 <td><a href="#absolutePath">absolutePath</a></td>
e465278aa177 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
56 <td>Public method to convert a path relative to a start path to an absolute path.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
57 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
58 <tr>
3834
e465278aa177 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
59 <td><a href="#absoluteUniversalPath">absoluteUniversalPath</a></td>
e465278aa177 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
60 <td>Public method to convert a path relative to a start path with universal separators to an absolute path.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
61 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
62 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
63 <td><a href="#checkPyside">checkPyside</a></td>
6296
db9b3a419845 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6106
diff changeset
64 <td>Module function to check the presence of PySide/PySide2.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
65 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
66 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
67 <td><a href="#compactPath">compactPath</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
68 <td>Function to return a compacted path fitting inside the given width.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
69 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
70 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
71 <td><a href="#convertLineEnds">convertLineEnds</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
72 <td>Function to convert the end of line characters.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
73 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
74 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
75 <td><a href="#decode">decode</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
76 <td>Function to decode some byte text into a string.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
77 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
78 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
79 <td><a href="#decodeBytes">decodeBytes</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
80 <td>Function to decode some byte text into a string.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
81 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
82 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
83 <td><a href="#decodeString">decodeString</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
84 <td>Function to decode a string containing Unicode encoded characters.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
85 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
86 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
87 <td><a href="#determinePythonVersion">determinePythonVersion</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
88 <td>Function to determine the python version of a given file.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
89 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
90 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
91 <td><a href="#direntries">direntries</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
92 <td>Function returning a list of all files and directories.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
93 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
94 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
95 <td><a href="#encode">encode</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
96 <td>Function to encode text into a byte text.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
97 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
98 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
99 <td><a href="#escape_entities">escape_entities</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
100 <td>Function to encode html entities.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
101 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
102 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
103 <td><a href="#escape_uentities">escape_uentities</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
104 <td>Function to encode html entities.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
105 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
106 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
107 <td><a href="#extractFlags">extractFlags</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
108 <td>Function to extract eric specific flags out of the given text.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
109 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
110 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
111 <td><a href="#extractFlagsFromFile">extractFlagsFromFile</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
112 <td>Function to extract eric specific flags out of the given file.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
113 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
114 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
115 <td><a href="#extractLineFlags">extractLineFlags</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
116 <td>Function to extract flags starting and ending with '__' from a line comment.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
117 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
118 <tr>
5020
d0afdfd8e45b Added capability to filter ANSI escape sequences out of output strings. This is limited to color sequences at the moment.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4397
diff changeset
119 <td><a href="#filterAnsiSequences">filterAnsiSequences</a></td>
d0afdfd8e45b Added capability to filter ANSI escape sequences out of output strings. This is limited to color sequences at the moment.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4397
diff changeset
120 <td>Function to filter out ANSI escape sequences (color only).</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
121 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
122 <tr>
7145
ceb3e8b242c1 Regenerated source docu after merge with 'micropython' branch.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
123 <td><a href="#findVolume">findVolume</a></td>
ceb3e8b242c1 Regenerated source docu after merge with 'micropython' branch.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
124 <td>Function to find the directory belonging to a given volume name.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
125 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
126 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
127 <td><a href="#fromNativeSeparators">fromNativeSeparators</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
128 <td>Function returning a path, that is using "/" separator characters.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
129 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
130 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
131 <td><a href="#generateDistroInfo">generateDistroInfo</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
132 <td>Module function to generate a string with distribution infos.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
133 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
134 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
135 <td><a href="#generatePluginsVersionInfo">generatePluginsVersionInfo</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
136 <td>Module function to generate a string with plugins version infos.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
137 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
138 <tr>
5697
ee81081a0ff7 Finished implementing the capability to configure the path to the PyQt tools or determine it based on the current Python interpreter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5606
diff changeset
139 <td><a href="#generatePyQtToolPath">generatePyQtToolPath</a></td>
ee81081a0ff7 Finished implementing the capability to configure the path to the PyQt tools or determine it based on the current Python interpreter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5606
diff changeset
140 <td>Module function to generate the executable path for a PyQt tool.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
141 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
142 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
143 <td><a href="#generatePySideToolPath">generatePySideToolPath</a></td>
6296
db9b3a419845 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6106
diff changeset
144 <td>Module function to generate the executable path for a PySide/PySide2 tool.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
145 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
146 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
147 <td><a href="#generateQtToolName">generateQtToolName</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
148 <td>Module function to generate the executable name for a Qt tool like designer.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
149 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
150 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
151 <td><a href="#generateVersionInfo">generateVersionInfo</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
152 <td>Module function to generate a string with various version infos.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
153 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
154 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
155 <td><a href="#getDirs">getDirs</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
156 <td>Function returning a list of all directories below path.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
157 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
158 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
159 <td><a href="#getEnvironmentEntry">getEnvironmentEntry</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
160 <td>Module function to get an environment entry.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
161 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
162 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
163 <td><a href="#getExecutablePath">getExecutablePath</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
164 <td>Function to build the full path of an executable file from the environment.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
165 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
166 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
167 <td><a href="#getExecutablePaths">getExecutablePaths</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
168 <td>Function to build all full path of an executable file from the environment.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
169 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
170 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
171 <td><a href="#getHomeDir">getHomeDir</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
172 <td>Function to get a users home directory.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
173 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
174 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
175 <td><a href="#getPercentReplacement">getPercentReplacement</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
176 <td>Function to get the replacement for code.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
177 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
178 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
179 <td><a href="#getPercentReplacementHelp">getPercentReplacementHelp</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
180 <td>Function to get the help text for the supported %-codes.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
181 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
182 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
183 <td><a href="#getPythonLibPath">getPythonLibPath</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
184 <td>Function to determine the path to Python's library.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
185 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
186 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
187 <td><a href="#getPythonVersion">getPythonVersion</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
188 <td>Function to get the Python version (major, minor) as an integer value.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
189 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
190 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
191 <td><a href="#getQtMacBundle">getQtMacBundle</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
192 <td>Module function to determine the correct Mac OS X bundle name for Qt tools.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
193 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
194 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
195 <td><a href="#getRealName">getRealName</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
196 <td>Function to get the real name of the user.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
197 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
198 <tr>
6544
51996454f89f CreateDialogCodeDialog: extended the logic to support projects loading custom widgets from outside the eric or project directories (via a virtual environment).
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6495
diff changeset
199 <td><a href="#getSysPath">getSysPath</a></td>
51996454f89f CreateDialogCodeDialog: extended the logic to support projects loading custom widgets from outside the eric or project directories (via a virtual environment).
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6495
diff changeset
200 <td>Module function to get the Python path (sys.path) of a specific interpreter.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
201 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
202 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
203 <td><a href="#getTestFileName">getTestFileName</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
204 <td>Function to build the filename of a unittest file.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
205 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
206 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
207 <td><a href="#getUserName">getUserName</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
208 <td>Function to get the user name.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
209 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
210 <tr>
7145
ceb3e8b242c1 Regenerated source docu after merge with 'micropython' branch.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
211 <td><a href="#getVolumeName">getVolumeName</a></td>
ceb3e8b242c1 Regenerated source docu after merge with 'micropython' branch.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
212 <td>Local function to determine the volume of a disk or device.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
213 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
214 <tr>
5332
41b32e1636e1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5020
diff changeset
215 <td><a href="#getWindowsExecutablePath">getWindowsExecutablePath</a></td>
41b32e1636e1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5020
diff changeset
216 <td>Function to build the full path of an executable file from the environment on Windows platforms.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
217 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
218 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
219 <td><a href="#get_coding">get_coding</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
220 <td>Function to get the coding of a text.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
221 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
222 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
223 <td><a href="#get_codingBytes">get_codingBytes</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
224 <td>Function to get the coding of a bytes text.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
225 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
226 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
227 <td><a href="#hasEnvironmentEntry">hasEnvironmentEntry</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
228 <td>Module function to check, if the environment contains an entry.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
229 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
230 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
231 <td><a href="#html_encode">html_encode</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
232 <td>Function to correctly encode a text for html.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
233 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
234 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
235 <td><a href="#html_udecode">html_udecode</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
236 <td>Function to correctly decode a html text to a unicode text.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
237 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
238 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
239 <td><a href="#html_uencode">html_uencode</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
240 <td>Function to correctly encode a unicode text for html.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
241 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
242 <tr>
5708
9b01b4004314 Fixed an issue in the file browser model caused some error message being shown upon startup in certain situations.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5697
diff changeset
243 <td><a href="#isDrive">isDrive</a></td>
9b01b4004314 Fixed an issue in the file browser model caused some error message being shown upon startup in certain situations.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5697
diff changeset
244 <td>Function to check, if a path is a Windows drive.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
245 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
246 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
247 <td><a href="#isExecutable">isExecutable</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
248 <td>Function to check, if a file is executable.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
249 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
250 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
251 <td><a href="#isinpath">isinpath</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
252 <td>Function to check for an executable file.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
253 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
254 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
255 <td><a href="#joinext">joinext</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
256 <td>Function to join a file extension to a path.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
257 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
258 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
259 <td><a href="#linesep">linesep</a></td>
6106
921d070cec82 Finished implementing support for EditorConfig.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5878
diff changeset
260 <td>Function to return the line separator used by the editor.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
261 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
262 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
263 <td><a href="#normabsjoinpath">normabsjoinpath</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
264 <td>Function returning a normalized, absolute path of the joined parts passed into it.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
265 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
266 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
267 <td><a href="#normabspath">normabspath</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
268 <td>Function returning a normalized, absolute path.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
269 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
270 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
271 <td><a href="#normcaseabspath">normcaseabspath</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
272 <td>Function returning an absolute path, that is normalized with respect to its case and references.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
273 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
274 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
275 <td><a href="#normcasepath">normcasepath</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
276 <td>Function returning a path, that is normalized with respect to its case and references.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
277 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
278 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
279 <td><a href="#normjoinpath">normjoinpath</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
280 <td>Function returning a normalized path of the joined parts passed into it.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
281 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
282 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
283 <td><a href="#parseEnvironmentString">parseEnvironmentString</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
284 <td>Function used to convert an environment string into a list of environment settings.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
285 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
286 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
287 <td><a href="#parseOptionString">parseOptionString</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
288 <td>Function used to convert an option string into a list of options.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
289 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
290 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
291 <td><a href="#parseString">parseString</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
292 <td>Function used to convert a string into a list.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
293 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
294 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
295 <td><a href="#prepareQtMacBundle">prepareQtMacBundle</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
296 <td>Module function for starting Qt tools that are Mac OS X bundles.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
297 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
298 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
299 <td><a href="#readEncodedFile">readEncodedFile</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
300 <td>Function to read a file and decode its contents into proper text.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
301 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
302 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
303 <td><a href="#readEncodedFileWithEncoding">readEncodedFileWithEncoding</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
304 <td>Function to read a file and decode its contents into proper text.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
305 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
306 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
307 <td><a href="#readEncodedFileWithHash">readEncodedFileWithHash</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
308 <td>Function to read a file, calculate a hash value and decode its contents into proper text.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
309 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
310 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
311 <td><a href="#readStringFromStream">readStringFromStream</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
312 <td>Module function to read a string from the given stream.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
313 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
314 <tr>
3834
e465278aa177 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
315 <td><a href="#relativePath">relativePath</a></td>
e465278aa177 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
316 <td>Function to convert a file path to a path relative to a start path.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
317 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
318 <tr>
3834
e465278aa177 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
319 <td><a href="#relativeUniversalPath">relativeUniversalPath</a></td>
e465278aa177 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
320 <td>Function to convert a file path to a path relative to a start path with universal separators.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
321 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
322 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
323 <td><a href="#relpath">relpath</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
324 <td>Return a relative version of a path.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
325 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
326 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
327 <td><a href="#samefilepath">samefilepath</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
328 <td>Function to compare two paths.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
329 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
330 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
331 <td><a href="#samepath">samepath</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
332 <td>Function to compare two paths.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
333 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
334 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
335 <td><a href="#splitPath">splitPath</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
336 <td>Function to split a pathname into a directory part and a file part.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
337 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
338 <tr>
3834
e465278aa177 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
339 <td><a href="#startswithPath">startswithPath</a></td>
e465278aa177 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
340 <td>Function to check, if a path starts with a given start path.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
341 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
342 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
343 <td><a href="#toBool">toBool</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
344 <td>Module function to convert a string to a boolean value.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
345 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
346 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
347 <td><a href="#toNativeSeparators">toNativeSeparators</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
348 <td>Function returning a path, that is using native separator characters.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
349 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
350 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
351 <td><a href="#unescape_uentities">unescape_uentities</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
352 <td>Function to decode html entities.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
353 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
354 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
355 <td><a href="#win32_GetUserName">win32_GetUserName</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
356 <td>Function to get the user name under Win32.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
357 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
358 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
359 <td><a href="#win32_Kill">win32_Kill</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
360 <td>Function to provide an os.kill equivalent for Win32.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
361 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
362 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
363 <td><a href="#win32_getRealName">win32_getRealName</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
364 <td>Function to get the user's real name (aka.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
365 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
366 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
367 <td><a href="#writeEncodedFile">writeEncodedFile</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
368 <td>Function to write a file with properly encoded text.</td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
369 </tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
370 </table>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
371 <hr />
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
372 <hr />
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
373 <a NAME="CodingError" ID="CodingError"></a>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
374 <h2>CodingError</h2>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
375
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
376 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
377 Class implementing an exception, which is raised, if a given coding is
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
378 incorrect.
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
379 </p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
380 <h3>Derived from</h3>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
381 Exception
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
382 <h3>Class Attributes</h3>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
383
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
384 <table>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
385 <tr><td>None</td></tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
386 </table>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
387 <h3>Class Methods</h3>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
388
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
389 <table>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
390 <tr><td>None</td></tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
391 </table>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
392 <h3>Methods</h3>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
393
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
394 <table>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
395
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
396 <tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
397 <td><a href="#CodingError.__init__">CodingError</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
398 <td>Constructor</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
399 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
400 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
401 <td><a href="#CodingError.__repr__">__repr__</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
402 <td>Special method returning a representation of the exception.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
403 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
404 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
405 <td><a href="#CodingError.__str__">__str__</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
406 <td>Special method returning a string representation of the exception.</td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
407 </tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
408 </table>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
409 <h3>Static Methods</h3>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
410
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
411 <table>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
412 <tr><td>None</td></tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
413 </table>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
414
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
415 <a NAME="CodingError.__init__" ID="CodingError.__init__"></a>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
416 <h4>CodingError (Constructor)</h4>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
417 <b>CodingError</b>(<i>coding</i>)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
418
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
419 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
420 Constructor
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
421 </p>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
422 <dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
423
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
424 <dt><i>coding</i></dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
425 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
426 coding to include in the message (string)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
427 </dd>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
428 </dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
429 <a NAME="CodingError.__repr__" ID="CodingError.__repr__"></a>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
430 <h4>CodingError.__repr__</h4>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
431 <b>__repr__</b>(<i></i>)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
432
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
433 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
434 Special method returning a representation of the exception.
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
435 </p>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
436 <dl>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
437 <dt>Returns:</dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
438 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
439 string representing the error message
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
440 </dd>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
441 </dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
442 <a NAME="CodingError.__str__" ID="CodingError.__str__"></a>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
443 <h4>CodingError.__str__</h4>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
444 <b>__str__</b>(<i></i>)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
445
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
446 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
447 Special method returning a string representation of the exception.
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
448 </p>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
449 <dl>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
450 <dt>Returns:</dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
451 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
452 string representing the error message
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
453 </dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
454 </dl>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
455 <div align="right"><a href="#top">Up</a></div>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
456 <hr />
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
457 <hr />
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
458 <a NAME="__showwarning" ID="__showwarning"></a>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
459 <h2>__showwarning</h2>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
460 <b>__showwarning</b>(<i>message, category, filename, lineno, file=None, line=""</i>)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
461
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
462 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
463 Module function to raise a SyntaxError for a SyntaxWarning.
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
464 </p>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
465 <dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
466
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
467 <dt><i>message</i></dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
468 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
469 warning object
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
470 </dd>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
471 <dt><i>category</i></dt>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
472 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
473 type object of the warning
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
474 </dd>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
475 <dt><i>filename</i></dt>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
476 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
477 name of the file causing the warning (string)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
478 </dd>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
479 <dt><i>lineno</i></dt>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
480 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
481 line number causing the warning (integer)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
482 </dd>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
483 <dt><i>file</i></dt>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
484 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
485 file to write the warning message to (ignored)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
486 </dd>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
487 <dt><i>line</i></dt>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
488 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
489 line causing the warning (ignored)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
490 </dd>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
491 </dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
492 <dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
493
7602
44998fccbf6f Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7586
diff changeset
494 <dt>Raises <b>err</b>:</dt>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
495 <dd>
7602
44998fccbf6f Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7586
diff changeset
496 exception of type SyntaxError
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
497 </dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
498 </dl>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
499 <div align="right"><a href="#top">Up</a></div>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
500 <hr />
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
501 <hr />
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
502 <a NAME="_percentReplacementFunc" ID="_percentReplacementFunc"></a>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
503 <h2>_percentReplacementFunc</h2>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
504 <b>_percentReplacementFunc</b>(<i>matchobj</i>)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
505
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
506 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
507 Protected function called for replacing % codes.
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
508 </p>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
509 <dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
510
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
511 <dt><i>matchobj</i></dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
512 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
513 matchobject for the code
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
514 </dd>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
515 </dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
516 <dl>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
517 <dt>Returns:</dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
518 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
519 replacement string
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
520 </dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
521 </dl>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
522 <div align="right"><a href="#top">Up</a></div>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
523 <hr />
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
524 <hr />
3834
e465278aa177 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
525 <a NAME="absolutePath" ID="absolutePath"></a>
e465278aa177 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
526 <h2>absolutePath</h2>
e465278aa177 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
527 <b>absolutePath</b>(<i>path, start</i>)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
528
3834
e465278aa177 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
529 <p>
e465278aa177 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
530 Public method to convert a path relative to a start path to an
e465278aa177 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
531 absolute path.
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
532 </p>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
533 <dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
534
3834
e465278aa177 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
535 <dt><i>path</i></dt>
e465278aa177 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
536 <dd>
e465278aa177 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
537 file or directory name to convert (string)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
538 </dd>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
539 <dt><i>start</i></dt>
3834
e465278aa177 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
540 <dd>
e465278aa177 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
541 start path (string)
e465278aa177 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
542 </dd>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
543 </dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
544 <dl>
3834
e465278aa177 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
545 <dt>Returns:</dt>
e465278aa177 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
546 <dd>
e465278aa177 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
547 absolute path (string)
e465278aa177 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
548 </dd>
e465278aa177 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
549 </dl>
e465278aa177 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
550 <div align="right"><a href="#top">Up</a></div>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
551 <hr />
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
552 <hr />
3834
e465278aa177 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
553 <a NAME="absoluteUniversalPath" ID="absoluteUniversalPath"></a>
e465278aa177 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
554 <h2>absoluteUniversalPath</h2>
e465278aa177 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
555 <b>absoluteUniversalPath</b>(<i>path, start</i>)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
556
3834
e465278aa177 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
557 <p>
e465278aa177 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
558 Public method to convert a path relative to a start path with
e465278aa177 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
559 universal separators to an absolute path.
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
560 </p>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
561 <dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
562
3834
e465278aa177 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
563 <dt><i>path</i></dt>
e465278aa177 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
564 <dd>
e465278aa177 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
565 file or directory name to convert (string)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
566 </dd>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
567 <dt><i>start</i></dt>
3834
e465278aa177 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
568 <dd>
e465278aa177 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
569 start path (string)
e465278aa177 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
570 </dd>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
571 </dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
572 <dl>
3834
e465278aa177 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
573 <dt>Returns:</dt>
e465278aa177 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
574 <dd>
e465278aa177 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
575 absolute path with native separators (string)
e465278aa177 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
576 </dd>
e465278aa177 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
577 </dl>
e465278aa177 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
578 <div align="right"><a href="#top">Up</a></div>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
579 <hr />
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
580 <hr />
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
581 <a NAME="checkPyside" ID="checkPyside"></a>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
582 <h2>checkPyside</h2>
6296
db9b3a419845 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6106
diff changeset
583 <b>checkPyside</b>(<i>variant="2"</i>)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
584
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
585 <p>
6296
db9b3a419845 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6106
diff changeset
586 Module function to check the presence of PySide/PySide2.
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
587 </p>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
588 <dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
589
6296
db9b3a419845 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6106
diff changeset
590 <dt><i>variant</i> (str)</dt>
db9b3a419845 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6106
diff changeset
591 <dd>
db9b3a419845 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6106
diff changeset
592 indicator for the PySide variant
db9b3a419845 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6106
diff changeset
593 </dd>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
594 </dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
595 <dl>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
596 <dt>Returns:</dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
597 <dd>
6296
db9b3a419845 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6106
diff changeset
598 list of two flags indicating the presence of PySide/PySide2 for
db9b3a419845 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6106
diff changeset
599 Python2 and PySide/PySide2 for Python3
db9b3a419845 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6106
diff changeset
600 </dd>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
601 </dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
602 <dl>
6296
db9b3a419845 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6106
diff changeset
603 <dt>Return Type:</dt>
db9b3a419845 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6106
diff changeset
604 <dd>
db9b3a419845 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6106
diff changeset
605 tuple of (bool, bool)
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
606 </dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
607 </dl>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
608 <div align="right"><a href="#top">Up</a></div>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
609 <hr />
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
610 <hr />
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
611 <a NAME="compactPath" ID="compactPath"></a>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
612 <h2>compactPath</h2>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
613 <b>compactPath</b>(<i>path, width, measure=len</i>)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
614
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
615 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
616 Function to return a compacted path fitting inside the given width.
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
617 </p>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
618 <dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
619
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
620 <dt><i>path</i></dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
621 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
622 path to be compacted (string)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
623 </dd>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
624 <dt><i>width</i></dt>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
625 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
626 width for the compacted path (integer)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
627 </dd>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
628 <dt><i>measure</i></dt>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
629 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
630 reference to a function used to measure the length of the
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
631 string
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
632 </dd>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
633 </dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
634 <dl>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
635 <dt>Returns:</dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
636 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
637 compacted path (string)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
638 </dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
639 </dl>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
640 <div align="right"><a href="#top">Up</a></div>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
641 <hr />
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
642 <hr />
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
643 <a NAME="convertLineEnds" ID="convertLineEnds"></a>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
644 <h2>convertLineEnds</h2>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
645 <b>convertLineEnds</b>(<i>text, eol</i>)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
646
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
647 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
648 Function to convert the end of line characters.
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
649 </p>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
650 <dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
651
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
652 <dt><i>text</i></dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
653 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
654 text to be converted (string)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
655 </dd>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
656 <dt><i>eol</i></dt>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
657 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
658 new eol setting (string)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
659 </dd>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
660 </dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
661 <dl>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
662 <dt>Returns:</dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
663 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
664 text with converted eols (string)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
665 </dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
666 </dl>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
667 <div align="right"><a href="#top">Up</a></div>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
668 <hr />
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
669 <hr />
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
670 <a NAME="decode" ID="decode"></a>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
671 <h2>decode</h2>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
672 <b>decode</b>(<i>text</i>)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
673
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
674 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
675 Function to decode some byte text into a string.
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
676 </p>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
677 <dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
678
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
679 <dt><i>text</i></dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
680 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
681 byte text to decode (bytes)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
682 </dd>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
683 </dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
684 <dl>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
685 <dt>Returns:</dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
686 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
687 tuple of decoded text and encoding (string, string)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
688 </dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
689 </dl>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
690 <div align="right"><a href="#top">Up</a></div>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
691 <hr />
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
692 <hr />
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
693 <a NAME="decodeBytes" ID="decodeBytes"></a>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
694 <h2>decodeBytes</h2>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
695 <b>decodeBytes</b>(<i>buffer</i>)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
696
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
697 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
698 Function to decode some byte text into a string.
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
699 </p>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
700 <dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
701
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
702 <dt><i>buffer</i></dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
703 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
704 byte buffer to decode (bytes)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
705 </dd>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
706 </dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
707 <dl>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
708 <dt>Returns:</dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
709 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
710 decoded text (string)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
711 </dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
712 </dl>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
713 <div align="right"><a href="#top">Up</a></div>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
714 <hr />
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
715 <hr />
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
716 <a NAME="decodeString" ID="decodeString"></a>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
717 <h2>decodeString</h2>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
718 <b>decodeString</b>(<i>text</i>)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
719
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
720 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
721 Function to decode a string containing Unicode encoded characters.
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
722 </p>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
723 <dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
724
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
725 <dt><i>text</i></dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
726 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
727 text containing encoded chars (string)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
728 </dd>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
729 </dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
730 <dl>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
731 <dt>Returns:</dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
732 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
733 decoded text (string)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
734 </dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
735 </dl>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
736 <div align="right"><a href="#top">Up</a></div>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
737 <hr />
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
738 <hr />
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
739 <a NAME="determinePythonVersion" ID="determinePythonVersion"></a>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
740 <h2>determinePythonVersion</h2>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
741 <b>determinePythonVersion</b>(<i>filename, source, editor=None</i>)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
742
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
743 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
744 Function to determine the python version of a given file.
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
745 </p>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
746 <dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
747
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
748 <dt><i>filename</i></dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
749 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
750 name of the file with extension (str)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
751 </dd>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
752 <dt><i>source</i></dt>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
753 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
754 of the file (str)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
755 </dd>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
756 <dt><i>editor=</i></dt>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
757 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
758 reference to the editor, if the file is opened
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
759 already (Editor object)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
760 </dd>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
761 </dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
762 <dl>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
763 <dt>Returns:</dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
764 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
765 Python version if file is Python2 or Python3 (int)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
766 </dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
767 </dl>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
768 <div align="right"><a href="#top">Up</a></div>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
769 <hr />
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
770 <hr />
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
771 <a NAME="direntries" ID="direntries"></a>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
772 <h2>direntries</h2>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
773 <b>direntries</b>(<i>path, filesonly=False, pattern=None, followsymlinks=True, checkStop=None</i>)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
774
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
775 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
776 Function returning a list of all files and directories.
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
777 </p>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
778 <dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
779
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
780 <dt><i>path</i></dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
781 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
782 root of the tree to check
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
783 </dd>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
784 <dt><i>filesonly</i></dt>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
785 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
786 flag indicating that only files are wanted
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
787 </dd>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
788 <dt><i>pattern</i></dt>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
789 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
790 a filename pattern to check against
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
791 </dd>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
792 <dt><i>followsymlinks</i></dt>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
793 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
794 flag indicating whether symbolic links
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
795 should be followed
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
796 </dd>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
797 <dt><i>checkStop</i></dt>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
798 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
799 function to be called to check for a stop
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
800 </dd>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
801 </dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
802 <dl>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
803 <dt>Returns:</dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
804 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
805 list of all files and directories in the tree rooted
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
806 at path. The names are expanded to start with path.
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
807 </dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
808 </dl>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
809 <div align="right"><a href="#top">Up</a></div>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
810 <hr />
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
811 <hr />
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
812 <a NAME="encode" ID="encode"></a>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
813 <h2>encode</h2>
6106
921d070cec82 Finished implementing support for EditorConfig.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5878
diff changeset
814 <b>encode</b>(<i>text, origEncoding, forcedEncoding=""</i>)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
815
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
816 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
817 Function to encode text into a byte text.
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
818 </p>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
819 <dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
820
6106
921d070cec82 Finished implementing support for EditorConfig.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5878
diff changeset
821 <dt><i>text</i> (str)</dt>
921d070cec82 Finished implementing support for EditorConfig.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5878
diff changeset
822 <dd>
921d070cec82 Finished implementing support for EditorConfig.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5878
diff changeset
823 text to be encoded
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
824 </dd>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
825 <dt><i>origEncoding</i> (str)</dt>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
826 <dd>
6106
921d070cec82 Finished implementing support for EditorConfig.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5878
diff changeset
827 type of the original encoding
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
828 </dd>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
829 <dt><i>forcedEncoding</i> (str)</dt>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
830 <dd>
6106
921d070cec82 Finished implementing support for EditorConfig.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5878
diff changeset
831 encoding to be used for writing, if no coding line
921d070cec82 Finished implementing support for EditorConfig.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5878
diff changeset
832 is present
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
833 </dd>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
834 </dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
835 <dl>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
836 <dt>Returns:</dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
837 <dd>
6106
921d070cec82 Finished implementing support for EditorConfig.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5878
diff changeset
838 tuple of encoded text and encoding used
921d070cec82 Finished implementing support for EditorConfig.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5878
diff changeset
839 </dd>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
840 </dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
841 <dl>
6106
921d070cec82 Finished implementing support for EditorConfig.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5878
diff changeset
842 <dt>Return Type:</dt>
921d070cec82 Finished implementing support for EditorConfig.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5878
diff changeset
843 <dd>
921d070cec82 Finished implementing support for EditorConfig.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5878
diff changeset
844 tuple of (bytes, str)
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
845 </dd>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
846 </dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
847 <dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
848
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
849 <dt>Raises <b>CodingError</b>:</dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
850 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
851 raised to indicate an invalid encoding
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
852 </dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
853 </dl>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
854 <div align="right"><a href="#top">Up</a></div>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
855 <hr />
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
856 <hr />
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
857 <a NAME="escape_entities" ID="escape_entities"></a>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
858 <h2>escape_entities</h2>
5606
da305d172769 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5586
diff changeset
859 <b>escape_entities</b>(<i>m, escmap=_escape_map</i>)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
860
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
861 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
862 Function to encode html entities.
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
863 </p>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
864 <dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
865
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
866 <dt><i>m</i></dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
867 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
868 the match object
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
869 </dd>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
870 <dt><i>escmap</i></dt>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
871 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
872 the map of entities to encode
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
873 </dd>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
874 </dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
875 <dl>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
876 <dt>Returns:</dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
877 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
878 the converted text (string)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
879 </dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
880 </dl>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
881 <div align="right"><a href="#top">Up</a></div>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
882 <hr />
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
883 <hr />
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
884 <a NAME="escape_uentities" ID="escape_uentities"></a>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
885 <h2>escape_uentities</h2>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
886 <b>escape_uentities</b>(<i>m</i>)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
887
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
888 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
889 Function to encode html entities.
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
890 </p>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
891 <dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
892
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
893 <dt><i>m</i></dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
894 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
895 the match object
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
896 </dd>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
897 </dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
898 <dl>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
899 <dt>Returns:</dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
900 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
901 the converted text (string)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
902 </dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
903 </dl>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
904 <div align="right"><a href="#top">Up</a></div>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
905 <hr />
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
906 <hr />
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
907 <a NAME="extractFlags" ID="extractFlags"></a>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
908 <h2>extractFlags</h2>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
909 <b>extractFlags</b>(<i>text</i>)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
910
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
911 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
912 Function to extract eric specific flags out of the given text.
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
913 </p>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
914 <p>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
915 Flags are contained in comments and are introduced by 'eflag:'.
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
916 The rest of the line is interpreted as 'key = value'. value is
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
917 analyzed for being an integer or float value. If that fails, it
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
918 is assumed to be a string. If a key does not contain a '='
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
919 character, it is assumed to be a boolean flag. Flags are expected
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
920 at the very end of a file. The search is ended, if a line without
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
921 the 'eflag:' marker is found.
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
922 </p>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
923 <dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
924
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
925 <dt><i>text</i></dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
926 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
927 text to be scanned (string)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
928 </dd>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
929 </dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
930 <dl>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
931 <dt>Returns:</dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
932 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
933 dictionary of string, boolean, complex, float and int
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
934 </dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
935 </dl>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
936 <div align="right"><a href="#top">Up</a></div>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
937 <hr />
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
938 <hr />
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
939 <a NAME="extractFlagsFromFile" ID="extractFlagsFromFile"></a>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
940 <h2>extractFlagsFromFile</h2>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
941 <b>extractFlagsFromFile</b>(<i>filename</i>)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
942
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
943 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
944 Function to extract eric specific flags out of the given file.
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
945 </p>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
946 <dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
947
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
948 <dt><i>filename</i></dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
949 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
950 name of the file to be scanned (string)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
951 </dd>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
952 </dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
953 <dl>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
954 <dt>Returns:</dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
955 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
956 dictionary of string, boolean, complex, float and int
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
957 </dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
958 </dl>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
959 <div align="right"><a href="#top">Up</a></div>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
960 <hr />
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
961 <hr />
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
962 <a NAME="extractLineFlags" ID="extractLineFlags"></a>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
963 <h2>extractLineFlags</h2>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
964 <b>extractLineFlags</b>(<i>line, startComment="</i>)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
965
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
966 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
967 Function to extract flags starting and ending with '__' from a line
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
968 comment.
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
969 </p>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
970 <dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
971
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
972 <dt><i>line</i></dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
973 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
974 line to extract flags from (string)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
975 </dd>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
976 <dt><i>startComment=</i></dt>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
977 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
978 string identifying the start of the comment (string)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
979 </dd>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
980 <dt><i>endComment=</i></dt>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
981 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
982 string identifying the end of a comment (string)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
983 </dd>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
984 <dt><i>flagsLine=</i></dt>
5586
0e5421d679e7 Added capability to place line flags (e.g. __IGNORE...) on the line following the one to be ignored.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5332
diff changeset
985 <dd>
0e5421d679e7 Added capability to place line flags (e.g. __IGNORE...) on the line following the one to be ignored.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5332
diff changeset
986 flag indicating to check for a flags only line (bool)
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
987 </dd>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
988 </dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
989 <dl>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
990 <dt>Returns:</dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
991 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
992 list containing the extracted flags (list of strings)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
993 </dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
994 </dl>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
995 <div align="right"><a href="#top">Up</a></div>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
996 <hr />
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
997 <hr />
5020
d0afdfd8e45b Added capability to filter ANSI escape sequences out of output strings. This is limited to color sequences at the moment.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4397
diff changeset
998 <a NAME="filterAnsiSequences" ID="filterAnsiSequences"></a>
d0afdfd8e45b Added capability to filter ANSI escape sequences out of output strings. This is limited to color sequences at the moment.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4397
diff changeset
999 <h2>filterAnsiSequences</h2>
d0afdfd8e45b Added capability to filter ANSI escape sequences out of output strings. This is limited to color sequences at the moment.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4397
diff changeset
1000 <b>filterAnsiSequences</b>(<i>txt</i>)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
1001
5020
d0afdfd8e45b Added capability to filter ANSI escape sequences out of output strings. This is limited to color sequences at the moment.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4397
diff changeset
1002 <p>
d0afdfd8e45b Added capability to filter ANSI escape sequences out of output strings. This is limited to color sequences at the moment.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4397
diff changeset
1003 Function to filter out ANSI escape sequences (color only).
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
1004 </p>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
1005 <dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
1006
5020
d0afdfd8e45b Added capability to filter ANSI escape sequences out of output strings. This is limited to color sequences at the moment.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4397
diff changeset
1007 <dt><i>txt</i> (str)</dt>
d0afdfd8e45b Added capability to filter ANSI escape sequences out of output strings. This is limited to color sequences at the moment.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4397
diff changeset
1008 <dd>
d0afdfd8e45b Added capability to filter ANSI escape sequences out of output strings. This is limited to color sequences at the moment.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4397
diff changeset
1009 text to be filtered
d0afdfd8e45b Added capability to filter ANSI escape sequences out of output strings. This is limited to color sequences at the moment.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4397
diff changeset
1010 </dd>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
1011 </dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
1012 <dl>
5020
d0afdfd8e45b Added capability to filter ANSI escape sequences out of output strings. This is limited to color sequences at the moment.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4397
diff changeset
1013 <dt>Returns:</dt>
d0afdfd8e45b Added capability to filter ANSI escape sequences out of output strings. This is limited to color sequences at the moment.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4397
diff changeset
1014 <dd>
d0afdfd8e45b Added capability to filter ANSI escape sequences out of output strings. This is limited to color sequences at the moment.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4397
diff changeset
1015 text without ANSI escape sequences
d0afdfd8e45b Added capability to filter ANSI escape sequences out of output strings. This is limited to color sequences at the moment.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4397
diff changeset
1016 </dd>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
1017 </dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7204
diff changeset
1018 <dl>
5020
d0afdfd8e45b Added capability to filter ANSI escape sequences out of output strings. This is limited to color sequences at the moment.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4397
diff changeset
1019 <dt>Return Type:</dt>
d0afdfd8e45b Added capability to filter ANSI escape sequences out of output strings. This is limited to color sequences at the moment.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4397
diff changeset
1020 <dd>
d0afdfd8e45b Added capability to filter ANSI escape sequences out of output strings. This is limited to color sequences at the moment.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4397
diff changeset
1021 str
d0afdfd8e45b Added capability to filter ANSI escape sequences out of output strings. This is limited to color sequences at the moment.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4397
diff changeset
1022 </dd>
d0afdfd8e45b Added capability to filter ANSI escape sequences out of output strings. This is limited to color sequences at the moment.
Detlev Offenbac