https://github.com/python/cpython/commit/24fa45b59f29e90cc37e83c4e2908b1377717f32 commit: 24fa45b59f29e90cc37e83c4e2908b1377717f32 branch: 3.12 author: Miss Islington (bot) <[email protected]> committer: erlend-aasland <[email protected]> date: 2024-01-21T11:33:23Z summary:
[3.12] Docs: mark up FTP() constructor with param list (GH-114359) (#114382) (cherry picked from commit 96c15b1c8d03db5b7b5b719214d9d156b317ba9d) Co-authored-by: Erlend E. Aasland <[email protected]> Co-authored-by: Hugo van Kemenade <[email protected]> files: M Doc/library/ftplib.rst diff --git a/Doc/library/ftplib.rst b/Doc/library/ftplib.rst index 16ad3a8b7f2d82..c4c5beb7b49525 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.: _______________________________________________ Python-checkins mailing list -- [email protected] To unsubscribe send an email to [email protected] https://mail.python.org/mailman3/lists/python-checkins.python.org/ Member address: [email protected]
