Mercurial Repositories > eric / file diff

--- a/Documentation/Source/eric6.DebugClients.Python.AsyncFile.html	Fri Oct 21 23:14:16 2016 +0200
+++ b/Documentation/Source/eric6.DebugClients.Python.AsyncFile.html	Sat Oct 22 17:09:08 2016 +0200
@@ -52,7 +52,7 @@
 object
 <h3>Class Attributes</h3>
 <table>
-<tr><td>maxbuffersize</td></tr><tr><td>maxtries</td></tr>
+<tr><td>maxtries</td></tr>
 </table>
 <h3>Class Methods</h3>
 <table>
@@ -67,9 +67,6 @@
 <td><a href="#AsyncFile.__checkMode">__checkMode</a></td>
 <td>Private method to check the mode.</td>
 </tr><tr>
-<td><a href="#AsyncFile.__nWrite">__nWrite</a></td>
-<td>Private method to write a specific number of pending bytes.</td>
-</tr><tr>
 <td><a href="#AsyncFile.close">close</a></td>
 <td>Public method to close the file.</td>
 </tr><tr>
@@ -77,13 +74,13 @@
 <td>Public method returning the file number.</td>
 </tr><tr>
 <td><a href="#AsyncFile.flush">flush</a></td>
-<td>Public method to write all pending bytes.</td>
+<td>Public method to write all pending entries.</td>
 </tr><tr>
 <td><a href="#AsyncFile.isatty">isatty</a></td>
 <td>Public method to indicate whether a tty interface is supported.</td>
 </tr><tr>
 <td><a href="#AsyncFile.pendingWrite">pendingWrite</a></td>
-<td>Public method that returns the number of bytes waiting to be written.</td>
+<td>Public method that returns the number of strings waiting to be written.</td>
 </tr><tr>
 <td><a href="#AsyncFile.read">read</a></td>
 <td>Public method to read bytes from this file.</td>
@@ -122,7 +119,7 @@
 <td>Public method to write a string to the file.</td>
 </tr><tr>
 <td><a href="#AsyncFile.write_p">write_p</a></td>
-<td>Public method to write a string to the file.</td>
+<td>Public method to write a json-rpc 2.0 coded string to the file.</td>
 </tr><tr>
 <td><a href="#AsyncFile.writelines">writelines</a></td>
 <td>Public method to write a list of strings to the file.</td>
@@ -138,15 +135,15 @@
 <p>
         Constructor
 </p><dl>
-<dt><i>sock</i></dt>
+<dt><i>sock</i> (socket)</dt>
 <dd>
 the socket object being wrapped
-</dd><dt><i>mode</i></dt>
+</dd><dt><i>mode</i> (str)</dt>
 <dd>
-mode of this file (string)
-</dd><dt><i>name</i></dt>
+mode of this file
+</dd><dt><i>name</i> (str)</dt>
 <dd>
-name of this file (string)
+name of this file
 </dd>
 </dl><a NAME="AsyncFile.__checkMode" ID="AsyncFile.__checkMode"></a>
 <h4>AsyncFile.__checkMode</h4>
@@ -157,35 +154,24 @@
         This method checks, if an operation is permitted according to
         the mode of the file. If it is not, an IOError is raised.
 </p><dl>
-<dt><i>mode</i></dt>
+<dt><i>mode</i> (string)</dt>
 <dd>
-the mode to be checked (string)
+the mode to be checked
 </dd>
 </dl><dl>
 <dt>Raises <b>IOError</b>:</dt>
 <dd>
 raised to indicate a bad file descriptor
 </dd>
-</dl><a NAME="AsyncFile.__nWrite" ID="AsyncFile.__nWrite"></a>
-<h4>AsyncFile.__nWrite</h4>
-<b>__nWrite</b>(<i>n</i>)
-<p>
-        Private method to write a specific number of pending bytes.
-</p><dl>
-<dt><i>n</i></dt>
-<dd>
-the number of bytes to be written (int)
-</dd>
 </dl><a NAME="AsyncFile.close" ID="AsyncFile.close"></a>
 <h4>AsyncFile.close</h4>
 <b>close</b>(<i>closeit=False</i>)
 <p>
         Public method to close the file.
 </p><dl>
-<dt><i>closeit</i></dt>
+<dt><i>closeit</i> (bool)</dt>
 <dd>
 flag to indicate a close ordered by the debugger code
-            (boolean)
 </dd>
 </dl><a NAME="AsyncFile.fileno" ID="AsyncFile.fileno"></a>
 <h4>AsyncFile.fileno</h4>
@@ -195,13 +181,18 @@
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-file number (int)
+file number
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+int
 </dd>
 </dl><a NAME="AsyncFile.flush" ID="AsyncFile.flush"></a>
 <h4>AsyncFile.flush</h4>
 <b>flush</b>(<i></i>)
 <p>
-        Public method to write all pending bytes.
+        Public method to write all pending entries.
 </p><a NAME="AsyncFile.isatty" ID="AsyncFile.isatty"></a>
 <h4>AsyncFile.isatty</h4>
 <b>isatty</b>(<i></i>)
@@ -212,15 +203,25 @@
 <dd>
 always false
 </dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
 </dl><a NAME="AsyncFile.pendingWrite" ID="AsyncFile.pendingWrite"></a>
 <h4>AsyncFile.pendingWrite</h4>
 <b>pendingWrite</b>(<i></i>)
 <p>
-        Public method that returns the number of bytes waiting to be written.
+        Public method that returns the number of strings waiting to be written.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-the number of bytes to be written (int)
+the number of strings to be written
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+int
 </dd>
 </dl><a NAME="AsyncFile.read" ID="AsyncFile.read"></a>
 <h4>AsyncFile.read</h4>
@@ -228,14 +229,19 @@
 <p>
         Public method to read bytes from this file.
 </p><dl>
-<dt><i>size</i></dt>
+<dt><i>size</i> (int)</dt>
 <dd>
-maximum number of bytes to be read (int)
+maximum number of bytes to be read
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-the bytes read (any)
+the bytes read
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl><a NAME="AsyncFile.read_p" ID="AsyncFile.read_p"></a>
 <h4>AsyncFile.read_p</h4>
@@ -243,14 +249,19 @@
 <p>
         Public method to read bytes from this file.
 </p><dl>
-<dt><i>size</i></dt>
+<dt><i>size</i> (int)</dt>
 <dd>
-maximum number of bytes to be read (int)
+maximum number of bytes to be read
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-the bytes read (any)
+the bytes read
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl><a NAME="AsyncFile.readable" ID="AsyncFile.readable"></a>
 <h4>AsyncFile.readable</h4>
@@ -260,7 +271,12 @@
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-flag indicating a readable stream (boolean)
+flag indicating a readable stream
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl><a NAME="AsyncFile.readline" ID="AsyncFile.readline"></a>
 <h4>AsyncFile.readline</h4>
@@ -268,14 +284,19 @@
 <p>
         Public method to read one line from this file.
 </p><dl>
-<dt><i>sizehint</i></dt>
+<dt><i>sizehint</i> (int)</dt>
 <dd>
-hint of the numbers of bytes to be read (int)
+hint of the numbers of bytes to be read
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-one line read (string)
+one line read
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl><a NAME="AsyncFile.readline_p" ID="AsyncFile.readline_p"></a>
 <h4>AsyncFile.readline_p</h4>
@@ -286,14 +307,19 @@
         <b>Note</b>: This method will not block and may return
         only a part of a line if that is all that is available.
 </p><dl>
-<dt><i>size</i></dt>
+<dt><i>size</i> (int)</dt>
 <dd>
-maximum number of bytes to be read (int)
+maximum number of bytes to be read
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-one line of text up to size bytes (string)
+one line of text up to size bytes
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl><a NAME="AsyncFile.readlines" ID="AsyncFile.readlines"></a>
 <h4>AsyncFile.readlines</h4>
@@ -301,14 +327,19 @@
 <p>
         Public method to read all lines from this file.
 </p><dl>
-<dt><i>sizehint</i></dt>
+<dt><i>sizehint</i> (int)</dt>
 <dd>
-hint of the numbers of bytes to be read (int)
+hint of the numbers of bytes to be read
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-list of lines read (list of strings)
+list of lines read
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
 </dd>
 </dl><a NAME="AsyncFile.seek" ID="AsyncFile.seek"></a>
 <h4>AsyncFile.seek</h4>
@@ -316,10 +347,10 @@
 <p>
         Public method to move the filepointer.
 </p><dl>
-<dt><i>offset</i></dt>
+<dt><i>offset</i> (int)</dt>
 <dd>
-offset to move the filepointer to (integer)
-</dd><dt><i>whence</i></dt>
+offset to move the filepointer to
+</dd><dt><i>whence</i> (int)</dt>
 <dd>
 position the offset relates to
 </dd>
@@ -337,7 +368,12 @@
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-flag indicating a seekable stream (boolean)
+flag indicating a seekable stream
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl><a NAME="AsyncFile.tell" ID="AsyncFile.tell"></a>
 <h4>AsyncFile.tell</h4>
@@ -356,9 +392,9 @@
 <p>
         Public method to truncate the file.
 </p><dl>
-<dt><i>size</i></dt>
+<dt><i>size</i> (int)</dt>
 <dd>
-size to truncate to (integer)
+size to truncate to
 </dd>
 </dl><dl>
 <dt>Raises <b>IOError</b>:</dt>
@@ -374,7 +410,12 @@
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-flag indicating a writable stream (boolean)
+flag indicating a writable stream
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl><a NAME="AsyncFile.write" ID="AsyncFile.write"></a>
 <h4>AsyncFile.write</h4>
@@ -382,24 +423,19 @@
 <p>
         Public method to write a string to the file.
 </p><dl>
-<dt><i>s</i></dt>
+<dt><i>s</i> (str)</dt>
 <dd>
-text to be written (string)
+text to be written
 </dd>
 </dl><a NAME="AsyncFile.write_p" ID="AsyncFile.write_p"></a>
 <h4>AsyncFile.write_p</h4>
 <b>write_p</b>(<i>s</i>)
 <p>
-        Public method to write a string to the file.
+        Public method to write a json-rpc 2.0 coded string to the file.
 </p><dl>
-<dt><i>s</i></dt>
+<dt><i>s</i> (str)</dt>
 <dd>
-text to be written (string)
-</dd>
-</dl><dl>
-<dt>Raises <b>socket.error</b>:</dt>
-<dd>
-raised to indicate too many send attempts
+text to be written
 </dd>
 </dl><a NAME="AsyncFile.writelines" ID="AsyncFile.writelines"></a>
 <h4>AsyncFile.writelines</h4>
@@ -407,9 +443,9 @@
 <p>
         Public method to write a list of strings to the file.
 </p><dl>
-<dt><i>lines</i></dt>
+<dt><i>lines</i> (list of str)</dt>
 <dd>
-list of texts to be written (list of string)
+list of texts to be written
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -420,14 +456,19 @@
 <p>
     Module function to check for data to be written.
 </p><dl>
-<dt><i>file</i></dt>
+<dt><i>file</i> (file)</dt>
 <dd>
-The file object to be checked (file)
+The file object to be checked
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-Flag indicating if there is data wating (int)
+Flag indicating if there is data waiting
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+int
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>