Coverage for python/lsst/pipe/base/automatic_connection_constants.py: 100%
25 statements
« prev ^ index » next coverage.py v7.3.0, created at 2023-08-31 09:39 +0000
« prev ^ index » next coverage.py v7.3.0, created at 2023-08-31 09:39 +0000
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/>.
22"""Constants used to define the connections automatically added for each
23PipelineTask by the execution system.
24"""
26from __future__ import annotations
28__all__ = (
29 "CONFIG_INIT_OUTPUT_CONNECTION_NAME",
30 "CONFIG_INIT_OUTPUT_TEMPLATE",
31 "CONFIG_INIT_OUTPUT_STORAGE_CLASS",
32 "PACKAGES_INIT_OUTPUT_NAME",
33 "PACKAGES_INIT_OUTPUT_STORAGE_CLASS",
34 "LOG_OUTPUT_CONNECTION_NAME",
35 "LOG_OUTPUT_TEMPLATE",
36 "LOG_OUTPUT_STORAGE_CLASS",
37 "METADATA_OUTPUT_CONNECTION_NAME",
38 "METADATA_OUTPUT_TEMPLATE",
39 "METADATA_OUTPUT_STORAGE_CLASS",
40)
43CONFIG_INIT_OUTPUT_CONNECTION_NAME: str = "_config"
44"""Internal task-side name for the config dataset connection.
45"""
47CONFIG_INIT_OUTPUT_TEMPLATE: str = "{label}" + CONFIG_INIT_OUTPUT_CONNECTION_NAME
48"""String template used to form the name for config init-output dataset
49type names.
50"""
52CONFIG_INIT_OUTPUT_STORAGE_CLASS: str = "Config"
53"""Name of the storage class for config init-output datasets.
54"""
56PACKAGES_INIT_OUTPUT_NAME: str = "packages"
57"""Name of the global init-output dataset type that holds software versions.
58"""
60PACKAGES_INIT_OUTPUT_STORAGE_CLASS: str = "Packages"
61"""Name of the storage class for the dataset type that holds software versions.
62"""
64LOG_OUTPUT_CONNECTION_NAME: str = "_log"
65"""Internal task-side name for the log dataset connection.
66"""
68LOG_OUTPUT_TEMPLATE: str = "{label}" + LOG_OUTPUT_CONNECTION_NAME
69"""String template used to form the name for log output dataset type names.
70"""
72LOG_OUTPUT_STORAGE_CLASS: str = "ButlerLogRecords"
73"""Name of the storage class for log output datasets.
74"""
76METADATA_OUTPUT_CONNECTION_NAME: str = "_metadata"
77"""Internal task-side name for the metadata dataset connection.
78"""
80METADATA_OUTPUT_TEMPLATE: str = "{label}" + METADATA_OUTPUT_CONNECTION_NAME
81"""String template used to form the name for task metadata output dataset
82type names.
83"""
85METADATA_OUTPUT_STORAGE_CLASS: str = "TaskMetadata"
86"""Name of the storage class for task metadata output datasets.
87"""