src/eric7/Documentation/Source/eric7.Utilities.FtpUtilities.html

branch
eric7
changeset 10433
328f3ec4b77a
parent 9209
b99e7fd55fd3
child 10479
856476537696
equal deleted inserted replaced
10432:2fe91fe443dd 10433:328f3ec4b77a
108 <p> 108 <p>
109 Constructor 109 Constructor
110 </p> 110 </p>
111 <dl> 111 <dl>
112 112
113 <dt><i>parent</i></dt> 113 <dt><i>parent</i> (QObject)</dt>
114 <dd> 114 <dd>
115 reference to the parent object (QObject) 115 reference to the parent object
116 </dd> 116 </dd>
117 </dl> 117 </dl>
118 <a NAME="FtpDirLineParser.__ignoreLine" ID="FtpDirLineParser.__ignoreLine"></a> 118 <a NAME="FtpDirLineParser.__ignoreLine" ID="FtpDirLineParser.__ignoreLine"></a>
119 <h4>FtpDirLineParser.__ignoreLine</h4> 119 <h4>FtpDirLineParser.__ignoreLine</h4>
120 <b>__ignoreLine</b>(<i>line</i>) 120 <b>__ignoreLine</b>(<i>line</i>)
122 <p> 122 <p>
123 Private method to check, if the line should be ignored. 123 Private method to check, if the line should be ignored.
124 </p> 124 </p>
125 <dl> 125 <dl>
126 126
127 <dt><i>line</i></dt> 127 <dt><i>line</i> (str)</dt>
128 <dd> 128 <dd>
129 to check (string) 129 to check
130 </dd> 130 </dd>
131 </dl> 131 </dl>
132 <dl> 132 <dl>
133 <dt>Return:</dt> 133 <dt>Return:</dt>
134 <dd> 134 <dd>
135 flag indicating to ignore the line (boolean) 135 flag indicating to ignore the line
136 </dd>
137 </dl>
138 <dl>
139 <dt>Return Type:</dt>
140 <dd>
141 bool
136 </dd> 142 </dd>
137 </dl> 143 </dl>
138 <a NAME="FtpDirLineParser.__parseUnixLine" ID="FtpDirLineParser.__parseUnixLine"></a> 144 <a NAME="FtpDirLineParser.__parseUnixLine" ID="FtpDirLineParser.__parseUnixLine"></a>
139 <h4>FtpDirLineParser.__parseUnixLine</h4> 145 <h4>FtpDirLineParser.__parseUnixLine</h4>
140 <b>__parseUnixLine</b>(<i>line</i>) 146 <b>__parseUnixLine</b>(<i>line</i>)
142 <p> 148 <p>
143 Private method to parse a Unix style directory listing line. 149 Private method to parse a Unix style directory listing line.
144 </p> 150 </p>
145 <dl> 151 <dl>
146 152
147 <dt><i>line</i></dt> 153 <dt><i>line</i> (str)</dt>
148 <dd> 154 <dd>
149 directory line to be parsed (string) 155 directory line to be parsed
150 </dd> 156 </dd>
151 </dl> 157 </dl>
152 <dl> 158 <dl>
153 <dt>Return:</dt> 159 <dt>Return:</dt>
154 <dd> 160 <dd>
155 URL info object containing the valid data (EricUrlInfo) 161 URL info object containing the valid data
162 </dd>
163 </dl>
164 <dl>
165 <dt>Return Type:</dt>
166 <dd>
167 EricUrlInfo
156 </dd> 168 </dd>
157 </dl> 169 </dl>
158 <a NAME="FtpDirLineParser.__parseUnixMode" ID="FtpDirLineParser.__parseUnixMode"></a> 170 <a NAME="FtpDirLineParser.__parseUnixMode" ID="FtpDirLineParser.__parseUnixMode"></a>
159 <h4>FtpDirLineParser.__parseUnixMode</h4> 171 <h4>FtpDirLineParser.__parseUnixMode</h4>
160 <b>__parseUnixMode</b>(<i>modeString, urlInfo</i>) 172 <b>__parseUnixMode</b>(<i>modeString, urlInfo</i>)
163 Private method to parse a Unix mode string modifying the 175 Private method to parse a Unix mode string modifying the
164 given URL info object. 176 given URL info object.
165 </p> 177 </p>
166 <dl> 178 <dl>
167 179
168 <dt><i>modeString</i></dt> 180 <dt><i>modeString</i> (str)</dt>
169 <dd> 181 <dd>
170 mode string to be parsed (string) 182 mode string to be parsed
171 </dd> 183 </dd>
172 <dt><i>urlInfo</i></dt> 184 <dt><i>urlInfo</i> (EricUrlInfo)</dt>
173 <dd> 185 <dd>
174 reference to the URL info object (EricUrlInfo) 186 reference to the URL info object
175 </dd> 187 </dd>
176 </dl> 188 </dl>
177 <dl> 189 <dl>
178 190
179 <dt>Raises <b>FtpDirLineParserError</b>:</dt> 191 <dt>Raises <b>FtpDirLineParserError</b>:</dt>
200 <li>"May 26 2005" (month name, day of month, year)</li> 212 <li>"May 26 2005" (month name, day of month, year)</li>
201 </ul> 213 </ul>
202 </p> 214 </p>
203 <dl> 215 <dl>
204 216
205 <dt><i>monthAbbreviation</i></dt> 217 <dt><i>monthAbbreviation</i> (str)</dt>
206 <dd> 218 <dd>
207 abbreviation of the month name (string) 219 abbreviation of the month name
208 </dd> 220 </dd>
209 <dt><i>day</i></dt> 221 <dt><i>day</i> (str)</dt>
210 <dd> 222 <dd>
211 day of the month (string) 223 day of the month
212 </dd> 224 </dd>
213 <dt><i>yearOrTime</i></dt> 225 <dt><i>yearOrTime</i> (str)</dt>
214 <dd> 226 <dd>
215 string giving the year or a time (string) 227 string giving the year or a time
216 </dd> 228 </dd>
217 <dt><i>urlInfo</i></dt> 229 <dt><i>urlInfo</i> (EricUrlInfo)</dt>
218 <dd> 230 <dd>
219 reference to the URL info object (EricUrlInfo) 231 reference to the URL info object
220 </dd> 232 </dd>
221 </dl> 233 </dl>
222 <dl> 234 <dl>
223 235
224 <dt>Raises <b>FtpDirLineParserError</b>:</dt> 236 <dt>Raises <b>FtpDirLineParserError</b>:</dt>
234 <p> 246 <p>
235 Private method to parse a Windows style directory listing line. 247 Private method to parse a Windows style directory listing line.
236 </p> 248 </p>
237 <dl> 249 <dl>
238 250
239 <dt><i>line</i></dt> 251 <dt><i>line</i> (str)</dt>
240 <dd> 252 <dd>
241 directory line to be parsed (string) 253 directory line to be parsed
242 </dd> 254 </dd>
243 </dl> 255 </dl>
244 <dl> 256 <dl>
245 <dt>Return:</dt> 257 <dt>Return:</dt>
246 <dd> 258 <dd>
247 URL info object containing the valid data (EricUrlInfo) 259 URL info object containing the valid data
260 </dd>
261 </dl>
262 <dl>
263 <dt>Return Type:</dt>
264 <dd>
265 EricUrlInfo
248 </dd> 266 </dd>
249 </dl> 267 </dl>
250 <dl> 268 <dl>
251 269
252 <dt>Raises <b>FtpDirLineParserError</b>:</dt> 270 <dt>Raises <b>FtpDirLineParserError</b>:</dt>
268 have the format "10-23-12 03:25PM" (month-day_of_month-two_digit_year, 286 have the format "10-23-12 03:25PM" (month-day_of_month-two_digit_year,
269 hour:minute, am/pm). 287 hour:minute, am/pm).
270 </p> 288 </p>
271 <dl> 289 <dl>
272 290
273 <dt><i>date</i></dt> 291 <dt><i>date</i> (str)</dt>
274 <dd> 292 <dd>
275 date string (string) 293 date string
276 </dd> 294 </dd>
277 <dt><i>time</i></dt> 295 <dt><i>time</i> (str)</dt>
278 <dd> 296 <dd>
279 time string (string) 297 time string
280 </dd> 298 </dd>
281 <dt><i>urlInfo</i></dt> 299 <dt><i>urlInfo</i> (EricUrlInfo)</dt>
282 <dd> 300 <dd>
283 reference to the URL info object (EricUrlInfo) 301 reference to the URL info object
284 </dd> 302 </dd>
285 </dl> 303 </dl>
286 <dl> 304 <dl>
287 305
288 <dt>Raises <b>FtpDirLineParserError</b>:</dt> 306 <dt>Raises <b>FtpDirLineParserError</b>:</dt>
302 It splits the line into meta data, number of links, user, group, size, 320 It splits the line into meta data, number of links, user, group, size,
303 month, day, year or time and name. 321 month, day, year or time and name.
304 </p> 322 </p>
305 <dl> 323 <dl>
306 324
307 <dt><i>line</i></dt> 325 <dt><i>line</i> (str)</dt>
308 <dd> 326 <dd>
309 directory line to split (string) 327 directory line to split
310 </dd> 328 </dd>
311 </dl> 329 </dl>
312 <dl> 330 <dl>
313 <dt>Return:</dt> 331 <dt>Return:</dt>
314 <dd> 332 <dd>
316 number of links, user, group, size, month, day, year or time 334 number of links, user, group, size, month, day, year or time
317 and name 335 and name
318 </dd> 336 </dd>
319 </dl> 337 </dl>
320 <dl> 338 <dl>
339 <dt>Return Type:</dt>
340 <dd>
341 tuple
342 </dd>
343 </dl>
344 <dl>
321 345
322 <dt>Raises <b>FtpDirLineParserError</b>:</dt> 346 <dt>Raises <b>FtpDirLineParserError</b>:</dt>
323 <dd> 347 <dd>
324 Raised if the line is not of a 348 Raised if the line is not of a
325 recognized Unix format. 349 recognized Unix format.
337 listings. It tries Unix style first and if that fails switches 361 listings. It tries Unix style first and if that fails switches
338 to Windows style. If that fails as well, an exception is raised. 362 to Windows style. If that fails as well, an exception is raised.
339 </p> 363 </p>
340 <dl> 364 <dl>
341 365
342 <dt><i>line</i></dt> 366 <dt><i>line</i> (str)</dt>
343 <dd> 367 <dd>
344 directory line to be parsed (string) 368 directory line to be parsed
345 </dd> 369 </dd>
346 </dl> 370 </dl>
347 <dl> 371 <dl>
348 <dt>Return:</dt> 372 <dt>Return:</dt>
349 <dd> 373 <dd>
350 URL info object containing the valid data (EricUrlInfo) 374 URL info object containing the valid data
375 </dd>
376 </dl>
377 <dl>
378 <dt>Return Type:</dt>
379 <dd>
380 EricUrlInfo
351 </dd> 381 </dd>
352 </dl> 382 </dl>
353 <div align="right"><a href="#top">Up</a></div> 383 <div align="right"><a href="#top">Up</a></div>
354 <hr /> 384 <hr />
355 <hr /> 385 <hr />

eric ide

mercurial