Coverage for /pythoncovmergedfiles/medio/medio/usr/local/lib/python3.11/site-packages/scapy/error.py: 90%

Shortcuts on this page

r m x   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

71 statements  

1# SPDX-License-Identifier: GPL-2.0-only 

2# This file is part of Scapy 

3# See https://scapy.net/ for more information 

4# Copyright (C) Philippe Biondi <phil@secdev.org> 

5 

6""" 

7Logging subsystem and basic exception class. 

8""" 

9 

10############################# 

11# Logging subsystem # 

12############################# 

13 

14 

15import logging 

16import traceback 

17import time 

18 

19from scapy.consts import WINDOWS 

20 

21# Typing imports 

22from logging import LogRecord 

23from typing import ( 

24 Any, 

25 Dict, 

26 Tuple, 

27) 

28 

29 

30class Scapy_Exception(Exception): 

31 pass 

32 

33 

34class ScapyInvalidPlatformException(Scapy_Exception): 

35 pass 

36 

37 

38class ScapyNoDstMacException(Scapy_Exception): 

39 pass 

40 

41 

42class ScapyNotRunningException(Scapy_Exception): 

43 pass 

44 

45 

46class ScapyFreqFilter(logging.Filter): 

47 def __init__(self): 

48 # type: () -> None 

49 logging.Filter.__init__(self) 

50 self.warning_table = {} # type: Dict[int, Tuple[float, int]] # noqa: E501 

51 

52 def filter(self, record): 

53 # type: (LogRecord) -> bool 

54 from scapy.config import conf 

55 # Levels below INFO are not covered 

56 if record.levelno <= logging.INFO: 

57 return True 

58 wt = conf.warning_threshold 

59 if wt > 0: 

60 stk = traceback.extract_stack() 

61 caller = 0 # type: int 

62 for _, l, n, _ in stk: 

63 if n == 'warning': 

64 break 

65 caller = l 

66 tm, nb = self.warning_table.get(caller, (0, 0)) 

67 ltm = time.time() 

68 if ltm - tm > wt: 

69 tm = ltm 

70 nb = 0 

71 else: 

72 if nb < 2: 

73 nb += 1 

74 if nb == 2: 

75 record.msg = "more " + str(record.msg) 

76 else: 

77 return False 

78 self.warning_table[caller] = (tm, nb) 

79 return True 

80 

81 

82class ScapyColoredFormatter(logging.Formatter): 

83 """A subclass of logging.Formatter that handles colors.""" 

84 levels_colored = { 

85 'DEBUG': 'reset', 

86 'INFO': 'reset', 

87 'WARNING': 'bold+yellow', 

88 'ERROR': 'bold+red', 

89 'CRITICAL': 'bold+white+bg_red' 

90 } 

91 

92 def format(self, record): 

93 # type: (LogRecord) -> str 

94 message = super(ScapyColoredFormatter, self).format(record) 

95 from scapy.config import conf 

96 message = conf.color_theme.format( 

97 message, 

98 self.levels_colored[record.levelname] 

99 ) 

100 return message 

101 

102 

103if WINDOWS: 

104 # colorama is bundled within IPython, but 

105 # logging.StreamHandler will be overwritten when called, 

106 # so we can't wait for IPython to call it 

107 try: 

108 import colorama 

109 colorama.init() 

110 except ImportError: 

111 pass 

112 

113# get Scapy's master logger 

114log_scapy = logging.getLogger("scapy") 

115log_scapy.propagate = False 

116# override the level if not already set 

117if log_scapy.level == logging.NOTSET: 

118 log_scapy.setLevel(logging.WARNING) 

119# add a custom handler controlled by Scapy's config 

120_handler = logging.StreamHandler() 

121_handler.setFormatter( 

122 ScapyColoredFormatter( 

123 "%(levelname)s: %(message)s", 

124 ) 

125) 

126log_scapy.addHandler(_handler) 

127# logs at runtime 

128log_runtime = logging.getLogger("scapy.runtime") 

129log_runtime.addFilter(ScapyFreqFilter()) 

130# logs in interactive functions 

131log_interactive = logging.getLogger("scapy.interactive") 

132log_interactive.setLevel(logging.DEBUG) 

133# logs when loading Scapy 

134log_loading = logging.getLogger("scapy.loading") 

135 

136 

137def warning(x, *args, **kargs): 

138 # type: (str, *Any, **Any) -> None 

139 """ 

140 Prints a warning during runtime. 

141 """ 

142 log_runtime.warning(x, *args, **kargs)