Hide keyboard shortcuts

Hot-keys on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

from __future__ import absolute_import 

from __future__ import division 

from __future__ import print_function 

 

import sys 

import warnings 

from contextlib import contextmanager 

 

import pytest 

from _pytest import compat 

 

SHOW_PYTEST_WARNINGS_ARG = "-Walways::pytest.RemovedInPytest4Warning" 

 

 

def _setoption(wmod, arg): 

""" 

Copy of the warning._setoption function but does not escape arguments. 

""" 

parts = arg.split(":") 

if len(parts) > 5: 

raise wmod._OptionError("too many fields (max 5): %r" % (arg,)) 

while len(parts) < 5: 

parts.append("") 

action, message, category, module, lineno = [s.strip() for s in parts] 

action = wmod._getaction(action) 

category = wmod._getcategory(category) 

if lineno: 

try: 

lineno = int(lineno) 

if lineno < 0: 

raise ValueError 

except (ValueError, OverflowError): 

raise wmod._OptionError("invalid lineno %r" % (lineno,)) 

else: 

lineno = 0 

wmod.filterwarnings(action, message, category, module, lineno) 

 

 

def pytest_addoption(parser): 

group = parser.getgroup("pytest-warnings") 

group.addoption( 

"-W", 

"--pythonwarnings", 

action="append", 

help="set which warnings to report, see -W option of python itself.", 

) 

parser.addini( 

"filterwarnings", 

type="linelist", 

help="Each line specifies a pattern for " 

"warnings.filterwarnings. " 

"Processed after -W and --pythonwarnings.", 

) 

 

 

def pytest_configure(config): 

config.addinivalue_line( 

"markers", 

"filterwarnings(warning): add a warning filter to the given test. " 

"see https://docs.pytest.org/en/latest/warnings.html#pytest-mark-filterwarnings ", 

) 

 

 

@contextmanager 

def catch_warnings_for_item(config, ihook, when, item): 

""" 

Context manager that catches warnings generated in the contained execution block. 

 

``item`` can be None if we are not in the context of an item execution. 

 

Each warning captured triggers the ``pytest_warning_captured`` hook. 

""" 

cmdline_filters = config.getoption("pythonwarnings") or [] 

inifilters = config.getini("filterwarnings") 

with warnings.catch_warnings(record=True) as log: 

 

if not sys.warnoptions: 

# if user is not explicitly configuring warning filters, show deprecation warnings by default (#2908) 

warnings.filterwarnings("always", category=DeprecationWarning) 

warnings.filterwarnings("always", category=PendingDeprecationWarning) 

 

warnings.filterwarnings("error", category=pytest.RemovedInPytest4Warning) 

 

# filters should have this precedence: mark, cmdline options, ini 

# filters should be applied in the inverse order of precedence 

for arg in inifilters: 

_setoption(warnings, arg) 

 

for arg in cmdline_filters: 

warnings._setoption(arg) 

 

if item is not None: 

for mark in item.iter_markers(name="filterwarnings"): 

for arg in mark.args: 

_setoption(warnings, arg) 

 

yield 

 

for warning_message in log: 

ihook.pytest_warning_captured.call_historic( 

kwargs=dict(warning_message=warning_message, when=when, item=item) 

) 

 

 

def warning_record_to_str(warning_message): 

"""Convert a warnings.WarningMessage to a string, taking in account a lot of unicode shenaningans in Python 2. 

 

When Python 2 support is dropped this function can be greatly simplified. 

""" 

warn_msg = warning_message.message 

unicode_warning = False 

if compat._PY2 and any(isinstance(m, compat.UNICODE_TYPES) for m in warn_msg.args): 

new_args = [] 

for m in warn_msg.args: 

new_args.append( 

compat.ascii_escaped(m) if isinstance(m, compat.UNICODE_TYPES) else m 

) 

unicode_warning = list(warn_msg.args) != new_args 

warn_msg.args = new_args 

 

msg = warnings.formatwarning( 

warn_msg, 

warning_message.category, 

warning_message.filename, 

warning_message.lineno, 

warning_message.line, 

) 

if unicode_warning: 

warnings.warn( 

"Warning is using unicode non convertible to ascii, " 

"converting to a safe representation:\n {!r}".format(compat.safe_str(msg)), 

UnicodeWarning, 

) 

return msg 

 

 

@pytest.hookimpl(hookwrapper=True, tryfirst=True) 

def pytest_runtest_protocol(item): 

with catch_warnings_for_item( 

config=item.config, ihook=item.ihook, when="runtest", item=item 

): 

yield 

 

 

@pytest.hookimpl(hookwrapper=True, tryfirst=True) 

def pytest_collection(session): 

config = session.config 

with catch_warnings_for_item( 

config=config, ihook=config.hook, when="collect", item=None 

): 

yield 

 

 

@pytest.hookimpl(hookwrapper=True) 

def pytest_terminal_summary(terminalreporter): 

config = terminalreporter.config 

with catch_warnings_for_item( 

config=config, ihook=config.hook, when="config", item=None 

): 

yield 

 

 

def _issue_warning_captured(warning, hook, stacklevel): 

""" 

This function should be used instead of calling ``warnings.warn`` directly when we are in the "configure" stage: 

at this point the actual options might not have been set, so we manually trigger the pytest_warning_captured 

hook so we can display this warnings in the terminal. This is a hack until we can sort out #2891. 

 

:param warning: the warning instance. 

:param hook: the hook caller 

:param stacklevel: stacklevel forwarded to warnings.warn 

""" 

with warnings.catch_warnings(record=True) as records: 

warnings.simplefilter("always", type(warning)) 

warnings.warn(warning, stacklevel=stacklevel) 

hook.pytest_warning_captured.call_historic( 

kwargs=dict(warning_message=records[0], when="config", item=None) 

)