Coverage for python/lsst/pipe/base/automatic_connection_constants.py: 100%
25 statements
« prev ^ index » next coverage.py v7.4.0, created at 2024-01-11 17:45 +0000
« prev ^ index » next coverage.py v7.4.0, created at 2024-01-11 17:45 +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 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/>.
28"""Constants used to define the connections automatically added for each
29PipelineTask by the execution system.
30"""
32from __future__ import annotations
34__all__ = (
35 "CONFIG_INIT_OUTPUT_CONNECTION_NAME",
36 "CONFIG_INIT_OUTPUT_TEMPLATE",
37 "CONFIG_INIT_OUTPUT_STORAGE_CLASS",
38 "PACKAGES_INIT_OUTPUT_NAME",
39 "PACKAGES_INIT_OUTPUT_STORAGE_CLASS",
40 "LOG_OUTPUT_CONNECTION_NAME",
41 "LOG_OUTPUT_TEMPLATE",
42 "LOG_OUTPUT_STORAGE_CLASS",
43 "METADATA_OUTPUT_CONNECTION_NAME",
44 "METADATA_OUTPUT_TEMPLATE",
45 "METADATA_OUTPUT_STORAGE_CLASS",
46)
49CONFIG_INIT_OUTPUT_CONNECTION_NAME: str = "_config"
50"""Internal task-side name for the config dataset connection.
51"""
53CONFIG_INIT_OUTPUT_TEMPLATE: str = "{label}" + CONFIG_INIT_OUTPUT_CONNECTION_NAME
54"""String template used to form the name for config init-output dataset
55type names.
56"""
58CONFIG_INIT_OUTPUT_STORAGE_CLASS: str = "Config"
59"""Name of the storage class for config init-output datasets.
60"""
62PACKAGES_INIT_OUTPUT_NAME: str = "packages"
63"""Name of the global init-output dataset type that holds software versions.
64"""
66PACKAGES_INIT_OUTPUT_STORAGE_CLASS: str = "Packages"
67"""Name of the storage class for the dataset type that holds software versions.
68"""
70LOG_OUTPUT_CONNECTION_NAME: str = "_log"
71"""Internal task-side name for the log dataset connection.
72"""
74LOG_OUTPUT_TEMPLATE: str = "{label}" + LOG_OUTPUT_CONNECTION_NAME
75"""String template used to form the name for log output dataset type names.
76"""
78LOG_OUTPUT_STORAGE_CLASS: str = "ButlerLogRecords"
79"""Name of the storage class for log output datasets.
80"""
82METADATA_OUTPUT_CONNECTION_NAME: str = "_metadata"
83"""Internal task-side name for the metadata dataset connection.
84"""
86METADATA_OUTPUT_TEMPLATE: str = "{label}" + METADATA_OUTPUT_CONNECTION_NAME
87"""String template used to form the name for task metadata output dataset
88type names.
89"""
91METADATA_OUTPUT_STORAGE_CLASS: str = "TaskMetadata"
92"""Name of the storage class for task metadata output datasets.
93"""