Coverage for python/lsst/pipe/base/automatic_connection_constants.py: 100%

21 statements  

« prev     ^ index     » next       coverage.py v7.2.7, created at 2023-06-11 02:00 -0700

1# This file is part of pipe_base. 

2# 

3# Developed for the LSST Data Management System. 

4# This product includes software developed by the LSST Project 

5# (http://www.lsst.org). 

6# See the COPYRIGHT file at the top-level directory of this distribution 

7# for details of code ownership. 

8# 

9# This program is free software: you can redistribute it and/or modify 

10# it under the terms of the GNU General Public License as published by 

11# the Free Software Foundation, either version 3 of the License, or 

12# (at your option) any later version. 

13# 

14# This program is distributed in the hope that it will be useful, 

15# but WITHOUT ANY WARRANTY; without even the implied warranty of 

16# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 

17# GNU General Public License for more details. 

18# 

19# You should have received a copy of the GNU General Public License 

20# along with this program. If not, see <http://www.gnu.org/licenses/>. 

21 

22"""Constants used to define the connections automatically added for each 

23PipelineTask by the execution system. 

24""" 

25 

26from __future__ import annotations 

27 

28__all__ = ( 

29 "CONFIG_INIT_OUTPUT_CONNECTION_NAME", 

30 "CONFIG_INIT_OUTPUT_TEMPLATE", 

31 "CONFIG_INIT_OUTPUT_STORAGE_CLASS", 

32 "LOG_OUTPUT_CONNECTION_NAME", 

33 "LOG_OUTPUT_TEMPLATE", 

34 "LOG_OUTPUT_STORAGE_CLASS", 

35 "METADATA_OUTPUT_CONNECTION_NAME", 

36 "METADATA_OUTPUT_TEMPLATE", 

37 "METADATA_OUTPUT_STORAGE_CLASS", 

38) 

39 

40 

41CONFIG_INIT_OUTPUT_CONNECTION_NAME: str = "_config" 

42"""Internal task-side name for the config dataset connection. 

43""" 

44 

45CONFIG_INIT_OUTPUT_TEMPLATE: str = "{label}" + CONFIG_INIT_OUTPUT_CONNECTION_NAME 

46"""String template used to form the name for config init-output dataset 

47type names. 

48""" 

49 

50CONFIG_INIT_OUTPUT_STORAGE_CLASS: str = "Config" 

51"""Name of the storage class for config init-output datasets. 

52""" 

53 

54LOG_OUTPUT_CONNECTION_NAME: str = "_log" 

55"""Internal task-side name for the log dataset connection. 

56""" 

57 

58LOG_OUTPUT_TEMPLATE: str = "{label}" + LOG_OUTPUT_CONNECTION_NAME 

59"""String template used to form the name for log output dataset type names. 

60""" 

61 

62LOG_OUTPUT_STORAGE_CLASS: str = "ButlerLogRecords" 

63"""Name of the storage class for log output datasets. 

64""" 

65 

66METADATA_OUTPUT_CONNECTION_NAME: str = "_metadata" 

67"""Internal task-side name for the metadata dataset connection. 

68""" 

69 

70METADATA_OUTPUT_TEMPLATE: str = "{label}" + METADATA_OUTPUT_CONNECTION_NAME 

71"""String template used to form the name for task metadata output dataset 

72type names. 

73""" 

74 

75METADATA_OUTPUT_STORAGE_CLASS: str = "TaskMetadata" 

76"""Name of the storage class for task metadata output datasets. 

77"""