Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code | Sign in
(14)

Side by Side Diff: Doc/library/ftplib.rst

Issue 18758: Fix internal references in the documentation
Patch Set: Created 6 years, 5 months ago
Left:
Right:
Use n/p to move between diff chunks; N/P to move between comments. Please Sign in to add in-line comments.
Jump to:
View unified diff | Download patch
« no previous file with comments | « Doc/library/fileinput.rst ('k') | Doc/library/http.server.rst » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 :mod:`ftplib` --- FTP protocol client 1 :mod:`ftplib` --- FTP protocol client
2 ===================================== 2 =====================================
3 3
4 .. module:: ftplib 4 .. module:: ftplib
5 :synopsis: FTP protocol client (requires sockets). 5 :synopsis: FTP protocol client (requires sockets).
6 6
7 7
8 .. index:: 8 .. index::
9 pair: FTP; protocol 9 pair: FTP; protocol
10 single: FTP; ftplib (standard module) 10 single: FTP; ftplib (standard module)
(...skipping 254 matching lines...) Expand 10 before | Expand all | Expand 10 after
265 .. method:: FTP.set_pasv(boolean) 265 .. method:: FTP.set_pasv(boolean)
266 266
267 Enable "passive" mode if *boolean* is true, other disable passive mode. 267 Enable "passive" mode if *boolean* is true, other disable passive mode.
268 Passive mode is on by default. 268 Passive mode is on by default.
269 269
270 270
271 .. method:: FTP.storbinary(cmd, file, blocksize=8192, callback=None, rest=None) 271 .. method:: FTP.storbinary(cmd, file, blocksize=8192, callback=None, rest=None)
272 272
273 Store a file in binary transfer mode. *cmd* should be an appropriate 273 Store a file in binary transfer mode. *cmd* should be an appropriate
274 ``STOR`` command: ``"STOR filename"``. *file* is a :term:`file object` 274 ``STOR`` command: ``"STOR filename"``. *file* is a :term:`file object`
275 (opened in binary mode) which is read until EOF using its :meth:`read` 275 (opened in binary mode) which is read until EOF using its :meth:`~io.IOBase.r ead`
276 method in blocks of size *blocksize* to provide the data to be stored. 276 method in blocks of size *blocksize* to provide the data to be stored.
277 The *blocksize* argument defaults to 8192. *callback* is an optional single 277 The *blocksize* argument defaults to 8192. *callback* is an optional single
278 parameter callable that is called on each block of data after it is sent. 278 parameter callable that is called on each block of data after it is sent.
279 *rest* means the same thing as in the :meth:`transfercmd` method. 279 *rest* means the same thing as in the :meth:`transfercmd` method.
280 280
281 .. versionchanged:: 3.2 281 .. versionchanged:: 3.2
282 *rest* parameter added. 282 *rest* parameter added.
283 283
284 284
285 .. method:: FTP.storlines(cmd, file, callback=None) 285 .. method:: FTP.storlines(cmd, file, callback=None)
286 286
287 Store a file in ASCII transfer mode. *cmd* should be an appropriate 287 Store a file in ASCII transfer mode. *cmd* should be an appropriate
288 ``STOR`` command (see :meth:`storbinary`). Lines are read until EOF from the 288 ``STOR`` command (see :meth:`storbinary`). Lines are read until EOF from the
289 :term:`file object` *file* (opened in binary mode) using its :meth:`readline` 289 :term:`file object` *file* (opened in binary mode) using its :meth:`~io.IOBas e.readline`
290 method to provide the data to be stored. *callback* is an optional single 290 method to provide the data to be stored. *callback* is an optional single
291 parameter callable that is called on each line after it is sent. 291 parameter callable that is called on each line after it is sent.
292 292
293 293
294 .. method:: FTP.transfercmd(cmd, rest=None) 294 .. method:: FTP.transfercmd(cmd, rest=None)
295 295
296 Initiate a transfer over the data connection. If the transfer is active, sen d a 296 Initiate a transfer over the data connection. If the transfer is active, sen d a
297 ``EPRT`` or ``PORT`` command and the transfer command specified by *cmd*, an d 297 ``EPRT`` or ``PORT`` command and the transfer command specified by *cmd*, an d
298 accept the connection. If the server is passive, send a ``EPSV`` or ``PASV`` 298 accept the connection. If the server is passive, send a ``EPSV`` or ``PASV``
299 command, connect to it, and start the transfer command. Either way, return t he 299 command, connect to it, and start the transfer command. Either way, return t he
(...skipping 135 matching lines...) Expand 10 before | Expand all | Expand 10 after
435 435
436 .. versionadded:: 3.3 436 .. versionadded:: 3.3
437 437
438 .. method:: FTP_TLS.prot_p() 438 .. method:: FTP_TLS.prot_p()
439 439
440 Set up secure data connection. 440 Set up secure data connection.
441 441
442 .. method:: FTP_TLS.prot_c() 442 .. method:: FTP_TLS.prot_c()
443 443
444 Set up clear text data connection. 444 Set up clear text data connection.
OLDNEW
« no previous file with comments | « Doc/library/fileinput.rst ('k') | Doc/library/http.server.rst » ('j') | no next file with comments »

RSS Feeds Recent Issues | This issue
This is Rietveld 894c83f36cb7+