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

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 software is dual licensed under the GNU General Public License and also 

10# under a 3-clause BSD license. Recipients may choose which of these licenses 

11# to use; please see the files gpl-3.0.txt and/or bsd_license.txt, 

12# respectively. If you choose the GPL option then the following text applies 

13# (but note that there is still no warranty even if you opt for BSD instead): 

14# 

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

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

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

18# (at your option) any later version. 

19# 

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

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

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

23# GNU General Public License for more details. 

24# 

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

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

27 

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

29PipelineTask by the execution system, as well as other special dataset types. 

30""" 

31 

32from __future__ import annotations 

33 

34__all__ = ( 

35 "CONFIG_INIT_OUTPUT_CONNECTION_NAME", 

36 "CONFIG_INIT_OUTPUT_STORAGE_CLASS", 

37 "CONFIG_INIT_OUTPUT_TEMPLATE", 

38 "LOG_OUTPUT_CONNECTION_NAME", 

39 "LOG_OUTPUT_STORAGE_CLASS", 

40 "LOG_OUTPUT_TEMPLATE", 

41 "METADATA_OUTPUT_CONNECTION_NAME", 

42 "METADATA_OUTPUT_STORAGE_CLASS", 

43 "METADATA_OUTPUT_TEMPLATE", 

44 "PACKAGES_INIT_OUTPUT_NAME", 

45 "PACKAGES_INIT_OUTPUT_STORAGE_CLASS", 

46 "PROVENANCE_DATASET_TYPE_NAME", 

47 "PROVENANCE_STORAGE_CLASS", 

48 "RESOURCE_USAGE_STORAGE_CLASS", 

49 "RESOURCE_USAGE_TEMPLATE", 

50) 

51 

52 

53CONFIG_INIT_OUTPUT_CONNECTION_NAME: str = "_config" 

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

55""" 

56 

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

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

59type names. 

60""" 

61 

62CONFIG_INIT_OUTPUT_STORAGE_CLASS: str = "Config" 

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

64""" 

65 

66PACKAGES_INIT_OUTPUT_NAME: str = "packages" 

67"""Name of the global init-output dataset type that holds software versions. 

68""" 

69 

70PACKAGES_INIT_OUTPUT_STORAGE_CLASS: str = "Packages" 

71"""Name of the storage class for the dataset type that holds software versions. 

72""" 

73 

74LOG_OUTPUT_CONNECTION_NAME: str = "_log" 

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

76""" 

77 

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

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

80""" 

81 

82LOG_OUTPUT_STORAGE_CLASS: str = "ButlerLogRecords" 

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

84""" 

85 

86METADATA_OUTPUT_CONNECTION_NAME: str = "_metadata" 

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

88""" 

89 

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

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

92type names. 

93""" 

94 

95METADATA_OUTPUT_STORAGE_CLASS: str = "TaskMetadata" 

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

97""" 

98 

99PROVENANCE_DATASET_TYPE_NAME: str = "run_provenance" 

100"""Name of the dataset used to store per-RUN provenance.""" 

101 

102PROVENANCE_STORAGE_CLASS: str = "ProvenanceQuantumGraph" 

103"""Name of the storage class used to store provenance.""" 

104 

105RESOURCE_USAGE_TEMPLATE: str = "{label}_resource_usage" 

106"""String template used to form the name of the resource usage dataset type for 

107a task. 

108""" 

109 

110RESOURCE_USAGE_STORAGE_CLASS: str = "ArrowAstropy" 

111"""Storage class of the resource usage dataset type for a task. 

112"""