def __init__(self, public_key, private_key):
"""
初始化 BucketManager 实例
@param public_key: string类型， 账户API公私钥的公钥
@param private_key: string类型，账户API公私钥的私钥
@return None，如果为非法的公私钥则抛出ValueError异常
"""
self.__auth = Auth(public_key, private_key)
def __init__(self, public_key, private_key):
"""
初始化 BaseUFile 对象
@param public_key: string类型， 账户API公私钥的公钥
@param private_key: string类型，账户API公私钥的私钥
@return None，如果为非法的公私钥则抛出ValueError异常
"""
self.__auth = Auth(public_key, private_key)
class BaseUFile(object):
"""
UCloud UFile 内容管理的基类，主要包括不同操作的公共方法
"""
def __init__(self, public_key, private_key):
"""
初始化 BaseUFile 对象
@param public_key: string类型， 账户API公私钥的公钥
@param private_key: string类型，账户API公私钥的私钥
@return None，如果为非法的公私钥则抛出ValueError异常
"""
self.__auth = Auth(public_key, private_key)
def set_keys(self, public_key, private_key):
"""
重新设置账户API公私钥
@param public_key: string类型， 账户API公私钥的公钥
@param private_key: string类型，账户API公私钥的私钥
@return None，如果为非法的公私钥则抛出ValueError异常
"""
self.__auth.set_keys(public_key, private_key)
def authorization(self, method, bucket, key, header=None, mime_type=None):
"""
根据不同的上传方法和HTTP请求头获得上传凭证
@param method: string类型，文件上传方法，为'put'或'post'
@param bucket: string类型，上传的空间名称
@param key: string类型，文件在上传空间中的名称
@param header: dict类型，键值对类型分别为string类型，HTTP请求的header
@param mime_type: string类型，上传文件的MIME，如果提供则采用其计算文件上传凭证
@return string类型，本次文件上传的上传凭证
"""
if header is None:
header = dict()
else:
_check_dict(header)
data = self.__digest_authorization_data(method, bucket, key, header, mime_type)
return self.__auth.ufile_authorization(data)
def signature(self, bucket, key, method="get", header=None, mime_type=None):
"""
根据不同的HTTP请求headers获得文件下载凭证
@param bucket: string类型, 下载文件所在空间名称
@param key: string类型，现在文件在空间中名称
@param method: string类型，为'get'
@param header: dict类型，键值对类型分别为string类型，HTTP请求的header
@param mime_type: string类型，上传文件的MIME，如果提供则采用其计算文件上传凭证
@return string类型，本次文件下载的下载签名
"""
if header is None:
header = dict()
else:
_check_dict(header)
data = self.__digest_signature_data(bucket, key, method, header, mime_type)
return self.__auth.ufile_signature(data)
def __digest_authorization_data(self, method, bucket, key, header=None, mime_type=None):
"""
获得进行认证的字符串
@param method: string类型, 为'put','post'和 'delete'
@param bucket: string类型，空间名称
@param key: string类型，文件在空间中的名称
@param header: dict类型，键值对类型分别为string类型，HTTP请求的header
@param mime_type: string类型，上传文件的MIME，如果提供则采用其计算文件上传凭证
@return string类型，将要进行认证的字符串
"""
if header is None:
header = dict()
else:
_check_dict(header)
data = ''.join([method.upper(), '\n'])
data += ''.join(['' if 'Content-MD5' not in header else header['Content-MD5'], '\n'])
data += ''.join([mime_type if mime_type is not None else '' if 'Content-Type' not in header else header['Content-Type'], '\n'])
data += ''.join(['' if 'Date' not in header else header['Date'], '\n'])
data += ''.join([self.__canonicalize_ucloud_headers(header), self.__canonicalize_resource(bucket, key)])
return data
def __digest_signature_data(self, bucket, key, method='get', header=None, mime_type=None):
"""
获得进行下载签名的字符串
@param bucket: string类型， 空间名称
@param key: string类型， 文件在空间中的名称
@param method: string类型，'get'
@param header: dict类型，键值对类型分别为string类型，HTTP请求的header
@param mime_type: string类型，上传文件的MIME，如果提供则采用其计算文件上传凭证
@return string类型，将要进行签名的字符串
"""
data = ''.join([method.upper(), '\n'])
data += ''.join(['' if 'Content-MD5' not in header else header['Content-MD5'], '\n'])
data += ''.join([mime_type if mime_type is not None else '' if 'Content-Type' not in header else header['Content-Type'], '\n'])
data += ''.join(['' if 'Expires' not in header else header['Expires'], '\n'])
data += ''.join([self.__canonicalize_ucloud_headers(header), self.__canonicalize_resource(bucket, key)])
return data
def __canonicalize_ucloud_headers(self, header):
"""
字符串化UCloud附加标头
@param header: dict类型，键值对类型分别为string类型，UCloud附加标头，键名以'X-UCloud-'开头
@return string类型
"""
# 以下语法不适用于Python 2.6
# ucloud_headers_map = {string.lower(x).strip(): x for x in header if string.lower(x).strip().startswith('x-ucloud-')}
ucloud_headers_map = dict([(x.lowerx.strip(), x) for x in header if x.lower().strip().startswith('x-ucloud-')])
ucloud_keys = sorted(ucloud_headers_map)
return '\n'.join([x+':'+header[ucloud_headers_map[x]].strip() for x in ucloud_keys])
def __canonicalize_resource(self, bucket, key):
"""
获得UFile 资源字符串
@param bucket: string类型, 空间名称
@param key: string类型，文件在空间中的名称
@return string类型，UFile资源字符串
"""
return '/{0}/{1}'.format(bucket, key)
def _public_key(self):
"""
返回账户公私钥中的公钥
@return string类型，公钥
"""
return self.__auth._public_key()
class BucketManager(object):
"""
UCloud UFile 空间管理类
"""
def __init__(self, public_key, private_key):
"""
初始化 BucketManager 实例
@param public_key: string类型， 账户API公私钥的公钥
@param private_key: string类型，账户API公私钥的私钥
@return None，如果为非法的公私钥则抛出ValueError异常
"""
self.__auth = Auth(public_key, private_key)
def set_keys(self, public_key, private_key):
"""
重新设置账户API公私钥
@param public_key: string类型， 账户API公私钥的公钥
@param private_key: string类型，账户API公私钥的私钥
@return None，如果为非法的公私钥则抛出ValueError异常
"""
self.__auth.set_keys(public_key, private_key)
def createbucket(self,
bucket,
buckettype='private',
domainlist=None,
header=None):
"""
创建新的空间
@param bucket: string类型，空间名称
@param buckettype: string类型，'private' 或者 'public'
@param domainlist: list 类型， 要绑定的域名列表
@param header: dict类型，http 请求header，键值对类型分别为string，比如{'User-Agent': 'Google Chrome'}
@return ret: 如果http状态码为[200, 204, 206]之一则返回None，否则如果服务器返回json信息则返回dict类型，键值对类型分别为string, unicode string类型，否则返回空的dict
@return ResponseInfo: 响应的具体信息，UCloud UFile 服务器返回信息或者网络链接异常
"""
if header is None:
header = dict()
else:
_check_dict(header)
if 'User-Agent' not in header:
header['User-Agent'] = config.get_default('user_agent')
param = dict()
param['Action'] = 'CreateBucket'
param['BucketName'] = bucket
param['Type'] = buckettype
if domainlist is None:
domainlist = []
for number, item in enumerate(domainlist):
param['Domain.{0}'.format(number)] = item
signature = self.__auth.bucket_signature(param)
param['Signature'] = signature
logger.info('start create bucket {0}'.format(bucket))
return _bucket_request(UCLOUD_API_URL, param, header)
def describebucket(self, bucket=None, offset=0, limit=10, header=None):
"""
获取空间的信息，如果不提供空间名称，则获取所有空间的信息
@param bucketname: string类型, 空间名称
@param offset: integer类型, 起始空间编码，当提供空间名时无效
@param limit: integer类型，获取空间数量，当提供具体空间名时无效
@param header: dict类型，http 请求header，键值对类型分别为string，比如{'User-Agent': 'Google Chrome'}
@return ret: 如果http状态码为[200, 204, 206]之一则返回None，否则如果服务器返回json信息则返回dict类型，键值对类型分别为string, unicode string类型，否则返回空的dict
@return ResponseInfo: 响应的具体信息，UCloud UFile 服务器返回信息或者网络链接异常
"""
if header is None:
header = dict()
else:
_check_dict(header)
if 'User-Agent' not in header:
header['User-Agent'] = config.get_default('user_agent')
param = dict()
param['Action'] = 'DescribeBucket'
if bucket is not None:
param['BucketName'] = bucket
param['Offset'] = s(str(offset))
param['Limit'] = s(str(limit))
signature = self.__auth.bucket_signature(param)
param['Signature'] = signature
logger.info('start request the bucket {0} details'.format(bucket))
return _bucket_request(UCLOUD_API_URL, param, header)
def updatebucket(self, bucket, buckettype, header=None):
"""
更新空间的属性
@param bucket: string类型，空间名称
@param buckettype: string类型， 'private' 或者 'string'
@param header: dict类型，http 请求header，键值对类型分别为string，比如{'User-Agent': 'Google Chrome'}
@return ret: 如果http状态码为[200, 204, 206]之一则返回None，否则如果服务器返回json信息则返回dict类型，键值对类型分别为string, unicode string类型，否则返回空的dict
@return ResponseInfo: 响应的具体信息，UCloud UFile 服务器返回信息或者网络链接异常
"""
if header is None:
header = dict()
else:
_check_dict(header)
if 'User-Agent' not in header:
header['User-Agent'] = config.get_default('user_agent')
param = dict()
param['Action'] = 'UpdateBucket'
param['BucketName'] = bucket
param['Type'] = buckettype
signature = self.__auth.bucket_signature(param)
param['signature'] = signature
return _bucket_request(UCLOUD_API_URL, param, header)
def deletebucket(self, bucket, header=None):
"""
删除空间
@param bucket: string类型，空间名称
@param header: dict类型，http 请求header，键值对类型分别为string，比如{'User-Agent': 'Google Chrome'}
@return ret: 如果http状态码为[200, 204, 206]之一则返回None，否则如果服务器返回json信息则返回dict类型，键值对类型分别为string, unicode string类型，否则返回空的dict
@return ResponseInfo: 响应的具体信息，UCloud UFile 服务器返回信息或者网络链接异常
"""
if header is None:
header = dict()
else:
_check_dict(header)
if 'User-Agent' not in header:
header['User-Agent'] = config.get_default('user_agent')
param = dict()
param['Action'] = 'DeleteBucket'
param['BucketName'] = bucket
signature = self.__auth.bucket_signature(param)
param['Signature'] = signature
logger.info('start delete bucket {0}'.format(bucket))
return _bucket_request(UCLOUD_API_URL, param, header)
def getfilelist(self, bucket, offset=0, limit=20, header=None):
"""
获取空间中文件列表
@param bucket: string类型,空间名称
@param offset: integer类型，文件列表偏移位置
@param limit: integer类型，返回文件数量
@return ret: 如果http状态码为[200, 204, 206]之一则返回None，否则如果服务器返回json信息则返回dict类型，键值对类型分别为string, unicode string类型，否则返回空的dict
@return ResponseInfo: 响应的具体信息，UCloud UFile 服务器返回信息或者网络链接异常
"""
if header is None:
header = dict()
else:
_check_dict(header)
if 'User-Agent' not in header:
header['User-Agent'] = config.get_default('user_agent')
param = dict()
param['Action'] = 'GetFileList'
param['BucketName'] = bucket
param['Offset'] = s(str(offset))
param['Limit'] = s(str(limit))
signature = self.__auth.bucket_signature(param)
param['Signature'] = signature
logger.info('start request the file list of bucket {0}'.format(bucket))
return _bucket_request(UCLOUD_API_URL, param, header)
class BaseUFile(object):
"""
UCloud UFile 内容管理的基类，主要包括不同操作的公共方法
"""
def __init__(self, public_key, private_key):
"""
初始化 BaseUFile 对象
@param public_key: string类型， 账户API公私钥的公钥
@param private_key: string类型，账户API公私钥的私钥
@return None，如果为非法的公私钥则抛出ValueError异常
"""
self.__auth = Auth(public_key, private_key)
def set_keys(self, public_key, private_key):
"""
重新设置账户API公私钥
@param public_key: string类型， 账户API公私钥的公钥
@param private_key: string类型，账户API公私钥的私钥
@return None，如果为非法的公私钥则抛出ValueError异常
"""
self.__auth.set_keys(public_key, private_key)
def authorization(self, method, bucket, key, header=None, mime_type=None):
"""
根据不同的上传方法和HTTP请求头获得上传凭证
@param method: string类型，文件上传方法，为'put'或'post'
@param bucket: string类型，上传的空间名称
@param key: string类型，文件在上传空间中的名称
@param header: dict类型，键值对类型分别为string类型，HTTP请求的header
@param mime_type: string类型，上传文件的MIME，如果提供则采用其计算文件上传凭证
@return string类型，本次文件上传的上传凭证
"""
if header is None:
header = dict()
else:
_check_dict(header)
data = self.__digest_authorization_data(method, bucket, key, header,
mime_type)
return self.__auth.ufile_authorization(data)
def signature(self,
bucket,
key,
method="get",
header=None,
mime_type=None):
"""
根据不同的HTTP请求headers获得文件下载凭证
@param bucket: string类型, 下载文件所在空间名称
@param key: string类型，现在文件在空间中名称
@param method: string类型，为'get'
@param header: dict类型，键值对类型分别为string类型，HTTP请求的header
@param mime_type: string类型，上传文件的MIME，如果提供则采用其计算文件上传凭证
@return string类型，本次文件下载的下载签名
"""
if header is None:
header = dict()
else:
_check_dict(header)
data = self.__digest_signature_data(bucket, key, method, header,
mime_type)
return self.__auth.ufile_signature(data)
def __digest_authorization_data(self,
method,
bucket,
key,
header=None,
mime_type=None):
"""
获得进行认证的字符串
@param method: string类型, 为'put','post'和 'delete'
@param bucket: string类型，空间名称
@param key: string类型，文件在空间中的名称
@param header: dict类型，键值对类型分别为string类型，HTTP请求的header
@param mime_type: string类型，上传文件的MIME，如果提供则采用其计算文件上传凭证
@return string类型，将要进行认证的字符串
"""
if header is None:
header = dict()
else:
_check_dict(header)
data = ''.join([method.upper(), '\n'])
data += ''.join([
'' if 'Content-MD5' not in header else header['Content-MD5'], '\n'
])
data += ''.join([
mime_type if mime_type is not None else
'' if 'Content-Type' not in header else header['Content-Type'],
'\n'
])
data += ''.join(['' if 'Date' not in header else header['Date'], '\n'])
data += ''.join([
self.__canonicalize_ucloud_headers(header),
self.__canonicalize_resource(bucket, key)
])
return data
def __digest_signature_data(self,
bucket,
key,
method='get',
header=None,
mime_type=None):
"""
获得进行下载签名的字符串
@param bucket: string类型， 空间名称
@param key: string类型， 文件在空间中的名称
@param method: string类型，'get'
@param header: dict类型，键值对类型分别为string类型，HTTP请求的header
@param mime_type: string类型，上传文件的MIME，如果提供则采用其计算文件上传凭证
@return string类型，将要进行签名的字符串
"""
data = ''.join([method.upper(), '\n'])
data += ''.join([
'' if 'Content-MD5' not in header else header['Content-MD5'], '\n'
])
data += ''.join([
mime_type if mime_type is not None else
'' if 'Content-Type' not in header else header['Content-Type'],
'\n'
])
data += ''.join(
['' if 'Expires' not in header else header['Expires'], '\n'])
data += ''.join([
self.__canonicalize_ucloud_headers(header),
self.__canonicalize_resource(bucket, key)
])
return data
def __canonicalize_ucloud_headers(self, header):
"""
字符串化UCloud附加标头
@param header: dict类型，键值对类型分别为string类型，UCloud附加标头，键名以'X-UCloud-'开头
@return string类型
"""
# 以下语法不适用于Python 2.6
# ucloud_headers_map = {string.lower(x).strip(): x for x in header if string.lower(x).strip().startswith('x-ucloud-')}
ucloud_headers_map = dict([(x.lowerx.strip(), x) for x in header
if x.lower().strip().startswith('x-ucloud-')
])
ucloud_keys = sorted(ucloud_headers_map)
return '\n'.join([
x + ':' + header[ucloud_headers_map[x]].strip()
for x in ucloud_keys
])
def __canonicalize_resource(self, bucket, key):
"""
获得UFile 资源字符串
@param bucket: string类型, 空间名称
@param key: string类型，文件在空间中的名称
@return string类型，UFile资源字符串
"""
return '/{0}/{1}'.format(bucket, key)
def _public_key(self):
"""
返回账户公私钥中的公钥
@return string类型，公钥
"""
return self.__auth._public_key()
class BucketManager(object):
"""
UCloud UFile 空间管理类
"""
def __init__(self, public_key, private_key):
"""
初始化 BucketManager 实例
@param public_key: string类型， 账户API公私钥的公钥
@param private_key: string类型，账户API公私钥的私钥
@return None，如果为非法的公私钥则抛出ValueError异常
"""
self.__auth = Auth(public_key, private_key)
def set_keys(self, public_key, private_key):
"""
重新设置账户API公私钥
@param public_key: string类型， 账户API公私钥的公钥
@param private_key: string类型，账户API公私钥的私钥
@return None，如果为非法的公私钥则抛出ValueError异常
"""
self.__auth.set_keys(public_key, private_key)
def createbucket(self, bucket, buckettype='private', domainlist=None, header=None):
"""
创建新的空间
@param bucket: string类型，空间名称
@param buckettype: string类型，'private' 或者 'public'
@param domainlist: list 类型， 要绑定的域名列表
@param header: dict类型，http 请求header，键值对类型分别为string，比如{'User-Agent': 'Google Chrome'}
@return ret: 如果http状态码为[200, 204, 206]之一则返回None，否则如果服务器返回json信息则返回dict类型，键值对类型分别为string, unicode string类型，否则返回空的dict
@return ResponseInfo: 响应的具体信息，UCloud UFile 服务器返回信息或者网络链接异常
"""
if header is None:
header = dict()
else:
_check_dict(header)
if 'User-Agent' not in header:
header['User-Agent'] = config.get_default('user_agent')
param = dict()
param['Action'] = 'CreateBucket'
param['BucketName'] = bucket
param['Type'] = buckettype
if domainlist is None:
domainlist = []
for number, item in enumerate(domainlist):
param['Domain.{0}'.format(number)] = item
signature = self.__auth.bucket_signature(param)
param['Signature'] = signature
logger.info('start create bucket {0}'.format(bucket))
return _bucket_request(UCLOUD_API_URL, param, header)
def describebucket(self, bucket=None, offset=0, limit=10, header=None):
"""
获取空间的信息，如果不提供空间名称，则获取所有空间的信息
@param bucketname: string类型, 空间名称
@param offset: integer类型, 起始空间编码，当提供空间名时无效
@param limit: integer类型，获取空间数量，当提供具体空间名时无效
@param header: dict类型，http 请求header，键值对类型分别为string，比如{'User-Agent': 'Google Chrome'}
@return ret: 如果http状态码为[200, 204, 206]之一则返回None，否则如果服务器返回json信息则返回dict类型，键值对类型分别为string, unicode string类型，否则返回空的dict
@return ResponseInfo: 响应的具体信息，UCloud UFile 服务器返回信息或者网络链接异常
"""
if header is None:
header = dict()
else:
_check_dict(header)
if 'User-Agent' not in header:
header['User-Agent'] = config.get_default('user_agent')
param = dict()
param['Action'] = 'DescribeBucket'
if bucket is not None:
param['BucketName'] = bucket
param['Offset'] = s(str(offset))
param['Limit'] = s(str(limit))
signature = self.__auth.bucket_signature(param)
param['Signature'] = signature
logger.info('start request the bucket {0} details'.format(bucket))
return _bucket_request(UCLOUD_API_URL, param, header)
def updatebucket(self, bucket, buckettype, header=None):
"""
更新空间的属性
@param bucket: string类型，空间名称
@param buckettype: string类型， 'private' 或者 'string'
@param header: dict类型，http 请求header，键值对类型分别为string，比如{'User-Agent': 'Google Chrome'}
@return ret: 如果http状态码为[200, 204, 206]之一则返回None，否则如果服务器返回json信息则返回dict类型，键值对类型分别为string, unicode string类型，否则返回空的dict
@return ResponseInfo: 响应的具体信息，UCloud UFile 服务器返回信息或者网络链接异常
"""
if header is None:
header = dict()
else:
_check_dict(header)
if 'User-Agent' not in header:
header['User-Agent'] = config.get_default('user_agent')
param = dict()
param['Action'] = 'UpdateBucket'
param['BucketName'] = bucket
param['Type'] = buckettype
signature = self.__auth.bucket_signature(param)
param['signature'] = signature
return _bucket_request(UCLOUD_API_URL, param, header)
def deletebucket(self, bucket, header=None):
"""
删除空间
@param bucket: string类型，空间名称
@param header: dict类型，http 请求header，键值对类型分别为string，比如{'User-Agent': 'Google Chrome'}
@return ret: 如果http状态码为[200, 204, 206]之一则返回None，否则如果服务器返回json信息则返回dict类型，键值对类型分别为string, unicode string类型，否则返回空的dict
@return ResponseInfo: 响应的具体信息，UCloud UFile 服务器返回信息或者网络链接异常
"""
if header is None:
header = dict()
else:
_check_dict(header)
if 'User-Agent' not in header:
header['User-Agent'] = config.get_default('user_agent')
param = dict()
param['Action'] = 'DeleteBucket'
param['BucketName'] = bucket
signature = self.__auth.bucket_signature(param)
param['Signature'] = signature
logger.info('start delete bucket {0}'.format(bucket))
return _bucket_request(UCLOUD_API_URL, param, header)
def getfilelist(self, bucket, offset=0, limit=20, header=None):
"""
获取空间中文件列表
@param bucket: string类型,空间名称
@param offset: integer类型，文件列表偏移位置
@param limit: integer类型，返回文件数量
@return ret: 如果http状态码为[200, 204, 206]之一则返回None，否则如果服务器返回json信息则返回dict类型，键值对类型分别为string, unicode string类型，否则返回空的dict
@return ResponseInfo: 响应的具体信息，UCloud UFile 服务器返回信息或者网络链接异常
"""
if header is None:
header = dict()
else:
_check_dict(header)
if 'User-Agent' not in header:
header['User-Agent'] = config.get_default('user_agent')
param = dict()
param['Action'] = 'GetFileList'
param['BucketName'] = bucket
param['Offset'] = s(str(offset))
param['Limit'] = s(str(limit))
signature = self.__auth.bucket_signature(param)
param['Signature'] = signature
logger.info('start request the file list of bucket {0}'.format(bucket))
return _bucket_request(UCLOUD_API_URL, param, header)