Coverage for python/lsst/daf/butler/script/register_dataset_type.py: 38%

11 statements  

« prev     ^ index     » next       coverage.py v7.4.4, created at 2024-04-05 10:00 +0000

1# This file is part of daf_butler. 

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/>. 

27from __future__ import annotations 

28 

29__all__ = ("register_dataset_type",) 

30 

31from .._butler import Butler 

32from .._dataset_type import DatasetType 

33 

34 

35def register_dataset_type( 

36 repo: str, 

37 dataset_type: str, 

38 storage_class: str, 

39 dimensions: tuple[str, ...], 

40 is_calibration: bool = False, 

41) -> bool: 

42 """Register a new dataset type. 

43 

44 Parameters 

45 ---------- 

46 repo : `str` 

47 URI string of the Butler repo to use. 

48 dataset_type : `str` 

49 The name of the new dataset type. 

50 storage_class : `str` 

51 The name of the storage class associated with this dataset type. 

52 dimensions : `tuple` [`str`] 

53 Dimensions associated with this dataset type. Can be empty. 

54 is_calibration : `bool` 

55 If `True` this dataset type may be included in calibration 

56 collections. 

57 

58 Returns 

59 ------- 

60 inserted : `bool` 

61 `True` if the dataset type was added; `False` if it was already 

62 there. 

63 

64 Raises 

65 ------ 

66 ValueError 

67 Raised if an attempt is made to register a component dataset type. 

68 Component dataset types are not real dataset types and so can not 

69 be created by this command. They are always derived from the composite 

70 dataset type. 

71 """ 

72 butler = Butler.from_config(repo, writeable=True, without_datastore=True) 

73 

74 _, component = DatasetType.splitDatasetTypeName(dataset_type) 

75 if component: 

76 raise ValueError("Component dataset types are created automatically when the composite is created.") 

77 

78 datasetType = DatasetType( 

79 dataset_type, 

80 butler.dimensions.conform(dimensions), 

81 storage_class, 

82 parentStorageClass=None, 

83 isCalibration=is_calibration, 

84 universe=butler.dimensions, 

85 ) 

86 

87 return butler.registry.registerDatasetType(datasetType)