py_monopla file.py

SIPF_FILEプロトコルのクライアント機能を提供します。

クラス

なし

関数

request_file_upload_url(file_id, auth)

アップロード先のURLを取得します。

引数

引数	意味	in/out	型	概要
auth	認証情報	in	SipfAuthクラス	さくらのモノプラットフォームで有効な認証情報
file_id	ファイルID	in	文字列	アップロードするファイルのファイルID

戻り値

戻り値	意味
文字列	アップロード先のURL
0未満	HTTPエラー(ステータスコード×-1) 例：ステータス451の場合は-451

例外

例外	意味
urllib.error.URLError	urllibで発生した例外

request_file_download_url(file_id, auth)

引数

引数	意味	in/out	型	概要
auth	認証情報	in	SipfAuthクラス	さくらのモノプラットフォームで有効な認証情報
file_id	ファイルID	in	文字列	ダウンロードするファイルのファイルID

戻り値

戻り値	意味
文字列	ダウンロード元のURL
0未満	HTTPエラー(ステータスコード×-1) 例：ステータス451の場合は-451

例外

例外	意味
urllib.error.URLError	urllibで発生した例外

send_upload_complete(file_id, auth)

引数

引数	意味	in/out	型	概要
auth	認証情報	in	SipfAuthクラス	さくらのモノプラットフォームで有効な認証情報
file_id	ファイルID	in	文字列	アップロードしたファイルのファイルID

戻り値

戻り値	意味
0	成功
0未満	HTTPエラー(ステータスコード×-1) 例：ステータス451の場合は-451

例外

例外	意味
urllib.error.URLError	urllibで発生した例外

upload(file_path, file_id, auth)

引数

引数	意味	in/out	型	概要
file_path	ファイルのパス	in	文字列	アップロードするファイルのパス
file_id	ファイルID	in	文字列	アップロードするファイルのファイルID
auth	認証情報	in	SipfAuthクラス	さくらのモノプラットフォームで有効な認証情報

戻り値

戻り値	意味
0	成功
-1	失敗
-1未満	HTTPエラー(ステータスコード×-1) 例：ステータス451の場合は-451

例外

例外	意味
FileNotFoundError	ファイルが存在しない
urllib.error.URLError	urllibで発生した例外

download(file_path, file_id, auth)

引数

引数	意味	in/out	型	概要
file_path	ファイルのパス	in	文字列	ダウンロードしたファイルを保存するパス
file_id	ファイルID	in	文字列	ダウンロードするファイルのファイルID
auth	認証情報	in	SipfAuthクラス	さくらのモノプラットフォームで有効な認証情報

戻り値

戻り値	意味
0	成功
-1	失敗
-1未満	HTTPエラー(ステータスコード×-1) 例：ステータス451の場合は-451

例外

例外	意味
FileNotFoundError	ファイルが存在しない
PermissionError	書き込みパーミションがない
urllib.error.URLError	urllibで発生した例外