Skip to content

[3.11] Docs: mark up FTP.retrbinary and FTP.storbinary with param lists (GH-114399) #114484

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 46 additions & 16 deletions Doc/library/ftplib.rst
Original file line number Diff line number Diff line change
Expand Up @@ -201,14 +201,27 @@ FTP objects

.. method:: FTP.retrbinary(cmd, callback, blocksize=8192, rest=None)

Retrieve a file in binary transfer mode. *cmd* should be an appropriate
``RETR`` command: ``'RETR filename'``. The *callback* function is called for
each block of data received, with a single bytes argument giving the data
block. The optional *blocksize* argument specifies the maximum chunk size to
read on the low-level socket object created to do the actual transfer (which
will also be the largest size of the data blocks passed to *callback*). A
reasonable default is chosen. *rest* means the same thing as in the
:meth:`transfercmd` method.
Retrieve a file in binary transfer mode.

:param str cmd:
An appropriate ``STOR`` command: :samp:`"STOR {filename}"`.

:param callback:
A single parameter callable that is called
for each block of data received,
with its single argument being the data as :class:`bytes`.
:type callback: :term:`callable`

:param int blocksize:
The maximum chunk size to read on the low-level
:class:`~socket.socket` object created to do the actual transfer.
This also corresponds to the largest size of data
that will be passed to *callback*.
Defaults to ``8192``.

:param int rest:
A ``REST`` command to be sent to the server.
See the documentation for the *rest* parameter of the :meth:`transfercmd` method.


.. method:: FTP.retrlines(cmd, callback=None)
Expand All @@ -232,16 +245,33 @@ FTP objects

.. method:: FTP.storbinary(cmd, fp, blocksize=8192, callback=None, rest=None)

Store a file in binary transfer mode. *cmd* should be an appropriate
``STOR`` command: ``"STOR filename"``. *fp* is a :term:`file object`
(opened in binary mode) which is read until EOF using its :meth:`~io.IOBase.read`
method in blocks of size *blocksize* to provide the data to be stored.
The *blocksize* argument defaults to 8192. *callback* is an optional single
parameter callable that is called on each block of data after it is sent.
*rest* means the same thing as in the :meth:`transfercmd` method.
Store a file in binary transfer mode.

:param str cmd:
An appropriate ``STOR`` command: :samp:`"STOR {filename}"`.

:param fp:
A file object (opened in binary mode) which is read until EOF,
using its :meth:`~io.RawIOBase.read` method in blocks of size *blocksize*
to provide the data to be stored.
:type fp: :term:`file object`

:param int blocksize:
The read block size.
Defaults to ``8192``.

:param callback:
A single parameter callable that is called
for each block of data sent,
with its single argument being the data as :class:`bytes`.
:type callback: :term:`callable`

:param int rest:
A ``REST`` command to be sent to the server.
See the documentation for the *rest* parameter of the :meth:`transfercmd` method.

.. versionchanged:: 3.2
*rest* parameter added.
The *rest* parameter was added.


.. method:: FTP.storlines(cmd, fp, callback=None)
Expand Down
1 change: 0 additions & 1 deletion Doc/tools/.nitignore
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,6 @@ Doc/library/enum.rst
Doc/library/exceptions.rst
Doc/library/faulthandler.rst
Doc/library/fcntl.rst
Doc/library/ftplib.rst
Doc/library/functools.rst
Doc/library/http.cookiejar.rst
Doc/library/http.server.rst
Expand Down