Coverage for python / lsst / ctrl / execute / templateWriter.py: 20%

1# This file is part of ctrl_execute. 

2# 

3# Developed for the LSST Data Management System. 

4# This product includes software developed by the LSST Project 

5# (https://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 <https://www.gnu.org/licenses/>. 

27 

28from lsst.resources import ResourcePath, ResourcePathExpression 

29 

30 

31class TemplateWriter: 

32 """Class to take a template file, substitute values through it, and 

33 write a new file with those values. 

34 """ 

35 

36 def rewrite(self, input: ResourcePathExpression, output: ResourcePathExpression, pairs): 

37 """Given a input template, take the keys from key/values in the config 

38 object and substitute the values, and write those to the output file. 

39 @param input - the input template name 

40 @param output - the output file name 

41 @param pairs of values to substitute in the template 

42 """ 

43 with ResourcePath(output).open(mode="w") as f_out: 

44 with ResourcePath(input).open(mode="r") as f_in: 

45 for line in f_in.readlines(): 

46 # replace the user defined names 

47 for name in pairs: 

48 key = "$" + name 

49 val = str(pairs[name]) 

50 line = line.replace(key, val) 

51 f_out.write(line)