diff options
| author | Erlend E. Aasland <erlend@python.org> | 2024-01-21 11:27:33 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-01-21 11:27:33 (GMT) |
| commit | 96c15b1c8d03db5b7b5b719214d9d156b317ba9d (patch) | |
| tree | 6cfccef9ccf102a0919928022216195055f36e6e /Doc | |
| parent | 5adff3f86ff92cbd27380ad88357c77b330af6e1 (diff) | |
| download | cpython-96c15b1c8d03db5b7b5b719214d9d156b317ba9d.zip cpython-96c15b1c8d03db5b7b5b719214d9d156b317ba9d.tar.gz cpython-96c15b1c8d03db5b7b5b719214d9d156b317ba9d.tar.bz2 | |
Docs: mark up FTP() constructor with param list (#114359)
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Diffstat (limited to 'Doc')
| -rw-r--r-- | Doc/library/ftplib.rst | 48 |
1 files changed, 37 insertions, 11 deletions
diff --git a/Doc/library/ftplib.rst b/Doc/library/ftplib.rst index 16ad3a8..c4c5beb 100644 --- a/Doc/library/ftplib.rst +++ b/Doc/library/ftplib.rst @@ -55,17 +55,43 @@ Reference FTP objects ^^^^^^^^^^^ -.. class:: FTP(host='', user='', passwd='', acct='', timeout=None, source_address=None, *, encoding='utf-8') - - Return a new instance of the :class:`FTP` class. When *host* is given, the - method call ``connect(host)`` is made. When *user* is given, additionally - the method call ``login(user, passwd, acct)`` is made (where *passwd* and - *acct* default to the empty string when not given). The optional *timeout* - parameter specifies a timeout in seconds for blocking operations like the - connection attempt (if is not specified, the global default timeout setting - will be used). *source_address* is a 2-tuple ``(host, port)`` for the socket - to bind to as its source address before connecting. The *encoding* parameter - specifies the encoding for directories and filenames. +.. class:: FTP(host='', user='', passwd='', acct='', timeout=None, \ + source_address=None, *, encoding='utf-8') + + Return a new instance of the :class:`FTP` class. + When *host* is given, the method call :meth:`connect(host) <connect>` + is made by the constructor. + When *user* is given, additionally the method call + :meth:`login(user, passwd, acct) <connect>` is made. + + :param str host: + The hostname to connect to. + + :param str user: + The username to log in with. + If empty string, ``"anonymous"`` is used. + + :param str passwd: + The password to use when logging in. + If not given, and if *passwd* is the empty string or ``"-"``, + a password will be automatically generated. + + :param str acct: + Account information; see the ACCT FTP command. + + :param timeout: + A timeout in seconds for blocking operations like :meth:`connect`. + If not specified, the global default timeout setting will be used. + :type timeout: int | None + + :param source_address: + *source_address* is a 2-tuple ``(host, port)`` for the socket + to bind to as its source address before connecting. + :type source_address: tuple | None + + :param str encoding: + The *encoding* parameter specifies the encoding + for directories and filenames. The :class:`FTP` class supports the :keyword:`with` statement, e.g.: |