--- a/src/eric7/Documentation/Source/eric7.EricNetwork.EricFtp.html Thu Jan 04 17:16:15 2024 +0100 +++ b/src/eric7/Documentation/Source/eric7.EricNetwork.EricFtp.html Thu Jan 04 18:02:25 2024 +0100 @@ -7,20 +7,18 @@ <body> <a NAME="top" ID="top"></a> <h1>eric7.EricNetwork.EricFtp</h1> - <p> Module implementing an extension to the Python FTP class to support FTP proxies. </p> + <h3>Global Attributes</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Classes</h3> - <table> - <tr> <td><a href="#EricFtp">EricFtp</a></td> <td>Class implementing an extension to the Python FTP class to support FTP proxies.</td> @@ -34,36 +32,35 @@ <td>Class defining the supported FTP proxy types.</td> </tr> </table> + <h3>Functions</h3> - <table> <tr><td>None</td></tr> </table> + <hr /> <hr /> <a NAME="EricFtp" ID="EricFtp"></a> <h2>EricFtp</h2> - <p> Class implementing an extension to the Python FTP class to support FTP proxies. </p> + <h3>Derived from</h3> ftplib.FTP <h3>Class Attributes</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Class Methods</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Methods</h3> - <table> - <tr> <td><a href="#EricFtp.__init__">EricFtp</a></td> <td>Constructor</td> @@ -85,19 +82,20 @@ <td>Public method to set the proxy authentication info.</td> </tr> </table> + <h3>Static Methods</h3> - <table> <tr><td>None</td></tr> </table> + <a NAME="EricFtp.__init__" ID="EricFtp.__init__"></a> <h4>EricFtp (Constructor)</h4> <b>EricFtp</b>(<i>host="", user="", password="", acct="", proxyType=EricFtpProxyType.NO_PROXY, proxyHost="", proxyPort=ftplib.FTP_PORT, proxyUser="", proxyPassword="", proxyAccount="", timeout=_GLOBAL_DEFAULT_TIMEOUT, </i>) - <p> Constructor </p> + <dl> <dt><i>host</i> (str)</dt> @@ -148,7 +146,6 @@ <a NAME="EricFtp.connect" ID="EricFtp.connect"></a> <h4>EricFtp.connect</h4> <b>connect</b>(<i>host="", port=0, timeout=-999</i>) - <p> Public method to connect to the given FTP server. </p> @@ -157,6 +154,7 @@ if a proxy is to be used. It throws an exception, if the proxy data is incomplete. </p> + <dl> <dt><i>host</i> (str)</dt> @@ -194,7 +192,6 @@ <a NAME="EricFtp.login" ID="EricFtp.login"></a> <h4>EricFtp.login</h4> <b>login</b>(<i>user="", password="", acct=""</i>) - <p> Public method to login to the FTP server. </p> @@ -276,6 +273,7 @@ </dd> </dl> </p> + <dl> <dt><i>user</i> (str)</dt> @@ -317,10 +315,10 @@ <a NAME="EricFtp.setProxy" ID="EricFtp.setProxy"></a> <h4>EricFtp.setProxy</h4> <b>setProxy</b>(<i>proxyType=EricFtpProxyType.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> (EricFtpProxyType)</dt> @@ -351,10 +349,10 @@ <a NAME="EricFtp.setProxyAuthentication" ID="EricFtp.setProxyAuthentication"></a> <h4>EricFtp.setProxyAuthentication</h4> <b>setProxyAuthentication</b>(<i>proxyUser="", proxyPassword="", proxyAccount=""</i>) - <p> Public method to set the proxy authentication info. </p> + <dl> <dt><i>proxyUser</i> (str)</dt> @@ -375,7 +373,6 @@ <hr /> <a NAME="EricFtpProxyError" ID="EricFtpProxyError"></a> <h2>EricFtpProxyError</h2> - <p> Class to signal an error related to proxy configuration. </p> @@ -400,61 +397,70 @@ <li>992: proxy usage is enabled but no proxy password given</li> </ul> </p> + <h3>Derived from</h3> ftplib.Error <h3>Class Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Class Methods</h3> <table> <tr><td>None</td></tr> </table> -<h3>Class Methods</h3> +<h3>Methods</h3> <table> <tr><td>None</td></tr> </table> -<h3>Methods</h3> +<h3>Static Methods</h3> <table> <tr><td>None</td></tr> </table> -<h3>Static Methods</h3> -<table> -<tr><td>None</td></tr> -</table> <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> <a NAME="EricFtpProxyType" ID="EricFtpProxyType"></a> <h2>EricFtpProxyType</h2> - <p> Class defining the supported FTP proxy types. </p> + <h3>Derived from</h3> enum.Enum <h3>Class Attributes</h3> - <table> -<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> +<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> -<table> -<tr><td>None</td></tr> -</table> -<h3>Methods</h3> - -<table> -<tr><td>None</td></tr> -</table> -<h3>Static Methods</h3> - +<h3>Class Methods</h3> <table> <tr><td>None</td></tr> </table> +<h3>Methods</h3> +<table> +<tr><td>None</td></tr> +</table> + +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> + + <div align="right"><a href="#top">Up</a></div> <hr /> -</body></html> \ No newline at end of file +</body></html>