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

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

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

""" basic collect and runtest protocol implementations """ 

from __future__ import absolute_import 

from __future__ import division 

from __future__ import print_function 

 

import bdb 

import os 

import sys 

from time import time 

 

import attr 

import six 

 

from .reports import CollectErrorRepr 

from .reports import CollectReport 

from .reports import TestReport 

from _pytest._code.code import ExceptionInfo 

from _pytest.outcomes import Exit 

from _pytest.outcomes import skip 

from _pytest.outcomes import Skipped 

from _pytest.outcomes import TEST_OUTCOME 

 

# 

# pytest plugin hooks 

 

 

def pytest_addoption(parser): 

group = parser.getgroup("terminal reporting", "reporting", after="general") 

group.addoption( 

"--durations", 

action="store", 

type=int, 

default=None, 

metavar="N", 

help="show N slowest setup/test durations (N=0 for all).", 

), 

 

 

def pytest_terminal_summary(terminalreporter): 

durations = terminalreporter.config.option.durations 

verbose = terminalreporter.config.getvalue("verbose") 

if durations is None: 

return 

tr = terminalreporter 

dlist = [] 

for replist in tr.stats.values(): 

for rep in replist: 

if hasattr(rep, "duration"): 

dlist.append(rep) 

if not dlist: 

return 

dlist.sort(key=lambda x: x.duration) 

dlist.reverse() 

if not durations: 

tr.write_sep("=", "slowest test durations") 

else: 

tr.write_sep("=", "slowest %s test durations" % durations) 

dlist = dlist[:durations] 

 

for rep in dlist: 

if verbose < 2 and rep.duration < 0.005: 

tr.write_line("") 

tr.write_line("(0.00 durations hidden. Use -vv to show these durations.)") 

break 

tr.write_line("%02.2fs %-8s %s" % (rep.duration, rep.when, rep.nodeid)) 

 

 

def pytest_sessionstart(session): 

session._setupstate = SetupState() 

 

 

def pytest_sessionfinish(session): 

session._setupstate.teardown_all() 

 

 

def pytest_runtest_protocol(item, nextitem): 

item.ihook.pytest_runtest_logstart(nodeid=item.nodeid, location=item.location) 

runtestprotocol(item, nextitem=nextitem) 

item.ihook.pytest_runtest_logfinish(nodeid=item.nodeid, location=item.location) 

return True 

 

 

def runtestprotocol(item, log=True, nextitem=None): 

hasrequest = hasattr(item, "_request") 

if hasrequest and not item._request: 

item._initrequest() 

rep = call_and_report(item, "setup", log) 

reports = [rep] 

if rep.passed: 

if item.config.option.setupshow: 

show_test_item(item) 

if not item.config.option.setuponly: 

reports.append(call_and_report(item, "call", log)) 

reports.append(call_and_report(item, "teardown", log, nextitem=nextitem)) 

# after all teardown hooks have been called 

# want funcargs and request info to go away 

if hasrequest: 

item._request = False 

item.funcargs = None 

return reports 

 

 

def show_test_item(item): 

"""Show test function, parameters and the fixtures of the test item.""" 

tw = item.config.get_terminal_writer() 

tw.line() 

tw.write(" " * 8) 

tw.write(item._nodeid) 

used_fixtures = sorted(item._fixtureinfo.name2fixturedefs.keys()) 

if used_fixtures: 

tw.write(" (fixtures used: {})".format(", ".join(used_fixtures))) 

 

 

def pytest_runtest_setup(item): 

_update_current_test_var(item, "setup") 

item.session._setupstate.prepare(item) 

 

 

def pytest_runtest_call(item): 

_update_current_test_var(item, "call") 

sys.last_type, sys.last_value, sys.last_traceback = (None, None, None) 

try: 

item.runtest() 

except Exception: 

# Store trace info to allow postmortem debugging 

type, value, tb = sys.exc_info() 

tb = tb.tb_next # Skip *this* frame 

sys.last_type = type 

sys.last_value = value 

sys.last_traceback = tb 

del type, value, tb # Get rid of these in this frame 

raise 

 

 

def pytest_runtest_teardown(item, nextitem): 

_update_current_test_var(item, "teardown") 

item.session._setupstate.teardown_exact(item, nextitem) 

_update_current_test_var(item, None) 

 

 

def _update_current_test_var(item, when): 

""" 

Update PYTEST_CURRENT_TEST to reflect the current item and stage. 

 

If ``when`` is None, delete PYTEST_CURRENT_TEST from the environment. 

""" 

var_name = "PYTEST_CURRENT_TEST" 

if when: 

value = "{} ({})".format(item.nodeid, when) 

# don't allow null bytes on environment variables (see #2644, #2957) 

value = value.replace("\x00", "(null)") 

os.environ[var_name] = value 

else: 

os.environ.pop(var_name) 

 

 

def pytest_report_teststatus(report): 

if report.when in ("setup", "teardown"): 

if report.failed: 

# category, shortletter, verbose-word 

return "error", "E", "ERROR" 

elif report.skipped: 

return "skipped", "s", "SKIPPED" 

else: 

return "", "", "" 

 

 

# 

# Implementation 

 

 

def call_and_report(item, when, log=True, **kwds): 

call = call_runtest_hook(item, when, **kwds) 

hook = item.ihook 

report = hook.pytest_runtest_makereport(item=item, call=call) 

if log: 

hook.pytest_runtest_logreport(report=report) 

if check_interactive_exception(call, report): 

hook.pytest_exception_interact(node=item, call=call, report=report) 

return report 

 

 

def check_interactive_exception(call, report): 

return call.excinfo and not ( 

hasattr(report, "wasxfail") 

or call.excinfo.errisinstance(skip.Exception) 

or call.excinfo.errisinstance(bdb.BdbQuit) 

) 

 

 

def call_runtest_hook(item, when, **kwds): 

hookname = "pytest_runtest_" + when 

ihook = getattr(item.ihook, hookname) 

reraise = (Exit,) 

if not item.config.getvalue("usepdb"): 

reraise += (KeyboardInterrupt,) 

return CallInfo.from_call( 

lambda: ihook(item=item, **kwds), when=when, reraise=reraise 

) 

 

 

@attr.s(repr=False) 

class CallInfo(object): 

""" Result/Exception info a function invocation. """ 

 

_result = attr.ib() 

# Optional[ExceptionInfo] 

excinfo = attr.ib() 

start = attr.ib() 

stop = attr.ib() 

when = attr.ib() 

 

@property 

def result(self): 

if self.excinfo is not None: 

raise AttributeError("{!r} has no valid result".format(self)) 

return self._result 

 

@classmethod 

def from_call(cls, func, when, reraise=None): 

#: context of invocation: one of "setup", "call", 

#: "teardown", "memocollect" 

start = time() 

excinfo = None 

try: 

result = func() 

except: # noqa 

excinfo = ExceptionInfo.from_current() 

if reraise is not None and excinfo.errisinstance(reraise): 

raise 

result = None 

stop = time() 

return cls(start=start, stop=stop, when=when, result=result, excinfo=excinfo) 

 

def __repr__(self): 

if self.excinfo is not None: 

status = "exception" 

value = self.excinfo.value 

else: 

# TODO: investigate unification 

value = repr(self._result) 

status = "result" 

return "<CallInfo when={when!r} {status}: {value}>".format( 

when=self.when, value=value, status=status 

) 

 

 

def pytest_runtest_makereport(item, call): 

when = call.when 

duration = call.stop - call.start 

keywords = {x: 1 for x in item.keywords} 

excinfo = call.excinfo 

sections = [] 

if not call.excinfo: 

outcome = "passed" 

longrepr = None 

else: 

if not isinstance(excinfo, ExceptionInfo): 

outcome = "failed" 

longrepr = excinfo 

elif excinfo.errisinstance(skip.Exception): 

outcome = "skipped" 

r = excinfo._getreprcrash() 

longrepr = (str(r.path), r.lineno, r.message) 

else: 

outcome = "failed" 

if call.when == "call": 

longrepr = item.repr_failure(excinfo) 

else: # exception in setup or teardown 

longrepr = item._repr_failure_py( 

excinfo, style=item.config.option.tbstyle 

) 

for rwhen, key, content in item._report_sections: 

sections.append(("Captured %s %s" % (key, rwhen), content)) 

return TestReport( 

item.nodeid, 

item.location, 

keywords, 

outcome, 

longrepr, 

when, 

sections, 

duration, 

user_properties=item.user_properties, 

) 

 

 

def pytest_make_collect_report(collector): 

call = CallInfo.from_call(lambda: list(collector.collect()), "collect") 

longrepr = None 

if not call.excinfo: 

outcome = "passed" 

else: 

from _pytest import nose 

 

skip_exceptions = (Skipped,) + nose.get_skip_exceptions() 

if call.excinfo.errisinstance(skip_exceptions): 

outcome = "skipped" 

r = collector._repr_failure_py(call.excinfo, "line").reprcrash 

longrepr = (str(r.path), r.lineno, r.message) 

else: 

outcome = "failed" 

errorinfo = collector.repr_failure(call.excinfo) 

if not hasattr(errorinfo, "toterminal"): 

errorinfo = CollectErrorRepr(errorinfo) 

longrepr = errorinfo 

rep = CollectReport( 

collector.nodeid, outcome, longrepr, getattr(call, "result", None) 

) 

rep.call = call # see collect_one_node 

return rep 

 

 

class SetupState(object): 

""" shared state for setting up/tearing down test items or collectors. """ 

 

def __init__(self): 

self.stack = [] 

self._finalizers = {} 

 

def addfinalizer(self, finalizer, colitem): 

""" attach a finalizer to the given colitem. 

if colitem is None, this will add a finalizer that 

is called at the end of teardown_all(). 

""" 

assert colitem and not isinstance(colitem, tuple) 

assert callable(finalizer) 

# assert colitem in self.stack # some unit tests don't setup stack :/ 

self._finalizers.setdefault(colitem, []).append(finalizer) 

 

def _pop_and_teardown(self): 

colitem = self.stack.pop() 

self._teardown_with_finalization(colitem) 

 

def _callfinalizers(self, colitem): 

finalizers = self._finalizers.pop(colitem, None) 

exc = None 

while finalizers: 

fin = finalizers.pop() 

try: 

fin() 

except TEST_OUTCOME: 

# XXX Only first exception will be seen by user, 

# ideally all should be reported. 

if exc is None: 

exc = sys.exc_info() 

if exc: 

six.reraise(*exc) 

 

def _teardown_with_finalization(self, colitem): 

self._callfinalizers(colitem) 

if hasattr(colitem, "teardown"): 

colitem.teardown() 

for colitem in self._finalizers: 

assert ( 

colitem is None or colitem in self.stack or isinstance(colitem, tuple) 

) 

 

def teardown_all(self): 

while self.stack: 

self._pop_and_teardown() 

for key in list(self._finalizers): 

self._teardown_with_finalization(key) 

assert not self._finalizers 

 

def teardown_exact(self, item, nextitem): 

needed_collectors = nextitem and nextitem.listchain() or [] 

self._teardown_towards(needed_collectors) 

 

def _teardown_towards(self, needed_collectors): 

exc = None 

while self.stack: 

if self.stack == needed_collectors[: len(self.stack)]: 

break 

try: 

self._pop_and_teardown() 

except TEST_OUTCOME: 

# XXX Only first exception will be seen by user, 

# ideally all should be reported. 

if exc is None: 

exc = sys.exc_info() 

if exc: 

six.reraise(*exc) 

 

def prepare(self, colitem): 

""" setup objects along the collector chain to the test-method 

and teardown previously setup objects.""" 

needed_collectors = colitem.listchain() 

self._teardown_towards(needed_collectors) 

 

# check if the last collection node has raised an error 

for col in self.stack: 

if hasattr(col, "_prepare_exc"): 

six.reraise(*col._prepare_exc) 

for col in needed_collectors[len(self.stack) :]: 

self.stack.append(col) 

try: 

col.setup() 

except TEST_OUTCOME: 

col._prepare_exc = sys.exc_info() 

raise 

 

 

def collect_one_node(collector): 

ihook = collector.ihook 

ihook.pytest_collectstart(collector=collector) 

rep = ihook.pytest_make_collect_report(collector=collector) 

call = rep.__dict__.pop("call", None) 

if call and check_interactive_exception(call, rep): 

ihook.pytest_exception_interact(node=collector, call=call, report=rep) 

return rep