Python FTP action Scripts & common functions

Requirements: Fast ftp upload, download, query files

Originally operated directly under the shell:

Need to "Connect, lose user name, lose password, single file operation, there is a timeout limit"

Too cumbersome, easy to operate failed

Scripting improvements:

A command, take care of multi-file upload, download, query, list and other operations

Later, you can add more powerful features

Directly on the script:

2. #!/usr/bin/python
4. #ftp. py
6. #this script is used to make some FTP operations more convenient
8. #add upload and download operations 20111210 version0.1
12. Import Sys,os,ftplib,socket
16. Const_host = "Your ftp HOST or IP"
18. Const_username = "Your USERNAME"
20. Const_pwd = "Your password"
22. Const_buffer_size = 8192
26. Color_none = "\033[m"
28. Color_green = "\033[01;32m"
30. color_red = "\033[01;31m"
32. Color_yellow = "\033[01;33m"
36. Def connect ():
38. Try:
40. FTP = Ftplib. FTP (Const_host)
42. Ftp.login (CONST_USERNAME,CONST_PWD)
44. return FTP
46. except Socket.error,socket.gaierror:
48. print ("FTP is unavailable,please check the host,username and password!")
50. Sys.exit (0)
54. def disconnect (FTP):
56. Ftp.quit ()
60. def upload (FTP, filepath):
62. f = open (filepath, "RB")
64. file_name = Os.path.split (filepath) [-1]
66. Try:
68. Ftp.storbinary (' STOR%s '%file_name, F, const_buffer_size)
70. except Ftplib.error_perm:
72. return False
74. return True
78. def download (FTP, filename):
80. f = open (filename,"WB"). Write
82. Try:
84. Ftp.retrbinary ("RETR%s"%filename, F, const_buffer_size)
86. except Ftplib.error_perm:
88. return False
90. return True
94. def list (FTP):
96. Ftp.dir ()
100. def find (Ftp,filename):
102. Ftp_f_list = Ftp.nlst ()
104. if filename in ftp_f_list:
106. return True
108. Else:
110. return False
114. def help ():
116. print ("Help info:")
118. Print ("[./ftp.py l]\t Show the file list of the FTP site")
120. Print ("[./ftp.py f Filenama filenameb]\t Check if the file is in the FTP site")
122. Print ("[./ftp.py p Filenamea filenameb]\t upload file into FTP site")
124. Print ("[./ftp.py g Filenamea filenameb]\t get file from FTP site")
126. Print ("[./ftp.py h]\t Show Help Info")
128. Print ("Other params is invalid")
134. def main ():
136. args = sys.argv[1:]
138. if Len (args) = = 0:
140. print ("Params needed!")
142. Sys.exit (0)
146. FTP = Connect ()
150. if args[0] = = "P":
152. F_list = args[1:]
154. For Up_file in f_list:
156. If not os.path.exists (up_file):
158. print ("UPLOAD:%s" +color_red+"FAILED" +color_none+": File not Exist")%up_file)
160. Continue
162. elif not os.path.isfile (up_file):
164. print ("UPLOAD:%s" +color_red+"FAILED" +color_none+":%s is not a file")% (up_file,up_file))
166. Continue
170. if Upload (FTP, up_file):
172. Print (("UPLOAD:%s" +color_green+"SUCCESS" +color_none)%up_file)
174. Else:
176. Print (("UPLOAD:%s" +color_red+"FAILED" +color_none)%up_file)
178. elif args[0] = = "G":
180. F_list = args[1:]
182. For Down_file in f_list:
184. If not find (ftp,down_file):
186. print ("DOWNLOAD:%s" +color_red+"FAILED" +color_none+":%s is not in the FTP site")% (Down_file,down_ file))
188. Continue
192. if Download (FTP, down_file):
194. Print (("DOWNLOAD:%s" +color_green+"SUCCESS" +color_none)%down_file)
196. Else:
198. Print (("DOWNLOAD:%s" +color_red+"FAILED" +color_none)%down_file)
202. elif args[0] = = "L":
204. List (FTP)
206. elif args[0] = = "F":
208. F_list = args[1:]
210. For F_file in f_list:
212. if Find (ftp,f_file):
214. Print (("SEARCH:%s" +color_green+"EXIST" +color_none)%f_file)
216. Else:
218. print ("SEARCH:%s" +color_red+"not EXIST" +color_none)%f_file)
222. elif args[0] = = "h":
224. Help ()
226. Else:
228. print ("args is invalid!")
230. Help ()
234. Disconnect (FTP)
242. if __name__ = = "__main__":
244. Main ()

Common functions:

In the manual view, the following is only brief, because useless, [to be sorted]:

Login (user= ', passwd= ', acct= ') to the FTP server, all parameters are optional
PWD () Current working directory
CWD (path) sets the current working directory to Path
Dir ([path[,...    [, CB]]) Displays the contents of the path directory, the optional parameter CB is a callback function that is passed to the Retrlines () method
Nlst ([path[,...]) is similar to Dir (), but returns a list of file names instead of displaying them
Retrlines (cmd [, CB]) given an FTP command (such as "RETR filename") for downloading a text file. Optional callback function CB is used to process each line of the file
Retrbinary (cmd, cb[,bs=8192[, RA]) is similar to Retrlines (), except that this instruction handles binary files. The callback function CB is used to process each piece of data downloaded (The block size defaults to 8K).
Storlines (cmd, f) is given an FTP command (such as "STOR filename") to upload a text file. To be given a file object F
Storbinary (cmd, f[,bs=8192]) is similar to Storlines (), except that this instruction handles binary files. To give a file object F, the upload block size BS defaults to 8kbs=8192])
Rename (old, new) rename the remote file old to new
Delete (path) deletes the remote file located in path
MKD (directory) to create a remote directory

Python FTP action Scripts & common functions