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

6 statements  

« prev     ^ index     » next       coverage.py v6.5.0, created at 2023-04-04 02:06 -0700

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

21from __future__ import annotations 

22 

23from .._butler import Butler 

24from ..core import Config 

25 

26 

27def createRepo( 

28 repo: str, 

29 seed_config: str | None = None, 

30 dimension_config: str | None = None, 

31 standalone: bool = False, 

32 override: bool = False, 

33 outfile: str | None = None, 

34) -> None: 

35 """Create an empty Gen3 Butler repository. 

36 

37 Parameters 

38 ---------- 

39 repo : `str` 

40 URI to the location to create the repo. 

41 seed_config : `str` or `None` 

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

43 dimension_config : `str` or `None` 

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

45 standalone : `bool` 

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

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

48 False. 

49 override : `bool` 

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

51 default False. 

52 outfile : `str` or None 

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

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

55 """ 

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

57 Butler.makeRepo( 

58 repo, 

59 config=config, 

60 dimensionConfig=dimension_config, 

61 standalone=standalone, 

62 forceConfigRoot=not override, 

63 outfile=outfile, 

64 )