refactor find function parameters to use obs_group and detector instead of...

refactor find function parameters to use obs_group and detector instead of project_id and detector_no

csst_dfs_client/level0.py

@@ -4,10 +4,10 @@ from .common import request, Result, utils, constants
 
 DateTimeTuple = Tuple[str, str]
 
-def find(project_id: Optional[str] = None,
+def find(obs_group: Optional[str] = None,
         obs_id: Optional[str] = None,
         instrument: Literal['MSC', 'IFS', 'MCI', 'HSTDM', 'CPIC'] = 'MSC', 
-        detector_no: Optional[str] = None,
+        detector: Optional[str] = None,
         obs_type: Optional[str] = None,
         filter: Optional[str] = None,
         obs_time: Optional[DateTimeTuple] = None,
@@ -26,10 +26,10 @@ def find(project_id: Optional[str] = None,
     根据给定的参数搜索0级数据文件记录
     
     Args:
-        project_id (Optional[str], optional): 项目ID. Defaults to None.
+        obs_group (Optional[str], optional): 项目ID. Defaults to None.
         obs_id (Optional[str], optional): 观测ID. Defaults to None.
         instrument (Optional[str], optional): 设备，如'MSC', 'IFS'. Defaults to 'MSC'.
-        detector_no (Optional[str], optional): 探测器编号. Defaults to None.
+        detector (Optional[str], optional): 探测器. Defaults to None.
         obs_type (Optional[str], optional): 观测类型，如'01'. Defaults to None.
         filter (Optional[str], optional): 滤光片. Defaults to None.
         obs_time (Optional[DateTimeTuple], optional): 观测时间范围. Defaults to None.
@@ -51,10 +51,10 @@ def find(project_id: Optional[str] = None,
     """
 
     params = {
-        'project_id': project_id,
+        'obs_group': obs_group,
         'obs_id': obs_id,
         'instrument': instrument,
-        'detector_no': detector_no,
+        'detector': detector,
         'obs_type': obs_type,
         'filter': filter,
         'qc0_status': qc0_status,
@@ -187,7 +187,7 @@ def write_cat(local_file: str,
 
 def generate_prc_msg(instrument: Literal['MSC', 'IFS', 'MCI', 'HSTDM', 'CPIC'], 
                     obs_id: str, 
-                    detector_no: str,
+                    detector: str,
                     level0_id: str,
                     dataset: str = constants.DEFAULT_DATASET,
                     batch_id: str = constants.DEFAULT_BATCH_ID) -> Result:
@@ -197,7 +197,7 @@ def generate_prc_msg(instrument: Literal['MSC', 'IFS', 'MCI', 'HSTDM', 'CPIC'],
     Args:
         instrument (str): 模块ID
         obs_id (str): 观测ID
-        detector_no (str): 探测器编号
+        detector (str): 探测器
         level0_id (str): 0级数据ID
         dataset (Optional[str], optional): 数据集名称..
         batch_id (Optional[str], optional): 批次ID. Defaults to 'auto'.
@@ -210,7 +210,7 @@ def generate_prc_msg(instrument: Literal['MSC', 'IFS', 'MCI', 'HSTDM', 'CPIC'],
         'dataset': dataset,
         'batch_id': batch_id,
         'obs_id': obs_id,
-        'detector_no': detector_no,
+        'detector': detector,
         "level0_id": level0_id,
     }
     

csst_dfs_client/level1.py

@@ -4,11 +4,11 @@ import os
 
 DateTimeTuple = Tuple[str, str]
 
-def find(project_id: Optional[str] = None,
+def find(obs_group: Optional[str] = None,
         obs_id: Optional[str] = None,
         level0_id: Optional[str] = None,
         instrument: Literal['MSC', 'IFS', 'MCI', 'HSTDM', 'CPIC'] = 'MSC',
-        detector_no: Optional[str] = None,
+        detector: Optional[str] = None,
         data_model: Optional[str] = None,
         obs_type: Optional[str] = None,
         filter: Optional[str] = None,
@@ -31,10 +31,10 @@ def find(project_id: Optional[str] = None,
     根据给定的参数搜索1级数据文件记录
     
     Args:
-        project_id (Optional[str], optional): 项目ID. Defaults to None.
+        obs_group (Optional[str], optional): 项目ID. Defaults to None.
         obs_id (Optional[str], optional): 观测ID. Defaults to None.
         instrument (Optional[str], optional): 模块ID，如'MSC', 'IFS'. Defaults to None.
-        detector_no (Optional[str], optional): 探测器编号. Defaults to None.
+        detector (Optional[str], optional): 探测器. Defaults to None.
         data_model (Optional[str], optional): 数据类型，如'csst-msc-l1-mbi'. Defaults to None.
         obs_type (Optional[str], optional): 观测类型，如'01'. Defaults to None.
         filter (Optional[str], optional): 滤光片. Defaults to None.
@@ -60,11 +60,11 @@ def find(project_id: Optional[str] = None,
     """
 
     params = {
-        'project_id': project_id,
+        'obs_group': obs_group,
         'level0_id': level0_id,
         'obs_id': obs_id,
         'instrument': instrument,
-        'detector_no': detector_no,
+        'detector': detector,
         'data_model': data_model,
         'obs_type': obs_type,
         'filter': filter,
@@ -157,7 +157,7 @@ def update_prc_status(level1_id: str, data_model: str, prc_status: int, batch_id
 
 def write(local_file: Union[IO, str], 
         instrument: Literal['MSC', 'IFS', 'MCI', 'HSTDM', 'CPIC'],
-        project_id: Optional[str],
+        obs_group: Optional[str],
         obs_type: str,
         level1_id: str,
         data_model: str,
@@ -176,7 +176,7 @@ def write(local_file: Union[IO, str],
     Args:
         local_file (Union[IO, str]): 文件路径或文件对象
         instrument ['MSC', 'IFS', 'MCI', 'HSTDM', 'CPIC']其中一个，代表: 模块ID
-        project_id (str): 项目ID
+        obs_group (str): 项目ID
         obs_type (str): 观测类型
         level0_id (Optional[str]): 0级数据的ID默认为 None
         level1_id (str): 1级数据的ID
@@ -195,7 +195,7 @@ def write(local_file: Union[IO, str],
     '''
     params = {
         'instrument': instrument, 
-        'project_id': project_id,
+        'obs_group': obs_group,
         'obs_type': obs_type,
         'level0_id': level0_id, 
         'level1_id': level1_id, 

csst_dfs_client/level2.py

@@ -6,10 +6,10 @@ from .common import request, Result, utils, constants
 DateTimeTuple = Tuple[str, str]
 
 def find(
-        project_id: Optional[str] = None,
+        obs_group: Optional[str] = None,
         obs_id: Optional[str] = None,
         instrument: Literal['MSC', 'IFS', 'MCI', 'HSTDM', 'CPIC'] = 'MSC',
-        detector_no: Optional[str] = None,
+        detector: Optional[str] = None,
         data_model: Optional[str] = None,
         filter: Optional[str] = None,
         obs_time: Optional[DateTimeTuple] = None,
@@ -26,10 +26,10 @@ def find(
     根据给定的参数搜索2级数据文件记录
     
     Args:
-        project_id (Optional[str], optional): 项目ID. Defaults to None.
+        obs_group (Optional[str], optional): 项目ID. Defaults to None.
         obs_id (Optional[str], optional): 观测ID. Defaults to None.
         instrument (Optional[str], optional): 模块ID，如'MSC', 'IFS'. Defaults to None.
-        detector_no (Optional[str], optional): 探测器编号. Defaults to None.
+        detector (Optional[str], optional): 探测器. Defaults to None.
         data_model (Optional[str], optional): 数据类型，如'csst-msc-l2-mbi-cat'. Defaults to None.
         filter (Optional[str], optional): 滤光片. Defaults to None.
         obs_time (Optional[DateTimeTuple], optional): 观测时间范围. Defaults to None.
@@ -49,10 +49,10 @@ def find(
     """
 
     params = {
-        'project_id': project_id,
+        'obs_group': obs_group,
         'obs_id': obs_id,
         'instrument': instrument,
-        'detector_no': detector_no,
+        'detector': detector,
         'data_model': data_model,
         'filter': filter,
         'qc2_status': qc2_status,

tests/test_level0.py

@@ -50,7 +50,7 @@ class Level0TestCase(unittest.TestCase):
             instrument='MSC',
             level0_id="1060940003452930",
             obs_id="10609400034529",
-            detector_no="30")
+            detector="30")
         print(result)
         self.assertEqual(result.code, 200, "error code: " + str(result.code) + ", message: " + result.message)
 

tests/test_level1.py

@@ -40,7 +40,7 @@ class Level1TestCase(unittest.TestCase):
         #     file_path = BytesIO(file.read())
             
         result = level1.write(local_file = file_path, 
-            project_id="10109100157991",
+            obs_group="10109100157991",
             obs_type="WIDE",
             instrument = "MSC",
             level0_id="1010910015799127",