11.4.1 FTP オブジェクト

FTP インスタンスは以下のメソッドを持ちます:

set_debuglevel (level)

インスタンスのデバッグレベルを設定します。 これはデバッグ出力の量を制御します。 デフォルトは0で、デバッグ出力はありません。 1は適度な量のデバッグ出力(たいていは要求ごとに１行の)をします。 2は最もたくさんのデバッグ出力があり、 制御接続の送信・受信がすべてロギングされます。

connect (host[, port])

与えられたホストに指定のポートで接続します。 デフォルトのポート番号は FTPプロトコルで決められている21です。 これはまれに別のポート番号である場合があります。 この関数はそれぞれのインスタンスで一度だけ呼ばれる必要があります; ホスト名を指定してインスタンスを生成したときは呼ぶ必要はありません。 ほかのメソッドすべては、接続が完了してからのみ使うことができます。

getwelcome ()

接続したときに、サーバから送られるウェルカムメッセージを返します。 (このメッセージは免責事項や、ユーザへの適切な情報を含んでいることがあります。)

login ([user[, passwd[, acct]]])

userでログインします。 passwdとacctはオプションで、デフォルトでは空です。 userを指定しないと、'anonymous'になります。 userが'anonymous'のとき、passwdのデフォルトは "realuser@host" で、realuserは、 実ユーザ名 ($LOGNAME か $USER 環境変数から得られる) で、host はsocket.gethostname()で返されるホスト名です。 この関数は接続が完了した後で一回だけ使用されなければなりません; ホストとユーザを指定してインスタンスを生成したときは使う必要はありません。 ほとんどの FTPコマンドは、クライアントがログインしてからのみ使えます。

abort ()

進行中のファイル転送を中断します。 いつでも中断できるとは限りませんが、やってみる価値はあるでしょう。

sendcmd (command)

単純なコマンド文字列を送り、結果を返します。

voidcmd (command)

単純なコマンド文字列を送り、結果を解析します。 応答コードが 200-299のとき、何も返しません。 それ以外なら例外を発生させます。

retrbinary (command, callback[, maxblocksize])

バイナリモードでファイルを受信します。 commandはたとえば'RETR filename'のような適切な "RETR"コマンドである必要があります。 データブロックを受信する毎に、 データブロックを引数としてcallback関数が実行されます。 オプションの maxblocksize引数は、低レベルのソケットオブジェクトが 実際に転送を行うときの最大チャンクサイズを指定します。 (これはcallbackまでの最大のデータブロックサイズにもなります。) これはデフォルトで適切な値になっています。

retrlines (command[, callback])

ASCIIモードでディレクトリのリストを取得します。 commandは適切な"RETR"コマンドである必要があります。 (retbinaryか"LIST"コマンドの項参照 (普通は単に'LIST'))。 CRLFで区切られる行ごとに、callback関数が呼ばれます。 デフォルトではcallbackはsys.stdoutに行を出力します。

storbinary (command, file, blocksize)

バイナリモードでファイルを送信します。 commandは"STOR filename"のような適切な"STOR" コマンドでなければなりません。 fileはオープンしてあるファイルオブジェクトで、 read()メソッドでblocksizeごとにEOFまで読まれます。

storlines (command, file)

ASCIIモードでファイルを送信します。 commandは適切な"STOR"コマンド(storbinaryを参照) でなければなりません。 送信データは、オープン済みのfileオブジェクトから readline()メソッドでEOFまで読み取られます。

nlst (argument[, ...])

"NLST"コマンドによって返されるファイルのリストを返します。 オプションargumentはリストするディレクトリを指定します (デフォルトはカレントディレクトリです)。 複数の引数は"NLST"コマンドに標準でないオプションを渡すのに使われます。

dir (argument[, ...])

"LIST"コマンドによって返されるファイルのリストを返します。 オプションargumentはリストするディレクトリを指定します (デフォルトはカレントディレクトリです)。 複数の引数は"LIST"コマンドに標準でないオプションを渡すのに使われます。 最後の引数が関数のとき、retrlinesに対するcallback関数として 使われます。

rename (fromname, toname)

サーバのファイルを fromnameからtonameに変えます。

cwd (pathname)

サーバのカレントディレクトリを設定します。

mkd (pathname)

サーバ上に新しいディレクトリを作成します。

pwd ()

サーバ上のカレントディレクトリのパス名を返します。

quit ()

サーバに"QUIT"コマンドを送り、接続を閉じます。 これは「上品な」接続の閉じ方ですが、 "QUIT"コマンドに対しサーバがエラーを返した場合には 例外が発生することがあります。

close ()

一方的に接続を閉じます。 これはすでに閉じられた接続に対して (例えばquit()が成功した後で) 使用します。