Loading docs/source/c7_changes.rst +19 −2 Original line number Diff line number Diff line Loading @@ -6,10 +6,27 @@ Change list ``top_level_interface.py`` 文件改名为 ``api.py`` , 这个文件中用于导入每个 python package 与流水线的接口函数 - 接口名称修改: 每个开发模块需要把接口函数命名为 ``base_`` 开头的函数,例如 ``base_phot`` - ``DataManager`` ``FileRecorder`` 不再使用, 底层接口都尽可能使用文件路径作为参数 - 使用 ``csst_common.status.Result`` 作为返回类型, 包含三个部分: - 运行状态 ``status`` 必须是 ``CsstStatus`` 的三种类型之一 - 输出文件列表 ``file_list``, 是一个 ``list``, 需要包含所有输出文件,包括临时文件 - 额外输出 (一般不需要,除非有其他额外输出) - 程序中禁止使用当前文件夹 ``.`` 或 ``./``,所有路径应使用绝对路径 - 接口定义修改: 样例代码如下 .. code-block:: python def base_distortion(input_file, output_file, rc="./gaia_dr3.fits") -> : return from csst_common.status import CsstStatus, CsstResult def base_distortion(input_file, output_file, rc="/path/to/gaia_dr3.fits", **kwargs) -> CsstResult: """ your docstring here """ # do your calculation process(input_file, output_fle) # construct CsstResult result = CsstResult( status=CsstStatus.PERFECT, file_list=[output_file, "an additional output file"] ) return result Loading
docs/source/c7_changes.rst +19 −2 Original line number Diff line number Diff line Loading @@ -6,10 +6,27 @@ Change list ``top_level_interface.py`` 文件改名为 ``api.py`` , 这个文件中用于导入每个 python package 与流水线的接口函数 - 接口名称修改: 每个开发模块需要把接口函数命名为 ``base_`` 开头的函数,例如 ``base_phot`` - ``DataManager`` ``FileRecorder`` 不再使用, 底层接口都尽可能使用文件路径作为参数 - 使用 ``csst_common.status.Result`` 作为返回类型, 包含三个部分: - 运行状态 ``status`` 必须是 ``CsstStatus`` 的三种类型之一 - 输出文件列表 ``file_list``, 是一个 ``list``, 需要包含所有输出文件,包括临时文件 - 额外输出 (一般不需要,除非有其他额外输出) - 程序中禁止使用当前文件夹 ``.`` 或 ``./``,所有路径应使用绝对路径 - 接口定义修改: 样例代码如下 .. code-block:: python def base_distortion(input_file, output_file, rc="./gaia_dr3.fits") -> : return from csst_common.status import CsstStatus, CsstResult def base_distortion(input_file, output_file, rc="/path/to/gaia_dr3.fits", **kwargs) -> CsstResult: """ your docstring here """ # do your calculation process(input_file, output_fle) # construct CsstResult result = CsstResult( status=CsstStatus.PERFECT, file_list=[output_file, "an additional output file"] ) return result