feat(sts): 增加 STS 令牌获取可以选择 OSS 区域和是否使用 VPC 域名的参数功能

Author: leafcoder

CHANGELOG.md

@@ -1,3 +1,12 @@
+## [0.6.1](https://github.com/teambge/bge-python-sdk/compare/v0.6.0...v0.6.1) (2023-12-04)
+
+
+### Features
+
+* **sts:** 增加 STS 令牌获取可以选择 OSS 区域和是否使用 VPC 域名的参数功能 ([f03cc7e](https://github.com/teambge/bge-python-sdk/commit/f03cc7e66f9d5fd75315c4820ae62e1c47a2e058))
+
+
+
 # [0.6.0](https://github.com/teambge/bge-python-sdk/compare/v0.5.4...v0.6.0) (2023-11-06)
 
 

bgesdk/client.py

@@ -633,7 +633,7 @@ def get_gene_abundance(self, biosample_id, catalog, data_type, ids=None,
         result['result'] = [models.Model(item) for item in result['result']]
         return result
 
-    def get_upload_token(self, **kwargs):
+    def get_upload_token(self, region_id=None, internal=False, **kwargs):
         """获取文件上传授权
         
         获取的授权仅包括当前目录(不含子目录)下的文件读、写权限;
@@ -644,15 +644,21 @@ def get_upload_token(self, **kwargs):
         timeout = self.timeout
         verbose = self.verbose
         max_retries = self.max_retries
+        data = {}
+        data.update(kwargs)
+        data.update({
+            'region_id': region_id,
+            'internal': internal,
+        })
         request = HTTPRequest(
             self.endpoint, max_retries=max_retries, verbose=verbose)
         request.set_authorization(self.token_type, self.access_token)
-        result = request.post('/sts/token', data=kwargs, timeout=timeout)
+        result = request.post('/sts/token', data=data, timeout=timeout)
         return models.Model(result)
 
     def upload(self, filename, file_or_string, part_size=None,
                multipart_threshold=None, multipart_num_threads=None,
-               cmk_id=None):
+               cmk_id=None, region_id=None, internal=False):
         """上传文件
 
         Args:
@@ -663,11 +669,16 @@ def upload(self, filename, file_or_string, part_size=None,
             multipart_num_threads: 分片上传缺省线程数, 默认 4;
             cmk_id (str): 阿里云 KMS 服务用户主密钥 ID,加密上传时提供 CMK ID 即可;
                           提供 cmk_id 后不支持分片上传;
+            region_id(str): 阿里云 OSS 区域编号，默认 oss-cn-shenzhen；
+            internal(bool): 是否使用内部 VPN 域名，默认 False；
 
         Returns:
             object_name: 文件的 OSS 对象名;
         """
-        token = self.get_upload_token()
+        token = self.get_upload_token(
+            region_id=region_id,
+            internal=internal
+        )
         return self._upload(
             token,
             filename,
@@ -680,7 +691,7 @@ def upload(self, filename, file_or_string, part_size=None,
 
     def batch_upload(self, files, part_size=None,
                      multipart_threshold=None, multipart_num_threads=None,
-                     cmk_id=None):
+                     cmk_id=None, region_id=None, internal=False):
         """批量上传文件
 
         Args:
@@ -689,6 +700,8 @@ def batch_upload(self, files, part_size=None,
             multipart_threshold(num): 上传数据大于或等于该值时分片上传, 默认 100M;
             multipart_num_threads: 分片上传缺省线程数, 默认 4;
             cmk_id (str): 阿里云 KMS 服务用户主密钥 ID,加密上传时提供 CMK ID 即可;
+            region_id(str): 阿里云 OSS 区域编号，默认 oss-cn-shenzhen；
+            internal(bool): 是否使用内部 VPN 域名，默认 False；
 
         Returns:
             object_name: 文件的 OSS 对象名;
@@ -698,7 +711,10 @@ def batch_upload(self, files, part_size=None,
         object_names = []
         if isinstance(files, (list, tuple)):
             files = [files]
-        token = self.get_upload_token()
+        token = self.get_upload_token(
+            region_id=region_id,
+            internal=internal
+        )
         for file_obj in files:
             if not isinstance(file_obj, FileItem):
                 continue
@@ -721,7 +737,7 @@ def batch_upload(self, files, part_size=None,
 
     def upload_dir(self, dirpath, part_size=None,
                    multipart_threshold=None, multipart_num_threads=None,
-                   cmk_id=None):
+                   cmk_id=None, region_id=None, internal=False):
         """上传目录下的文件(不递归上传子文件夹中文件)
 
         仅上传目录中的文件,软链接、符号链接、文件夹均不会上传至平台。
@@ -736,7 +752,10 @@ def upload_dir(self, dirpath, part_size=None,
         Returns:
             object_names: 上传的文件 OSS 对象名列表;
         """
-        token = self.get_upload_token()
+        token = self.get_upload_token(
+            region_id=region_id,
+            internal=internal
+        )
         object_names = []
         for filename in os.listdir(dirpath):
             filepath = join(dirpath, filename)

bgesdk/management/commands/api/commands/aggregate_omics_data.py

@@ -21,7 +21,7 @@
 class Command(BaseCommand):
 
     order = 10
-    help='聚合组学数据（目前仅支持聚合数据流中符合平台设定 JSONPath 规则的数值型数据）。'
+    help = '聚合组学数据（目前仅支持聚合数据流中符合平台设定 JSONPath 规则的数值型数据）。'
 
     def add_arguments(self, parser):
         parser.add_argument(

bgesdk/management/commands/api/commands/download.py

@@ -22,7 +22,7 @@
 class Command(BaseCommand):
 
     order = 13
-    help='下载文件。'
+    help = '下载文件。'
 
     def add_arguments(self, parser):
         parser.add_argument(

bgesdk/management/commands/api/commands/get_data_items.py

@@ -21,7 +21,7 @@
 class Command(BaseCommand):
 
     order = 7
-    help='请求数据项。'
+    help = '请求数据项。'
 
     def add_arguments(self, parser):
         parser.add_argument(

bgesdk/management/commands/api/commands/get_externals.py

@@ -21,7 +21,7 @@
 class Command(BaseCommand):
 
     order = 9
-    help='获取套件外部编号对应表。'
+    help = '获取套件外部编号对应表。'
 
     def add_arguments(self, parser):
         parser.add_argument(

bgesdk/management/commands/api/commands/get_range_stream.py

@@ -21,7 +21,7 @@
 class Command(BaseCommand):
 
     order = 8
-    help='请求数据流。'
+    help = '请求数据流。'
 
     def add_arguments(self, parser):
         parser.add_argument(

bgesdk/management/commands/api/commands/get_samples.py

@@ -29,7 +29,7 @@
 class Command(BaseCommand):
 
     order = 2
-    help='获取样品信息。'
+    help = '获取样品信息。'
 
     def add_arguments(self, parser):
         parser.add_argument(
@@ -69,7 +69,7 @@ def add_arguments(self, parser):
             '--statuses',
             type=str,
             help='数据状态，详情见 BGE 开放平台文档 https://api.bge.genomics.cn/doc/#/ot'
-                'hers/appendix?id=样品状态编码表'
+                 'hers/appendix?id=样品状态编码表'
         )
         parser.add_argument(
             '--require_files',

bgesdk/management/commands/api/commands/get_user.py

@@ -21,7 +21,7 @@
 class Command(BaseCommand):
 
     order = 1
-    help='获取用户信息。'
+    help = '获取用户信息。'
 
     def add_arguments(self, parser):
         parser.add_argument(

bgesdk/management/commands/api/commands/get_variants.py

@@ -21,7 +21,7 @@
 class Command(BaseCommand):
 
     order = 3
-    help='获取变异位点数据。'
+    help = '获取变异位点数据。'
 
     def add_arguments(self, parser):
         parser.add_argument(