|
1 <?xml version="1.0" encoding="utf-8"?> |
|
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' |
|
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> |
|
4 <html><head> |
|
5 <title>eric5.E5XML.XMLWriterBase</title> |
|
6 <style> |
|
7 body { |
|
8 background:white; |
|
9 margin: 0em 1em 10em 1em; |
|
10 color: black; |
|
11 } |
|
12 |
|
13 h1 { color: white; background: #4FA4FF; } |
|
14 h2 { color: white; background: #4FA4FF; } |
|
15 h3 { color: white; background: #00557F; } |
|
16 h4 { color: white; background: #00557F; } |
|
17 |
|
18 a { color: #AA5500; } |
|
19 |
|
20 </style> |
|
21 </head> |
|
22 <body><a NAME="top" ID="top"></a> |
|
23 <h1>eric5.E5XML.XMLWriterBase</h1> |
|
24 <p> |
|
25 Module implementing a base class for all of eric5s XML writers. |
|
26 </p> |
|
27 <h3>Global Attributes</h3> |
|
28 <table> |
|
29 <tr><td>None</td></tr> |
|
30 </table> |
|
31 <h3>Classes</h3> |
|
32 <table> |
|
33 <tr> |
|
34 <td><a href="#XMLWriterBase">XMLWriterBase</a></td> |
|
35 <td>Class implementing a base class for all of eric5s XML writers.</td> |
|
36 </tr> |
|
37 </table> |
|
38 <h3>Functions</h3> |
|
39 <table> |
|
40 <tr><td>None</td></tr> |
|
41 </table> |
|
42 <hr /><hr /> |
|
43 <a NAME="XMLWriterBase" ID="XMLWriterBase"></a> |
|
44 <h2>XMLWriterBase</h2> |
|
45 <p> |
|
46 Class implementing a base class for all of eric5s XML writers. |
|
47 </p> |
|
48 <h3>Derived from</h3> |
|
49 object |
|
50 <h3>Class Attributes</h3> |
|
51 <table> |
|
52 <tr><td>None</td></tr> |
|
53 </table> |
|
54 <h3>Methods</h3> |
|
55 <table> |
|
56 <tr> |
|
57 <td><a href="#XMLWriterBase.__init__">XMLWriterBase</a></td> |
|
58 <td>Constructor</td> |
|
59 </tr><tr> |
|
60 <td><a href="#XMLWriterBase._write">_write</a></td> |
|
61 <td>Protected method used to do the real write operation.</td> |
|
62 </tr><tr> |
|
63 <td><a href="#XMLWriterBase._writeBasics">_writeBasics</a></td> |
|
64 <td>Protected method to dump an object of a basic Python type.</td> |
|
65 </tr><tr> |
|
66 <td><a href="#XMLWriterBase._write_bool">_write_bool</a></td> |
|
67 <td>Protected method to dump a bool object.</td> |
|
68 </tr><tr> |
|
69 <td><a href="#XMLWriterBase._write_bytearray">_write_bytearray</a></td> |
|
70 <td>Protected method to dump a bytearray object.</td> |
|
71 </tr><tr> |
|
72 <td><a href="#XMLWriterBase._write_bytes">_write_bytes</a></td> |
|
73 <td>Protected method to dump a bytes object.</td> |
|
74 </tr><tr> |
|
75 <td><a href="#XMLWriterBase._write_complex">_write_complex</a></td> |
|
76 <td>Protected method to dump a complex object.</td> |
|
77 </tr><tr> |
|
78 <td><a href="#XMLWriterBase._write_dictionary">_write_dictionary</a></td> |
|
79 <td>Protected method to dump a dict object.</td> |
|
80 </tr><tr> |
|
81 <td><a href="#XMLWriterBase._write_float">_write_float</a></td> |
|
82 <td>Protected method to dump a float object.</td> |
|
83 </tr><tr> |
|
84 <td><a href="#XMLWriterBase._write_frozenset">_write_frozenset</a></td> |
|
85 <td>Protected method to dump a frozenset object.</td> |
|
86 </tr><tr> |
|
87 <td><a href="#XMLWriterBase._write_int">_write_int</a></td> |
|
88 <td>Protected method to dump an int object.</td> |
|
89 </tr><tr> |
|
90 <td><a href="#XMLWriterBase._write_list">_write_list</a></td> |
|
91 <td>Protected method to dump a list object.</td> |
|
92 </tr><tr> |
|
93 <td><a href="#XMLWriterBase._write_none">_write_none</a></td> |
|
94 <td>Protected method to dump a NoneType object.</td> |
|
95 </tr><tr> |
|
96 <td><a href="#XMLWriterBase._write_set">_write_set</a></td> |
|
97 <td>Protected method to dump a set object.</td> |
|
98 </tr><tr> |
|
99 <td><a href="#XMLWriterBase._write_string">_write_string</a></td> |
|
100 <td>Protected method to dump a str object.</td> |
|
101 </tr><tr> |
|
102 <td><a href="#XMLWriterBase._write_tuple">_write_tuple</a></td> |
|
103 <td>Protected method to dump a tuple object.</td> |
|
104 </tr><tr> |
|
105 <td><a href="#XMLWriterBase._write_unimplemented">_write_unimplemented</a></td> |
|
106 <td>Protected method to dump a type, that has no special method.</td> |
|
107 </tr><tr> |
|
108 <td><a href="#XMLWriterBase.encodedNewLines">encodedNewLines</a></td> |
|
109 <td>Public method to encode newlines and paragraph breaks.</td> |
|
110 </tr><tr> |
|
111 <td><a href="#XMLWriterBase.escape">escape</a></td> |
|
112 <td>Function to escape &, <, and > in a string of data.</td> |
|
113 </tr><tr> |
|
114 <td><a href="#XMLWriterBase.writeXML">writeXML</a></td> |
|
115 <td>Public method to write the XML to the file.</td> |
|
116 </tr> |
|
117 </table> |
|
118 <a NAME="XMLWriterBase.__init__" ID="XMLWriterBase.__init__"></a> |
|
119 <h4>XMLWriterBase (Constructor)</h4> |
|
120 <b>XMLWriterBase</b>(<i>file</i>) |
|
121 <p> |
|
122 Constructor |
|
123 </p><dl> |
|
124 <dt><i>file</i></dt> |
|
125 <dd> |
|
126 open file (like) object for writing |
|
127 </dd> |
|
128 </dl><a NAME="XMLWriterBase._write" ID="XMLWriterBase._write"></a> |
|
129 <h4>XMLWriterBase._write</h4> |
|
130 <b>_write</b>(<i>s, newline = True</i>) |
|
131 <p> |
|
132 Protected method used to do the real write operation. |
|
133 </p><dl> |
|
134 <dt><i>s</i></dt> |
|
135 <dd> |
|
136 string to be written to the XML file |
|
137 </dd><dt><i>newline</i></dt> |
|
138 <dd> |
|
139 flag indicating a linebreak |
|
140 </dd> |
|
141 </dl><a NAME="XMLWriterBase._writeBasics" ID="XMLWriterBase._writeBasics"></a> |
|
142 <h4>XMLWriterBase._writeBasics</h4> |
|
143 <b>_writeBasics</b>(<i>pyobject, indent = 0</i>) |
|
144 <p> |
|
145 Protected method to dump an object of a basic Python type. |
|
146 </p><dl> |
|
147 <dt><i>pyobject</i></dt> |
|
148 <dd> |
|
149 object to be dumped |
|
150 </dd><dt><i>indent</i></dt> |
|
151 <dd> |
|
152 indentation level for prettier output (integer) |
|
153 </dd> |
|
154 </dl><a NAME="XMLWriterBase._write_bool" ID="XMLWriterBase._write_bool"></a> |
|
155 <h4>XMLWriterBase._write_bool</h4> |
|
156 <b>_write_bool</b>(<i>value, indent</i>) |
|
157 <p> |
|
158 Protected method to dump a bool object. |
|
159 </p><dl> |
|
160 <dt><i>value</i></dt> |
|
161 <dd> |
|
162 value to be dumped (boolean) |
|
163 </dd><dt><i>indent</i></dt> |
|
164 <dd> |
|
165 indentation level for prettier output (integer) |
|
166 </dd> |
|
167 </dl><a NAME="XMLWriterBase._write_bytearray" ID="XMLWriterBase._write_bytearray"></a> |
|
168 <h4>XMLWriterBase._write_bytearray</h4> |
|
169 <b>_write_bytearray</b>(<i>value, indent</i>) |
|
170 <p> |
|
171 Protected method to dump a bytearray object. |
|
172 </p><dl> |
|
173 <dt><i>value</i></dt> |
|
174 <dd> |
|
175 value to be dumped (bytearray) |
|
176 </dd><dt><i>indent</i></dt> |
|
177 <dd> |
|
178 indentation level for prettier output (integer) |
|
179 </dd> |
|
180 </dl><a NAME="XMLWriterBase._write_bytes" ID="XMLWriterBase._write_bytes"></a> |
|
181 <h4>XMLWriterBase._write_bytes</h4> |
|
182 <b>_write_bytes</b>(<i>value, indent</i>) |
|
183 <p> |
|
184 Protected method to dump a bytes object. |
|
185 </p><dl> |
|
186 <dt><i>value</i></dt> |
|
187 <dd> |
|
188 value to be dumped (bytes) |
|
189 </dd><dt><i>indent</i></dt> |
|
190 <dd> |
|
191 indentation level for prettier output (integer) |
|
192 </dd> |
|
193 </dl><a NAME="XMLWriterBase._write_complex" ID="XMLWriterBase._write_complex"></a> |
|
194 <h4>XMLWriterBase._write_complex</h4> |
|
195 <b>_write_complex</b>(<i>value, indent</i>) |
|
196 <p> |
|
197 Protected method to dump a complex object. |
|
198 </p><dl> |
|
199 <dt><i>value</i></dt> |
|
200 <dd> |
|
201 value to be dumped (complex) |
|
202 </dd><dt><i>indent</i></dt> |
|
203 <dd> |
|
204 indentation level for prettier output (integer) |
|
205 </dd> |
|
206 </dl><a NAME="XMLWriterBase._write_dictionary" ID="XMLWriterBase._write_dictionary"></a> |
|
207 <h4>XMLWriterBase._write_dictionary</h4> |
|
208 <b>_write_dictionary</b>(<i>value, indent</i>) |
|
209 <p> |
|
210 Protected method to dump a dict object. |
|
211 </p><dl> |
|
212 <dt><i>value</i></dt> |
|
213 <dd> |
|
214 value to be dumped (dictionary) |
|
215 </dd><dt><i>indent</i></dt> |
|
216 <dd> |
|
217 indentation level for prettier output (integer) |
|
218 </dd> |
|
219 </dl><a NAME="XMLWriterBase._write_float" ID="XMLWriterBase._write_float"></a> |
|
220 <h4>XMLWriterBase._write_float</h4> |
|
221 <b>_write_float</b>(<i>value, indent</i>) |
|
222 <p> |
|
223 Protected method to dump a float object. |
|
224 </p><dl> |
|
225 <dt><i>value</i></dt> |
|
226 <dd> |
|
227 value to be dumped (float) |
|
228 </dd><dt><i>indent</i></dt> |
|
229 <dd> |
|
230 indentation level for prettier output (integer) |
|
231 </dd> |
|
232 </dl><a NAME="XMLWriterBase._write_frozenset" ID="XMLWriterBase._write_frozenset"></a> |
|
233 <h4>XMLWriterBase._write_frozenset</h4> |
|
234 <b>_write_frozenset</b>(<i>value, indent</i>) |
|
235 <p> |
|
236 Protected method to dump a frozenset object. |
|
237 </p><dl> |
|
238 <dt><i>value</i></dt> |
|
239 <dd> |
|
240 value to be dumped (frozenset) |
|
241 </dd><dt><i>indent</i></dt> |
|
242 <dd> |
|
243 indentation level for prettier output (integer) |
|
244 </dd> |
|
245 </dl><a NAME="XMLWriterBase._write_int" ID="XMLWriterBase._write_int"></a> |
|
246 <h4>XMLWriterBase._write_int</h4> |
|
247 <b>_write_int</b>(<i>value, indent</i>) |
|
248 <p> |
|
249 Protected method to dump an int object. |
|
250 </p><dl> |
|
251 <dt><i>value</i></dt> |
|
252 <dd> |
|
253 value to be dumped (integer) |
|
254 </dd><dt><i>indent</i></dt> |
|
255 <dd> |
|
256 indentation level for prettier output (integer) |
|
257 </dd> |
|
258 </dl><a NAME="XMLWriterBase._write_list" ID="XMLWriterBase._write_list"></a> |
|
259 <h4>XMLWriterBase._write_list</h4> |
|
260 <b>_write_list</b>(<i>value, indent</i>) |
|
261 <p> |
|
262 Protected method to dump a list object. |
|
263 </p><dl> |
|
264 <dt><i>value</i></dt> |
|
265 <dd> |
|
266 value to be dumped (list) |
|
267 </dd><dt><i>indent</i></dt> |
|
268 <dd> |
|
269 indentation level for prettier output (integer) |
|
270 </dd> |
|
271 </dl><a NAME="XMLWriterBase._write_none" ID="XMLWriterBase._write_none"></a> |
|
272 <h4>XMLWriterBase._write_none</h4> |
|
273 <b>_write_none</b>(<i>value, indent</i>) |
|
274 <p> |
|
275 Protected method to dump a NoneType object. |
|
276 </p><dl> |
|
277 <dt><i>value</i></dt> |
|
278 <dd> |
|
279 value to be dumped (None) (ignored) |
|
280 </dd><dt><i>indent</i></dt> |
|
281 <dd> |
|
282 indentation level for prettier output (integer) |
|
283 </dd> |
|
284 </dl><a NAME="XMLWriterBase._write_set" ID="XMLWriterBase._write_set"></a> |
|
285 <h4>XMLWriterBase._write_set</h4> |
|
286 <b>_write_set</b>(<i>value, indent</i>) |
|
287 <p> |
|
288 Protected method to dump a set object. |
|
289 </p><dl> |
|
290 <dt><i>value</i></dt> |
|
291 <dd> |
|
292 value to be dumped (set) |
|
293 </dd><dt><i>indent</i></dt> |
|
294 <dd> |
|
295 indentation level for prettier output (integer) |
|
296 </dd> |
|
297 </dl><a NAME="XMLWriterBase._write_string" ID="XMLWriterBase._write_string"></a> |
|
298 <h4>XMLWriterBase._write_string</h4> |
|
299 <b>_write_string</b>(<i>value, indent</i>) |
|
300 <p> |
|
301 Protected method to dump a str object. |
|
302 </p><dl> |
|
303 <dt><i>value</i></dt> |
|
304 <dd> |
|
305 value to be dumped (string) |
|
306 </dd><dt><i>indent</i></dt> |
|
307 <dd> |
|
308 indentation level for prettier output (integer) |
|
309 </dd> |
|
310 </dl><a NAME="XMLWriterBase._write_tuple" ID="XMLWriterBase._write_tuple"></a> |
|
311 <h4>XMLWriterBase._write_tuple</h4> |
|
312 <b>_write_tuple</b>(<i>value, indent</i>) |
|
313 <p> |
|
314 Protected method to dump a tuple object. |
|
315 </p><dl> |
|
316 <dt><i>value</i></dt> |
|
317 <dd> |
|
318 value to be dumped (tuple) |
|
319 </dd><dt><i>indent</i></dt> |
|
320 <dd> |
|
321 indentation level for prettier output (integer) |
|
322 </dd> |
|
323 </dl><a NAME="XMLWriterBase._write_unimplemented" ID="XMLWriterBase._write_unimplemented"></a> |
|
324 <h4>XMLWriterBase._write_unimplemented</h4> |
|
325 <b>_write_unimplemented</b>(<i>value, indent</i>) |
|
326 <p> |
|
327 Protected method to dump a type, that has no special method. |
|
328 </p><dl> |
|
329 <dt><i>value</i></dt> |
|
330 <dd> |
|
331 value to be dumped (any pickleable object) |
|
332 </dd><dt><i>indent</i></dt> |
|
333 <dd> |
|
334 indentation level for prettier output (integer) |
|
335 </dd> |
|
336 </dl><a NAME="XMLWriterBase.encodedNewLines" ID="XMLWriterBase.encodedNewLines"></a> |
|
337 <h4>XMLWriterBase.encodedNewLines</h4> |
|
338 <b>encodedNewLines</b>(<i>text</i>) |
|
339 <p> |
|
340 Public method to encode newlines and paragraph breaks. |
|
341 </p><dl> |
|
342 <dt><i>text</i></dt> |
|
343 <dd> |
|
344 text to encode (string or QString) |
|
345 </dd> |
|
346 </dl><a NAME="XMLWriterBase.escape" ID="XMLWriterBase.escape"></a> |
|
347 <h4>XMLWriterBase.escape</h4> |
|
348 <b>escape</b>(<i>data, attribute=False</i>) |
|
349 <p> |
|
350 Function to escape &, <, and > in a string of data. |
|
351 </p><dl> |
|
352 <dt><i>data</i></dt> |
|
353 <dd> |
|
354 data to be escaped (string) |
|
355 </dd><dt><i>attribute</i></dt> |
|
356 <dd> |
|
357 flag indicating escaping is done for an attribute |
|
358 </dd> |
|
359 </dl><dl> |
|
360 <dt>Returns:</dt> |
|
361 <dd> |
|
362 the escaped data (string) |
|
363 </dd> |
|
364 </dl><a NAME="XMLWriterBase.writeXML" ID="XMLWriterBase.writeXML"></a> |
|
365 <h4>XMLWriterBase.writeXML</h4> |
|
366 <b>writeXML</b>(<i></i>) |
|
367 <p> |
|
368 Public method to write the XML to the file. |
|
369 </p> |
|
370 <div align="right"><a href="#top">Up</a></div> |
|
371 <hr /> |
|
372 </body></html> |