https://github.com/python/cpython/commit/ec71690fcc53d99266c7eaf548172cdf6abd1a8b
commit: ec71690fcc53d99266c7eaf548172cdf6abd1a8b
branch: 3.11
author: Miss Islington (bot) <31488909+miss-isling...@users.noreply.github.com>
committer: erlend-aasland <erlend.aasl...@protonmail.com>
date: 2024-01-23T14:00:35Z
summary:
[3.11] Docs: mark up FTP.retrbinary and FTP.storbinary with param lists
(GH-114399) (#114484)
(cherry picked from commit 5277d4c7dbd1baee300e494fce2738cee218c243)
Co-authored-by: Erlend E. Aasland <erl...@python.org>
Co-authored-by: Ezio Melotti <ezio.melo...@gmail.com>
files:
M Doc/library/ftplib.rst
M Doc/tools/.nitignore
diff --git a/Doc/library/ftplib.rst b/Doc/library/ftplib.rst
index 93481c128a4588..9ac68316e7c75a 100644
--- a/Doc/library/ftplib.rst
+++ b/Doc/library/ftplib.rst
@@ -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)
@@ -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)
diff --git a/Doc/tools/.nitignore b/Doc/tools/.nitignore
index c173e6dd4fcb40..1e244bf325b38d 100644
--- a/Doc/tools/.nitignore
+++ b/Doc/tools/.nitignore
@@ -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
_______________________________________________
Python-checkins mailing list -- python-checkins@python.org
To unsubscribe send an email to python-checkins-le...@python.org
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: arch...@mail-archive.com
