Mercurial Repositories > eric / changeset
changeset
Removed the obsolete XMLWriterBase.
Mon, 13 Sep 2010 19:53:57 +0200
- author
- Detlev Offenbach <detlev@die-offenbachs.de>
- date
- Mon, 13 Sep 2010 19:53:57 +0200
- changeset 611
- 4d2c91bd319e
- parent 610
- 3a625b0793d8
- child 612
- 52a95c4536d7
Removed the obsolete XMLWriterBase.
| Documentation/Source/eric5.E5XML.XMLWriterBase.html | file | annotate | diff | comparison | revisions | |
| E5XML/XMLWriterBase.py | file | annotate | diff | comparison | revisions | |
| eric5.e4p | file | annotate | diff | comparison | revisions |
--- a/Documentation/Source/eric5.E5XML.XMLWriterBase.html Mon Sep 13 19:52:30 2010 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,372 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' -'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> -<html><head> -<title>eric5.E5XML.XMLWriterBase</title> -<style> -body { - background: #EDECE6; - margin: 0em 1em 10em 1em; - color: black; -} - -h1 { color: white; background: #85774A; } -h2 { color: white; background: #85774A; } -h3 { color: white; background: #9D936E; } -h4 { color: white; background: #9D936E; } - -a { color: #BA6D36; } - -</style> -</head> -<body><a NAME="top" ID="top"></a> -<h1>eric5.E5XML.XMLWriterBase</h1> -<p> -Module implementing a base class for all of eric5s XML writers. -</p> -<h3>Global Attributes</h3> -<table> -<tr><td>None</td></tr> -</table> -<h3>Classes</h3> -<table> -<tr> -<td><a href="#XMLWriterBase">XMLWriterBase</a></td> -<td>Class implementing a base class for all of eric5s XML writers.</td> -</tr> -</table> -<h3>Functions</h3> -<table> -<tr><td>None</td></tr> -</table> -<hr /><hr /> -<a NAME="XMLWriterBase" ID="XMLWriterBase"></a> -<h2>XMLWriterBase</h2> -<p> - Class implementing a base class for all of eric5s XML writers. -</p> -<h3>Derived from</h3> -object -<h3>Class Attributes</h3> -<table> -<tr><td>None</td></tr> -</table> -<h3>Methods</h3> -<table> -<tr> -<td><a href="#XMLWriterBase.__init__">XMLWriterBase</a></td> -<td>Constructor</td> -</tr><tr> -<td><a href="#XMLWriterBase._write">_write</a></td> -<td>Protected method used to do the real write operation.</td> -</tr><tr> -<td><a href="#XMLWriterBase._writeBasics">_writeBasics</a></td> -<td>Protected method to dump an object of a basic Python type.</td> -</tr><tr> -<td><a href="#XMLWriterBase._write_bool">_write_bool</a></td> -<td>Protected method to dump a bool object.</td> -</tr><tr> -<td><a href="#XMLWriterBase._write_bytearray">_write_bytearray</a></td> -<td>Protected method to dump a bytearray object.</td> -</tr><tr> -<td><a href="#XMLWriterBase._write_bytes">_write_bytes</a></td> -<td>Protected method to dump a bytes object.</td> -</tr><tr> -<td><a href="#XMLWriterBase._write_complex">_write_complex</a></td> -<td>Protected method to dump a complex object.</td> -</tr><tr> -<td><a href="#XMLWriterBase._write_dictionary">_write_dictionary</a></td> -<td>Protected method to dump a dict object.</td> -</tr><tr> -<td><a href="#XMLWriterBase._write_float">_write_float</a></td> -<td>Protected method to dump a float object.</td> -</tr><tr> -<td><a href="#XMLWriterBase._write_frozenset">_write_frozenset</a></td> -<td>Protected method to dump a frozenset object.</td> -</tr><tr> -<td><a href="#XMLWriterBase._write_int">_write_int</a></td> -<td>Protected method to dump an int object.</td> -</tr><tr> -<td><a href="#XMLWriterBase._write_list">_write_list</a></td> -<td>Protected method to dump a list object.</td> -</tr><tr> -<td><a href="#XMLWriterBase._write_none">_write_none</a></td> -<td>Protected method to dump a NoneType object.</td> -</tr><tr> -<td><a href="#XMLWriterBase._write_set">_write_set</a></td> -<td>Protected method to dump a set object.</td> -</tr><tr> -<td><a href="#XMLWriterBase._write_string">_write_string</a></td> -<td>Protected method to dump a str object.</td> -</tr><tr> -<td><a href="#XMLWriterBase._write_tuple">_write_tuple</a></td> -<td>Protected method to dump a tuple object.</td> -</tr><tr> -<td><a href="#XMLWriterBase._write_unimplemented">_write_unimplemented</a></td> -<td>Protected method to dump a type, that has no special method.</td> -</tr><tr> -<td><a href="#XMLWriterBase.encodedNewLines">encodedNewLines</a></td> -<td>Public method to encode newlines and paragraph breaks.</td> -</tr><tr> -<td><a href="#XMLWriterBase.escape">escape</a></td> -<td>Function to escape &, <, and > in a string of data.</td> -</tr><tr> -<td><a href="#XMLWriterBase.writeXML">writeXML</a></td> -<td>Public method to write the XML to the file.</td> -</tr> -</table> -<a NAME="XMLWriterBase.__init__" ID="XMLWriterBase.__init__"></a> -<h4>XMLWriterBase (Constructor)</h4> -<b>XMLWriterBase</b>(<i>file</i>) -<p> - Constructor -</p><dl> -<dt><i>file</i></dt> -<dd> -open file (like) object for writing -</dd> -</dl><a NAME="XMLWriterBase._write" ID="XMLWriterBase._write"></a> -<h4>XMLWriterBase._write</h4> -<b>_write</b>(<i>s, newline = True</i>) -<p> - Protected method used to do the real write operation. -</p><dl> -<dt><i>s</i></dt> -<dd> -string to be written to the XML file -</dd><dt><i>newline</i></dt> -<dd> -flag indicating a linebreak -</dd> -</dl><a NAME="XMLWriterBase._writeBasics" ID="XMLWriterBase._writeBasics"></a> -<h4>XMLWriterBase._writeBasics</h4> -<b>_writeBasics</b>(<i>pyobject, indent = 0</i>) -<p> - Protected method to dump an object of a basic Python type. -</p><dl> -<dt><i>pyobject</i></dt> -<dd> -object to be dumped -</dd><dt><i>indent</i></dt> -<dd> -indentation level for prettier output (integer) -</dd> -</dl><a NAME="XMLWriterBase._write_bool" ID="XMLWriterBase._write_bool"></a> -<h4>XMLWriterBase._write_bool</h4> -<b>_write_bool</b>(<i>value, indent</i>) -<p> - Protected method to dump a bool object. -</p><dl> -<dt><i>value</i></dt> -<dd> -value to be dumped (boolean) -</dd><dt><i>indent</i></dt> -<dd> -indentation level for prettier output (integer) -</dd> -</dl><a NAME="XMLWriterBase._write_bytearray" ID="XMLWriterBase._write_bytearray"></a> -<h4>XMLWriterBase._write_bytearray</h4> -<b>_write_bytearray</b>(<i>value, indent</i>) -<p> - Protected method to dump a bytearray object. -</p><dl> -<dt><i>value</i></dt> -<dd> -value to be dumped (bytearray) -</dd><dt><i>indent</i></dt> -<dd> -indentation level for prettier output (integer) -</dd> -</dl><a NAME="XMLWriterBase._write_bytes" ID="XMLWriterBase._write_bytes"></a> -<h4>XMLWriterBase._write_bytes</h4> -<b>_write_bytes</b>(<i>value, indent</i>) -<p> - Protected method to dump a bytes object. -</p><dl> -<dt><i>value</i></dt> -<dd> -value to be dumped (bytes) -</dd><dt><i>indent</i></dt> -<dd> -indentation level for prettier output (integer) -</dd> -</dl><a NAME="XMLWriterBase._write_complex" ID="XMLWriterBase._write_complex"></a> -<h4>XMLWriterBase._write_complex</h4> -<b>_write_complex</b>(<i>value, indent</i>) -<p> - Protected method to dump a complex object. -</p><dl> -<dt><i>value</i></dt> -<dd> -value to be dumped (complex) -</dd><dt><i>indent</i></dt> -<dd> -indentation level for prettier output (integer) -</dd> -</dl><a NAME="XMLWriterBase._write_dictionary" ID="XMLWriterBase._write_dictionary"></a> -<h4>XMLWriterBase._write_dictionary</h4> -<b>_write_dictionary</b>(<i>value, indent</i>) -<p> - Protected method to dump a dict object. -</p><dl> -<dt><i>value</i></dt> -<dd> -value to be dumped (dictionary) -</dd><dt><i>indent</i></dt> -<dd> -indentation level for prettier output (integer) -</dd> -</dl><a NAME="XMLWriterBase._write_float" ID="XMLWriterBase._write_float"></a> -<h4>XMLWriterBase._write_float</h4> -<b>_write_float</b>(<i>value, indent</i>) -<p> - Protected method to dump a float object. -</p><dl> -<dt><i>value</i></dt> -<dd> -value to be dumped (float) -</dd><dt><i>indent</i></dt> -<dd> -indentation level for prettier output (integer) -</dd> -</dl><a NAME="XMLWriterBase._write_frozenset" ID="XMLWriterBase._write_frozenset"></a> -<h4>XMLWriterBase._write_frozenset</h4> -<b>_write_frozenset</b>(<i>value, indent</i>) -<p> - Protected method to dump a frozenset object. -</p><dl> -<dt><i>value</i></dt> -<dd> -value to be dumped (frozenset) -</dd><dt><i>indent</i></dt> -<dd> -indentation level for prettier output (integer) -</dd> -</dl><a NAME="XMLWriterBase._write_int" ID="XMLWriterBase._write_int"></a> -<h4>XMLWriterBase._write_int</h4> -<b>_write_int</b>(<i>value, indent</i>) -<p> - Protected method to dump an int object. -</p><dl> -<dt><i>value</i></dt> -<dd> -value to be dumped (integer) -</dd><dt><i>indent</i></dt> -<dd> -indentation level for prettier output (integer) -</dd> -</dl><a NAME="XMLWriterBase._write_list" ID="XMLWriterBase._write_list"></a> -<h4>XMLWriterBase._write_list</h4> -<b>_write_list</b>(<i>value, indent</i>) -<p> - Protected method to dump a list object. -</p><dl> -<dt><i>value</i></dt> -<dd> -value to be dumped (list) -</dd><dt><i>indent</i></dt> -<dd> -indentation level for prettier output (integer) -</dd> -</dl><a NAME="XMLWriterBase._write_none" ID="XMLWriterBase._write_none"></a> -<h4>XMLWriterBase._write_none</h4> -<b>_write_none</b>(<i>value, indent</i>) -<p> - Protected method to dump a NoneType object. -</p><dl> -<dt><i>value</i></dt> -<dd> -value to be dumped (None) (ignored) -</dd><dt><i>indent</i></dt> -<dd> -indentation level for prettier output (integer) -</dd> -</dl><a NAME="XMLWriterBase._write_set" ID="XMLWriterBase._write_set"></a> -<h4>XMLWriterBase._write_set</h4> -<b>_write_set</b>(<i>value, indent</i>) -<p> - Protected method to dump a set object. -</p><dl> -<dt><i>value</i></dt> -<dd> -value to be dumped (set) -</dd><dt><i>indent</i></dt> -<dd> -indentation level for prettier output (integer) -</dd> -</dl><a NAME="XMLWriterBase._write_string" ID="XMLWriterBase._write_string"></a> -<h4>XMLWriterBase._write_string</h4> -<b>_write_string</b>(<i>value, indent</i>) -<p> - Protected method to dump a str object. -</p><dl> -<dt><i>value</i></dt> -<dd> -value to be dumped (string) -</dd><dt><i>indent</i></dt> -<dd> -indentation level for prettier output (integer) -</dd> -</dl><a NAME="XMLWriterBase._write_tuple" ID="XMLWriterBase._write_tuple"></a> -<h4>XMLWriterBase._write_tuple</h4> -<b>_write_tuple</b>(<i>value, indent</i>) -<p> - Protected method to dump a tuple object. -</p><dl> -<dt><i>value</i></dt> -<dd> -value to be dumped (tuple) -</dd><dt><i>indent</i></dt> -<dd> -indentation level for prettier output (integer) -</dd> -</dl><a NAME="XMLWriterBase._write_unimplemented" ID="XMLWriterBase._write_unimplemented"></a> -<h4>XMLWriterBase._write_unimplemented</h4> -<b>_write_unimplemented</b>(<i>value, indent</i>) -<p> - Protected method to dump a type, that has no special method. -</p><dl> -<dt><i>value</i></dt> -<dd> -value to be dumped (any pickleable object) -</dd><dt><i>indent</i></dt> -<dd> -indentation level for prettier output (integer) -</dd> -</dl><a NAME="XMLWriterBase.encodedNewLines" ID="XMLWriterBase.encodedNewLines"></a> -<h4>XMLWriterBase.encodedNewLines</h4> -<b>encodedNewLines</b>(<i>text</i>) -<p> - Public method to encode newlines and paragraph breaks. -</p><dl> -<dt><i>text</i></dt> -<dd> -text to encode (string) -</dd> -</dl><a NAME="XMLWriterBase.escape" ID="XMLWriterBase.escape"></a> -<h4>XMLWriterBase.escape</h4> -<b>escape</b>(<i>data, attribute=False</i>) -<p> - Function to escape &, <, and > in a string of data. -</p><dl> -<dt><i>data</i></dt> -<dd> -data to be escaped (string) -</dd><dt><i>attribute</i></dt> -<dd> -flag indicating escaping is done for an attribute -</dd> -</dl><dl> -<dt>Returns:</dt> -<dd> -the escaped data (string) -</dd> -</dl><a NAME="XMLWriterBase.writeXML" ID="XMLWriterBase.writeXML"></a> -<h4>XMLWriterBase.writeXML</h4> -<b>writeXML</b>(<i></i>) -<p> - Public method to write the XML to the file. -</p> -<div align="right"><a href="#top">Up</a></div> -<hr /> -</body></html> \ No newline at end of file
--- a/E5XML/XMLWriterBase.py Mon Sep 13 19:52:30 2010 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,255 +0,0 @@ -# -*- coding: utf-8 -*- - -# Copyright (c) 2004 - 2010 Detlev Offenbach <detlev@die-offenbachs.de> -# - -""" -Module implementing a base class for all of eric5s XML writers. -""" - -import pickle -import base64 - -class XMLWriterBase(object): - """ - Class implementing a base class for all of eric5s XML writers. - """ - def __init__(self, file): - """ - Constructor - - @param file open file (like) object for writing - """ - self.pf = file - - self.basics = { - type(None) : self._write_none, - int : self._write_int, - float : self._write_float, - complex : self._write_complex, - bool : self._write_bool, - str : self._write_string, - bytes : self._write_bytes, - bytearray : self._write_bytearray, - tuple : self._write_tuple, - list : self._write_list, - dict : self._write_dictionary, - set : self._write_set, - frozenset : self._write_frozenset, - } - - self.NEWPARA = chr(0x2029) - self.NEWLINE = chr(0x2028) - - def _write(self, s, newline = True): - """ - Protected method used to do the real write operation. - - @param s string to be written to the XML file - @param newline flag indicating a linebreak - """ - self.pf.write("{0}{1}".format(s, - newline and "\n" or "")) - - def writeXML(self): - """ - Public method to write the XML to the file. - """ - # write the XML header - self._write('<?xml version="1.0" encoding="UTF-8"?>') - - def escape(self, data, attribute=False): - """ - Function to escape &, <, and > in a string of data. - - @param data data to be escaped (string) - @param attribute flag indicating escaping is done for an attribute - @return the escaped data (string) - """ - - # must do ampersand first - data = data.replace("&", "&") - data = data.replace(">", ">") - data = data.replace("<", "<") - if attribute: - data = data.replace('"', """) - return data - - def encodedNewLines(self, text): - """ - Public method to encode newlines and paragraph breaks. - - @param text text to encode (string) - """ - return text.replace("\n\n", self.NEWPARA).replace("\n", self.NEWLINE) - - def _writeBasics(self, pyobject, indent = 0): - """ - Protected method to dump an object of a basic Python type. - - @param pyobject object to be dumped - @param indent indentation level for prettier output (integer) - """ - writeMethod = self.basics.get(type(pyobject)) or self._write_unimplemented - writeMethod(pyobject, indent) - - ############################################################################ - ## The various writer methods for basic types - ############################################################################ - - def _write_none(self, value, indent): - """ - Protected method to dump a NoneType object. - - @param value value to be dumped (None) (ignored) - @param indent indentation level for prettier output (integer) - """ - self._write('{0}<none />'.format(" " * indent)) - - def _write_int(self, value, indent): - """ - Protected method to dump an int object. - - @param value value to be dumped (integer) - @param indent indentation level for prettier output (integer) - """ - self._write('{0}<int>{1}</int>'.format(" " * indent, value)) - - def _write_bool(self, value, indent): - """ - Protected method to dump a bool object. - - @param value value to be dumped (boolean) - @param indent indentation level for prettier output (integer) - """ - self._write('{0}<bool>{1}</bool>'.format(" " * indent, value)) - - def _write_float(self, value, indent): - """ - Protected method to dump a float object. - - @param value value to be dumped (float) - @param indent indentation level for prettier output (integer) - """ - self._write('{0}<float>{1}</float>'.format(" " * indent, value)) - - def _write_complex(self, value, indent): - """ - Protected method to dump a complex object. - - @param value value to be dumped (complex) - @param indent indentation level for prettier output (integer) - """ - self._write('{0}<complex>{1} {2}</complex>'.format( - " " * indent, value.real, value.imag)) - - def _write_string(self, value, indent): - """ - Protected method to dump a str object. - - @param value value to be dumped (string) - @param indent indentation level for prettier output (integer) - """ - self._write('{0}<string>{1}</string>'.format(" " * indent, self.escape(value))) - - def _write_bytes(self, value, indent): - """ - Protected method to dump a bytes object. - - @param value value to be dumped (bytes) - @param indent indentation level for prettier output (integer) - """ - self._write('{0}<bytes>{1}</bytes>'.format( - " " * indent, ",".join(["{0:d}".format(b) for b in value]))) - - def _write_bytearray(self, value, indent): - """ - Protected method to dump a bytearray object. - - @param value value to be dumped (bytearray) - @param indent indentation level for prettier output (integer) - """ - self._write('{0}<bytearray>{1}</bytearray>'.format( - " " * indent, ",".join(["{0:d}".format(b) for b in value]))) - - def _write_tuple(self, value, indent): - """ - Protected method to dump a tuple object. - - @param value value to be dumped (tuple) - @param indent indentation level for prettier output (integer) - """ - self._write('{0}<tuple>'.format(" " * indent)) - nindent = indent + 1 - for elem in value: - self._writeBasics(elem, nindent) - self._write('{0}</tuple>'.format(" " * indent)) - - def _write_list(self, value, indent): - """ - Protected method to dump a list object. - - @param value value to be dumped (list) - @param indent indentation level for prettier output (integer) - """ - self._write('{0}<list>'.format(" " * indent)) - nindent = indent + 1 - for elem in value: - self._writeBasics(elem, nindent) - self._write('{0}</list>'.format(" " * indent)) - - def _write_dictionary(self, value, indent): - """ - Protected method to dump a dict object. - - @param value value to be dumped (dictionary) - @param indent indentation level for prettier output (integer) - """ - self._write('{0}<dict>'.format(" " * indent)) - nindent1 = indent + 1 - nindent2 = indent + 2 - keys = sorted(list(value.keys())) - for key in keys: - self._write('{0}<key>'.format(" " * nindent1)) - self._writeBasics(key, nindent2) - self._write('{0}</key>'.format(" " * nindent1)) - self._write('{0}<value>'.format(" " * nindent1)) - self._writeBasics(value[key], nindent2) - self._write('{0}</value>'.format(" " * nindent1)) - self._write('{0}</dict>'.format(" " * indent)) - - def _write_set(self, value, indent): - """ - Protected method to dump a set object. - - @param value value to be dumped (set) - @param indent indentation level for prettier output (integer) - """ - self._write('{0}<set>'.format(" " * indent)) - nindent = indent + 1 - for elem in value: - self._writeBasics(elem, nindent) - self._write('{0}</set>'.format(" " * indent)) - - def _write_frozenset(self, value, indent): - """ - Protected method to dump a frozenset object. - - @param value value to be dumped (frozenset) - @param indent indentation level for prettier output (integer) - """ - self._write('{0}<frozenset>'.format(" " * indent)) - nindent = indent + 1 - for elem in value: - self._writeBasics(elem, nindent) - self._write('{0}</frozenset>'.format(" " * indent)) - - def _write_unimplemented(self, value, indent): - """ - Protected method to dump a type, that has no special method. - - @param value value to be dumped (any pickleable object) - @param indent indentation level for prettier output (integer) - """ - self._write('{0}<pickle method="pickle" encoding="base64">{1}</pickle>'.format( - " " * indent, str(base64.b64encode(pickle.dumps(value)), "ASCII")))
--- a/eric5.e4p Mon Sep 13 19:52:30 2010 +0200 +++ b/eric5.e4p Mon Sep 13 19:53:57 2010 +0200 @@ -722,7 +722,6 @@ <Source>E5XML/HighlightingStylesWriter.py</Source> <Source>E5XML/XMLUtilities.py</Source> <Source>E5XML/XMLHandlerBase.py</Source> - <Source>E5XML/XMLWriterBase.py</Source> <Source>E5XML/XMLMessageDialog.py</Source> <Source>E5XML/XMLEntityResolver.py</Source> <Source>E5XML/XMLErrorHandler.py</Source>
