--- a/src/eric7/Documentation/Source/eric7.DebugClients.Python.AsyncFile.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.DebugClients.Python.AsyncFile.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,58 +7,56 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.DebugClients.Python.AsyncFile</h1>
-
<p>
Module implementing an asynchronous file like socket interface for the
debugger.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#AsyncFile">AsyncFile</a></td>
<td>Class wrapping a socket object with a file interface.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
-
<tr>
<td><a href="#AsyncPendingWrite">AsyncPendingWrite</a></td>
<td>Module function to check for data to be written.</td>
</tr>
</table>
+
<hr />
<hr />
<a NAME="AsyncFile" ID="AsyncFile"></a>
<h2>AsyncFile</h2>
-
<p>
Class wrapping a socket object with a file interface.
</p>
+
<h3>Derived from</h3>
None
<h3>Class Attributes</h3>
+<table>
+<tr><td>BUFSIZE</td></tr>
+<tr><td>CMD_BUFSIZE</td></tr>
+<tr><td>MAX_TRIES</td></tr>
+</table>
-<table>
-<tr><td>BUFSIZE</td></tr><tr><td>CMD_BUFSIZE</td></tr><tr><td>MAX_TRIES</td></tr>
-</table>
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#AsyncFile.__init__">AsyncFile</a></td>
<td>Constructor</td>
@@ -148,19 +146,20 @@
<td>Public method to write a list of strings to the file.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="AsyncFile.__init__" ID="AsyncFile.__init__"></a>
<h4>AsyncFile (Constructor)</h4>
<b>AsyncFile</b>(<i>sock, mode, name</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>sock</i> (socket)</dt>
@@ -179,7 +178,6 @@
<a NAME="AsyncFile.__checkMode" ID="AsyncFile.__checkMode"></a>
<h4>AsyncFile.__checkMode</h4>
<b>__checkMode</b>(<i>mode</i>)
-
<p>
Private method to check the mode.
</p>
@@ -187,6 +185,7 @@
This method checks, if an operation is permitted according to
the mode of the file. If it is not, an OSError is raised.
</p>
+
<dl>
<dt><i>mode</i> (string)</dt>
@@ -204,10 +203,10 @@
<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> (bool)</dt>
@@ -218,10 +217,10 @@
<a NAME="AsyncFile.fileno" ID="AsyncFile.fileno"></a>
<h4>AsyncFile.fileno</h4>
<b>fileno</b>(<i></i>)
-
<p>
Public method returning the file number.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -237,17 +236,17 @@
<a NAME="AsyncFile.flush" ID="AsyncFile.flush"></a>
<h4>AsyncFile.flush</h4>
<b>flush</b>(<i></i>)
-
<p>
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>)
-
<p>
Public method to indicate whether a tty interface is supported.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -263,10 +262,10 @@
<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 strings waiting to be written.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -282,10 +281,10 @@
<a NAME="AsyncFile.read" ID="AsyncFile.read"></a>
<h4>AsyncFile.read</h4>
<b>read</b>(<i>size=-1</i>)
-
<p>
Public method to read bytes from this file.
</p>
+
<dl>
<dt><i>size</i> (int)</dt>
@@ -308,10 +307,10 @@
<a NAME="AsyncFile.readCommand" ID="AsyncFile.readCommand"></a>
<h4>AsyncFile.readCommand</h4>
<b>readCommand</b>(<i></i>)
-
<p>
Public method to read a length prefixed command string.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -327,10 +326,10 @@
<a NAME="AsyncFile.read_p" ID="AsyncFile.read_p"></a>
<h4>AsyncFile.read_p</h4>
<b>read_p</b>(<i>size=-1</i>)
-
<p>
Public method to read bytes from this file.
</p>
+
<dl>
<dt><i>size</i> (int)</dt>
@@ -353,10 +352,10 @@
<a NAME="AsyncFile.readable" ID="AsyncFile.readable"></a>
<h4>AsyncFile.readable</h4>
<b>readable</b>(<i></i>)
-
<p>
Public method to check, if the stream is readable.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -372,10 +371,10 @@
<a NAME="AsyncFile.readline" ID="AsyncFile.readline"></a>
<h4>AsyncFile.readline</h4>
<b>readline</b>(<i>sizehint=-1</i>)
-
<p>
Public method to read one line from this file.
</p>
+
<dl>
<dt><i>sizehint</i> (int)</dt>
@@ -398,7 +397,6 @@
<a NAME="AsyncFile.readline_p" ID="AsyncFile.readline_p"></a>
<h4>AsyncFile.readline_p</h4>
<b>readline_p</b>(<i>size=-1</i>)
-
<p>
Public method to read a line from this file.
</p>
@@ -406,6 +404,7 @@
<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> (int)</dt>
@@ -428,10 +427,10 @@
<a NAME="AsyncFile.readlines" ID="AsyncFile.readlines"></a>
<h4>AsyncFile.readlines</h4>
<b>readlines</b>(<i>sizehint=-1</i>)
-
<p>
Public method to read all lines from this file.
</p>
+
<dl>
<dt><i>sizehint</i> (int)</dt>
@@ -454,10 +453,10 @@
<a NAME="AsyncFile.seek" ID="AsyncFile.seek"></a>
<h4>AsyncFile.seek</h4>
<b>seek</b>(<i>offset, whence=0</i>)
-
<p>
Public method to move the filepointer.
</p>
+
<dl>
<dt><i>offset</i> (int)</dt>
@@ -480,10 +479,10 @@
<a NAME="AsyncFile.seekable" ID="AsyncFile.seekable"></a>
<h4>AsyncFile.seekable</h4>
<b>seekable</b>(<i></i>)
-
<p>
Public method to check, if the stream is seekable.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -499,10 +498,10 @@
<a NAME="AsyncFile.tell" ID="AsyncFile.tell"></a>
<h4>AsyncFile.tell</h4>
<b>tell</b>(<i></i>)
-
<p>
Public method to get the filepointer position.
</p>
+
<dl>
<dt>Raises <b>OSError</b>:</dt>
@@ -514,10 +513,10 @@
<a NAME="AsyncFile.truncate" ID="AsyncFile.truncate"></a>
<h4>AsyncFile.truncate</h4>
<b>truncate</b>(<i>size=-1</i>)
-
<p>
Public method to truncate the file.
</p>
+
<dl>
<dt><i>size</i> (int)</dt>
@@ -536,10 +535,10 @@
<a NAME="AsyncFile.writable" ID="AsyncFile.writable"></a>
<h4>AsyncFile.writable</h4>
<b>writable</b>(<i></i>)
-
<p>
Public method to check, if a stream is writable.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -555,10 +554,10 @@
<a NAME="AsyncFile.write" ID="AsyncFile.write"></a>
<h4>AsyncFile.write</h4>
<b>write</b>(<i>s</i>)
-
<p>
Public method to write a string to the file.
</p>
+
<dl>
<dt><i>s</i> (str, bytes or bytearray)</dt>
@@ -569,10 +568,10 @@
<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 json-rpc 2.0 coded string to the file.
</p>
+
<dl>
<dt><i>s</i> (str)</dt>
@@ -583,10 +582,10 @@
<a NAME="AsyncFile.writelines" ID="AsyncFile.writelines"></a>
<h4>AsyncFile.writelines</h4>
<b>writelines</b>(<i>lines</i>)
-
<p>
Public method to write a list of strings to the file.
</p>
+
<dl>
<dt><i>lines</i> (list of str)</dt>
@@ -600,10 +599,10 @@
<a NAME="AsyncPendingWrite" ID="AsyncPendingWrite"></a>
<h2>AsyncPendingWrite</h2>
<b>AsyncPendingWrite</b>(<i>file</i>)
-
<p>
Module function to check for data to be written.
</p>
+
<dl>
<dt><i>file</i> (file)</dt>
@@ -625,4 +624,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
