Coverage for python / lsst / ctrl / execute / seqFile.py: 30%

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 SeqFile: 

32 """Class which can read and increment files used to store sequence 

33 numbers""" 

34 

35 filename: ResourcePath 

36 

37 def __init__(self, seqFileName: ResourcePathExpression): 

38 """Constructor 

39 @param seqFileName file name to operate on 

40 """ 

41 self.fileName = ResourcePath(seqFileName) 

42 

43 def nextSeq(self): 

44 """Produce the next sequence number. 

45 @return a sequence number 

46 """ 

47 seq = 0 

48 if not self.fileName.exists(): 

49 self.writeSeq(seq) 

50 else: 

51 seq = self.readSeq() 

52 seq += 1 

53 self.writeSeq(seq) 

54 return seq 

55 

56 def readSeq(self): 

57 """Read a sequence number 

58 @return a sequence number 

59 """ 

60 with self.fileName.open(mode="r") as seqFile: 

61 line = seqFile.readline() 

62 seq = int(line) 

63 return seq 

64 

65 def writeSeq(self, seq): 

66 """Write a sequence number""" 

67 with self.fileName.open(mode="w") as seqFile: 

68 print(seq, file=seqFile)