eric: comparison E5Network/E5Ftp.py

-:7efa8b8b6903
+:583beaf0b4b8
 # Copyright (c) 2012 - 2013 Detlev Offenbach <detlev@die-offenbachs.de>
 #
 """
-Module implementing an extension to the Python FTP class to support FTP proxies.
+Module implementing an extension to the Python FTP class to support FTP
+proxies.
 """
 import ftplib
 from socket import _GLOBAL_DEFAULT_TIMEOUT
 Class to signal an error related to proxy configuration.
 The error message starts with a three digit error code followed by a
 space and the error string. Supported error codes are:
 <ul>
-<li>910: proxy error; the second number gives the category of the proxy error.
+<li>910: proxy error; the second number gives the category of the proxy
-The original response from the proxy is appended in the next line.</li>
+error. The original response from the proxy is appended in the next
-<li>930: proxy error; the second number gives the category of the proxy error.
+line.</li>
-The original response from the proxy is appended in the next line.</li>
+<li>930: proxy error; the second number gives the category of the proxy
-<li>940: proxy error; the second number gives the category of the proxy error.
+error. The original response from the proxy is appended in the next
-The original response from the proxy is appended in the next line.</li>
+line.</li>
-<li>950: proxy error; the second number gives the category of the proxy error.
+<li>940: proxy error; the second number gives the category of the proxy
-The original response from the proxy is appended in the next line.</li>
+error. The original response from the proxy is appended in the next
+line.</li>
+<li>950: proxy error; the second number gives the category of the proxy
+error. The original response from the proxy is appended in the next
+line.</li>
 <li>990: proxy usage is enabled but no proxy host given</li>
 <li>991: proxy usage is enabled but no proxy user given</li>
 <li>992: proxy usage is enabled but no proxy password given</li>
 </ul>
 """
 Site = 3                        # proxy login first, than use SITE command
 Open = 4                        # proxy login first, than use OPEN command
 UserAtProxyuserAtServer = 5     # one login for both
 ProxyuserAtServer = 6           # proxy login with remote host given, than
 # normal remote login
-AuthResp = 7                    # authenticate to proxy with AUTH and RESP commands
+AuthResp = 7                    # authenticate to proxy with AUTH and
+# RESP commands
 Bluecoat = 8                    # bluecoat proxy
 class E5Ftp(ftplib.FTP):
 """
-Class implementing an extension to the Python FTP class to support FTP proxies.
+Class implementing an extension to the Python FTP class to support FTP
+proxies.
 """
 def __init__(self, host="", user="", password="", acct="",
-proxyType=E5FtpProxyType.NoProxy, proxyHost="", proxyPort=ftplib.FTP_PORT,
+proxyType=E5FtpProxyType.NoProxy, proxyHost="",
-proxyUser="", proxyPassword="", proxyAccount="",
+proxyPort=ftplib.FTP_PORT, proxyUser="", proxyPassword="",
-timeout=_GLOBAL_DEFAULT_TIMEOUT):
+proxyAccount="", timeout=_GLOBAL_DEFAULT_TIMEOUT):
 """
 Constructor
 @param host name of the FTP host (string)
 @param user user name for login to FTP host (string)
 self.connect(host)
 if user:
 self.login(user, password, acct)
 def setProxy(self, proxyType=E5FtpProxyType.NoProxy, proxyHost="",
-proxyPort=ftplib.FTP_PORT, proxyUser="", proxyPassword="", proxyAccount=""):
+proxyPort=ftplib.FTP_PORT, proxyUser="", proxyPassword="",
+proxyAccount=""):
 """
 Public method to set the proxy configuration.
 @param proxyType type of the FTP proxy (integer 0 to 8)
 @param proxyHost name of the FTP proxy (string)
 self.__proxyPort = proxyPort
 self.__proxyUser = proxyUser
 self.__proxyPassword = proxyPassword
 self.__proxyAccount = proxyAccount
-def setProxyAuthentication(self, proxyUser="", proxyPassword="", proxyAccount=""):
+def setProxyAuthentication(self, proxyUser="", proxyPassword="",
+proxyAccount=""):
 """
 Public method to set the proxy authentication info.
 @param proxyUser user name for login to the proxy (string)
 @param proxyPassword password  for login to the proxy (string)
 if self.__proxyType != E5FtpProxyType.NoProxy:
 if not self.__proxyHost:
 raise E5FtpProxyError(
 "990 Proxy usage requested, but no proxy host given.")
-return super().connect(self.__proxyHost, self.__proxyPort, self.__timeout)
+return super().connect(
+self.__proxyHost, self.__proxyPort, self.__timeout)
 else:
 return super().connect(self.__host, self.__port, self.__timeout)
 def login(self, user="", password="", acct=""):
 """
 Public method to login to the FTP server.
-This extended method respects the FTP proxy configuration. There are many
+This extended method respects the FTP proxy configuration. There are
-different FTP proxy products available. But unfortunately there is no
+many different FTP proxy products available. But unfortunately there
-standard for how o traverse a FTP proxy. The lis below shows the sequence
+is no standard for how o traverse a FTP proxy. The lis below shows
-of commands used.
+the sequence of commands used.
 <table>
 <tr><td>user</td><td>Username for remote host</td></tr>
 <tr><td>pass</td><td>Password for remote host</td></tr>
 <tr><td>pruser</td><td>Username for FTP proxy</td></tr>
 <tr><td>prpass</td><td>Password for FTP proxy</td></tr>
-<tr><td>remote.host</td><td>Hostname of the remote FTP server</td></tr>
+<tr><td>remote.host</td><td>Hostname of the remote FTP server</td>
+</tr>
 </table>
 <dl>
 <dt>E5FtpProxyType.NoProxy:</dt>
 <dd>
 if not self.__proxyUser:
 raise E5FtpProxyError(
 "991 Proxy usage requested, but no proxy user given")
 if not self.__proxyPassword:
 raise E5FtpProxyError(
-"992 Proxy usage requested, but no proxy password given")
+"992 Proxy usage requested, but no proxy password"
+" given")
 if self.__proxyType in [E5FtpProxyType.NonAuthorizing,
 E5FtpProxyType.AuthResp, E5FtpProxyType.Bluecoat]:
 user += "@" + self.__host
 if self.__proxyType == E5FtpProxyType.Bluecoat:
 user += " " + self.__proxyUser
 acct = self.__proxyPassword
 elif self.__proxyType == E5FtpProxyType.UserAtProxyuserAtServer:
-user = "{0}@{1}@{2}".format(user, self.__proxyUser, self.__host)
+user = "{0}@{1}@{2}".format(
+user, self.__proxyUser, self.__host)
 password = "{0}@{1}".format(password, self.__proxyPassword)
 else:
 pruser = self.__proxyUser
 if self.__proxyType == E5FtpProxyType.UserAtServer:
 user += "@" + self.__host
 if presp[0] == "3":
 presp = self.sendcmd("PASS " + self.__proxyPassword)
 if presp[0] == "3" and self.__proxyAccount:
 presp = self.sendcmd("ACCT " + self.__proxyAccount)
 if presp[0] != "2":
-raise E5FtpProxyError("9{0}0 Error authorizing at proxy\n{1}".format(
+raise E5FtpProxyError(
+"9{0}0 Error authorizing at proxy\n{1}".format(
 presp[0], presp))
 if self.__proxyType == E5FtpProxyType.Site:
 # send SITE command
 presp = self.sendcmd("SITE " + self.__host)
 # authorize to the FTP proxy
 presp = self.sendcmd("AUTH " + self.__proxyUser)
 if presp[0] == "3":
 presp = self.sendcmd("RESP " + self.__proxyPassword)
 if presp[0] != "2":
-raise E5FtpProxyError("9{0}0 Error authorizing at proxy\n{1}".format(
+raise E5FtpProxyError(
+"9{0}0 Error authorizing at proxy\n{1}".format(
 presp[0], presp))
 return resp

Mercurial Repositories > eric / file comparison

comparison: E5Network/E5Ftp.py

E5Network/E5Ftp.py