Coverage for python / lsst / pipe / base / log_on_close.py: 53%

1# This file is part of pipe_base. 

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 __future__ import annotations 

29 

30__all__ = ("LogOnClose",) 

31 

32from collections.abc import Callable, Iterator 

33from contextlib import AbstractContextManager, contextmanager 

34 

35from lsst.utils.logging import VERBOSE 

36 

37 

38class LogOnClose: 

39 """A factory for context manager wrappers that emit a log message when 

40 they are closed. 

41 

42 Parameters 

43 ---------- 

44 log_func : `~collections.abc.Callable` [ `int`, `str` ] 

45 Callable that takes an integer log level and a string message and emits 

46 a log message. Note that placeholder formatting is not supported. 

47 """ 

48 

49 def __init__(self, log_func: Callable[[int, str], None]): 

50 self.log_func = log_func 

51 

52 def wrap[T]( 

53 self, 

54 cm: AbstractContextManager[T], 

55 msg: str, 

56 level: int = VERBOSE, 

57 ) -> AbstractContextManager[T]: 

58 """Wrap a context manager to log when it is exited. 

59 

60 Parameters 

61 ---------- 

62 cm : `contextlib.AbstractContextManager` 

63 Context manager to wrap. 

64 msg : `str` 

65 Log message. 

66 level : `int`, optional 

67 Log level. 

68 """ 

69 

70 @contextmanager 

71 def wrapper() -> Iterator[T]: 

72 with cm as result: 

73 yield result 

74 self.log_func(level, msg) 

75 

76 return wrapper()