Coverage for tests / plugin2.py: 64.103%

1# Licensed under the Apache License: http://www.apache.org/licenses/LICENSE-2.0 

2# For details: https://github.com/coveragepy/coveragepy/blob/main/NOTICE.txt 

3 

4"""A file tracer plugin for test_plugins.py to import.""" 

5 

6from __future__ import annotations 27 ctx1abcdefghijklmnopqrstuvwxyzA

7 

8import os.path 27 ctx1abcdefghijklmnopqrstuvwxyzA

9 

10from types import FrameType 27 ctx1abcdefghijklmnopqrstuvwxyzA

11from typing import Any 27 ctx1abcdefghijklmnopqrstuvwxyzA

12 

13from coverage import CoveragePlugin, FileReporter, FileTracer 27 ctx1abcdefghijklmnopqrstuvwxyzA

14from coverage.plugin_support import Plugins 27 ctx1abcdefghijklmnopqrstuvwxyzA

15from coverage.types import TLineNo 27 ctx1abcdefghijklmnopqrstuvwxyzA

16 

17try: 27 ctx1abcdefghijklmnopqrstuvwxyzA

18 import third.render # pylint: disable=unused-import 27 ctx1abcdefghijklmnopqrstuvwxyzA

19except ImportError: 27 ctx1abcdefghijklmnopqrstuvwxyzA

20 # This plugin is used in a few tests. One of them has the third.render 

21 # module, but most don't. We need to import it but not use it, so just 

22 # try importing it and it's OK if the module doesn't exist. 

23 pass 27 ctx1abcdefghijklmnopqrstuvwxyzA

24 

25 

26class Plugin(CoveragePlugin): 27 ctx1abcdefghijklmnopqrstuvwxyzA

27 """A file tracer plugin for testing.""" 

28 

29 def file_tracer(self, filename: str) -> FileTracer | None: 27 ctx1abcdefghijklmnopqrstuvwxyzA

30 if "render.py" in filename: 

31 return RenderFileTracer() 

32 return None 

33 

34 def file_reporter(self, filename: str) -> FileReporter: 27 ctx1abcdefghijklmnopqrstuvwxyzA

35 return MyFileReporter(filename) 27 ctx1abcdefghijklmnopqrstuvwxyzA

36 

37 

38class RenderFileTracer(FileTracer): 27 ctx1abcdefghijklmnopqrstuvwxyzA

39 """A FileTracer using information from the caller.""" 

40 

41 def has_dynamic_source_filename(self) -> bool: 27 ctx1abcdefghijklmnopqrstuvwxyzA

42 return True 

43 

44 def dynamic_source_filename( 27 ctx1abcdefghijklmnopqrstuvwxyzA

45 self, 

46 filename: str, 

47 frame: FrameType, 

48 ) -> str | None: 

49 if frame.f_code.co_name != "render": 

50 return None 

51 source_filename: str = os.path.abspath(frame.f_locals["filename"]) 

52 return source_filename 

53 

54 def line_number_range(self, frame: FrameType) -> tuple[TLineNo, TLineNo]: 27 ctx1abcdefghijklmnopqrstuvwxyzA

55 lineno = frame.f_locals["linenum"] 

56 return lineno, lineno + 1 

57 

58 

59class MyFileReporter(FileReporter): 27 ctx1abcdefghijklmnopqrstuvwxyzA

60 """A goofy file reporter.""" 

61 

62 def lines(self) -> set[TLineNo]: 27 ctx1abcdefghijklmnopqrstuvwxyzA

63 # Goofy test arrangement: claim that the file has as many lines as the 

64 # number in its name. 

65 num = os.path.basename(self.filename).split(".")[0].split("_")[1] 27 ctx1abcdefghijklmnopqrstuvwxyzA

66 return set(range(1, int(num) + 1)) 27 ctx1abcdefghijklmnopqrstuvwxyzA

67 

68 

69def coverage_init( 27 ctx1abcdefghijklmnopqrstuvwxyzA

70 reg: Plugins, 

71 options: Any, # pylint: disable=unused-argument 

72) -> None: 

73 """Called by coverage to initialize the plugins here.""" 

74 reg.add_file_tracer(Plugin()) 27 ctx1abcdefghijklmnopqrstuvwxyzA