Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

Docs: mark up FTP() constructor with param list (#114359) 

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
This commit is contained in:
Erlend E. Aasland 2024-01-21 12:27:33 +01:00 committed by GitHub
parent 5adff3f86f
commit 96c15b1c8d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 36 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
Doc/library/ftplib.rst
View File

@ -55,17 +55,43 @@ Reference
FTP objects
^^^^^^^^^^^
.. class:: FTP(host='', user='', passwd='', acct='', timeout=None, source_address=None, *, encoding='utf-8')
.. 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.
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.: