Coverage for python/lsst/ctrl/mpexec/cli/script/update_graph_run.py: 43%

7 statements  

« prev     ^ index     » next       coverage.py v7.3.2, created at 2023-11-17 10:53 +0000

1# This file is part of ctrl_mpexec. 

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

27 

28from lsst.pipe.base import QuantumGraph 

29from lsst.resources import ResourcePathExpression 

30 

31 

32def update_graph_run( 

33 input_graph: ResourcePathExpression, 

34 run: str, 

35 output_graph: ResourcePathExpression, 

36 metadata_run_key: str, 

37 update_graph_id: bool, 

38) -> None: 

39 """Update quantum graph with new output run name and dataset IDs and save 

40 updated graph to a file. 

41 

42 Parameters 

43 ---------- 

44 input_graph : `~lsst.resources.ResourcePathExpression` 

45 Location of a file with existing quantum graph. 

46 run : `str` 

47 Collection name, if collection exists it must be of ``RUN`` type. 

48 output_graph : `~lsst.resources.ResourcePathExpression` 

49 Location to store updated quantum graph. 

50 update_graph_id : `bool` 

51 If `True` then also update graph ID with a new unique value. 

52 """ 

53 qgraph = QuantumGraph.loadUri(input_graph) 

54 key = metadata_run_key if metadata_run_key else None 

55 qgraph.updateRun(run, metadata_key=key, update_graph_id=update_graph_id) 

56 qgraph.saveUri(output_graph)