Skip to content

Latest commit

 

History

History
195 lines (161 loc) · 6.04 KB

README.md

File metadata and controls

195 lines (161 loc) · 6.04 KB

transfer_lib

各プロトコルを使用したファイル転送に関連するラッパークラスを作成しました ご利用は自己責任でご自由にどうぞ

使い方

1.pipコマンドを実行し、モジュールをダウンロードしてください

pip install transfer_lib

2.クラスをインポートし、下記例の用に使用してください

from transfer_lib.ftp import FtpLibWrapper
ftp = FtpLibWrapper('host', 'user', 'password')
ftp.chg_dir('dir_name')
for file_name in ftp.get_file_list()
    print file_name
ftp.get_file('hoge.txt', '/tmp/hogehoge.txt')

機能紹介

FtpLibWrapper

FTP、FTPSプロトコルを使用した通信処理のラッパークラスです


init(host, user, password, is_pasv=True, is_ssl=False):

名前 必須 説明 デフォルト値
host 接続サーバドメイン名 -
user 接続ユーザ -
password 接続パスワード -
is_pasv × パッシブモードかどうか True
is_ssl × FTPSを使用するかどうか False

get_file_list():現在のディレクトリに存在するファイルの一覧をリストで返します(フォルダは除外)

戻り値:List


chg_dir(path):指定したパスに移動します

名前 必須 説明 デフォルト値
path 移動したいディレクトリ名 -
戻り値:なし

make_dir(path):ディレクトリを作成します、すでに存在する場合は何もしません

名前 必須 説明 デフォルト値
path 作成したいディレクトリ名 -
戻り値:なし

get_file(server_file_name, local_file_name):ファイルをダウンロードします

名前 必須 説明 デフォルト値
server_file_name 取得したいファイル名 -
local_file_name 取得したファイルのローカルフルパス -
戻り値:なし

delete_file(server_file_name):指定したファイル、フォルダを削除します、フォルダの中身が存在する場合も削除します

名前 必須 説明 デフォルト値
server_file_name 削除したいファイル名 -
戻り値:なし

upload_file(server_file_name, local_file_name):ファイルをアップロードします

名前 必須 説明 デフォルト値
server_file_name アップロードするファイルの名称 -
local_file_name アップロードしたいファイルのローカルフルパス -
戻り値:なし

rename_file(server_file_name, new_name):ファイル名を変更します

名前 必須 説明 デフォルト値
server_file_name 変更前の名称 -
new_name 変更後の名称 -
戻り値:なし

quit():サーバとの通信を終了します、最後にかならず実行してください

戻り値:なし


SftpLibWrapper

SFTPプロトコルを使用した通信処理のラッパークラスです


init(host, user, password, port=22, private_key=None):

名前 必須 説明 デフォルト値
host 接続サーバドメイン名 -
user 接続ユーザ -
password × 接続パスワード None
port × 使用ポート 22
private_key × 秘密鍵パス None

get_file_list():現在のディレクトリに存在するファイルの一覧をリストで返します(フォルダは除外)

戻り値:List


chg_dir(path):指定したパスに移動します

名前 必須 説明 デフォルト値
path 移動したいディレクトリ名 -
戻り値:なし

make_dir(path):ディレクトリを作成します、すでに存在する場合は何もしません

名前 必須 説明 デフォルト値
path 作成したいディレクトリ名 -
戻り値:なし

get_file(server_file_name, local_file_name):ファイルをダウンロードします

名前 必須 説明 デフォルト値
server_file_name 取得したいファイル名 -
local_file_name 取得したファイルのローカルフルパス -
戻り値:なし

delete_file(server_file_name):指定したファイル、フォルダを削除します、フォルダの中身が存在する場合も削除します

名前 必須 説明 デフォルト値
server_file_name 削除したいファイル名 -
戻り値:なし

upload_file(server_file_name, local_file_name):ファイルをアップロードします

名前 必須 説明 デフォルト値
server_file_name アップロードするファイルの名称 -
local_file_name アップロードしたいファイルのローカルフルパス -
戻り値:なし

rename_file(server_file_name, new_name):ファイル名を変更します

名前 必須 説明 デフォルト値
server_file_name 変更前の名称 -
new_name 変更後の名称 -
戻り値:なし

quit():サーバとの通信を終了します、最後にかならず実行してください

戻り値:なし


get_list():現在のディレクトリに存在するファイル、フォルダの一覧をリストで返します

戻り値:List


HttpFileTransfer

HTTP、HTTPSプロトコルを使用した通信処理のラッパークラスです


init(self, domain, user, password, is_ssl=False):

名前 必須 説明 デフォルト値
domain 接続サーバドメイン名 -
user 接続ユーザ -
password 接続パスワード -
is_ssl × HTTPSを使用するかどうか False

get_file(file_path, local_file_path, local_file_encode):ファイルをダウンロードします

名前 必須 説明 デフォルト値
file_path 取得したいファイルパス -
local_file_path 取得したファイルのローカルフルパス -
local_file_encode 取得したファイルの文字コード -
戻り値:なし

関連情報

  1. ググレカス(ブログ)
  2. LinkedIn

ライセンス

Distributed under the [MIT License][mit]. [MIT]: http://www.opensource.org/licenses/mit-license.php