Merge pull request #379 from qiniu/develop

修复扩展状态码异常处理问题、添加了查询短信发送记录、空间和域名操作 相关方法

Author: Mei-Zhao

README.md

@@ -60,7 +60,7 @@ $ py.test
 ## 常见问题
 
 - 第二个参数info保留了请求响应的信息，失败情况下ret 为none, 将info可以打印出来，提交给我们。
-- API 的使用 demo 可以参考 [单元测试](https://github.com/qiniu/python-sdk/blob/master/test_qiniu.py)。
+- API 的使用 demo 可以参考 [examples示例](https://github.com/qiniu/python-sdk/tree/master/examples)。
 - 如果碰到`ImportError: No module named requests.auth` 请安装 `requests` 。
 
 ## 代码贡献

examples/.qiniu_pythonsdk_hostscache.json

@@ -0,0 +1 @@
+{"http:wxCLv4yl_5saIuOHbbZbkP-Ef3kFFFeCDYmwTdg3:upload30": {"upHosts": ["http://up.qiniu.com", "http://upload.qiniu.com", "-H up.qiniu.com http://183.131.7.3"], "ioHosts": ["http://iovip.qbox.me"], "deadline": 1598428478}}

examples/batch_restoreAr.py

@@ -0,0 +1,31 @@
+# -*- coding: utf-8 -*-
+# flake8: noqa
+
+"""
+批量解冻文件
+https://developer.qiniu.com/kodo/api/1250/batch
+"""
+
+from qiniu import build_batch_restoreAr, Auth, BucketManager
+
+# 七牛账号的公钥和私钥
+access_key = '<access_key>'
+secret_key = '<secret_key>'
+
+q = Auth(access_key, secret_key)
+
+bucket = BucketManager(q)
+
+# 存储空间
+bucket_name = "空间名"
+
+# 字典的键为需要解冻的文件，值为解冻有效期1-7
+ops = build_batch_restoreAr(bucket_name,
+                            {"test00.png": 1,
+                             "test01.jpeg": 2,
+                             "test02.mp4": 3
+                             }
+                            )
+
+ret, info = bucket.batch(ops)
+print(info)

examples/bucket_domain.py

@@ -0,0 +1,24 @@
+# -*- coding: utf-8 -*-
+# flake8: noqa
+
+from qiniu import Auth
+from qiniu import BucketManager
+
+"""
+获取空间绑定的加速域名
+https://developer.qiniu.com/kodo/api/3949/get-the-bucket-space-domain
+"""
+
+# 七牛账号的 公钥和私钥
+access_key = '<access_key>'
+secret_key = '<secret_key>'
+
+# 空间名
+bucket_name = ''
+
+q = Auth(access_key, secret_key)
+
+bucket = BucketManager(q)
+
+ret, info = bucket.bucket_domain(bucket_name)
+print(info)

examples/change_bucket_permission.py

@@ -0,0 +1,22 @@
+# -*- coding: utf-8 -*-
+# flake8: noqa
+
+from qiniu import Auth
+from qiniu import BucketManager
+
+# 需要填写七牛账号的 公钥和私钥
+access_key = '<access_key>'
+secret_key = '<secret_key>'
+
+# 空间名
+bucket_name = ""
+
+# private 参数必须是str类型，0表示公有空间，1表示私有空间
+private = "0"
+
+q = Auth(access_key, secret_key)
+
+bucket = BucketManager(q)
+
+ret, info = bucket.change_bucket_permission(bucket_name, private)
+print(info)

examples/domain_relevant.py

@@ -0,0 +1,60 @@
+# -*- coding: utf-8 -*-
+from qiniu import QiniuMacAuth, DomainManager
+import json
+
+"""域名上线"""
+
+# 七牛账号的 公钥和私钥
+access_key = "<access_key>"
+secret_key = "<secret_key>"
+
+auth = QiniuMacAuth(access_key, secret_key)
+
+manager = DomainManager(auth)
+
+# 域名
+name = "zhuchangzhao2.peterpy.cn"
+
+ret, res = manager.domain_online(name)
+
+headers = {"code": res.status_code, "reqid": res.req_id, "xlog": res.x_log}
+print(json.dumps(headers, indent=4, ensure_ascii=False))
+print(json.dumps(ret, indent=4, ensure_ascii=False))
+
+"""域名下线"""
+
+# 七牛账号的 公钥和私钥
+access_key = "<access_key>"
+secret_key = "<secret_key>"
+
+auth = QiniuMacAuth(access_key, secret_key)
+
+manager = DomainManager(auth)
+
+# 域名
+name = ""
+
+ret, res = manager.domain_offline(name)
+
+headers = {"code": res.status_code, "reqid": res.req_id, "xlog": res.x_log}
+print(json.dumps(headers, indent=4, ensure_ascii=False))
+print(json.dumps(ret, indent=4, ensure_ascii=False))
+
+"""删除域名"""
+
+# 七牛账号的 公钥和私钥
+access_key = "<access_key>"
+secret_key = "<secret_key>"
+
+auth = QiniuMacAuth(access_key, secret_key)
+
+manager = DomainManager(auth)
+
+# 域名
+name = ""
+
+ret, res = manager.delete_domain(name)
+
+headers = {"code": res.status_code, "reqid": res.req_id, "xlog": res.x_log}
+print(json.dumps(headers, indent=4, ensure_ascii=False))
+print(json.dumps(ret, indent=4, ensure_ascii=False))

examples/sms_test.py

@@ -84,15 +84,17 @@
 print(req, info)
 """
 
+"""
+# 查询短信发送记录
+req, info = sms.get_messages_info()
+print(req, info)
+"""
+
 """
 #发送短信
 """
-template_id	= ''
+template_id = ''
 mobiles = []
 parameters = {}
 req, info = sms.sendMessage(template_id, mobiles, parameters)
 print(req, info)
-
-
-
-

qiniu/__init__.py

@@ -18,7 +18,7 @@
 from .region import Region
 
 from .services.storage.bucket import BucketManager, build_batch_copy, build_batch_rename, build_batch_move, \
-    build_batch_stat, build_batch_delete
+    build_batch_stat, build_batch_delete, build_batch_restoreAr
 from .services.storage.uploader import put_data, put_file, put_stream
 from .services.cdn.manager import CdnManager, create_timestamp_anti_leech_url, DomainManager
 from .services.processing.pfop import PersistentFop

qiniu/http.py

@@ -113,7 +113,7 @@ def _post_with_auth(url, data, auth):
 
 
 def _get_with_auth(url, data, auth):
-    return _get(url, data,  qiniu.auth.RequestsAuth(auth))
+    return _get(url, data, qiniu.auth.RequestsAuth(auth))
 
 
 def _post_with_auth_and_headers(url, data, auth, headers):
@@ -245,14 +245,14 @@ def __init__(self, response, exception=None):
             self.req_id = response.headers.get('X-Reqid')
             self.x_log = response.headers.get('X-Log')
             if self.status_code >= 400:
-                if 600 > self.status_code >= 499:
-                    self.error = response.text
-                else:
+                if self.__check_json(response):
                     ret = response.json() if response.text != '' else None
-                    if ret is None or ret['error'] is None:
+                    if ret is None:
                         self.error = 'unknown'
                     else:
-                        self.error = ret['error']
+                        self.error = response.text
+                else:
+                    self.error = response.text
             if self.req_id is None and self.status_code == 200:
                 self.error = 'server is not qiniu'
 
@@ -280,3 +280,10 @@ def __str__(self):
 
     def __repr__(self):
         return self.__str__()
+
+    def __check_json(self, reponse):
+        try:
+            reponse.json()
+            return True
+        except Exception:
+            return False

qiniu/services/cdn/manager.py

@@ -200,6 +200,46 @@ def create_domain(self, name, body):
         url = '{0}/domain/{1}'.format(self.server, name)
         return self.__post(url, body)
 
+    def domain_online(self, name):
+        """
+        上线域名，文档 https://developer.qiniu.com/fusion/api/4246/the-domain-name#6
+
+        Args:
+            name:     域名, 如果是泛域名，必须以点号 . 开头
+            bosy:     创建域名参数
+        Returns:
+            {}
+        """
+        url = '{0}/domain/{1}/online'.format(self.server, name)
+        return http._post_with_qiniu_mac(url, None, self.auth)
+
+    def domain_offline(self, name):
+        """
+        下线域名，文档 https://developer.qiniu.com/fusion/api/4246/the-domain-name#5
+
+        Args:
+            name:     域名, 如果是泛域名，必须以点号 . 开头
+            bosy:     创建域名参数
+        Returns:
+            {}
+        """
+        url = '{0}/domain/{1}/offline'.format(self.server, name)
+        return http._post_with_qiniu_mac(url, None, self.auth)
+
+    def delete_domain(self, name):
+        """
+        删除域名，文档 https://developer.qiniu.com/fusion/api/4246/the-domain-name#8
+
+        Args:
+            name:     域名, 如果是泛域名，必须以点号 . 开头
+        Returns:
+            返回一个tuple对象，其格式为(<result>, <ResponseInfo>)
+            - result          成功返回dict{}，失败返回{"error": "<errMsg string>"}
+            - ResponseInfo    请求的Response信息
+        """
+        url = '{0}/domain/{1}'.format(self.server, name)
+        return self.__get(url)
+
     def get_domain(self, name):
         """
         获取域名信息，文档 https://developer.qiniu.com/fusion/api/4246/the-domain-name

qiniu/services/sms/sms.py

@@ -56,11 +56,11 @@ def querySignature(self, audit_status=None, page=1, page_size=20):
             "page_size": int,
             }
         """
-        url = '{}/v1/signature'.format(self.server)
+        url = '{0}/v1/signature'.format(self.server)
         if audit_status:
-            url = '{}?audit_status={}&page={}&page_size={}'.format(url, audit_status, page, page_size)
+            url = '{0}?audit_status={1}&page={2}&page_size={3}'.format(url, audit_status, page, page_size)
         else:
-            url = '{}?page={}&page_size={}'.format(url, page, page_size)
+            url = '{0}?page={1}&page_size={2}'.format(url, page, page_size)
         return self.__get(url)
 
     def updateSignature(self, id, signature):
@@ -73,7 +73,7 @@ def updateSignature(self, id, signature):
         }
         :return:
         """
-        url = '{}/v1/signature/{}'.format(self.server, id)
+        url = '{0}/v1/signature/{1}'.format(self.server, id)
         req = {}
         req['signature'] = signature
         body = json.dumps(req)
@@ -87,7 +87,7 @@ def deleteSignature(self, id):
         * @retrun : 请求成功 HTTP 状态码为 200
 
         """
-        url = '{}/v1/signature/{}'.format(self.server, id)
+        url = '{0}/v1/signature/{1}'.format(self.server, id)
         return self.__delete(url)
 
     def createTemplate(self, name, template, type, description, signature_id):
@@ -103,7 +103,7 @@ def createTemplate(self, name, template, type, description, signature_id):
         "template_id": string
                 }
         """
-        url = '{}/v1/template'.format(self.server)
+        url = '{0}/v1/template'.format(self.server)
         req = {}
         req['name'] = name
         req['template'] = template
@@ -137,11 +137,11 @@ def queryTemplate(self, audit_status, page=1, page_size=20):
             "page_size": int
         }
         """
-        url = '{}/v1/template'.format(self.server)
+        url = '{0}/v1/template'.format(self.server)
         if audit_status:
-            url = '{}?audit_status={}&page={}&page_size={}'.format(url, audit_status, page, page_size)
+            url = '{0}?audit_status={1}&page={2}&page_size={3}'.format(url, audit_status, page, page_size)
         else:
-            url = '{}?page={}&page_size={}'.format(url, page, page_size)
+            url = '{0}?page={1}&page_size={2}'.format(url, page, page_size)
         return self.__get(url)
 
     def updateTemplate(self, id, name, template, description, signature_id):
@@ -154,7 +154,7 @@ def updateTemplate(self, id, name, template, description, signature_id):
         :param signature_id: 已经审核通过的签名 string  类型，必填
         :return: 请求成功 HTTP 状态码为 200
         """
-        url = '{}/v1/template/{}'.format(self.server, id)
+        url = '{0}/v1/template/{1}'.format(self.server, id)
         req = {}
         req['name'] = name
         req['template'] = template
@@ -169,7 +169,7 @@ def deleteTemplate(self, id):
         :param id: template_id
         :return: 请求成功 HTTP 状态码为 200
         """
-        url = '{}/v1/template/{}'.format(self.server, id)
+        url = '{0}/v1/template/{1}'.format(self.server, id)
         return self.__delete(url)
 
     def sendMessage(self, template_id, mobiles, parameters):
@@ -182,14 +182,23 @@ def sendMessage(self, template_id, mobiles, parameters):
             "job_id": string
         }
         """
-        url = '{}/v1/message'.format(self.server)
+        url = '{0}/v1/message'.format(self.server)
         req = {}
         req['template_id'] = template_id
         req['mobiles'] = mobiles
         req['parameters'] = parameters
         body = json.dumps(req)
         return self.__post(url, body)
 
+    def get_messages_info(self):
+        """
+        查询发送记录，文档：https://developer.qiniu.com/sms/api/5852/query-send-sms
+        :return:
+            {}
+        """
+        url = "{0}/v1/messages".format(self.server)
+        return self.__get(url)
+
     def __post(self, url, data=None):
         headers = {'Content-Type': 'application/json'}
         return http._post_with_qiniu_mac_and_headers(url, data, self.auth, headers)