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

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

""" hook specifications for pytest plugins, invoked from main.py and builtin plugins.  """ 

 

from _pytest._pluggy import HookspecMarker 

 

hookspec = HookspecMarker("pytest") 

 

# ------------------------------------------------------------------------- 

# Initialization hooks called for every plugin 

# ------------------------------------------------------------------------- 

 

exit@hookspec(historic=True) 

def pytest_addhooks(pluginmanager): 

    """called at plugin registration time to allow adding new hooks via a call to 

    pluginmanager.add_hookspecs(module_or_class, prefix).""" 

 

 

exit@hookspec(historic=True) 

def pytest_namespace(): 

    """return dict of name->object to be made globally available in 

    the pytest namespace.  This hook is called at plugin registration 

    time. 

    """ 

 

exit@hookspec(historic=True) 

def pytest_plugin_registered(plugin, manager): 

    """ a new pytest plugin got registered. """ 

 

 

exit@hookspec(historic=True) 

def pytest_addoption(parser): 

    """register argparse-style options and ini-style config values, 

    called once at the beginning of a test run. 

 

    .. note:: 

 

        This function should be implemented only in plugins or ``conftest.py`` 

        files situated at the tests root directory due to how py.test 

        :ref:`discovers plugins during startup <pluginorder>`. 

 

    :arg parser: To add command line options, call 

        :py:func:`parser.addoption(...) <_pytest.config.Parser.addoption>`. 

        To add ini-file values call :py:func:`parser.addini(...) 

        <_pytest.config.Parser.addini>`. 

 

    Options can later be accessed through the 

    :py:class:`config <_pytest.config.Config>` object, respectively: 

 

    - :py:func:`config.getoption(name) <_pytest.config.Config.getoption>` to 

      retrieve the value of a command line option. 

 

    - :py:func:`config.getini(name) <_pytest.config.Config.getini>` to retrieve 

      a value read from an ini-style file. 

 

    The config object is passed around on many internal objects via the ``.config`` 

    attribute or can be retrieved as the ``pytestconfig`` fixture or accessed 

    via (deprecated) ``pytest.config``. 

    """ 

 

exit@hookspec(historic=True) 

def pytest_configure(config): 

    """ called after command line options have been parsed 

    and all plugins and initial conftest files been loaded. 

    This hook is called for every plugin. 

    """ 

 

# ------------------------------------------------------------------------- 

# Bootstrapping hooks called for plugins registered early enough: 

# internal and 3rd party plugins as well as directly 

# discoverable conftest.py local plugins. 

# ------------------------------------------------------------------------- 

 

exit@hookspec(firstresult=True) 

def pytest_cmdline_parse(pluginmanager, args): 

    """return initialized config object, parsing the specified args. """ 

 

exitdef pytest_cmdline_preparse(config, args): 

    """(deprecated) modify command line arguments before option parsing. """ 

 

exit@hookspec(firstresult=True) 

def pytest_cmdline_main(config): 

    """ called for performing the main command line action. The default 

    implementation will invoke the configure hooks and runtest_mainloop. """ 

 

exitdef pytest_load_initial_conftests(early_config, parser, args): 

    """ implements the loading of initial conftest files ahead 

    of command line option parsing. """ 

 

 

# ------------------------------------------------------------------------- 

# collection hooks 

# ------------------------------------------------------------------------- 

 

exit@hookspec(firstresult=True) 

def pytest_collection(session): 

    """ perform the collection protocol for the given session. """ 

 

exitdef pytest_collection_modifyitems(session, config, items): 

    """ called after collection has been performed, may filter or re-order 

    the items in-place.""" 

 

exitdef pytest_collection_finish(session): 

    """ called after collection has been performed and modified. """ 

 

exit@hookspec(firstresult=True) 

def pytest_ignore_collect(path, config): 

    """ return True to prevent considering this path for collection. 

    This hook is consulted for all files and directories prior to calling 

    more specific hooks. 

    """ 

 

exit@hookspec(firstresult=True) 

def pytest_collect_directory(path, parent): 

    """ called before traversing a directory for collection files. """ 

 

exitdef pytest_collect_file(path, parent): 

    """ return collection Node or None for the given path. Any new node 

    needs to have the specified ``parent`` as a parent.""" 

 

# logging hooks for collection 

exitdef pytest_collectstart(collector): 

    """ collector starts collecting. """ 

 

exitdef pytest_itemcollected(item): 

    """ we just collected a test item. """ 

 

exitdef pytest_collectreport(report): 

    """ collector finished collecting. """ 

 

exitdef pytest_deselected(items): 

    """ called for test items deselected by keyword. """ 

 

exit@hookspec(firstresult=True) 

def pytest_make_collect_report(collector): 

    """ perform ``collector.collect()`` and return a CollectReport. """ 

 

# ------------------------------------------------------------------------- 

# Python test function related hooks 

# ------------------------------------------------------------------------- 

 

exit@hookspec(firstresult=True) 

def pytest_pycollect_makemodule(path, parent): 

    """ return a Module collector or None for the given path. 

    This hook will be called for each matching test module path. 

    The pytest_collect_file hook needs to be used if you want to 

    create test modules for files that do not match as a test module. 

    """ 

 

exit@hookspec(firstresult=True) 

def pytest_pycollect_makeitem(collector, name, obj): 

    """ return custom item/collector for a python object in a module, or None.  """ 

 

exit@hookspec(firstresult=True) 

def pytest_pyfunc_call(pyfuncitem): 

    """ call underlying test function. """ 

 

exitdef pytest_generate_tests(metafunc): 

    """ generate (multiple) parametrized calls to a test function.""" 

 

# ------------------------------------------------------------------------- 

# generic runtest related hooks 

# ------------------------------------------------------------------------- 

 

exit@hookspec(firstresult=True) 

def pytest_runtestloop(session): 

    """ called for performing the main runtest loop 

    (after collection finished). """ 

 

exitdef pytest_itemstart(item, node): 

    """ (deprecated, use pytest_runtest_logstart). """ 

 

exit@hookspec(firstresult=True) 

def pytest_runtest_protocol(item, nextitem): 

    """ implements the runtest_setup/call/teardown protocol for 

    the given test item, including capturing exceptions and calling 

    reporting hooks. 

 

    :arg item: test item for which the runtest protocol is performed. 

 

    :arg nextitem: the scheduled-to-be-next test item (or None if this 

                   is the end my friend).  This argument is passed on to 

                   :py:func:`pytest_runtest_teardown`. 

 

    :return boolean: True if no further hook implementations should be invoked. 

    """ 

 

exitdef pytest_runtest_logstart(nodeid, location): 

    """ signal the start of running a single test item. """ 

 

exitdef pytest_runtest_setup(item): 

    """ called before ``pytest_runtest_call(item)``. """ 

 

exitdef pytest_runtest_call(item): 

    """ called to execute the test ``item``. """ 

 

exitdef pytest_runtest_teardown(item, nextitem): 

    """ called after ``pytest_runtest_call``. 

 

    :arg nextitem: the scheduled-to-be-next test item (None if no further 

                   test item is scheduled).  This argument can be used to 

                   perform exact teardowns, i.e. calling just enough finalizers 

                   so that nextitem only needs to call setup-functions. 

    """ 

 

exit@hookspec(firstresult=True) 

def pytest_runtest_makereport(item, call): 

    """ return a :py:class:`_pytest.runner.TestReport` object 

    for the given :py:class:`pytest.Item` and 

    :py:class:`_pytest.runner.CallInfo`. 

    """ 

 

exitdef pytest_runtest_logreport(report): 

    """ process a test setup/call/teardown report relating to 

    the respective phase of executing a test. """ 

 

# ------------------------------------------------------------------------- 

# test session related hooks 

# ------------------------------------------------------------------------- 

 

exitdef pytest_sessionstart(session): 

    """ before session.main() is called. """ 

 

exitdef pytest_sessionfinish(session, exitstatus): 

    """ whole test run finishes. """ 

 

exitdef pytest_unconfigure(config): 

    """ called before test process is exited.  """ 

 

 

# ------------------------------------------------------------------------- 

# hooks for customising the assert methods 

# ------------------------------------------------------------------------- 

 

exitdef pytest_assertrepr_compare(config, op, left, right): 

    """return explanation for comparisons in failing assert expressions. 

 

    Return None for no custom explanation, otherwise return a list 

    of strings.  The strings will be joined by newlines but any newlines 

    *in* a string will be escaped.  Note that all but the first line will 

    be indented sligthly, the intention is for the first line to be a summary. 

    """ 

 

# ------------------------------------------------------------------------- 

# hooks for influencing reporting (invoked from _pytest_terminal) 

# ------------------------------------------------------------------------- 

 

exitdef pytest_report_header(config, startdir): 

    """ return a string to be displayed as header info for terminal reporting.""" 

 

exit@hookspec(firstresult=True) 

def pytest_report_teststatus(report): 

    """ return result-category, shortletter and verbose word for reporting.""" 

 

exitdef pytest_terminal_summary(terminalreporter): 

    """ add additional section in terminal summary reporting.  """ 

 

 

exit@hookspec(historic=True) 

def pytest_logwarning(message, code, nodeid, fslocation): 

    """ process a warning specified by a message, a code string, 

    a nodeid and fslocation (both of which may be None 

    if the warning is not tied to a partilar node/location).""" 

 

# ------------------------------------------------------------------------- 

# doctest hooks 

# ------------------------------------------------------------------------- 

 

exit@hookspec(firstresult=True) 

def pytest_doctest_prepare_content(content): 

    """ return processed content for a given doctest""" 

 

# ------------------------------------------------------------------------- 

# error handling and internal debugging hooks 

# ------------------------------------------------------------------------- 

 

exitdef pytest_internalerror(excrepr, excinfo): 

    """ called for internal errors. """ 

 

exitdef pytest_keyboard_interrupt(excinfo): 

    """ called for keyboard interrupt. """ 

 

exitdef pytest_exception_interact(node, call, report): 

    """called when an exception was raised which can potentially be 

    interactively handled. 

 

    This hook is only called if an exception was raised 

    that is not an internal exception like ``skip.Exception``. 

    """ 

 

exitdef pytest_enter_pdb(config): 

    """ called upon pdb.set_trace(), can be used by plugins to take special 

    action just before the python debugger enters in interactive mode. 

 

    :arg config: pytest config object 

    :type config: _pytest.config.Config 

    """