初心者向けPython ftplibガイド:FTP接続からファイル操作まで
ftplib
は、Pythonの標準ライブラリに含まれるモジュールで、FTP (File Transfer Protocol) クライアントを実装するための機能を提供します。FTPは、ネットワーク上でファイルを転送するためのプロトコルであり、ftplib
を使うことで、PythonプログラムからFTPサーバーに接続し、ファイルのアップロード、ダウンロード、ディレクトリの操作などを行うことができます。
ftplib
でできること
ftplib
を使うと、主に以下のようなFTP操作が可能です。
- FTP接続の切断: サーバーからログアウトし、接続を閉じます (
quit()
,close()
)。 - ファイルの転送:
- ファイルのダウンロード (
retrbinary()
,retrlines()
) - ファイルのアップロード (
storbinary()
,storlines()
) - ファイルのリネーム (
rename()
) - ファイルの削除 (
delete()
)
- ファイルのダウンロード (
- ディレクトリの操作:
- カレントディレクトリの変更 (
cwd()
) - カレントディレクトリの取得 (
pwd()
) - ディレクトリ内のファイルやディレクトリの一覧表示 (
nlst()
,dir()
) - 新しいディレクトリの作成 (
mkd()
) - ディレクトリの削除 (
rmd()
)
- カレントディレクトリの変更 (
- FTPサーバーへの接続と認証: ホスト名、ユーザー名、パスワードを使ってFTPサーバーに接続し、ログインします。
ftplib
の基本的な使い方(例)
以下は、ftplib
を使ってFTPサーバーに接続し、ファイル一覧を取得する簡単な例です。
from ftplib import FTP
try:
# FTPサーバーに接続
# ホスト名、ユーザー名、パスワードを適切に設定してください
ftp = FTP('your_ftp_server.com')
ftp.login('your_username', 'your_password')
print(f"現在のディレクトリ: {ftp.pwd()}")
# ファイルとディレクトリの一覧を取得
print("\nファイル一覧:")
files = ftp.nlst()
for file in files:
print(file)
# 接続を閉じる
ftp.quit()
print("\nFTP接続を切断しました。")
except Exception as e:
print(f"エラーが発生しました: {e}")
retrlines()
やstorlines()
を使う際は、テキストモード(テキストファイルなど)でファイルを転送します。retrbinary()
やstorbinary()
を使う際は、バイナリモード(画像、PDFなど)でファイルを転送します。your_ftp_server.com
、your_username
、your_password
は、実際のFTPサーバーの情報に置き換えてください。
ftplib
の注意点
- エラーハンドリング: ネットワークの問題や認証の失敗など、さまざまなエラーが発生する可能性があります。
try...except
ブロックを使って適切にエラーを処理することが重要です。 - セキュリティ: FTPは、ユーザー名やパスワードが平文で送信されるため、セキュリティ上のリスクがあります。機密性の高い情報を扱う場合は、SFTP (SSH File Transfer Protocol) や FTPS (FTP Secure) のような、よりセキュアなプロトコルを使用することを検討してください。
ftplib
はSFTPやFTPSを直接サポートしていません。
ftplib
を使用する際に遭遇しやすいエラーと、それらの問題解決のためのヒントを以下に説明します。
接続関連のエラー (ftplib.all_errors)
FTPサーバーへの接続時に最も頻繁に発生する問題です。
-
トラブルシューティング
- ホスト名・IPアドレスの確認
FTPサーバーの正しいアドレスを再確認してください。pingコマンドなどで到達可能かテストするのも有効です。 - サーバーの稼働状況確認
FTPサーバー管理者に問い合わせるか、Webサイトのステータスを確認してください。 - ファイアウォールの設定確認
自分のPCやサーバーのファイアウォール設定で、ポート21 (FTPのデフォルトポート) のアウトバウンド/インバウンド接続が許可されているか確認してください。 - ポート番号の指定
FTPサーバーが標準以外のポートを使用している場合、FTP('hostname', port=xxxx)
のようにポート番号を明示的に指定します。 - ログイン情報の再確認
ユーザー名とパスワードを慎重に入力し直してください。大文字・小文字も区別されます。 - ネットワーク環境の確認
インターネット接続自体に問題がないか確認してください。
- ホスト名・IPアドレスの確認
-
原因
- ホスト名またはIPアドレスの誤り
指定したFTPサーバーのアドレスが間違っている。 - サーバーがダウンしている/応答しない
FTPサーバーが稼働していないか、ネットワークの問題で到達できない。 - ファイアウォールによるブロック
クライアント側またはサーバー側のファイアウォールがFTP接続をブロックしている。 - ポートの誤り
FTPは通常ポート21を使用しますが、サーバーが異なるポートで稼働している。 - ログイン情報の誤り
ユーザー名やパスワードが間違っている。 - 同時接続数の制限
サーバーが同時に許可する接続数を超えている。
- ホスト名またはIPアドレスの誤り
-
socket.gaierror: [Errno 8] nodename nor servname provided, or not known
(ホスト名解決エラー)socket.error: [Errno 111] Connection refused
(接続拒否)socket.timeout: timed out
(接続タイムアウト)ftplib.error_temp: 421 Service not available, remote server has closed connection
(サービスが利用できない)ftplib.error_perm: 530 Login incorrect.
(ログイン情報の誤り)
ファイル転送関連のエラー (ftplib.error_perm, ftplib.error_temp)
ファイルのアップロードやダウンロード中に発生するエラーです。
-
トラブルシューティング
- パスの確認
ローカルファイルの場合はフルパスを、FTPサーバー上のファイルの場合は、カレントディレクトリからの相対パスまたは絶対パスが正しいか確認してください。 - パーミッションの確認
FTPサーバーのユーザーに、対象ディレクトリやファイルへの適切な権限(読み取り、書き込み、削除など)があるか確認してください。サーバー管理者に問い合わせる必要があります。 - ファイル名/ディレクトリ名の修正
半角英数字と一部の記号のみを使用するなど、シンプルな名前に変更してみてください。 - パッシブモードの利用 (ftp.set_pasv(True))
ほとんどの環境ではパッシブモードが推奨されます。ftplib
はデフォルトでパッシブモードを使用しますが、明示的にftp.set_pasv(True)
を呼び出すことで解決する場合があります。ftp.set_pasv(False)
でアクティブモードを試すこともできますが、アクティブモードはファイアウォールとの相性が悪いことが多いです。 - ディスク容量の確認
FTPサーバーのディスク使用状況を確認し、必要に応じて不要なファイルを削除するか、容量を増やす必要があります。
- パスの確認
-
原因
- ファイルのパスの誤り
指定したファイルがFTPサーバー上に存在しないか、ローカルPCのパスが間違っている。 - アクセス権限不足
ログインしているFTPユーザーに、ファイルの読み取り/書き込み/削除の権限がない。 - ファイル名/ディレクトリ名の問題
特殊文字が含まれている、サーバーのファイル名規則に違反している。 - パッシブモード/アクティブモードの問題
FTPのデータ転送モード(アクティブモードとパッシブモード)に関する問題。特にファイアウォールがある環境で発生しやすい。 - ディスク容量不足
FTPサーバーのディスク容量がいっぱいになっている。
- ファイルのパスの誤り
-
エラーの例
ftplib.error_perm: 550 Requested action not taken. File unavailable (e.g., file not found, no access).
(ファイルが見つからない、またはアクセス権がない)ftplib.error_perm: 553 Requested action not taken. File name not allowed.
(ファイル名が許可されていない)ftplib.error_temp: 425 Can't open data connection.
(データ接続を開けない)ftplib.error_perm: 552 Requested file action aborted. Exceeded storage allocation (for current directory/file).
(ディスク容量不足)
ディレクトリ操作関連のエラー (ftplib.error_perm)
ディレクトリの作成、削除、移動時に発生するエラーです。
-
トラブルシューティング
- パスの確認
対象のディレクトリパスが正しいか再確認してください。 - パーミッションの確認
ログインしているFTPユーザーが、対象ディレクトリへの適切な権限(作成、削除など)を持っているか確認してください。 - ディレクトリを空にする
削除する前に、ディレクトリ内のすべてのファイルとサブディレクトリを再帰的に削除してください。
- パスの確認
-
原因
- パスの誤り
指定したディレクトリパスが間違っている。 - パーミッション不足
ディレクトリの作成・削除・変更権限がない。 - 空ではないディレクトリの削除
ディレクトリを削除しようとしているが、その中にファイルやサブディレクトリが存在する。
- パスの誤り
-
エラーの例
ftplib.error_perm: 550 CWD failed. "/nonexistent_dir": directory not found
(ディレクトリが見つからない)ftplib.error_perm: 550 Can't remove directory: Directory not empty
(ディレクトリが空ではないため削除できない)ftplib.error_perm: 550 Create directory operation failed.
(ディレクトリ作成失敗)
- 接続の切断
処理が終わったら必ずftp.quit()
を呼び出して接続を安全に切断するようにしてください。これにより、サーバー側のリソースを解放し、不必要な接続が残るのを防ぎます。 - ログ出力
try...except
ブロックでエラーを捕捉し、エラーメッセージをログファイルに出力することで、後で問題分析を行うことができます。 - デバッグ出力の有効化
ftplib.FTP
オブジェクトのコンストラクタでdebuglevel
引数を設定することで、より詳細なデバッグ情報を得ることができます。ftp = FTP('your_ftp_server.com', debuglevel=2)
debuglevel=1
は基本的なFTPコマンドと応答を表示し、debuglevel=2
はさらに詳細なソケット通信情報などを表示します。 - エラーメッセージの読解
ftplib
のエラーメッセージは、FTPサーバーから返されるFTP応答コード(例: 550, 421, 530など)を含んでいます。これらのコードは、問題の原因を特定するのに非常に役立ちます。一般的なFTP応答コードの意味を調べてみましょう。
Python ftplib
プログラミング例
ftplib
は、FTPサーバーとの間でファイルを転送したり、ディレクトリを操作したりするための強力なツールです。ここでは、基本的な操作からよく使われるパターンまで、いくつかのコード例を見ていきましょう。
FTPサーバーへの接続とログイン
最も基本的なステップです。ホスト名、ユーザー名、パスワードを使ってFTPサーバーに接続します。
from ftplib import FTP
ftp_host = 'your_ftp_server.com' # あなたのFTPサーバーのホスト名
ftp_user = 'your_username' # あなたのFTPユーザー名
ftp_pass = 'your_password' # あなたのFTPパスワード
try:
# FTPオブジェクトを作成し、サーバーに接続
# debuglevel=2 を設定すると、詳細な通信ログが表示されデバッグに役立ちます
with FTP(ftp_host, timeout=30, debuglevel=0) as ftp:
# ログイン
ftp.login(user=ftp_user, passwd=ftp_pass)
print(f"FTPサーバーに接続し、ログインしました: {ftp_host}")
# 現在の作業ディレクトリを表示
print(f"現在のディレクトリ: {ftp.pwd()}")
# 接続を終了 (with ステートメントを使っているため、自動的に切断されますが、明示的にquitも可能)
# ftp.quit()
except Exception as e:
print(f"FTP接続中にエラーが発生しました: {e}")
ポイント
with
ステートメントを使うことで、処理が終了した際に自動的にFTP接続が閉じられます。debuglevel
を設定すると、FTPコマンドとサーバー応答のログを見ることができます。デバッグ時に非常に役立ちます。timeout
引数で接続のタイムアウト時間を設定できます。FTP(ftp_host)
で接続を開始し、ftp.login()
で認証します。
ファイルとディレクトリの一覧表示
FTPサーバー上のファイルやディレクトリを確認します。
from ftplib import FTP
ftp_host = 'your_ftp_server.com'
ftp_user = 'your_username'
ftp_pass = 'your_password'
try:
with FTP(ftp_host) as ftp:
ftp.login(user=ftp_user, passwd=ftp_pass)
print(f"現在のディレクトリ: {ftp.pwd()}")
# nlts() を使ってファイルとディレクトリ名をリストアップ
print("\n--- nlts() による一覧 (名前のみ) ---")
items_nlst = ftp.nlst()
for item in items_nlst:
print(item)
# dir() を使って詳細情報をリストアップ (ls -l のような形式)
print("\n--- dir() による一覧 (詳細情報) ---")
# dir() は直接リストを返さないため、コールバック関数で処理します
ftp.dir(callback=lambda line: print(line))
except Exception as e:
print(f"FTP操作中にエラーが発生しました: {e}")
ポイント
ftp.dir()
は、UNIXのls -l
コマンドのように、詳細な情報(パーミッション、所有者、サイズなど)を含むリストを返します。結果はコールバック関数で処理する必要があります。ftp.nlst()
は、ファイルやディレクトリの名前のリストを返します。
ファイルのダウンロード
FTPサーバーからファイルをローカルPCにダウンロードします。バイナリファイルとテキストファイルで転送方法が異なります。
from ftplib import FTP
import os
ftp_host = 'your_ftp_server.com'
ftp_user = 'your_username'
ftp_pass = 'your_password'
remote_file = 'remote_example.txt' # ダウンロードしたいサーバー上のファイル名
local_file_path = 'downloaded_example.txt' # ローカルに保存するファイル名
remote_image = 'remote_image.jpg' # ダウンロードしたいサーバー上の画像ファイル
local_image_path = 'downloaded_image.jpg' # ローカルに保存する画像ファイル
try:
with FTP(ftp_host) as ftp:
ftp.login(user=ftp_user, passwd=ftp_pass)
print(f"現在のディレクトリ: {ftp.pwd()}")
# --- テキストファイルのダウンロード例 ---
print(f"\nテキストファイル '{remote_file}' をダウンロード中...")
with open(local_file_path, 'w', encoding='utf-8') as local_fp:
# retrlines は行ごとにデータを取得し、ファイルに書き込むのに適しています
ftp.retrlines(f"RETR {remote_file}", local_fp.write)
print(f"'{remote_file}' を '{local_file_path}' にダウンロードしました。")
# --- バイナリファイルのダウンロード例 (画像、PDFなど) ---
print(f"\nバイナリファイル '{remote_image}' をダウンロード中...")
with open(local_image_path, 'wb') as local_fp:
# retrbinary はバイナリデータをブロックごとに取得します
ftp.retrbinary(f"RETR {remote_image}", local_fp.write)
print(f"'{remote_image}' を '{local_image_path}' にダウンロードしました。")
except FileNotFoundError:
print(f"エラー: 指定されたローカルファイルパス '{local_file_path}' または '{local_image_path}' が見つかりません。")
except Exception as e:
print(f"FTPファイルダウンロード中にエラーが発生しました: {e}")
ポイント
- ローカルファイルを開く際は、テキストモード (
'w'
) と バイナリモード ('wb'
) を正しく使い分けることが重要です。 ftp.retrbinary(command, callback, blocksize)
: バイナリファイルをダウンロードする際に使用します。blocksize
で一度に転送するバイト数を指定できます(デフォルトは8192バイト)。ftp.retrlines(command, callback)
: テキストファイルをダウンロードする際に使用します。callback
関数(この例ではlocal_fp.write
)に各行が渡されます。
ファイルのアップロード
ローカルPCからFTPサーバーにファイルをアップロードします。これもバイナリとテキストで異なります。
from ftplib import FTP
import os
ftp_host = 'your_ftp_server.com'
ftp_user = 'your_username'
ftp_pass = 'your_password'
local_upload_text_file = 'local_upload_text.txt' # アップロードするローカルのテキストファイル
remote_dest_text_file = 'uploaded_text_on_server.txt' # サーバー上の保存先ファイル名
local_upload_image_file = 'local_upload_image.png' # アップロードするローカルの画像ファイル
remote_dest_image_file = 'uploaded_image_on_server.png' # サーバー上の保存先ファイル名
# テスト用のファイルを作成 (実際のファイルに置き換えてもOK)
with open(local_upload_text_file, 'w') as f:
f.write("これはftplibでアップロードされたテキストファイルです。\n")
f.write("Japanese example content.\n")
# ダミーの画像ファイルを作成 (または既存の画像ファイルを使用)
# 例えばPIL (Pillow) を使って作成
try:
from PIL import Image
img = Image.new('RGB', (60, 30), color = 'red')
img.save(local_upload_image_file)
print(f"ダミー画像ファイル '{local_upload_image_file}' を作成しました。")
except ImportError:
print("Pillow (PIL) がインストールされていません。`pip install Pillow` でインストールしてください。")
print(f"'{local_upload_image_file}' は作成されませんでした。既存の画像ファイルを使用してください。")
# 例示のため、ここでは強制終了せず続行します
try:
with FTP(ftp_host) as ftp:
ftp.login(user=ftp_user, passwd=ftp_pass)
print(f"現在のディレクトリ: {ftp.pwd()}")
# --- テキストファイルのアップロード例 ---
if os.path.exists(local_upload_text_file):
print(f"\nテキストファイル '{local_upload_text_file}' をアップロード中...")
with open(local_upload_text_file, 'r', encoding='utf-8') as local_fp:
# storlines は行ごとにデータをサーバーに送信します
ftp.storlines(f"STOR {remote_dest_text_file}", local_fp)
print(f"'{local_upload_text_file}' を '{remote_dest_text_file}' にアップロードしました。")
else:
print(f"エラー: ローカルファイル '{local_upload_text_file}' が見つかりません。")
# --- バイナリファイルのアップロード例 ---
if os.path.exists(local_upload_image_file):
print(f"\nバイナリファイル '{local_upload_image_file}' をアップロード中...")
with open(local_upload_image_file, 'rb') as local_fp:
# storbinary はバイナリデータをブロックごとにサーバーに送信します
ftp.storbinary(f"STOR {remote_dest_image_file}", local_fp)
print(f"'{local_upload_image_file}' を '{remote_dest_image_file}' にアップロードしました。")
else:
print(f"エラー: ローカルファイル '{local_upload_image_file}' が見つかりません。")
except FileNotFoundError:
print(f"エラー: 指定されたローカルファイルパスが見つかりません。")
except Exception as e:
print(f"FTPファイルアップロード中にエラーが発生しました: {e}")
finally:
# 作成したテストファイルをクリーンアップ
if os.path.exists(local_upload_text_file):
os.remove(local_upload_text_file)
if os.path.exists(local_upload_image_file):
os.remove(local_upload_image_file)
ポイント
- ダウンロードと同様に、ローカルファイルを開く際は テキストモード (
'r'
) と バイナリモード ('rb'
) を正しく使い分ける必要があります。 ftp.storbinary(command, file, blocksize)
: バイナリファイルをアップロードする際に使用します。ftp.storlines(command, file)
: テキストファイルをアップロードする際に使用します。ファイルオブジェクトを渡します。
ディレクトリ操作
FTPサーバー上のディレクトリを作成、変更、削除します。
from ftplib import FTP
ftp_host = 'your_ftp_server.com'
ftp_user = 'your_username'
ftp_pass = 'your_password'
new_dir = 'new_test_directory'
old_dir_name = 'old_name'
new_dir_name = 'renamed_directory'
try:
with FTP(ftp_host) as ftp:
ftp.login(user=ftp_user, passwd=ftp_pass)
print(f"初期ディレクトリ: {ftp.pwd()}")
# --- 新しいディレクトリの作成 ---
print(f"\nディレクトリ '{new_dir}' を作成中...")
try:
ftp.mkd(new_dir)
print(f"ディレクトリ '{new_dir}' を作成しました。")
except Exception as e:
print(f"ディレクトリ '{new_dir}' の作成に失敗しました (すでに存在するか、権限がない): {e}")
# --- ディレクトリの移動 (変更) ---
print(f"\nディレクトリを '{new_dir}' に移動中...")
ftp.cwd(new_dir)
print(f"現在のディレクトリ: {ftp.pwd()}")
# 親ディレクトリに戻る
print("\n親ディレクトリに戻る...")
ftp.cwd('..')
print(f"現在のディレクトリ: {ftp.pwd()}")
# --- ディレクトリの名前変更 ---
# 既存のディレクトリ名が存在するか確認
if old_dir_name in ftp.nlst():
print(f"\nディレクトリ '{old_dir_name}' を '{new_dir_name}' に名前変更中...")
ftp.rename(old_dir_name, new_dir_name)
print(f"ディレクトリ名を '{old_dir_name}' から '{new_dir_name}' に変更しました。")
else:
print(f"\nエラー: ディレクトリ '{old_dir_name}' が存在しないため、名前変更できません。")
# --- ディレクトリの削除 ---
# 削除する前に、ディレクトリが空であることを確認する必要があります
print(f"\nディレクトリ '{new_dir}' を削除中...")
try:
# 一時的に作成したディレクトリに移動して、もし何かファイルがあれば削除する
# ftp.cwd(new_dir)
# for item in ftp.nlst():
# ftp.delete(item)
# ftp.cwd('..')
# 空になったディレクトリを削除
ftp.rmd(new_dir)
print(f"ディレクトリ '{new_dir}' を削除しました。")
except Exception as e:
print(f"ディレクトリ '{new_dir}' の削除に失敗しました (空ではないか、権限がない): {e}")
except Exception as e:
print(f"FTPディレクトリ操作中にエラーが発生しました: {e}")
ポイント
ftp.rmd(dirname)
: ディレクトリを削除します。重要な注意点として、削除するディレクトリは空である必要があります。 空でない場合はエラーになります。ftp.rename(from_name, to_name)
: ファイルまたはディレクトリの名前を変更します。ftp.cwd(path)
: 現在の作業ディレクトリを変更します。..
で親ディレクトリに戻れます。ftp.mkd(dirname)
: 新しいディレクトリを作成します。
FTPサーバー上のファイルを削除します。
from ftplib import FTP
import os
ftp_host = 'your_ftp_server.com'
ftp_user = 'your_username'
ftp_pass = 'your_password'
file_to_delete = 'file_to_be_deleted.txt' # サーバー上で削除したいファイル名
# テスト用にサーバーにファイルをアップロード (削除するファイルを作成)
try:
with FTP(ftp_host) as ftp:
ftp.login(user=ftp_user, passwd=ftp_pass)
print(f"現在のディレクトリ: {ftp.pwd()}")
# 削除テスト用にファイルを作成
with open('temp_upload_file.txt', 'w') as f:
f.write("このファイルは削除されます。\n")
with open('temp_upload_file.txt', 'r') as f:
ftp.storlines(f"STOR {file_to_delete}", f)
print(f"テストファイル '{file_to_delete}' をサーバーにアップロードしました。")
os.remove('temp_upload_file.txt') # ローカルの一時ファイルを削除
# --- ファイルの削除 ---
print(f"\nファイル '{file_to_delete}' を削除中...")
ftp.delete(file_to_delete)
print(f"ファイル '{file_to_delete}' を削除しました。")
# 削除されたことを確認 (エラーになれば削除されている)
print("\nファイルが削除されたか確認中...")
try:
ftp.nlst(file_to_delete) # 存在しないファイルをnlstしようとするとエラー
print("エラー: ファイルがまだ存在します。")
except Exception:
print("ファイルは正常に削除されました (nlstでエラー)。")
except Exception as e:
print(f"FTPファイル削除中にエラーが発生しました: {e}")
ftp.delete(filename)
: 指定したファイルを削除します。ファイルが存在しない場合や、権限がない場合はエラーになります。
ftplib
は標準ライブラリに含まれており、FTPプロトコルを扱う上で便利ですが、FTP自体の限界(特にセキュリティ面)や、よりモダンなプロトコルを利用したいケースがあります。ここでは、ftplib
の代替となりうる主な方法をいくつか紹介します。
SFTP (SSH File Transfer Protocol) を使用する
FTPの最も一般的な代替手段であり、セキュリティが強化されています。SSH (Secure Shell) プロトコル上で動作するため、データは暗号化され、安全に転送されます。
- 簡単なコード例 (paramiko)
import paramiko import os hostname = 'your_sftp_server.com' port = 22 # SFTPのデフォルトポート username = 'your_sftp_username' password = 'your_sftp_password' # または秘密鍵認証の場合 # private_key_path = '~/.ssh/id_rsa' remote_file = '/path/to/remote/file.txt' local_dest_path = 'downloaded_sftp_file.txt' local_source_path = 'local_sftp_upload.txt' remote_upload_path = '/path/to/remote/uploaded_file.txt' try: # SSHクライアントを初期化 with paramiko.SSHClient() as client: client.set_missing_host_key_policy(paramiko.AutoAddPolicy()) # 初回接続時にホストキーを追加 # パスワード認証で接続 client.connect(hostname=hostname, port=port, username=username, password=password) # または秘密鍵認証で接続 # client.connect(hostname=hostname, port=port, username=username, key_filename=os.path.expanduser(private_key_path)) # SFTPクライアントを取得 with client.open_sftp() as sftp: print(f"SFTPサーバーに接続しました: {hostname}") # ファイルのダウンロード print(f"'{remote_file}' をダウンロード中...") sftp.get(remote_file, local_dest_path) print(f"'{remote_file}' を '{local_dest_path}' にダウンロードしました。") # ファイルのアップロード # テスト用のローカルファイルを作成 with open(local_source_path, 'w') as f: f.write("これはSFTPでアップロードされたテキストファイルです。\n") print(f"'{local_source_path}' をアップロード中...") sftp.put(local_source_path, remote_upload_path) print(f"'{local_source_path}' を '{remote_upload_path}' にアップロードしました。") # ディレクトリの一覧表示 print("\nリモートディレクトリのファイル一覧:") for entry in sftp.listdir('/path/to/remote/directory'): print(entry) except paramiko.AuthenticationException: print("認証に失敗しました。ユーザー名またはパスワード/秘密鍵を確認してください。") except paramiko.SSHException as e: print(f"SSH接続エラー: {e}") except Exception as e: print(f"SFTP操作中にエラーが発生しました: {e}") finally: # 作成したローカルファイルを削除 if os.path.exists(local_source_path): os.remove(local_source_path)
- Pythonライブラリ
paramiko
:最も広く使われているSSH2プロトコルライブラリで、SFTPクライアント機能も提供します。
- いつ使うべきか
- セキュリティが最優先される場合(パスワードや機密データの転送)。
- FTPサーバーの代わりにSFTPサーバーが利用可能な場合。
- SSH接続が確立できる環境。
FTPS (FTP Secure) を使用する
FTPSは、通常のFTP接続にSSL/TLS暗号化を追加したものです。制御チャネルのみを暗号化する「Implicit FTPS」(通常ポート990)と、接続後に暗号化を開始する「Explicit FTPS」(通常ポート21)があります。
- 簡単なコード例 (ftplib.FTP_TLS)
注意点: サーバーによっては証明書の検証設定が必要になる場合があります。その場合はfrom ftplib import FTP_TLS import ssl # SSLコンテキストのためにインポート ftp_host = 'your_ftps_server.com' ftp_user = 'your_username' ftp_pass = 'your_password' ftp_port = 21 # Explicit FTPSの場合 remote_file = 'remote_ftps_file.txt' local_dest_path = 'downloaded_ftps_file.txt' try: # FTP_TLSオブジェクトを作成 with FTP_TLS(ftp_host, user=ftp_user, passwd=ftp_pass, timeout=30) as ftps: print(f"FTPSサーバーに接続しました: {ftp_host}") # 制御チャネルを保護 (AUTH TLSまたはAUTH SSLコマンドを送信) # デフォルトで ftps.prot_p() が呼び出され、データチャネルも保護されます。 # データチャネルを保護しない場合は ftps.prot_c() を呼び出します。 ftps.prot_p() # データチャネルも暗号化 (推奨) print(f"現在のディレクトリ: {ftps.pwd()}") # ファイルのダウンロード (retrlines はテキストファイル用) print(f"'{remote_file}' をダウンロード中...") with open(local_dest_path, 'w', encoding='utf-8') as local_fp: ftps.retrlines(f"RETR {remote_file}", local_fp.write) print(f"'{remote_file}' を '{local_dest_path}' にダウンロードしました。") except Exception as e: print(f"FTPS接続または操作中にエラーが発生しました: {e}")
ssl.create_default_context()
やcontext=ssl._create_unverified_context()
(非推奨、テスト用) などをFTP_TLS
のコンストラクタに渡す必要があります。 - Pythonライブラリ
ftplib
のFTP_TLS
クラス:Python 3.4以降で利用可能で、FTPSをサポートします。
- いつ使うべきか
- 既存のFTPインフラストラクチャがあり、セキュリティを強化したいが、SFTPへの移行が難しい場合。
- FTPSサーバーが利用可能な場合。
クラウドストレージサービスのSDKを使用する
AWS S3, Google Cloud Storage, Azure Blob Storageなどのクラウドストレージサービスは、ファイル転送の管理やスケーラビリティ、可用性においてFTPよりも優れた選択肢となることが多いです。
- 簡単なコード例 (AWS S3のboto3)
import boto3 import os # AWS認証情報 (環境変数、設定ファイルなどで管理することを推奨) # aws_access_key_id = 'YOUR_ACCESS_KEY' # aws_secret_access_key = 'YOUR_SECRET_KEY' # region_name = 'ap-northeast-1' # 例: 東京リージョン bucket_name = 'your-s3-bucket-name' s3_object_key = 'example_s3_object.txt' local_file_path = 'local_file_for_s3.txt' download_dest_path = 'downloaded_from_s3.txt' # テスト用のローカルファイルを作成 with open(local_file_path, 'w') as f: f.write("これはAWS S3にアップロードされるテストファイルです。\n") try: # S3クライアントを作成 s3 = boto3.client('s3') # または認証情報を明示的に指定する場合 # s3 = boto3.client('s3', # aws_access_key_id=aws_access_key_id, # aws_secret_access_key=aws_secret_access_key, # region_name=region_name) print(f"S3バケット '{bucket_name}' に接続中...") # ファイルのアップロード print(f"'{local_file_path}' をS3オブジェクト '{s3_object_key}' としてアップロード中...") s3.upload_file(local_file_path, bucket_name, s3_object_key) print(f"'{local_file_path}' をS3にアップロードしました。") # ファイルのダウンロード print(f"S3オブジェクト '{s3_object_key}' をダウンロード中...") s3.download_file(bucket_name, s3_object_key, download_dest_path) print(f"S3から '{s3_object_key}' を '{download_dest_path}' にダウンロードしました。") except Exception as e: print(f"AWS S3操作中にエラーが発生しました: {e}") finally: if os.path.exists(local_file_path): os.remove(local_file_path)
- Pythonライブラリ
boto3
(AWS S3)google-cloud-storage
(Google Cloud Storage)azure-storage-blob
(Azure Blob Storage)
- いつ使うべきか
- 大規模なデータストレージが必要な場合。
- 高い可用性、耐久性、スケーラビリティが求められる場合。
- クラウドベースのアプリケーションを構築している場合。
- FTPサーバーの管理から解放されたい場合。
HTTP/HTTPS を使用する (REST APIなど)
ファイルサーバーがWebサーバーとして動作し、HTTP/HTTPS経由でファイルを公開している場合、PythonのHTTPクライアントライブラリを使用してファイルをダウンロード・アップロードできます。
- Pythonライブラリ
requests
:非常に人気があり、使いやすいHTTPクライアントライブラリ。urllib.request
:標準ライブラリ。
- いつ使うべきか
- RESTful API経由でのファイル操作が提供されている場合。
- Webサーバーから公開されているファイルをダウンロードしたい場合。
- シンプルなファイル転送(特にダウンロード)であれば、セットアップが容易。