diff -r f0cb7579c0b4 -r e26d7d0c1088 Documentation/Source/eric6.Utilities.compatibility_fixes.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Documentation/Source/eric6.Utilities.compatibility_fixes.html Sat Jul 05 12:29:15 2014 +0200 @@ -0,0 +1,230 @@ +<!DOCTYPE html> +<html><head> +<title>eric6.Utilities.compatibility_fixes</title> +<meta charset="UTF-8"> +<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>eric6.Utilities.compatibility_fixes</h1> +<p> +Module implementing the open behavior of Python3 for use with Eric6. +</p><p> +The Eric6 used features are emulated only. The not emulated features +should throw a NotImplementedError exception. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#File">File</a></td> +<td></td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr> +<td><a href="#open">open</a></td> +<td>Replacement for the build in open function.</td> +</tr> +</table> +<hr /><hr /> +<a NAME="File" ID="File"></a> +<h2>File</h2> + +<h3>Derived from</h3> +file +<h3>Class Attributes</h3> +<table> +<tr><td>fp</td></tr> +</table> +<h3>Class Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#File.__init__">File</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#File.next">next</a></td> +<td>Public method used in an iterator.</td> +</tr><tr> +<td><a href="#File.read">read</a></td> +<td>Public method to read n bytes or all if n=-1 from file.</td> +</tr><tr> +<td><a href="#File.readline">readline</a></td> +<td>Public method to read one line from file.</td> +</tr><tr> +<td><a href="#File.readlines">readlines</a></td> +<td>Public method to read all lines from file.</td> +</tr><tr> +<td><a href="#File.write">write</a></td> +<td>Public method to write given data to file and encode if needed.</td> +</tr> +</table> +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<a NAME="File.__init__" ID="File.__init__"></a> +<h4>File (Constructor)</h4> +<b>File</b>(<i>filein, mode='r', buffering=-1, encoding=None, errors=None, newline=None, closefd=True</i>) +<p> + Constructor +</p><p> + It checks for unimplemented parameters. +</p><dl> +<dt><i>filein</i></dt> +<dd> +filename or file descriptor (string) +</dd><dt><i>mode=</i></dt> +<dd> +access mode (string) +</dd><dt><i>buffering=</i></dt> +<dd> +size of the read buffer (string) +</dd><dt><i>encoding=</i></dt> +<dd> +character encoding for reading/ writing (string) +</dd><dt><i>errors=</i></dt> +<dd> +behavior for the character encoding ('strict', + 'explicit', ...) (string) +</dd><dt><i>newline=</i></dt> +<dd> +controls how universal newlines works (string) +</dd><dt><i>closefd=</i></dt> +<dd> +close underlying file descriptor if given as file + parameter (boolean) +</dd> +</dl><dl> +<dt>Raises <b>NotImplementedError</b>:</dt> +<dd> +for not implemented method parameters +</dd> +</dl><a NAME="File.next" ID="File.next"></a> +<h4>File.next</h4> +<b>next</b>(<i></i>) +<p> + Public method used in an iterator. +</p><dl> +<dt>Returns:</dt> +<dd> +decoded data read +</dd> +</dl><a NAME="File.read" ID="File.read"></a> +<h4>File.read</h4> +<b>read</b>(<i>n=-1</i>) +<p> + Public method to read n bytes or all if n=-1 from file. +</p><dl> +<dt><i>n=</i></dt> +<dd> +bytecount or all if n=-1 (int) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +decoded bytes read +</dd> +</dl><a NAME="File.readline" ID="File.readline"></a> +<h4>File.readline</h4> +<b>readline</b>(<i>limit=-1</i>) +<p> + Public method to read one line from file. +</p><dl> +<dt><i>limit=</i></dt> +<dd> +maximum bytes to read or all if limit=-1 (int) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +decoded line read +</dd> +</dl><a NAME="File.readlines" ID="File.readlines"></a> +<h4>File.readlines</h4> +<b>readlines</b>(<i>hint=-1</i>) +<p> + Public method to read all lines from file. +</p><dl> +<dt><i>hint=</i></dt> +<dd> +maximum bytes to read or all if hint=-1 (int) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +decoded lines read +</dd> +</dl><a NAME="File.write" ID="File.write"></a> +<h4>File.write</h4> +<b>write</b>(<i>txt</i>) +<p> + Public method to write given data to file and encode if needed. +</p><dl> +<dt><i>txt</i></dt> +<dd> +data to write. (str, bytes) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="open" ID="open"></a> +<h2>open</h2> +<b>open</b>(<i>file, mode='r', buffering=-1, encoding=None, errors=None, newline=None, closefd=True</i>) +<p> + Replacement for the build in open function. +</p><dl> +<dt><i>file</i></dt> +<dd> +filename or file descriptor (string) +</dd><dt><i>mode=</i></dt> +<dd> +access mode (string) +</dd><dt><i>buffering=</i></dt> +<dd> +size of the read buffer (string) +</dd><dt><i>encoding=</i></dt> +<dd> +character encoding for reading/ writing (string) +</dd><dt><i>errors=</i></dt> +<dd> +behavior for the character encoding ('strict', + 'explicit', ...) (string) +</dd><dt><i>newline=</i></dt> +<dd> +controls how universal newlines works (string) +</dd><dt><i>closefd=</i></dt> +<dd> +close underlying file descriptor if given as file + parameter (boolean) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +Returns the new file object +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file