Coverage for lintro / enums / bandit_levels.py: 100%

1"""Bandit severity and confidence level enum definitions. 

2 

3This module defines supported severity and confidence levels for Bandit issues. 

4""" 

5 

6from __future__ import annotations 

7 

8from enum import auto 

9 

10from lintro.enums.uppercase_str_enum import UppercaseStrEnum 

11 

12 

13class BanditSeverityLevel(UppercaseStrEnum): 

14 """Supported severity levels for Bandit issues. 

15 

16 Values are upper-case string identifiers to align with Bandit tool outputs. 

17 """ 

18 

19 LOW = auto() 

20 MEDIUM = auto() 

21 HIGH = auto() 

22 

23 

24class BanditConfidenceLevel(UppercaseStrEnum): 

25 """Supported confidence levels for Bandit issues. 

26 

27 Values are upper-case string identifiers to align with Bandit tool outputs. 

28 """ 

29 

30 LOW = auto() 

31 MEDIUM = auto() 

32 HIGH = auto() 

33 

34 

35def normalize_bandit_severity_level( 

36 value: str | BanditSeverityLevel, 

37) -> BanditSeverityLevel: 

38 """Normalize a raw value to a BanditSeverityLevel enum. 

39 

40 Args: 

41 value: str or BanditSeverityLevel to normalize. 

42 

43 Returns: 

44 BanditSeverityLevel: Normalized enum value. 

45 

46 Raises: 

47 ValueError: If value is not a valid severity level. 

48 """ 

49 if isinstance(value, BanditSeverityLevel): 

50 return value 

51 try: 

52 return BanditSeverityLevel[value.upper()] 

53 except KeyError as err: 

54 supported = f"Supported levels: {list(BanditSeverityLevel)}" 

55 raise ValueError( 

56 f"Unknown bandit severity level: {value!r}. {supported}", 

57 ) from err 

58 

59 

60def normalize_bandit_confidence_level( 

61 value: str | BanditConfidenceLevel, 

62) -> BanditConfidenceLevel: 

63 """Normalize a raw value to a BanditConfidenceLevel enum. 

64 

65 Args: 

66 value: str or BanditConfidenceLevel to normalize. 

67 

68 Returns: 

69 BanditConfidenceLevel: Normalized enum value. 

70 

71 Raises: 

72 ValueError: If value is not a valid confidence level. 

73 """ 

74 if isinstance(value, BanditConfidenceLevel): 

75 return value 

76 try: 

77 return BanditConfidenceLevel[value.upper()] 

78 except KeyError as err: 

79 raise ValueError( 

80 f"Unknown bandit confidence level: {value!r}. " 

81 f"Supported levels: {list(BanditConfidenceLevel)}", 

82 ) from err