Coverage for python / lsst / ctrl / execute / envString.py: 0%

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 

28import os 

29 

30 

31def resolve(input: str) -> str: 

32 """Render a string with any `$`-prefixed words substituted with a matching 

33 environment variable. 

34 

35 .. deprecated:: w.2025.05 

36 `lsst.ctrl.execute.envString.resolve` is deprecated and no longer used 

37 by any internal APIs because `lsst.resource.ResourcePath` handles 

38 environment variable expansion. 

39 

40 Parameters 

41 ---------- 

42 input : `str` 

43 A string containing environment variables to resolve. 

44 

45 Raises 

46 ------ 

47 RuntimeError 

48 If the environment variable does not exist 

49 """ 

50 

51 if "$" in (retVal := os.path.expandvars(input)): 

52 raise RuntimeError(f"couldn't resolve all environment variables in {retVal}") 

53 return retVal