--- a/eric6/Documentation/Source/eric6.E5Network.E5Ftp.html Sun May 02 18:13:23 2021 +0200 +++ b/eric6/Documentation/Source/eric6.E5Network.E5Ftp.html Sun May 02 18:14:11 2021 +0200 @@ -107,56 +107,56 @@ <a NAME="E5Ftp.__init__" ID="E5Ftp.__init__"></a> <h4>E5Ftp (Constructor)</h4> -<b>E5Ftp</b>(<i>host="", user="", password="", acct="", proxyType=E5FtpProxyType.NoProxy, proxyHost="", proxyPort=ftplib.FTP_PORT, proxyUser="", proxyPassword="", proxyAccount="", timeout=_GLOBAL_DEFAULT_TIMEOUT</i>) +<b>E5Ftp</b>(<i>host="", user="", password="", acct="", proxyType=E5FtpProxyType.NO_PROXY, proxyHost="", proxyPort=ftplib.FTP_PORT, proxyUser="", proxyPassword="", proxyAccount="", timeout=_GLOBAL_DEFAULT_TIMEOUT</i>) <p> Constructor </p> <dl> -<dt><i>host</i></dt> +<dt><i>host</i> (str)</dt> <dd> -name of the FTP host (string) +name of the FTP host </dd> -<dt><i>user</i></dt> +<dt><i>user</i> (str)</dt> <dd> -user name for login to FTP host (string) +user name for login to FTP host </dd> -<dt><i>password</i></dt> +<dt><i>password</i> (str)</dt> <dd> -password for login to FTP host (string) +password for login to FTP host </dd> -<dt><i>acct</i></dt> +<dt><i>acct</i> (str)</dt> <dd> -account for login to FTP host (string) +account for login to FTP host </dd> -<dt><i>proxyType</i></dt> +<dt><i>proxyType</i> (E5FtpProxyType)</dt> <dd> -type of the FTP proxy (integer 0 to 8) +type of the FTP proxy </dd> -<dt><i>proxyHost</i></dt> +<dt><i>proxyHost</i> (str)</dt> <dd> -name of the FTP proxy (string) +name of the FTP proxy </dd> -<dt><i>proxyPort</i></dt> +<dt><i>proxyPort</i> (int)</dt> <dd> -port of the FTP proxy (integer) +port of the FTP proxy </dd> -<dt><i>proxyUser</i></dt> +<dt><i>proxyUser</i> (str)</dt> <dd> -user name for login to the proxy (string) +user name for login to the proxy </dd> -<dt><i>proxyPassword</i></dt> +<dt><i>proxyPassword</i> (str)</dt> <dd> -password for login to the proxy (string) +password for login to the proxy </dd> -<dt><i>proxyAccount</i></dt> +<dt><i>proxyAccount</i> (str)</dt> <dd> -accounting info for the proxy (string) +accounting info for the proxy </dd> -<dt><i>timeout</i></dt> +<dt><i>timeout</i> (int)</dt> <dd> -timeout in seconds for blocking operations (integer) +timeout in seconds for blocking operations </dd> </dl> <a NAME="E5Ftp.connect" ID="E5Ftp.connect"></a> @@ -173,23 +173,29 @@ </p> <dl> -<dt><i>host</i></dt> +<dt><i>host</i> (str)</dt> <dd> -name of the FTP host (string) +name of the FTP host </dd> -<dt><i>port</i></dt> +<dt><i>port</i> (int)</dt> <dd> -port of the FTP host (integer) +port of the FTP host </dd> -<dt><i>timeout</i></dt> +<dt><i>timeout</i> (int)</dt> <dd> -timeout in seconds for blocking operations (integer) +timeout in seconds for blocking operations </dd> </dl> <dl> <dt>Return:</dt> <dd> -welcome message of the server (string) +welcome message of the server +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <dl> @@ -205,36 +211,36 @@ <a NAME="E5Ftp.setProxy" ID="E5Ftp.setProxy"></a> <h4>E5Ftp.setProxy</h4> -<b>setProxy</b>(<i>proxyType=E5FtpProxyType.NoProxy, proxyHost="", proxyPort=ftplib.FTP_PORT, proxyUser="", proxyPassword="", proxyAccount=""</i>) +<b>setProxy</b>(<i>proxyType=E5FtpProxyType.NO_PROXY, proxyHost="", proxyPort=ftplib.FTP_PORT, proxyUser="", proxyPassword="", proxyAccount=""</i>) <p> Public method to set the proxy configuration. </p> <dl> -<dt><i>proxyType</i></dt> +<dt><i>proxyType</i> (E5FtpProxyType)</dt> <dd> -type of the FTP proxy (integer 0 to 8) +type of the FTP proxy </dd> -<dt><i>proxyHost</i></dt> +<dt><i>proxyHost</i> (str)</dt> <dd> -name of the FTP proxy (string) +name of the FTP proxy </dd> -<dt><i>proxyPort</i></dt> +<dt><i>proxyPort</i> (int)</dt> <dd> -port of the FTP proxy (integer) +port of the FTP proxy </dd> -<dt><i>proxyUser</i></dt> +<dt><i>proxyUser</i> (str)</dt> <dd> -user name for login to the proxy (string) +user name for login to the proxy </dd> -<dt><i>proxyPassword</i></dt> +<dt><i>proxyPassword</i> (str)</dt> <dd> -password for login to the proxy (string) +password for login to the proxy </dd> -<dt><i>proxyAccount</i></dt> +<dt><i>proxyAccount</i> (str)</dt> <dd> -accounting info for the proxy (string) +accounting info for the proxy </dd> </dl> <a NAME="E5Ftp.setProxyAuthentication" ID="E5Ftp.setProxyAuthentication"></a> @@ -246,17 +252,17 @@ </p> <dl> -<dt><i>proxyUser</i></dt> +<dt><i>proxyUser</i> (str)</dt> <dd> -user name for login to the proxy (string) +user name for login to the proxy </dd> -<dt><i>proxyPassword</i></dt> +<dt><i>proxyPassword</i> (str)</dt> <dd> -password for login to the proxy (string) +password for login to the proxy </dd> -<dt><i>proxyAccount</i></dt> +<dt><i>proxyAccount</i> (str)</dt> <dd> -accounting info for the proxy (string) +accounting info for the proxy </dd> </dl> <div align="right"><a href="#top">Up</a></div> @@ -322,11 +328,11 @@ Class defining the supported FTP proxy types. </p> <h3>Derived from</h3> -None +enum.Enum <h3>Class Attributes</h3> <table> -<tr><td>AuthResp</td></tr><tr><td>Bluecoat</td></tr><tr><td>NoProxy</td></tr><tr><td>NonAuthorizing</td></tr><tr><td>Open</td></tr><tr><td>ProxyuserAtServer</td></tr><tr><td>Site</td></tr><tr><td>UserAtProxyuserAtServer</td></tr><tr><td>UserAtServer</td></tr> +<tr><td>AUTH_RESP</td></tr><tr><td>BLUECOAT</td></tr><tr><td>NON_AUTHORIZING</td></tr><tr><td>NO_PROXY</td></tr><tr><td>OPEN</td></tr><tr><td>PROXYUSER_SERVER</td></tr><tr><td>SITE</td></tr><tr><td>USER_PROXYUSER_SERVER</td></tr><tr><td>USER_SERVER</td></tr> </table> <h3>Class Methods</h3>