Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric5.DebugClients.Python3.AsyncFile.html

Documentation/Source/eric5.DebugClients.Python3.AsyncFile.html

changeset 58
37f0444c3479
parent 21
b88a0e6268bd
child 409
0ea528e80202
equal deleted inserted replaced
57:81326a94fdca 58:37f0444c3479
20 </style> 20 </style>
21 </head> 21 </head>
22 <body><a NAME="top" ID="top"></a> 22 <body><a NAME="top" ID="top"></a>
23 <h1>eric5.DebugClients.Python3.AsyncFile</h1> 23 <h1>eric5.DebugClients.Python3.AsyncFile</h1>
24 <p> 24 <p>
25 &#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97;&#110; &#97;&#115;y&#110;&#99;&#104;&#114;&#111;&#110;&#111;&#117;&#115; &#102;&#105;&#108;&#101; &#108;&#105;&#107;&#101; &#115;&#111;&#99;&#107;&#101;&#116; &#105;&#110;&#116;&#101;&#114;&#102;&#97;&#99;&#101; &#102;&#111;&#114; &#116;&#104;&#101; &#100;&#101;&#98;&#117;&#103;&#103;&#101;&#114;. 25 Module implementing an asynchronous file like socket interface for the debugger.
26 </p> 26 </p>
27 <h3>Global Attributes</h3> 27 <h3>Global Attributes</h3>
28 <table> 28 <table>
29 <tr><td>None</td></tr> 29 <tr><td>None</td></tr>
30 </table> 30 </table>
31 <h3>Classes</h3> 31 <h3>Classes</h3>
32 <table> 32 <table>
33 <tr> 33 <tr>
34 <td><a href="#AsyncFile">AsyncFile</a></td> 34 <td><a href="#AsyncFile">AsyncFile</a></td>
35 <td>&#67;&#108;&#97;&#115;&#115; w&#114;&#97;&#112;&#112;&#105;&#110;&#103; &#97; &#115;&#111;&#99;&#107;&#101;&#116; &#111;&#98;&#106;&#101;&#99;&#116; w&#105;&#116;&#104; &#97; &#102;&#105;&#108;&#101; &#105;&#110;&#116;&#101;&#114;&#102;&#97;&#99;&#101;.</td> 35 <td>Class wrapping a socket object with a file interface.</td>
36 </tr> 36 </tr>
37 </table> 37 </table>
38 <h3>Functions</h3> 38 <h3>Functions</h3>
39 <table> 39 <table>
40 <tr> 40 <tr>
41 <td><a href="#AsyncPendingWrite">AsyncPendingWrite</a></td> 41 <td><a href="#AsyncPendingWrite">AsyncPendingWrite</a></td>
42 <td>&#77;&#111;&#100;&#117;&#108;&#101; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#99;&#104;&#101;&#99;&#107; &#102;&#111;&#114; &#100;&#97;&#116;&#97; &#116;&#111; &#98;&#101; w&#114;&#105;&#116;&#116;&#101;&#110;.</td> 42 <td>Module function to check for data to be written.</td>
43 </tr> 43 </tr>
44 </table> 44 </table>
45 <hr /><hr /> 45 <hr /><hr />
46 <a NAME="AsyncFile" ID="AsyncFile"></a> 46 <a NAME="AsyncFile" ID="AsyncFile"></a>
47 <h2>AsyncFile</h2> 47 <h2>AsyncFile</h2>
48 <p> 48 <p>
49 &#67;&#108;&#97;&#115;&#115; w&#114;&#97;&#112;&#112;&#105;&#110;&#103; &#97; &#115;&#111;&#99;&#107;&#101;&#116; &#111;&#98;&#106;&#101;&#99;&#116; w&#105;&#116;&#104; &#97; &#102;&#105;&#108;&#101; &#105;&#110;&#116;&#101;&#114;&#102;&#97;&#99;&#101;. 49 Class wrapping a socket object with a file interface.
50 </p> 50 </p>
51 <h3>Derived from</h3> 51 <h3>Derived from</h3>
52 object 52 object
53 <h3>Class Attributes</h3> 53 <h3>Class Attributes</h3>
54 <table> 54 <table>
56 </table> 56 </table>
57 <h3>Methods</h3> 57 <h3>Methods</h3>
58 <table> 58 <table>
59 <tr> 59 <tr>
60 <td><a href="#AsyncFile.__init__">AsyncFile</a></td> 60 <td><a href="#AsyncFile.__init__">AsyncFile</a></td>
61 <td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td> 61 <td>Constructor</td>
62 </tr><tr> 62 </tr><tr>
63 <td><a href="#AsyncFile.__checkMode">__checkMode</a></td> 63 <td><a href="#AsyncFile.__checkMode">__checkMode</a></td>
64 <td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107; &#116;&#104;&#101; &#109;&#111;&#100;&#101;.</td> 64 <td>Private method to check the mode.</td>
65 </tr><tr> 65 </tr><tr>
66 <td><a href="#AsyncFile.__nWrite">__nWrite</a></td> 66 <td><a href="#AsyncFile.__nWrite">__nWrite</a></td>
67 <td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; w&#114;&#105;&#116;&#101; &#97; &#115;&#112;&#101;&#99;&#105;&#102;&#105;&#99; &#110;&#117;&#109;&#98;&#101;&#114; &#111;&#102; &#112;&#101;&#110;&#100;&#105;&#110;&#103; &#98;y&#116;&#101;&#115;.</td> 67 <td>Private method to write a specific number of pending bytes.</td>
68 </tr><tr> 68 </tr><tr>
69 <td><a href="#AsyncFile.close">close</a></td> 69 <td><a href="#AsyncFile.close">close</a></td>
70 <td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#108;&#111;&#115;&#101; &#116;&#104;&#101; &#102;&#105;&#108;&#101;.</td> 70 <td>Public method to close the file.</td>
71 </tr><tr> 71 </tr><tr>
72 <td><a href="#AsyncFile.fileno">fileno</a></td> 72 <td><a href="#AsyncFile.fileno">fileno</a></td>
73 <td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#114;&#101;&#116;&#117;&#114;&#110;&#105;&#110;&#103; &#116;&#104;&#101; &#102;&#105;&#108;&#101; &#110;&#117;&#109;&#98;&#101;&#114;.</td> 73 <td>Public method returning the file number.</td>
74 </tr><tr> 74 </tr><tr>
75 <td><a href="#AsyncFile.flush">flush</a></td> 75 <td><a href="#AsyncFile.flush">flush</a></td>
76 <td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; w&#114;&#105;&#116;&#101; &#97;&#108;&#108; &#112;&#101;&#110;&#100;&#105;&#110;&#103; &#98;y&#116;&#101;&#115;.</td> 76 <td>Public method to write all pending bytes.</td>
77 </tr><tr> 77 </tr><tr>
78 <td><a href="#AsyncFile.isatty">isatty</a></td> 78 <td><a href="#AsyncFile.isatty">isatty</a></td>
79 <td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#101; w&#104;&#101;&#116;&#104;&#101;&#114; &#97; &#116;&#116;y &#105;&#110;&#116;&#101;&#114;&#102;&#97;&#99;&#101; &#105;&#115; &#115;&#117;&#112;&#112;&#111;&#114;&#116;&#101;&#100;.</td> 79 <td>Public method to indicate whether a tty interface is supported.</td>
80 </tr><tr> 80 </tr><tr>
81 <td><a href="#AsyncFile.pendingWrite">pendingWrite</a></td> 81 <td><a href="#AsyncFile.pendingWrite">pendingWrite</a></td>
82 <td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#104;&#97;&#116; &#114;&#101;&#116;&#117;&#114;&#110;&#115; &#116;&#104;&#101; &#110;&#117;&#109;&#98;&#101;&#114; &#111;&#102; &#98;y&#116;&#101;&#115; w&#97;&#105;&#116;&#105;&#110;&#103; &#116;&#111; &#98;&#101; w&#114;&#105;&#116;&#116;&#101;&#110;.</td> 82 <td>Public method that returns the number of bytes waiting to be written.</td>
83 </tr><tr> 83 </tr><tr>
84 <td><a href="#AsyncFile.read">read</a></td> 84 <td><a href="#AsyncFile.read">read</a></td>
85 <td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#97;&#100; &#98;y&#116;&#101;&#115; &#102;&#114;&#111;&#109; &#116;&#104;&#105;&#115; &#102;&#105;&#108;&#101;.</td> 85 <td>Public method to read bytes from this file.</td>
86 </tr><tr> 86 </tr><tr>
87 <td><a href="#AsyncFile.read_p">read_p</a></td> 87 <td><a href="#AsyncFile.read_p">read_p</a></td>
88 <td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#97;&#100; &#98;y&#116;&#101;&#115; &#102;&#114;&#111;&#109; &#116;&#104;&#105;&#115; &#102;&#105;&#108;&#101;.</td> 88 <td>Public method to read bytes from this file.</td>
89 </tr><tr> 89 </tr><tr>
90 <td><a href="#AsyncFile.readline">readline</a></td> 90 <td><a href="#AsyncFile.readline">readline</a></td>
91 <td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#97;&#100; &#111;&#110;&#101; &#108;&#105;&#110;&#101; &#102;&#114;&#111;&#109; &#116;&#104;&#105;&#115; &#102;&#105;&#108;&#101;.</td> 91 <td>Public method to read one line from this file.</td>
92 </tr><tr> 92 </tr><tr>
93 <td><a href="#AsyncFile.readline_p">readline_p</a></td> 93 <td><a href="#AsyncFile.readline_p">readline_p</a></td>
94 <td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#97;&#100; &#97; &#108;&#105;&#110;&#101; &#102;&#114;&#111;&#109; &#116;&#104;&#105;&#115; &#102;&#105;&#108;&#101;.</td> 94 <td>Public method to read a line from this file.</td>
95 </tr><tr> 95 </tr><tr>
96 <td><a href="#AsyncFile.readlines">readlines</a></td> 96 <td><a href="#AsyncFile.readlines">readlines</a></td>
97 <td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#97;&#100; &#97;&#108;&#108; &#108;&#105;&#110;&#101;&#115; &#102;&#114;&#111;&#109; &#116;&#104;&#105;&#115; &#102;&#105;&#108;&#101;.</td> 97 <td>Public method to read all lines from this file.</td>
98 </tr><tr> 98 </tr><tr>
99 <td><a href="#AsyncFile.seek">seek</a></td> 99 <td><a href="#AsyncFile.seek">seek</a></td>
100 <td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#109;&#111;v&#101; &#116;&#104;&#101; &#102;&#105;&#108;&#101;&#112;&#111;&#105;&#110;&#116;&#101;&#114;.</td> 100 <td>Public method to move the filepointer.</td>
101 </tr><tr> 101 </tr><tr>
102 <td><a href="#AsyncFile.tell">tell</a></td> 102 <td><a href="#AsyncFile.tell">tell</a></td>
103 <td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#116; &#116;&#104;&#101; &#102;&#105;&#108;&#101;&#112;&#111;&#105;&#110;&#116;&#101;&#114; &#112;&#111;&#115;&#105;&#116;&#105;&#111;&#110;.</td> 103 <td>Public method to get the filepointer position.</td>
104 </tr><tr> 104 </tr><tr>
105 <td><a href="#AsyncFile.truncate">truncate</a></td> 105 <td><a href="#AsyncFile.truncate">truncate</a></td>
106 <td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#116;&#114;&#117;&#110;&#99;&#97;&#116;&#101; &#116;&#104;&#101; &#102;&#105;&#108;&#101;.</td> 106 <td>Public method to truncate the file.</td>
107 </tr><tr> 107 </tr><tr>
108 <td><a href="#AsyncFile.write">write</a></td> 108 <td><a href="#AsyncFile.write">write</a></td>
109 <td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; w&#114;&#105;&#116;&#101; &#97; &#115;&#116;&#114;&#105;&#110;&#103; &#116;&#111; &#116;&#104;&#101; &#102;&#105;&#108;&#101;.</td> 109 <td>Public method to write a string to the file.</td>
110 </tr><tr> 110 </tr><tr>
111 <td><a href="#AsyncFile.writelines">writelines</a></td> 111 <td><a href="#AsyncFile.writelines">writelines</a></td>
112 <td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; w&#114;&#105;&#116;&#101; &#97; &#108;&#105;&#115;&#116; &#111;&#102; &#115;&#116;&#114;&#105;&#110;&#103;&#115; &#116;&#111; &#116;&#104;&#101; &#102;&#105;&#108;&#101;.</td> 112 <td>Public method to write a list of strings to the file.</td>
113 </tr> 113 </tr>
114 </table> 114 </table>
115 <a NAME="AsyncFile.__init__" ID="AsyncFile.__init__"></a> 115 <a NAME="AsyncFile.__init__" ID="AsyncFile.__init__"></a>
116 <h4>AsyncFile (Constructor)</h4> 116 <h4>AsyncFile (Constructor)</h4>
117 <b>AsyncFile</b>(<i>sock, mode, name</i>) 117 <b>AsyncFile</b>(<i>sock, mode, name</i>)
118 <p> 118 <p>
119 &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114; 119 Constructor
120 </p><dl> 120 </p><dl>
121 <dt><i>sock</i></dt> 121 <dt><i>sock</i></dt>
122 <dd> 122 <dd>
123 &#116;&#104;&#101; &#115;&#111;&#99;&#107;&#101;&#116; &#111;&#98;&#106;&#101;&#99;&#116; &#98;&#101;&#105;&#110;&#103; w&#114;&#97;&#112;&#112;&#101;&#100; 123 the socket object being wrapped
124 </dd><dt><i>mode</i></dt> 124 </dd><dt><i>mode</i></dt>
125 <dd> 125 <dd>
126 &#109;&#111;&#100;&#101; &#111;&#102; &#116;&#104;&#105;&#115; &#102;&#105;&#108;&#101; (&#115;&#116;&#114;&#105;&#110;&#103;) 126 mode of this file (string)
127 </dd><dt><i>name</i></dt> 127 </dd><dt><i>name</i></dt>
128 <dd> 128 <dd>
129 &#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#105;&#115; &#102;&#105;&#108;&#101; (&#115;&#116;&#114;&#105;&#110;&#103;) 129 name of this file (string)
130 </dd> 130 </dd>
131 </dl><a NAME="AsyncFile.__checkMode" ID="AsyncFile.__checkMode"></a> 131 </dl><a NAME="AsyncFile.__checkMode" ID="AsyncFile.__checkMode"></a>
132 <h4>AsyncFile.__checkMode</h4> 132 <h4>AsyncFile.__checkMode</h4>
133 <b>__checkMode</b>(<i>mode</i>) 133 <b>__checkMode</b>(<i>mode</i>)
134 <p> 134 <p>
135 &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107; &#116;&#104;&#101; &#109;&#111;&#100;&#101;. 135 Private method to check the mode.
136 </p><p> 136 </p><p>
137 &#84;&#104;&#105;&#115; &#109;&#101;&#116;&#104;&#111;&#100; &#99;&#104;&#101;&#99;&#107;&#115;, &#105;&#102; &#97;&#110; &#111;&#112;&#101;&#114;&#97;&#116;&#105;&#111;&#110; &#105;&#115; &#112;&#101;&#114;&#109;&#105;&#116;&#116;&#101;&#100; &#97;&#99;&#99;&#111;&#114;&#100;&#105;&#110;&#103; &#116;&#111; 137 This method checks, if an operation is permitted according to
138 &#116;&#104;&#101; &#109;&#111;&#100;&#101; &#111;&#102; &#116;&#104;&#101; &#102;&#105;&#108;&#101;. &#73;&#102; &#105;&#116; &#105;&#115; &#110;&#111;&#116;, &#97;&#110; &#73;&#79;&#69;&#114;&#114;&#111;&#114; &#105;&#115; &#114;&#97;&#105;&#115;&#101;&#100;. 138 the mode of the file. If it is not, an IOError is raised.
139 </p><dl> 139 </p><dl>
140 <dt><i>mode</i></dt> 140 <dt><i>mode</i></dt>
141 <dd> 141 <dd>
142 &#116;&#104;&#101; &#109;&#111;&#100;&#101; &#116;&#111; &#98;&#101; &#99;&#104;&#101;&#99;&#107;&#101;&#100; (&#115;&#116;&#114;&#105;&#110;&#103;) 142 the mode to be checked (string)
143 </dd> 143 </dd>
144 </dl><a NAME="AsyncFile.__nWrite" ID="AsyncFile.__nWrite"></a> 144 </dl><a NAME="AsyncFile.__nWrite" ID="AsyncFile.__nWrite"></a>
145 <h4>AsyncFile.__nWrite</h4> 145 <h4>AsyncFile.__nWrite</h4>
146 <b>__nWrite</b>(<i>n</i>) 146 <b>__nWrite</b>(<i>n</i>)
147 <p> 147 <p>
148 &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; w&#114;&#105;&#116;&#101; &#97; &#115;&#112;&#101;&#99;&#105;&#102;&#105;&#99; &#110;&#117;&#109;&#98;&#101;&#114; &#111;&#102; &#112;&#101;&#110;&#100;&#105;&#110;&#103; &#98;y&#116;&#101;&#115;. 148 Private method to write a specific number of pending bytes.
149 </p><dl> 149 </p><dl>
150 <dt><i>n</i></dt> 150 <dt><i>n</i></dt>
151 <dd> 151 <dd>
152 &#116;&#104;&#101; &#110;&#117;&#109;&#98;&#101;&#114; &#111;&#102; &#98;y&#116;&#101;&#115; &#116;&#111; &#98;&#101; w&#114;&#105;&#116;&#116;&#101;&#110; (&#105;&#110;&#116;) 152 the number of bytes to be written (int)
153 </dd> 153 </dd>
154 </dl><a NAME="AsyncFile.close" ID="AsyncFile.close"></a> 154 </dl><a NAME="AsyncFile.close" ID="AsyncFile.close"></a>
155 <h4>AsyncFile.close</h4> 155 <h4>AsyncFile.close</h4>
156 <b>close</b>(<i>closeit = False</i>) 156 <b>close</b>(<i>closeit = False</i>)
157 <p> 157 <p>
158 &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#108;&#111;&#115;&#101; &#116;&#104;&#101; &#102;&#105;&#108;&#101;. 158 Public method to close the file.
159 </p><dl> 159 </p><dl>
160 <dt><i>closeit</i></dt> 160 <dt><i>closeit</i></dt>
161 <dd> 161 <dd>
162 &#102;&#108;&#97;&#103; &#116;&#111; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#101; &#97; &#99;&#108;&#111;&#115;&#101; &#111;&#114;&#100;&#101;&#114;&#101;&#100; &#98;y &#116;&#104;&#101; &#100;&#101;&#98;&#117;&#103;&#103;&#101;&#114; &#99;&#111;&#100;&#101; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;) 162 flag to indicate a close ordered by the debugger code (boolean)
163 </dd> 163 </dd>
164 </dl><a NAME="AsyncFile.fileno" ID="AsyncFile.fileno"></a> 164 </dl><a NAME="AsyncFile.fileno" ID="AsyncFile.fileno"></a>
165 <h4>AsyncFile.fileno</h4> 165 <h4>AsyncFile.fileno</h4>
166 <b>fileno</b>(<i></i>) 166 <b>fileno</b>(<i></i>)
167 <p> 167 <p>
168 &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#114;&#101;&#116;&#117;&#114;&#110;&#105;&#110;&#103; &#116;&#104;&#101; &#102;&#105;&#108;&#101; &#110;&#117;&#109;&#98;&#101;&#114;. 168 Public method returning the file number.
169 </p><dl> 169 </p><dl>
170 <dt>Returns:</dt> 170 <dt>Returns:</dt>
171 <dd> 171 <dd>
172 &#102;&#105;&#108;&#101; &#110;&#117;&#109;&#98;&#101;&#114; (&#105;&#110;&#116;) 172 file number (int)
173 </dd> 173 </dd>
174 </dl><a NAME="AsyncFile.flush" ID="AsyncFile.flush"></a> 174 </dl><a NAME="AsyncFile.flush" ID="AsyncFile.flush"></a>
175 <h4>AsyncFile.flush</h4> 175 <h4>AsyncFile.flush</h4>
176 <b>flush</b>(<i></i>) 176 <b>flush</b>(<i></i>)
177 <p> 177 <p>
178 &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; w&#114;&#105;&#116;&#101; &#97;&#108;&#108; &#112;&#101;&#110;&#100;&#105;&#110;&#103; &#98;y&#116;&#101;&#115;. 178 Public method to write all pending bytes.
179 </p><a NAME="AsyncFile.isatty" ID="AsyncFile.isatty"></a> 179 </p><a NAME="AsyncFile.isatty" ID="AsyncFile.isatty"></a>
180 <h4>AsyncFile.isatty</h4> 180 <h4>AsyncFile.isatty</h4>
181 <b>isatty</b>(<i></i>) 181 <b>isatty</b>(<i></i>)
182 <p> 182 <p>
183 &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#101; w&#104;&#101;&#116;&#104;&#101;&#114; &#97; &#116;&#116;y &#105;&#110;&#116;&#101;&#114;&#102;&#97;&#99;&#101; &#105;&#115; &#115;&#117;&#112;&#112;&#111;&#114;&#116;&#101;&#100;. 183 Public method to indicate whether a tty interface is supported.
184 </p><dl> 184 </p><dl>
185 <dt>Returns:</dt> 185 <dt>Returns:</dt>
186 <dd> 186 <dd>
187 &#97;&#108;w&#97;y&#115; &#102;&#97;&#108;&#115;&#101; 187 always false
188 </dd> 188 </dd>
189 </dl><a NAME="AsyncFile.pendingWrite" ID="AsyncFile.pendingWrite"></a> 189 </dl><a NAME="AsyncFile.pendingWrite" ID="AsyncFile.pendingWrite"></a>
190 <h4>AsyncFile.pendingWrite</h4> 190 <h4>AsyncFile.pendingWrite</h4>
191 <b>pendingWrite</b>(<i></i>) 191 <b>pendingWrite</b>(<i></i>)
192 <p> 192 <p>
193 &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#104;&#97;&#116; &#114;&#101;&#116;&#117;&#114;&#110;&#115; &#116;&#104;&#101; &#110;&#117;&#109;&#98;&#101;&#114; &#111;&#102; &#98;y&#116;&#101;&#115; w&#97;&#105;&#116;&#105;&#110;&#103; &#116;&#111; &#98;&#101; w&#114;&#105;&#116;&#116;&#101;&#110;. 193 Public method that returns the number of bytes waiting to be written.
194 </p><dl> 194 </p><dl>
195 <dt>Returns:</dt> 195 <dt>Returns:</dt>
196 <dd> 196 <dd>
197 &#116;&#104;&#101; &#110;&#117;&#109;&#98;&#101;&#114; &#111;&#102; &#98;y&#116;&#101;&#115; &#116;&#111; &#98;&#101; w&#114;&#105;&#116;&#116;&#101;&#110; (&#105;&#110;&#116;) 197 the number of bytes to be written (int)
198 </dd> 198 </dd>
199 </dl><a NAME="AsyncFile.read" ID="AsyncFile.read"></a> 199 </dl><a NAME="AsyncFile.read" ID="AsyncFile.read"></a>
200 <h4>AsyncFile.read</h4> 200 <h4>AsyncFile.read</h4>
201 <b>read</b>(<i>size = -1</i>) 201 <b>read</b>(<i>size = -1</i>)
202 <p> 202 <p>
203 &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#97;&#100; &#98;y&#116;&#101;&#115; &#102;&#114;&#111;&#109; &#116;&#104;&#105;&#115; &#102;&#105;&#108;&#101;. 203 Public method to read bytes from this file.
204 </p><dl> 204 </p><dl>
205 <dt><i>size</i></dt> 205 <dt><i>size</i></dt>
206 <dd> 206 <dd>
207 &#109;&#97;x&#105;&#109;&#117;&#109; &#110;&#117;&#109;&#98;&#101;&#114; &#111;&#102; &#98;y&#116;&#101;&#115; &#116;&#111; &#98;&#101; &#114;&#101;&#97;&#100; (&#105;&#110;&#116;) 207 maximum number of bytes to be read (int)
208 </dd> 208 </dd>
209 </dl><dl> 209 </dl><dl>
210 <dt>Returns:</dt> 210 <dt>Returns:</dt>
211 <dd> 211 <dd>
212 &#116;&#104;&#101; &#98;y&#116;&#101;&#115; &#114;&#101;&#97;&#100; (&#97;&#110;y) 212 the bytes read (any)
213 </dd> 213 </dd>
214 </dl><a NAME="AsyncFile.read_p" ID="AsyncFile.read_p"></a> 214 </dl><a NAME="AsyncFile.read_p" ID="AsyncFile.read_p"></a>
215 <h4>AsyncFile.read_p</h4> 215 <h4>AsyncFile.read_p</h4>
216 <b>read_p</b>(<i>size = -1</i>) 216 <b>read_p</b>(<i>size = -1</i>)
217 <p> 217 <p>
218 &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#97;&#100; &#98;y&#116;&#101;&#115; &#102;&#114;&#111;&#109; &#116;&#104;&#105;&#115; &#102;&#105;&#108;&#101;. 218 Public method to read bytes from this file.
219 </p><dl> 219 </p><dl>
220 <dt><i>size</i></dt> 220 <dt><i>size</i></dt>
221 <dd> 221 <dd>
222 &#109;&#97;x&#105;&#109;&#117;&#109; &#110;&#117;&#109;&#98;&#101;&#114; &#111;&#102; &#98;y&#116;&#101;&#115; &#116;&#111; &#98;&#101; &#114;&#101;&#97;&#100; (&#105;&#110;&#116;) 222 maximum number of bytes to be read (int)
223 </dd> 223 </dd>
224 </dl><dl> 224 </dl><dl>
225 <dt>Returns:</dt> 225 <dt>Returns:</dt>
226 <dd> 226 <dd>
227 &#116;&#104;&#101; &#98;y&#116;&#101;&#115; &#114;&#101;&#97;&#100; (&#97;&#110;y) 227 the bytes read (any)
228 </dd> 228 </dd>
229 </dl><a NAME="AsyncFile.readline" ID="AsyncFile.readline"></a> 229 </dl><a NAME="AsyncFile.readline" ID="AsyncFile.readline"></a>
230 <h4>AsyncFile.readline</h4> 230 <h4>AsyncFile.readline</h4>
231 <b>readline</b>(<i>sizehint = -1</i>) 231 <b>readline</b>(<i>sizehint = -1</i>)
232 <p> 232 <p>
233 &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#97;&#100; &#111;&#110;&#101; &#108;&#105;&#110;&#101; &#102;&#114;&#111;&#109; &#116;&#104;&#105;&#115; &#102;&#105;&#108;&#101;. 233 Public method to read one line from this file.
234 </p><dl> 234 </p><dl>
235 <dt><i>sizehint</i></dt> 235 <dt><i>sizehint</i></dt>
236 <dd> 236 <dd>
237 &#104;&#105;&#110;&#116; &#111;&#102; &#116;&#104;&#101; &#110;&#117;&#109;&#98;&#101;&#114;&#115; &#111;&#102; &#98;y&#116;&#101;&#115; &#116;&#111; &#98;&#101; &#114;&#101;&#97;&#100; (&#105;&#110;&#116;) 237 hint of the numbers of bytes to be read (int)
238 </dd> 238 </dd>
239 </dl><dl> 239 </dl><dl>
240 <dt>Returns:</dt> 240 <dt>Returns:</dt>
241 <dd> 241 <dd>
242 &#111;&#110;&#101; &#108;&#105;&#110;&#101; &#114;&#101;&#97;&#100; (&#115;&#116;&#114;&#105;&#110;&#103;) 242 one line read (string)
243 </dd> 243 </dd>
244 </dl><a NAME="AsyncFile.readline_p" ID="AsyncFile.readline_p"></a> 244 </dl><a NAME="AsyncFile.readline_p" ID="AsyncFile.readline_p"></a>
245 <h4>AsyncFile.readline_p</h4> 245 <h4>AsyncFile.readline_p</h4>
246 <b>readline_p</b>(<i>size = -1</i>) 246 <b>readline_p</b>(<i>size = -1</i>)
247 <p> 247 <p>
248 &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#97;&#100; &#97; &#108;&#105;&#110;&#101; &#102;&#114;&#111;&#109; &#116;&#104;&#105;&#115; &#102;&#105;&#108;&#101;. 248 Public method to read a line from this file.
249 </p><p> 249 </p><p>
250 &#60;&#98;&#62;&#78;&#111;&#116;&#101;&#60;/&#98;&#62;&#58; &#84;&#104;&#105;&#115; &#109;&#101;&#116;&#104;&#111;&#100; w&#105;&#108;&#108; &#110;&#111;&#116; &#98;&#108;&#111;&#99;&#107; &#97;&#110;&#100; &#109;&#97;y &#114;&#101;&#116;&#117;&#114;&#110; 250 <b>Note</b>: This method will not block and may return
251 &#111;&#110;&#108;y &#97; &#112;&#97;&#114;&#116; &#111;&#102; &#97; &#108;&#105;&#110;&#101; &#105;&#102; &#116;&#104;&#97;&#116; &#105;&#115; &#97;&#108;&#108; &#116;&#104;&#97;&#116; &#105;&#115; &#97;v&#97;&#105;&#108;&#97;&#98;&#108;&#101;. 251 only a part of a line if that is all that is available.
252 </p><dl> 252 </p><dl>
253 <dt><i>size</i></dt> 253 <dt><i>size</i></dt>
254 <dd> 254 <dd>
255 &#109;&#97;x&#105;&#109;&#117;&#109; &#110;&#117;&#109;&#98;&#101;&#114; &#111;&#102; &#98;y&#116;&#101;&#115; &#116;&#111; &#98;&#101; &#114;&#101;&#97;&#100; (&#105;&#110;&#116;) 255 maximum number of bytes to be read (int)
256 </dd> 256 </dd>
257 </dl><dl> 257 </dl><dl>
258 <dt>Returns:</dt> 258 <dt>Returns:</dt>
259 <dd> 259 <dd>
260 &#111;&#110;&#101; &#108;&#105;&#110;&#101; &#111;&#102; &#116;&#101;x&#116; &#117;&#112; &#116;&#111; &#115;&#105;z&#101; &#98;y&#116;&#101;&#115; (&#115;&#116;&#114;&#105;&#110;&#103;) 260 one line of text up to size bytes (string)
261 </dd> 261 </dd>
262 </dl><a NAME="AsyncFile.readlines" ID="AsyncFile.readlines"></a> 262 </dl><a NAME="AsyncFile.readlines" ID="AsyncFile.readlines"></a>
263 <h4>AsyncFile.readlines</h4> 263 <h4>AsyncFile.readlines</h4>
264 <b>readlines</b>(<i>sizehint = -1</i>) 264 <b>readlines</b>(<i>sizehint = -1</i>)
265 <p> 265 <p>
266 &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#97;&#100; &#97;&#108;&#108; &#108;&#105;&#110;&#101;&#115; &#102;&#114;&#111;&#109; &#116;&#104;&#105;&#115; &#102;&#105;&#108;&#101;. 266 Public method to read all lines from this file.
267 </p><dl> 267 </p><dl>
268 <dt><i>sizehint</i></dt> 268 <dt><i>sizehint</i></dt>
269 <dd> 269 <dd>
270 &#104;&#105;&#110;&#116; &#111;&#102; &#116;&#104;&#101; &#110;&#117;&#109;&#98;&#101;&#114;&#115; &#111;&#102; &#98;y&#116;&#101;&#115; &#116;&#111; &#98;&#101; &#114;&#101;&#97;&#100; (&#105;&#110;&#116;) 270 hint of the numbers of bytes to be read (int)
271 </dd> 271 </dd>
272 </dl><dl> 272 </dl><dl>
273 <dt>Returns:</dt> 273 <dt>Returns:</dt>
274 <dd> 274 <dd>
275 &#108;&#105;&#115;&#116; &#111;&#102; &#108;&#105;&#110;&#101;&#115; &#114;&#101;&#97;&#100; (&#108;&#105;&#115;&#116; &#111;&#102; &#115;&#116;&#114;&#105;&#110;&#103;&#115;) 275 list of lines read (list of strings)
276 </dd> 276 </dd>
277 </dl><a NAME="AsyncFile.seek" ID="AsyncFile.seek"></a> 277 </dl><a NAME="AsyncFile.seek" ID="AsyncFile.seek"></a>
278 <h4>AsyncFile.seek</h4> 278 <h4>AsyncFile.seek</h4>
279 <b>seek</b>(<i>offset, whence = 0</i>) 279 <b>seek</b>(<i>offset, whence = 0</i>)
280 <p> 280 <p>
281 &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#109;&#111;v&#101; &#116;&#104;&#101; &#102;&#105;&#108;&#101;&#112;&#111;&#105;&#110;&#116;&#101;&#114;. 281 Public method to move the filepointer.
282 </p><dl> 282 </p><dl>
283 <dt><i>offset</i></dt> 283 <dt><i>offset</i></dt>
284 <dd> 284 <dd>
285 &#111;&#102;&#102;&#115;&#101;&#116; &#116;&#111; &#109;&#111;v&#101; &#116;&#104;&#101; &#102;&#105;&#108;&#101;&#112;&#111;&#105;&#110;&#116;&#101;&#114; &#116;&#111; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;) 285 offset to move the filepointer to (integer)
286 </dd><dt><i>whence</i></dt> 286 </dd><dt><i>whence</i></dt>
287 <dd> 287 <dd>
288 &#112;&#111;&#115;&#105;&#116;&#105;&#111;&#110; &#116;&#104;&#101; &#111;&#102;&#102;&#115;&#101;&#116; &#114;&#101;&#108;&#97;&#116;&#101;&#115; &#116;&#111; 288 position the offset relates to
289 </dd> 289 </dd>
290 </dl><dl> 290 </dl><dl>
291 <dt>Raises <b>IOError</b>:</dt> 291 <dt>Raises <b>IOError</b>:</dt>
292 <dd> 292 <dd>
293 &#84;&#104;&#105;&#115; &#109;&#101;&#116;&#104;&#111;&#100; &#105;&#115; &#110;&#111;&#116; &#115;&#117;&#112;&#112;&#111;&#114;&#116;&#101;&#100; &#97;&#110;&#100; &#97;&#108;w&#97;y&#115; &#114;&#97;&#105;&#115;&#101;&#115; &#97;&#110; 293 This method is not supported and always raises an
294 &#73;&#79;&#69;&#114;&#114;&#111;&#114;. 294 IOError.
295 </dd> 295 </dd>
296 </dl><a NAME="AsyncFile.tell" ID="AsyncFile.tell"></a> 296 </dl><a NAME="AsyncFile.tell" ID="AsyncFile.tell"></a>
297 <h4>AsyncFile.tell</h4> 297 <h4>AsyncFile.tell</h4>
298 <b>tell</b>(<i></i>) 298 <b>tell</b>(<i></i>)
299 <p> 299 <p>
300 &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#116; &#116;&#104;&#101; &#102;&#105;&#108;&#101;&#112;&#111;&#105;&#110;&#116;&#101;&#114; &#112;&#111;&#115;&#105;&#116;&#105;&#111;&#110;. 300 Public method to get the filepointer position.
301 </p><dl> 301 </p><dl>
302 <dt>Raises <b>IOError</b>:</dt> 302 <dt>Raises <b>IOError</b>:</dt>
303 <dd> 303 <dd>
304 &#84;&#104;&#105;&#115; &#109;&#101;&#116;&#104;&#111;&#100; &#105;&#115; &#110;&#111;&#116; &#115;&#117;&#112;&#112;&#111;&#114;&#116;&#101;&#100; &#97;&#110;&#100; &#97;&#108;w&#97;y&#115; &#114;&#97;&#105;&#115;&#101;&#115; &#97;&#110; 304 This method is not supported and always raises an
305 &#73;&#79;&#69;&#114;&#114;&#111;&#114;. 305 IOError.
306 </dd> 306 </dd>
307 </dl><a NAME="AsyncFile.truncate" ID="AsyncFile.truncate"></a> 307 </dl><a NAME="AsyncFile.truncate" ID="AsyncFile.truncate"></a>
308 <h4>AsyncFile.truncate</h4> 308 <h4>AsyncFile.truncate</h4>
309 <b>truncate</b>(<i>size = -1</i>) 309 <b>truncate</b>(<i>size = -1</i>)
310 <p> 310 <p>
311 &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#116;&#114;&#117;&#110;&#99;&#97;&#116;&#101; &#116;&#104;&#101; &#102;&#105;&#108;&#101;. 311 Public method to truncate the file.
312 </p><dl> 312 </p><dl>
313 <dt><i>size</i></dt> 313 <dt><i>size</i></dt>
314 <dd> 314 <dd>
315 &#115;&#105;z&#101; &#116;&#111; &#116;&#114;&#117;&#110;&#99;&#97;z&#101; &#116;&#111; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;) 315 size to truncaze to (integer)
316 </dd> 316 </dd>
317 </dl><dl> 317 </dl><dl>
318 <dt>Raises <b>IOError</b>:</dt> 318 <dt>Raises <b>IOError</b>:</dt>
319 <dd> 319 <dd>
320 &#84;&#104;&#105;&#115; &#109;&#101;&#116;&#104;&#111;&#100; &#105;&#115; &#110;&#111;&#116; &#115;&#117;&#112;&#112;&#111;&#114;&#116;&#101;&#100; &#97;&#110;&#100; &#97;&#108;w&#97;y&#115; &#114;&#97;&#105;&#115;&#101;&#115; &#97;&#110; 320 This method is not supported and always raises an
321 &#73;&#79;&#69;&#114;&#114;&#111;&#114;. 321 IOError.
322 </dd> 322 </dd>
323 </dl><a NAME="AsyncFile.write" ID="AsyncFile.write"></a> 323 </dl><a NAME="AsyncFile.write" ID="AsyncFile.write"></a>
324 <h4>AsyncFile.write</h4> 324 <h4>AsyncFile.write</h4>
325 <b>write</b>(<i>s</i>) 325 <b>write</b>(<i>s</i>)
326 <p> 326 <p>
327 &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; w&#114;&#105;&#116;&#101; &#97; &#115;&#116;&#114;&#105;&#110;&#103; &#116;&#111; &#116;&#104;&#101; &#102;&#105;&#108;&#101;. 327 Public method to write a string to the file.
328 </p><dl> 328 </p><dl>
329 <dt><i>s</i></dt> 329 <dt><i>s</i></dt>
330 <dd> 330 <dd>
331 &#98;y&#116;&#101;&#115; &#116;&#111; &#98;&#101; w&#114;&#105;&#116;&#116;&#101;&#110; (&#115;&#116;&#114;&#105;&#110;&#103;) 331 bytes to be written (string)
332 </dd> 332 </dd>
333 </dl><a NAME="AsyncFile.writelines" ID="AsyncFile.writelines"></a> 333 </dl><a NAME="AsyncFile.writelines" ID="AsyncFile.writelines"></a>
334 <h4>AsyncFile.writelines</h4> 334 <h4>AsyncFile.writelines</h4>
335 <b>writelines</b>(<i>list</i>) 335 <b>writelines</b>(<i>list</i>)
336 <p> 336 <p>
337 &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; w&#114;&#105;&#116;&#101; &#97; &#108;&#105;&#115;&#116; &#111;&#102; &#115;&#116;&#114;&#105;&#110;&#103;&#115; &#116;&#111; &#116;&#104;&#101; &#102;&#105;&#108;&#101;. 337 Public method to write a list of strings to the file.
338 </p><dl> 338 </p><dl>
339 <dt><i>list</i></dt> 339 <dt><i>list</i></dt>
340 <dd> 340 <dd>
341 &#116;&#104;&#101; &#108;&#105;&#115;&#116; &#116;&#111; &#98;&#101; w&#114;&#105;&#116;&#116;&#101;&#110; (&#108;&#105;&#115;&#116; &#111;&#102; &#115;&#116;&#114;&#105;&#110;&#103;) 341 the list to be written (list of string)
342 </dd> 342 </dd>
343 </dl> 343 </dl>
344 <div align="right"><a href="#top">Up</a></div> 344 <div align="right"><a href="#top">Up</a></div>
345 <hr /><hr /> 345 <hr /><hr />
346 <a NAME="AsyncPendingWrite" ID="AsyncPendingWrite"></a> 346 <a NAME="AsyncPendingWrite" ID="AsyncPendingWrite"></a>
347 <h2>AsyncPendingWrite</h2> 347 <h2>AsyncPendingWrite</h2>
348 <b>AsyncPendingWrite</b>(<i>file</i>) 348 <b>AsyncPendingWrite</b>(<i>file</i>)
349 <p> 349 <p>
350 &#77;&#111;&#100;&#117;&#108;&#101; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#99;&#104;&#101;&#99;&#107; &#102;&#111;&#114; &#100;&#97;&#116;&#97; &#116;&#111; &#98;&#101; w&#114;&#105;&#116;&#116;&#101;&#110;. 350 Module function to check for data to be written.
351 </p><dl> 351 </p><dl>
352 <dt><i>file</i></dt> 352 <dt><i>file</i></dt>
353 <dd> 353 <dd>
354 &#84;&#104;&#101; &#102;&#105;&#108;&#101; &#111;&#98;&#106;&#101;&#99;&#116; &#116;&#111; &#98;&#101; &#99;&#104;&#101;&#99;&#107;&#101;&#100; (&#102;&#105;&#108;&#101;) 354 The file object to be checked (file)
355 </dd> 355 </dd>
356 </dl><dl> 356 </dl><dl>
357 <dt>Returns:</dt> 357 <dt>Returns:</dt>
358 <dd> 358 <dd>
359 &#70;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; &#105;&#102; &#116;&#104;&#101;&#114;&#101; &#105;&#115; &#100;&#97;&#116;&#97; w&#97;&#116;&#105;&#110;&#103; (&#105;&#110;&#116;) 359 Flag indicating if there is data wating (int)
360 </dd> 360 </dd>
361 </dl> 361 </dl>
362 <div align="right"><a href="#top">Up</a></div> 362 <div align="right"><a href="#top">Up</a></div>
363 <hr /> 363 <hr />
364 </body></html> 364 </body></html>

Mercurial Repository: eric

eric ide

mercurial