Merge pull request #430 from qiniu/docs/update-links

update docs links & bump version to v7.10.0

Author: bachue

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 7.10.0（2022-11-15）
+* 对象存储，修复通过 set_default 设置 rs, rsf 不生效，而 SDK 自动获取的问题（v7.9.0）
+* 对象存储，支持直接从 qiniu 导入 UploadProgressRecorder
+* 对象存储，优化分片上传 ctx 超时检测
+* 文档，更新注释中文档链接
+
 ## 7.9.0（2022-07-20）
 * 对象存储，支持使用时不配置区域信息，SDK 自动获取；
 * 对象存储，新增 list_domains API 用于查询空间绑定的域名

README.md

@@ -43,7 +43,7 @@ import qiniu
 ...
 
 ```
-更多参见SDK使用指南： http://developer.qiniu.com/code/v7/sdk/python.html
+更多参见SDK使用指南： https://developer.qiniu.com/kodo/sdk/python
 ```
 
 ## 测试

examples/pfop_watermark.py

@@ -14,7 +14,7 @@
 # 转码是使用的队列名称。
 pipeline = 'pipeline_name'
 
-# 需要添加水印的图片UrlSafeBase64,可以参考http://developer.qiniu.com/code/v6/api/dora-api/av/video-watermark.html
+# 需要添加水印的图片UrlSafeBase64,可以参考 https://developer.qiniu.com/dora/api/video-watermarking
 base64URL = urlsafe_base64_encode(
     'http://developer.qiniu.com/resource/logo-2.jpg')
 

qiniu/__init__.py

@@ -9,7 +9,7 @@
 
 # flake8: noqa
 
-__version__ = '7.9.0'
+__version__ = '7.10.0'
 
 from .auth import Auth, QiniuMacAuth
 

qiniu/http.py

@@ -239,8 +239,8 @@ class ResponseInfo(object):
     Attributes:
         status_code: 整数变量，响应状态码
         text_body:   字符串变量，响应的body
-        req_id:      字符串变量，七牛HTTP扩展字段，参考 http://developer.qiniu.com/docs/v6/api/reference/extended-headers.html
-        x_log:       字符串变量，七牛HTTP扩展字段，参考 http://developer.qiniu.com/docs/v6/api/reference/extended-headers.html
+        req_id:      字符串变量，七牛HTTP扩展字段，参考 https://developer.qiniu.com/kodo/3924/common-request-headers
+        x_log:       字符串变量，七牛HTTP扩展字段，参考 https://developer.qiniu.com/kodo/3924/common-request-headers
         error:       字符串变量，响应的错误内容
     """
 

qiniu/services/cdn/manager.py

@@ -25,7 +25,7 @@ def __init__(self, auth):
 
     def refresh_urls(self, urls):
         """
-        刷新文件列表，文档 http://developer.qiniu.com/article/fusion/api/refresh.html
+        刷新文件列表，文档 https://developer.qiniu.com/fusion/api/cache-refresh
 
         Args:
             urls: 待刷新的文件外链列表
@@ -38,7 +38,7 @@ def refresh_urls(self, urls):
 
     def refresh_dirs(self, dirs):
         """
-        刷新目录，文档 http://developer.qiniu.com/article/fusion/api/refresh.html
+        刷新目录，文档 https://developer.qiniu.com/fusion/api/cache-refresh
 
         Args:
             urls: 待刷新的目录列表
@@ -51,7 +51,7 @@ def refresh_dirs(self, dirs):
 
     def refresh_urls_and_dirs(self, urls, dirs):
         """
-        刷新文件目录，文档 http://developer.qiniu.com/article/fusion/api/refresh.html
+        刷新文件目录，文档 https://developer.qiniu.com/fusion/api/cache-refresh
 
         Args:
            urls: 待刷新的目录列表
@@ -73,7 +73,7 @@ def refresh_urls_and_dirs(self, urls, dirs):
 
     def prefetch_urls(self, urls):
         """
-        预取文件列表，文档 http://developer.qiniu.com/article/fusion/api/prefetch.html
+        预取文件列表，文档 https://developer.qiniu.com/fusion/api/file-prefetching
 
         Args:
            urls: 待预取的文件外链列表
@@ -91,7 +91,7 @@ def prefetch_urls(self, urls):
 
     def get_bandwidth_data(self, domains, start_date, end_date, granularity):
         """
-        查询带宽数据，文档 http://developer.qiniu.com/article/fusion/api/traffic-bandwidth.html
+        查询带宽数据，文档 https://developer.qiniu.com/fusion/api/traffic-bandwidth
 
         Args:
            domains:     域名列表
@@ -115,7 +115,7 @@ def get_bandwidth_data(self, domains, start_date, end_date, granularity):
 
     def get_flux_data(self, domains, start_date, end_date, granularity):
         """
-        查询流量数据，文档 http://developer.qiniu.com/article/fusion/api/traffic-bandwidth.html
+        查询流量数据，文档 https://developer.qiniu.com/fusion/api/traffic-bandwidth
 
         Args:
            domains:     域名列表
@@ -139,7 +139,7 @@ def get_flux_data(self, domains, start_date, end_date, granularity):
 
     def get_log_list_data(self, domains, log_date):
         """
-        获取日志下载链接，文档 http://developer.qiniu.com/article/fusion/api/log.html
+        获取日志下载链接，文档 https://developer.qiniu.com/fusion/api/download-the-log
 
         Args:
            domains:     域名列表
@@ -159,7 +159,7 @@ def get_log_list_data(self, domains, log_date):
 
     def put_httpsconf(self, name, certid, forceHttps=False):
         """
-        修改证书，文档 https://developer.qiniu.com/fusion/api/4246/the-domain-name#11
+        修改证书，文档 https://developer.qiniu.com/fusion/4246/the-domain-name#11
 
         Args:
            domains:     域名name

qiniu/services/processing/pfop.py

@@ -8,12 +8,12 @@ class PersistentFop(object):
     """持久化处理类
 
     该类用于主动触发异步持久化操作，具体规格参考：
-    http://developer.qiniu.com/docs/v6/api/reference/fop/pfop/pfop.html
+    https://developer.qiniu.com/dora/api/persistent-data-processing-pfop
 
     Attributes:
         auth:       账号管理密钥对，Auth对象
         bucket:     操作资源所在空间
-        pipeline:   多媒体处理队列，详见 https://portal.qiniu.com/mps/pipeline
+        pipeline:   多媒体处理队列，详见 https://developer.qiniu.com/dora/6499/tasks-and-workflows
         notify_url: 持久化处理结果通知URL
     """
 

qiniu/services/storage/bucket.py

@@ -9,7 +9,7 @@ class BucketManager(object):
     """空间管理类
 
     主要涉及了空间资源管理及批量操作接口的实现，具体的接口规格可以参考：
-    http://developer.qiniu.com/docs/v6/api/reference/rs/
+    https://developer.qiniu.com/kodo/1274/rs
 
     Attributes:
         auth: 账号管理密钥对，Auth对象
@@ -33,7 +33,7 @@ def list(self, bucket, prefix=None, marker=None, limit=None, delimiter=None):
         2. 无论 err 值如何，均应该先看 ret.get('items') 是否有内容
         3. 如果后续没有更多数据，err 返回 EOF，marker 返回 None（但不通过该特征来判断是否结束）
         具体规格参考:
-        http://developer.qiniu.com/docs/v6/api/reference/rs/list.html
+        https://developer.qiniu.com/kodo/api/list
 
         Args:
             bucket:     空间名
@@ -111,7 +111,7 @@ def delete(self, bucket, key):
         """删除文件:
 
         删除指定资源，具体规格参考：
-        http://developer.qiniu.com/docs/v6/api/reference/rs/delete.html
+        https://developer.qiniu.com/kodo/api/delete
 
         Args:
             bucket: 待获取信息资源所在的空间
@@ -144,7 +144,7 @@ def move(self, bucket, key, bucket_to, key_to, force='false'):
         """移动文件:
 
         将资源从一个空间到另一个空间，具体规格参考：
-        http://developer.qiniu.com/docs/v6/api/reference/rs/move.html
+        https://developer.qiniu.com/kodo/api/move
 
         Args:
             bucket:     待操作资源所在空间
@@ -164,7 +164,7 @@ def copy(self, bucket, key, bucket_to, key_to, force='false'):
         """复制文件:
 
         将指定资源复制为新命名资源，具体规格参考：
-        http://developer.qiniu.com/docs/v6/api/reference/rs/copy.html
+        https://developer.qiniu.com/kodo/api/copy
 
         Args:
             bucket:     待操作资源所在空间
@@ -183,7 +183,7 @@ def copy(self, bucket, key, bucket_to, key_to, force='false'):
     def fetch(self, url, bucket, key=None, hostscache_dir=None):
         """抓取文件:
         从指定URL抓取资源，并将该资源存储到指定空间中，具体规格参考：
-        http://developer.qiniu.com/docs/v6/api/reference/rs/fetch.html
+        https://developer.qiniu.com/kodo/api/fetch
 
         Args:
             url:      指定的URL
@@ -205,7 +205,7 @@ def prefetch(self, bucket, key, hostscache_dir=None):
         """镜像回源预取文件:
 
         从镜像源站抓取资源到空间中，如果空间中已经存在，则覆盖该资源，具体规格参考
-        http://developer.qiniu.com/docs/v6/api/reference/rs/prefetch.html
+        https://developer.qiniu.com/kodo/api/prefetch
 
         Args:
             bucket: 待获取资源所在的空间
@@ -223,7 +223,7 @@ def change_mime(self, bucket, key, mime):
         """修改文件mimeType:
 
         主动修改指定资源的文件类型，具体规格参考：
-        http://developer.qiniu.com/docs/v6/api/reference/rs/chgm.html
+        https://developer.qiniu.com/kodo/api/chgm
 
         Args:
             bucket: 待操作资源所在空间
@@ -238,7 +238,7 @@ def change_type(self, bucket, key, storage_type):
         """修改文件的存储类型
 
         修改文件的存储类型，参考文档：
-        https://developer.qiniu.com/kodo/api/3710/modify-the-file-type
+        https://developer.qiniu.com/kodo/3710/chtype
 
         Args:
             bucket:         待操作资源所在空间
@@ -252,7 +252,7 @@ def restoreAr(self, bucket, key, freezeAfter_days):
         """解冻归档存储、深度归档存储文件
 
         对归档存储、深度归档存储文件，进行解冻操作参考文档：
-        https://developer.qiniu.com/kodo/api/6380/restore-archive
+        https://developer.qiniu.com/kodo/6380/restore-archive
 
         Args:
             bucket:         待操作资源所在空间
@@ -324,7 +324,7 @@ def batch(self, operations):
         """批量操作:
 
         在单次请求中进行多个资源管理操作，具体规格参考：
-        http://developer.qiniu.com/docs/v6/api/reference/rs/batch.html
+        https://developer.qiniu.com/kodo/api/batch
 
         Args:
             operations: 资源管理操作数组，可通过

qiniu/services/storage/uploader.py

@@ -19,7 +19,7 @@ def put_data(
         up_token:         上传凭证
         key:              上传文件名
         data:             上传二进制流
-        params:           自定义变量，规格参考 http://developer.qiniu.com/docs/v6/api/overview/up/response/vars.html#xvar
+        params:           自定义变量，规格参考 https://developer.qiniu.com/kodo/manual/vars#xvar
         mime_type:        上传数据的mimeType
         check_crc:        是否校验crc32
         progress_handler: 上传进度
@@ -56,7 +56,7 @@ def put_file(up_token, key, file_path, params=None,
         up_token:                 上传凭证
         key:                      上传文件名
         file_path:                上传文件的路径
-        params:                   自定义变量，规格参考 http://developer.qiniu.com/docs/v6/api/overview/up/response/vars.html#xvar
+        params:                   自定义变量，规格参考 https://developer.qiniu.com/kodo/manual/vars#xvar
         mime_type:                上传数据的mimeType
         check_crc:                是否校验crc32
         progress_handler:         上传进度
@@ -153,15 +153,15 @@ class _Resume(object):
     """断点续上传类
 
     该类主要实现了分块上传，断点续上，以及相应地创建块和创建文件过程，详细规格参考：
-    http://developer.qiniu.com/docs/v6/api/reference/up/mkblk.html
-    http://developer.qiniu.com/docs/v6/api/reference/up/mkfile.html
+    https://developer.qiniu.com/kodo/api/mkblk
+    https://developer.qiniu.com/kodo/api/mkfile
 
     Attributes:
         up_token:                   上传凭证
         key:                        上传文件名
         input_stream:               上传二进制流
         data_size:                  上传流大小
-        params:                     自定义变量，规格参考 http://developer.qiniu.com/docs/v6/api/overview/up/response/vars.html#xvar
+        params:                     自定义变量，规格参考 https://developer.qiniu.com/kodo/manual/vars#xvar
         mime_type:                  上传数据的mimeType
         progress_handler:           上传进度
         upload_progress_recorder:   记录上传进度，用于断点续传

test_qiniu.py

@@ -322,14 +322,14 @@ def test_prefetch(self):
         assert ret['key'] == 'python-sdk.html'
 
     def test_fetch(self):
-        ret, info = self.bucket.fetch('http://developer.qiniu.com/docs/v6/sdk/python-sdk.html', bucket_name,
+        ret, info = self.bucket.fetch('https://developer.qiniu.com/kodo/sdk/python', bucket_name,
                                       'fetch.html', hostscache_dir=hostscache_dir)
         print(info)
         assert ret['key'] == 'fetch.html'
         assert 'hash' in ret
 
     def test_fetch_without_key(self):
-        ret, info = self.bucket.fetch('http://developer.qiniu.com/docs/v6/sdk/python-sdk.html', bucket_name,
+        ret, info = self.bucket.fetch('https://developer.qiniu.com/kodo/sdk/python', bucket_name,
                                       hostscache_dir=hostscache_dir)
         print(info)
         assert ret['key'] == ret['hash']