improvement: 增加样品接口 require_files 参数

Author: leafcoder

bgesdk/client.py

@@ -352,7 +352,8 @@ def professional_variant(self, biosample_id, only_variant_site=True,
     def get_samples(self, biosample_ids=None, biosample_sites=None,
                     omics=None, project_ids=None, organisms=None,
                     data_availability=None, statuses=None,
-                    next_page=None, limit=50, **kwargs):
+                    require_files=None, next_page=None, limit=50,
+                    **kwargs):
         """获取样品列表
 
         授权码模式: 可通过本接口获取授权用户的样品；
@@ -388,7 +389,8 @@ def get_samples(self, biosample_ids=None, biosample_sites=None,
             'data_availability': data_availability,
             'statuses': statuses,
             'page': page,
-            'limit': limit
+            'limit': limit,
+            'require_files': require_files
         })
         timeout = self.timeout
         verbose = self.verbose
@@ -404,7 +406,7 @@ def get_samples(self, biosample_ids=None, biosample_sites=None,
         result['result'] = data
         return result
 
-    def get_sample(self, biosample_id):
+    def get_sample(self, biosample_id, require_files=None):
         """获取样品
 
         授权码模式: 可通过本接口获取授权用户的样品；
@@ -419,13 +421,15 @@ def get_sample(self, biosample_id):
         if biosample_id:
             biosample_id = biosample_id.upper()
         url = '/samples/{}'.format(biosample_id)
+        params = {}
+        params['require_files'] = require_files
         timeout = self.timeout
         verbose = self.verbose
         max_retries = self.max_retries
         request = HTTPRequest(
             self.endpoint, max_retries=max_retries, verbose=verbose)
         request.set_authorization(self.token_type, self.access_token)
-        result = request.get(url, timeout=timeout)
+        result = request.get(url, params=params, timeout=timeout)
         return models.Model(result)
 
     def register_sample(self, external_sample_id, biosample_site,

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

@@ -65,6 +65,12 @@ def add_arguments(self, parser):
             help='数据状态，详情见 BGE 开放平台文档 https://api.bge.genomics.cn/doc/#/ot'
                 'hers/appendix?id=样品状态编码表'
         )
+        parser.add_argument(
+            '--require_files',
+            default=None,
+            action='store_true',
+            help='要求接口返回值中包含文件相关字段 files。'
+        )
         parser.add_argument(
             '-p',
             '--next_page',

bgesdk/version.py

@@ -1,3 +1,3 @@
 #-*- coding: utf-8 -*-
 
-__version__ = '0.2.5'
+__version__ = '0.2.6'

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = bge-python-sdk
-version = 0.2.5
+version = 0.2.6
 description = 可用于调用 BGE 开放平台的相关接口。
 long_description = file: README.md
 long_description_content_type = text/markdown