home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 5 / DATAFILE_PDCD5.iso / utilities / p / python / pyhtmldoc / f / ftp_object < prev    next >
Text File  |  1996-11-14  |  7KB  |  123 lines
  1. <TITLE>FTP Objects -- Python library reference</TITLE>
  2. Prev: <A HREF="../f/ftplib" TYPE="Prev">ftplib</A>  
  3. Up: <A HREF="../f/ftplib" TYPE="Up">ftplib</A>  
  4. Top: <A HREF="../t/top" TYPE="Top">Top</A>  
  5. <H2>10.4.1. FTP Objects</H2>
  6. FTP instances have the following methods:
  7. <P>
  8. <DL><DT><B>set_debuglevel</B> (<VAR>level</VAR>) -- Method on FTP object<DD>
  9. Set the instance's debugging level.  This controls the amount of
  10. debugging output printed.  The default, 0, produces no debugging
  11. output.  A value of 1 produces a moderate amount of debugging output,
  12. generally a single line per request.  A value of 2 or higher produces
  13. the maximum amount of debugging output, logging each line sent and
  14. received on the control connection.
  15. </DL>
  16. <DL><DT><B>connect</B> (<VAR>host</VAR>[, <VAR>port</VAR>]) -- Method on FTP object<DD>
  17. Connect to the given host and port.  The default port number is 21, as
  18. specified by the FTP protocol specification.  It is rarely needed to
  19. specify a different port number.  This function should be called only
  20. once for each instance; it should not be called at all if a host was
  21. given when the instance was created.  All other methods can only be
  22. used after a connection has been made.
  23. </DL>
  24. <DL><DT><B>getwelcome</B> () -- Method on FTP object<DD>
  25. Return the welcome message sent by the server in reply to the initial
  26. connection.  (This message sometimes contains disclaimers or help
  27. information that may be relevant to the user.)
  28. </DL>
  29. <DL><DT><B>login</B> ([<VAR>user</VAR>[, <VAR>passwd</VAR>[, <VAR>acct</VAR>]]]) -- Method on FTP object<DD>
  30. Log in as the given <VAR>user</VAR>.  The <VAR>passwd</VAR> and <VAR>acct</VAR>
  31. parameters are optional and default to the empty string.  If no
  32. <VAR>user</VAR> is specified, it defaults to `<SAMP>anonymous</SAMP>'.  If
  33. <VAR>user</VAR> is <CODE>anonymous</CODE>, the default <VAR>passwd</VAR> is
  34. `<SAMP><VAR>realuser</VAR>@<VAR>host</VAR></SAMP>' where <VAR>realuser</VAR> is the real user
  35. name (glanced from the `<SAMP>LOGNAME</SAMP>' or `<SAMP>USER</SAMP>' environment
  36. variable) and <VAR>host</VAR> is the hostname as returned by
  37. <CODE>socket.gethostname()</CODE>.  This function should be called only
  38. once for each instance, after a connection has been established; it
  39. should not be called at all if a host and user were given when the
  40. instance was created.  Most FTP commands are only allowed after the
  41. client has logged in.
  42. </DL>
  43. <DL><DT><B>abort</B> () -- Method on FTP object<DD>
  44. Abort a file transfer that is in progress.  Using this does not always
  45. work, but it's worth a try.
  46. </DL>
  47. <DL><DT><B>sendcmd</B> (<VAR>command</VAR>) -- Method on FTP object<DD>
  48. Send a simple command string to the server and return the response
  49. string.
  50. </DL>
  51. <DL><DT><B>voidcmd</B> (<VAR>command</VAR>) -- Method on FTP object<DD>
  52. Send a simple command string to the server and handle the response.
  53. Return nothing if a response code in the range 200--299 is received.
  54. Raise an exception otherwise.
  55. </DL>
  56. <DL><DT><B>retrbinary</B> (<VAR>command</VAR>, <VAR>callback</VAR>, <VAR>maxblocksize</VAR>) -- Method on FTP object<DD>
  57. Retrieve a file in binary transfer mode.  <VAR>command</VAR> should be an
  58. appropriate `<SAMP>RETR</SAMP>' command, i.e. <CODE>"RETR <VAR>filename</VAR>"</CODE>.
  59. The <VAR>callback</VAR> function is called for each block of data received,
  60. with a single string argument giving the data block.
  61. The <VAR>maxblocksize</VAR> argument specifies the maximum block size
  62. (which may not be the actual size of the data blocks passed to
  63. <VAR>callback</VAR>).
  64. </DL>
  65. <DL><DT><B>retrlines</B> (<VAR>command</VAR>[, <VAR>callback</VAR>]) -- Method on FTP object<DD>
  66. Retrieve a file or directory listing in ASCII transfer mode.
  67. varcommand should be an appropriate `<SAMP>RETR</SAMP>' command (see
  68. <CODE>retrbinary()</CODE> or a `<SAMP>LIST</SAMP>' command (usually just the string
  69. <CODE>"LIST"</CODE>).  The <VAR>callback</VAR> function is called for each line,
  70. with the trailing CRLF stripped.  The default <VAR>callback</VAR> prints
  71. the line to <CODE>sys.stdout</CODE>.
  72. </DL>
  73. <DL><DT><B>storbinary</B> (<VAR>command</VAR>, <VAR>file</VAR>, <VAR>blocksize</VAR>) -- Method on FTP object<DD>
  74. Store a file in binary transfer mode.  <VAR>command</VAR> should be an
  75. appropriate `<SAMP>STOR</SAMP>' command, i.e. <CODE>"STOR <VAR>filename</VAR>"</CODE>.
  76. <VAR>file</VAR> is an open file object which is read until EOF using its
  77. <CODE>read()</CODE> method in blocks of size <VAR>blocksize</VAR> to provide the
  78. data to be stored.
  79. </DL>
  80. <DL><DT><B>storlines</B> (<VAR>command</VAR>, <VAR>file</VAR>) -- Method on FTP object<DD>
  81. Store a file in ASCII transfer mode.  <VAR>command</VAR> should be an
  82. appropriate `<SAMP>STOR</SAMP>' command (see <CODE>storbinary()</CODE>).  Lines are
  83. read until EOF from the open file object <VAR>file</VAR> using its
  84. <CODE>readline()</CODE> method to privide the data to be stored.
  85. </DL>
  86. <DL><DT><B>nlst</B> (<VAR>argument</VAR>[, @vardots]) -- Method on FTP object<DD>
  87. Return a list of files as returned by the `<SAMP>NLST</SAMP>' command.  The
  88. optional varargument is a directory to list (default is the current
  89. server directory).  Multiple arguments can be used to pass
  90. non-standard options to the `<SAMP>NLST</SAMP>' command.
  91. </DL>
  92. <DL><DT><B>dir</B> (<VAR>argument</VAR>[, @vardots]) -- Method on FTP object<DD>
  93. Return a directory listing as returned by the `<SAMP>LIST</SAMP>' command, as
  94. a list of lines.  The optional varargument is a directory to list
  95. (default is the current server directory).  Multiple arguments can be
  96. used to pass non-standard options to the `<SAMP>LIST</SAMP>' command.  If the
  97. last argument is a function, it is used as a <VAR>callback</VAR> function
  98. as for <CODE>retrlines()</CODE>.
  99. </DL>
  100. <DL><DT><B>rename</B> (<VAR>fromname</VAR>, <VAR>toname</VAR>) -- Method on FTP object<DD>
  101. Rename file <VAR>fromname</VAR> on the server to <VAR>toname</VAR>.
  102. </DL>
  103. <DL><DT><B>cwd</B> (<VAR>pathname</VAR>) -- Method on FTP object<DD>
  104. Set the current directory on the server.
  105. </DL>
  106. <DL><DT><B>mkd</B> (<VAR>pathname</VAR>) -- Method on FTP object<DD>
  107. Create a new directory on the server.
  108. </DL>
  109. <DL><DT><B>pwd</B> () -- Method on FTP object<DD>
  110. Return the pathname of the current directory on the server.
  111. </DL>
  112. <DL><DT><B>quit</B> () -- Method on FTP object<DD>
  113. Send a `<SAMP>QUIT</SAMP>' command to the server and close the connection.
  114. This is the ``polite'' way to close a connection, but it may raise an
  115. exception of the server reponds with an error to the <CODE>QUIT</CODE>
  116. command.
  117. </DL>
  118. <DL><DT><B>close</B> () -- Method on FTP object<DD>
  119. Close the connection unilaterally.  This should not be applied to an
  120. already closed connection (e.g. after a successful call to
  121. <CODE>quit()</CODE>.
  122. </DL>
  123.