Merge pull request #38 from Yulegu-bj/master

Head请求添加X-Ufile-restore头信息

Author: Tianchang

examples/example_opMeta.py

@@ -0,0 +1,21 @@
+# !/usr/bin/env python
+# -*- encoding: utf-8 -*-
+from ufile import filemanager
+
+bucket = ''  # 空间名称
+key = ''  # 文件名称
+public_key = ''  # 账户公钥
+private_key = ''  # 账户私钥
+metakey = 'mimetype'  # 自定义元数据键
+metavalue = 'text/plain'  # 自定义元数据值
+
+# 设置上传host后缀,外网可用后缀形如 .cn-bj.ufileos.com（cn-bj为北京地区，其他地区具体后缀可见控制台：对象存储-单地域空间管理-存储空间域名）
+# 默认值为'.cn-bj.ufileos.com'，如果上传文件的bucket所在地域不在北京，请务必设置此项
+upload_suffix = 'YOUR_UPLOAD_SUFFIX'
+
+file = filemanager.FileManager(public_key, private_key, upload_suffix)
+
+# 设置文件元数据
+ret, resp = file.opMeta(bucket, key, metakey, metavalue)
+assert resp.status_code == 200, resp.error
+print('setfilemetakey success')

ufile/__init__.py

@@ -4,4 +4,4 @@
 UCloud UFile SDK for python
 """
 
-__version__ = '3.2.8'
+__version__ = '3.2.9'

ufile/filemanager.py

@@ -10,11 +10,12 @@
 from .compact import b, s, u, url_parse, quote
 from .config import BLOCKSIZE
 from .httprequest import _put_stream, _put_file, _post_file, ResponseInfo, _uploadhit_file, _download_file, \
-    _delete_file, _getfilelist, _head_file, _restore_file, _classswitch_file, _copy_file, _rename_file, _listobjects
+    _delete_file, _getfilelist, _head_file, _restore_file, _classswitch_file, _copy_file, _rename_file, _listobjects, \
+    _op_meta
 from .logger import logger
 from .util import _check_dict, ufile_put_url, ufile_post_url, file_etag, ufile_uploadhit_url, ufile_getfilelist_url, \
     mimetype_from_file, ufile_restore_url, ufile_classswitch_url, ufile_copy_url, ufile_rename_url, \
-    ufile_listobjects_url
+    ufile_listobjects_url, ufile_op_meta_url
 
 
 class FileManager(BaseUFile):
@@ -535,3 +536,35 @@ def listobjects(self, bucket, prefix=None, marker=None, maxkeys=None, delimiter=
         logger.info(info_message)
         url = ufile_listobjects_url(bucket, upload_suffix=self.__upload_suffix)
         return _listobjects(url, header, param)
+
+    def opMeta(self, bucket, key, metak, metav, op="set", header=None):
+        """
+        获取文件元数据
+
+        :param bucket: string 类型，空间名称
+        :param key: string 类型，文件在空间中的名称
+        :param metak: string 类型，元数据的key
+        :param metav: string 类型，元数据的value
+        :param op: string 类型，操作类型，目前只支持set
+        :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')
+        header['Content-Type'] = 'application/json'
+
+        auth = self.authorization('post', bucket, key, header, action="opmeta")
+        header['Authorization'] = auth
+        data = {
+            'op': op,
+            'metak': metak,
+            'metav': metav
+        }
+        url = ufile_op_meta_url(bucket, key, upload_suffix=self.__upload_suffix)
+        return _op_meta(url, json.dumps(data), header)

ufile/httprequest.py

@@ -343,6 +343,21 @@ def _get_multi_upload_part(url, header):
     return __return_wraper(response)
 
 
+def _op_meta(url, body, header):
+    """
+    UCloud UFile 文件元数据操作请求
+
+    :param url: String类型，文件元数据操作请求的url
+    :param body: dict类型，键值对类型分别为string类型，HTTP请求的body信息
+    :param header: dict类型，键值对类型分别为string类型，HTTP请求头信息
+    """
+    try:
+        response = requests.post(url, headers=header, data=body, timeout=config.get_default('connection_timeout'))
+    except RequestException as e:
+        return None, ResponseInfo(None, e)
+    return __return_wraper(response)
+
+
 class ResponseInfo(object):
     """
     UCloud UFile 服务器返回信息,解析UCloud UFile服务器返回信息以及网络连接问题
@@ -382,6 +397,7 @@ def __init__(self, response, exception=None, content_consumed=False):
             self.ret_code = None
             self.content = None
             self.md5 = None
+            self.x_ufile_restore = None
         else:
             self.status_code = response.status_code
             self.x_session_id = response.headers.get('X-SessionId')
@@ -390,6 +406,7 @@ def __init__(self, response, exception=None, content_consumed=False):
             self.content_length = response.headers.get('Content-Length')
             content_length = response.headers.get('content-range')
             self.content = None if content_consumed else response.content
+            self.x_ufile_restore = response.headers.get('X-Ufile-restore')
             if content_length is not None:
                 byteslist = re.split('[- /]', content_length)
                 self.content_range = (int(byteslist[1]), int(byteslist[2]))

ufile/util.py

@@ -542,6 +542,17 @@ def ufile_listparts_url(bucket, upload_suffix, upload_id, max_parts=None, part_n
     return url
 
 
+def ufile_op_meta_url(bucket, key, upload_suffix=None):
+    """
+    文件元数据的url
+
+    :param bucket: string类型, 待创建的空间名称
+    :param key:  string类型, 在空间中的文件名
+    :return: string类型, 获取文件元数据的url
+    """
+    return 'http://{0}{1}/{2}?opmeta'.format(bucket, upload_suffix or config.get_default('upload_suffix'), key)
+
+
 def deprecated(message):
     def deprecated_decorator(func):
         def deprecated_func(*args, **kwargs):