Coverage for python/lsst/daf/butler/script/createRepo.py: 67%

6 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 

29from .._butler import Butler 

30from .._config import Config 

31 

32 

33def createRepo( 

34 repo: str, 

35 seed_config: str | None = None, 

36 dimension_config: str | None = None, 

37 standalone: bool = False, 

38 override: bool = False, 

39 outfile: str | None = None, 

40) -> None: 

41 """Create an empty Gen3 Butler repository. 

42 

43 Parameters 

44 ---------- 

45 repo : `str` 

46 URI to the location to create the repo. 

47 seed_config : `str` or `None` 

48 Path to an existing YAML config file to apply (on top of defaults). 

49 dimension_config : `str` or `None` 

50 Path to an existing YAML config file with dimensions configuration. 

51 standalone : `bool` 

52 Include all the defaults in the config file in the repo if True. 

53 Insulates the the repo from changes to package defaults. By default 

54 False. 

55 override : `bool` 

56 Allow values in the config file to override any repo settings, by 

57 default False. 

58 outfile : `str` or None 

59 Name of output file to receive repository configuration. Default is to 

60 write butler.yaml into the specified repo, by default False. 

61 """ 

62 config = Config(seed_config) if seed_config is not None else None 

63 Butler.makeRepo( 

64 repo, 

65 config=config, 

66 dimensionConfig=dimension_config, 

67 standalone=standalone, 

68 forceConfigRoot=not override, 

69 outfile=outfile, 

70 )