Coverage for coverage / disposition.py: 61.111%

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"""Simple value objects for tracking what to do with files.""" 

5 

6from __future__ import annotations 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

7 

8from typing import TYPE_CHECKING 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

9 

10from coverage.types import TFileDisposition 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

11 

12if TYPE_CHECKING: 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

13 from coverage.plugin import FileTracer 

14 

15 

16class FileDisposition: 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

17 """A simple value type for recording what to do with a file.""" 

18 

19 original_filename: str 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

20 canonical_filename: str 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

21 source_filename: str | None 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

22 trace: bool 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

23 reason: str 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

24 file_tracer: FileTracer | None 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

25 has_dynamic_filename: bool 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

26 

27 def __repr__(self) -> str: 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

28 return f"<FileDisposition {self.canonical_filename!r}: trace={self.trace}>" 

29 

30 

31# FileDisposition "methods": FileDisposition is a pure value object, so it can 

32# be implemented in either C or Python. Acting on them is done with these 

33# functions. 

34 

35 

36def disposition_init(cls: type[TFileDisposition], original_filename: str) -> TFileDisposition: 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

37 """Construct and initialize a new FileDisposition object.""" 

38 disp = cls() 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

39 disp.original_filename = original_filename 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

40 disp.canonical_filename = original_filename 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

41 disp.source_filename = None 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

42 disp.trace = False 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

43 disp.reason = "" 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

44 disp.file_tracer = None 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

45 disp.has_dynamic_filename = False 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

46 return disp 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

47 

48 

49def disposition_debug_msg(disp: TFileDisposition) -> str: 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

50 """Make a nice debug message of what the FileDisposition is doing.""" 

51 if disp.trace: 

52 msg = f"Tracing {disp.original_filename!r}" 

53 if disp.original_filename != disp.source_filename: 

54 msg += f" as {disp.source_filename!r}" 

55 if disp.file_tracer: 

56 msg += f": will be traced by {disp.file_tracer!r}" 

57 else: 

58 msg = f"Not tracing {disp.original_filename!r}: {disp.reason}" 

59 return msg