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

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

953

954

955

956

957

958

959

960

961

962

963

964

965

966

967

968

969

970

971

972

973

974

975

976

977

978

979

980

981

982

983

984

985

986

987

988

989

990

991

992

993

994

995

996

997

998

999

1000

1001

1002

1003

1004

1005

1006

1007

1008

1009

1010

1011

1012

1013

1014

1015

1016

1017

1018

1019

1020

1021

1022

1023

1024

1025

1026

1027

1028

1029

1030

1031

1032

1033

1034

1035

1036

1037

1038

1039

1040

1041

1042

1043

1044

1045

1046

1047

1048

1049

1050

1051

1052

1053

1054

1055

1056

1057

1058

1059

1060

1061

1062

1063

1064

1065

1066

1067

1068

1069

1070

1071

1072

1073

1074

1075

1076

1077

1078

1079

1080

1081

1082

1083

1084

1085

1086

1087

1088

1089

1090

1091

1092

1093

1094

from __future__ import absolute_import 

from __future__ import division 

from __future__ import print_function 

 

import inspect 

import pprint 

import re 

import sys 

import traceback 

from inspect import CO_VARARGS 

from inspect import CO_VARKEYWORDS 

from weakref import ref 

 

import attr 

import pluggy 

import py 

import six 

from six import text_type 

 

import _pytest 

from _pytest._io.saferepr import saferepr 

from _pytest.compat import _PY2 

from _pytest.compat import _PY3 

from _pytest.compat import PY35 

from _pytest.compat import safe_str 

 

if _PY3: 

from traceback import format_exception_only 

else: 

from ._py2traceback import format_exception_only 

 

 

class Code(object): 

""" wrapper around Python code objects """ 

 

def __init__(self, rawcode): 

if not hasattr(rawcode, "co_filename"): 

rawcode = getrawcode(rawcode) 

try: 

self.filename = rawcode.co_filename 

self.firstlineno = rawcode.co_firstlineno - 1 

self.name = rawcode.co_name 

except AttributeError: 

raise TypeError("not a code object: %r" % (rawcode,)) 

self.raw = rawcode 

 

def __eq__(self, other): 

return self.raw == other.raw 

 

__hash__ = None 

 

def __ne__(self, other): 

return not self == other 

 

@property 

def path(self): 

""" return a path object pointing to source code (note that it 

might not point to an actually existing file). """ 

try: 

p = py.path.local(self.raw.co_filename) 

# maybe don't try this checking 

if not p.check(): 

raise OSError("py.path check failed.") 

except OSError: 

# XXX maybe try harder like the weird logic 

# in the standard lib [linecache.updatecache] does? 

p = self.raw.co_filename 

 

return p 

 

@property 

def fullsource(self): 

""" return a _pytest._code.Source object for the full source file of the code 

""" 

from _pytest._code import source 

 

full, _ = source.findsource(self.raw) 

return full 

 

def source(self): 

""" return a _pytest._code.Source object for the code object's source only 

""" 

# return source only for that part of code 

import _pytest._code 

 

return _pytest._code.Source(self.raw) 

 

def getargs(self, var=False): 

""" return a tuple with the argument names for the code object 

 

if 'var' is set True also return the names of the variable and 

keyword arguments when present 

""" 

# handfull shortcut for getting args 

raw = self.raw 

argcount = raw.co_argcount 

if var: 

argcount += raw.co_flags & CO_VARARGS 

argcount += raw.co_flags & CO_VARKEYWORDS 

return raw.co_varnames[:argcount] 

 

 

class Frame(object): 

"""Wrapper around a Python frame holding f_locals and f_globals 

in which expressions can be evaluated.""" 

 

def __init__(self, frame): 

self.lineno = frame.f_lineno - 1 

self.f_globals = frame.f_globals 

self.f_locals = frame.f_locals 

self.raw = frame 

self.code = Code(frame.f_code) 

 

@property 

def statement(self): 

""" statement this frame is at """ 

import _pytest._code 

 

if self.code.fullsource is None: 

return _pytest._code.Source("") 

return self.code.fullsource.getstatement(self.lineno) 

 

def eval(self, code, **vars): 

""" evaluate 'code' in the frame 

 

'vars' are optional additional local variables 

 

returns the result of the evaluation 

""" 

f_locals = self.f_locals.copy() 

f_locals.update(vars) 

return eval(code, self.f_globals, f_locals) 

 

def exec_(self, code, **vars): 

""" exec 'code' in the frame 

 

'vars' are optiona; additional local variables 

""" 

f_locals = self.f_locals.copy() 

f_locals.update(vars) 

six.exec_(code, self.f_globals, f_locals) 

 

def repr(self, object): 

""" return a 'safe' (non-recursive, one-line) string repr for 'object' 

""" 

return saferepr(object) 

 

def is_true(self, object): 

return object 

 

def getargs(self, var=False): 

""" return a list of tuples (name, value) for all arguments 

 

if 'var' is set True also include the variable and keyword 

arguments when present 

""" 

retval = [] 

for arg in self.code.getargs(var): 

try: 

retval.append((arg, self.f_locals[arg])) 

except KeyError: 

pass # this can occur when using Psyco 

return retval 

 

 

class TracebackEntry(object): 

""" a single entry in a traceback """ 

 

_repr_style = None 

exprinfo = None 

 

def __init__(self, rawentry, excinfo=None): 

self._excinfo = excinfo 

self._rawentry = rawentry 

self.lineno = rawentry.tb_lineno - 1 

 

def set_repr_style(self, mode): 

assert mode in ("short", "long") 

self._repr_style = mode 

 

@property 

def frame(self): 

import _pytest._code 

 

return _pytest._code.Frame(self._rawentry.tb_frame) 

 

@property 

def relline(self): 

return self.lineno - self.frame.code.firstlineno 

 

def __repr__(self): 

return "<TracebackEntry %s:%d>" % (self.frame.code.path, self.lineno + 1) 

 

@property 

def statement(self): 

""" _pytest._code.Source object for the current statement """ 

source = self.frame.code.fullsource 

return source.getstatement(self.lineno) 

 

@property 

def path(self): 

""" path to the source code """ 

return self.frame.code.path 

 

def getlocals(self): 

return self.frame.f_locals 

 

locals = property(getlocals, None, None, "locals of underlaying frame") 

 

def getfirstlinesource(self): 

# on Jython this firstlineno can be -1 apparently 

return max(self.frame.code.firstlineno, 0) 

 

def getsource(self, astcache=None): 

""" return failing source code. """ 

# we use the passed in astcache to not reparse asttrees 

# within exception info printing 

from _pytest._code.source import getstatementrange_ast 

 

source = self.frame.code.fullsource 

if source is None: 

return None 

key = astnode = None 

if astcache is not None: 

key = self.frame.code.path 

if key is not None: 

astnode = astcache.get(key, None) 

start = self.getfirstlinesource() 

try: 

astnode, _, end = getstatementrange_ast( 

self.lineno, source, astnode=astnode 

) 

except SyntaxError: 

end = self.lineno + 1 

else: 

if key is not None: 

astcache[key] = astnode 

return source[start:end] 

 

source = property(getsource) 

 

def ishidden(self): 

""" return True if the current frame has a var __tracebackhide__ 

resolving to True 

 

If __tracebackhide__ is a callable, it gets called with the 

ExceptionInfo instance and can decide whether to hide the traceback. 

 

mostly for internal use 

""" 

try: 

tbh = self.frame.f_locals["__tracebackhide__"] 

except KeyError: 

try: 

tbh = self.frame.f_globals["__tracebackhide__"] 

except KeyError: 

return False 

 

if callable(tbh): 

return tbh(None if self._excinfo is None else self._excinfo()) 

else: 

return tbh 

 

def __str__(self): 

try: 

fn = str(self.path) 

except py.error.Error: 

fn = "???" 

name = self.frame.code.name 

try: 

line = str(self.statement).lstrip() 

except KeyboardInterrupt: 

raise 

except: # noqa 

line = "???" 

return " File %r:%d in %s\n %s\n" % (fn, self.lineno + 1, name, line) 

 

def name(self): 

return self.frame.code.raw.co_name 

 

name = property(name, None, None, "co_name of underlaying code") 

 

 

class Traceback(list): 

""" Traceback objects encapsulate and offer higher level 

access to Traceback entries. 

""" 

 

Entry = TracebackEntry 

 

def __init__(self, tb, excinfo=None): 

""" initialize from given python traceback object and ExceptionInfo """ 

self._excinfo = excinfo 

if hasattr(tb, "tb_next"): 

 

def f(cur): 

while cur is not None: 

yield self.Entry(cur, excinfo=excinfo) 

cur = cur.tb_next 

 

list.__init__(self, f(tb)) 

else: 

list.__init__(self, tb) 

 

def cut(self, path=None, lineno=None, firstlineno=None, excludepath=None): 

""" return a Traceback instance wrapping part of this Traceback 

 

by provding any combination of path, lineno and firstlineno, the 

first frame to start the to-be-returned traceback is determined 

 

this allows cutting the first part of a Traceback instance e.g. 

for formatting reasons (removing some uninteresting bits that deal 

with handling of the exception/traceback) 

""" 

for x in self: 

code = x.frame.code 

codepath = code.path 

if ( 

(path is None or codepath == path) 

and ( 

excludepath is None 

or not hasattr(codepath, "relto") 

or not codepath.relto(excludepath) 

) 

and (lineno is None or x.lineno == lineno) 

and (firstlineno is None or x.frame.code.firstlineno == firstlineno) 

): 

return Traceback(x._rawentry, self._excinfo) 

return self 

 

def __getitem__(self, key): 

val = super(Traceback, self).__getitem__(key) 

if isinstance(key, type(slice(0))): 

val = self.__class__(val) 

return val 

 

def filter(self, fn=lambda x: not x.ishidden()): 

""" return a Traceback instance with certain items removed 

 

fn is a function that gets a single argument, a TracebackEntry 

instance, and should return True when the item should be added 

to the Traceback, False when not 

 

by default this removes all the TracebackEntries which are hidden 

(see ishidden() above) 

""" 

return Traceback(filter(fn, self), self._excinfo) 

 

def getcrashentry(self): 

""" return last non-hidden traceback entry that lead 

to the exception of a traceback. 

""" 

for i in range(-1, -len(self) - 1, -1): 

entry = self[i] 

if not entry.ishidden(): 

return entry 

return self[-1] 

 

def recursionindex(self): 

""" return the index of the frame/TracebackEntry where recursion 

originates if appropriate, None if no recursion occurred 

""" 

cache = {} 

for i, entry in enumerate(self): 

# id for the code.raw is needed to work around 

# the strange metaprogramming in the decorator lib from pypi 

# which generates code objects that have hash/value equality 

# XXX needs a test 

key = entry.frame.code.path, id(entry.frame.code.raw), entry.lineno 

# print "checking for recursion at", key 

values = cache.setdefault(key, []) 

if values: 

f = entry.frame 

loc = f.f_locals 

for otherloc in values: 

if f.is_true( 

f.eval( 

co_equal, 

__recursioncache_locals_1=loc, 

__recursioncache_locals_2=otherloc, 

) 

): 

return i 

values.append(entry.frame.f_locals) 

return None 

 

 

co_equal = compile( 

"__recursioncache_locals_1 == __recursioncache_locals_2", "?", "eval" 

) 

 

 

@attr.s(repr=False) 

class ExceptionInfo(object): 

""" wraps sys.exc_info() objects and offers 

help for navigating the traceback. 

""" 

 

_assert_start_repr = ( 

"AssertionError(u'assert " if _PY2 else "AssertionError('assert " 

) 

 

_excinfo = attr.ib() 

_striptext = attr.ib(default="") 

_traceback = attr.ib(default=None) 

 

@classmethod 

def from_current(cls, exprinfo=None): 

"""returns an ExceptionInfo matching the current traceback 

 

.. warning:: 

 

Experimental API 

 

 

:param exprinfo: a text string helping to determine if we should 

strip ``AssertionError`` from the output, defaults 

to the exception message/``__str__()`` 

""" 

tup = sys.exc_info() 

_striptext = "" 

if exprinfo is None and isinstance(tup[1], AssertionError): 

exprinfo = getattr(tup[1], "msg", None) 

if exprinfo is None: 

exprinfo = saferepr(tup[1]) 

if exprinfo and exprinfo.startswith(cls._assert_start_repr): 

_striptext = "AssertionError: " 

 

return cls(tup, _striptext) 

 

@classmethod 

def for_later(cls): 

"""return an unfilled ExceptionInfo 

""" 

return cls(None) 

 

@property 

def type(self): 

"""the exception class""" 

return self._excinfo[0] 

 

@property 

def value(self): 

"""the exception value""" 

return self._excinfo[1] 

 

@property 

def tb(self): 

"""the exception raw traceback""" 

return self._excinfo[2] 

 

@property 

def typename(self): 

"""the type name of the exception""" 

return self.type.__name__ 

 

@property 

def traceback(self): 

"""the traceback""" 

if self._traceback is None: 

self._traceback = Traceback(self.tb, excinfo=ref(self)) 

return self._traceback 

 

@traceback.setter 

def traceback(self, value): 

self._traceback = value 

 

def __repr__(self): 

if self._excinfo is None: 

return "<ExceptionInfo for raises contextmanager>" 

return "<ExceptionInfo %s tblen=%d>" % (self.typename, len(self.traceback)) 

 

def exconly(self, tryshort=False): 

""" return the exception as a string 

 

when 'tryshort' resolves to True, and the exception is a 

_pytest._code._AssertionError, only the actual exception part of 

the exception representation is returned (so 'AssertionError: ' is 

removed from the beginning) 

""" 

lines = format_exception_only(self.type, self.value) 

text = "".join(lines) 

text = text.rstrip() 

if tryshort: 

if text.startswith(self._striptext): 

text = text[len(self._striptext) :] 

return text 

 

def errisinstance(self, exc): 

""" return True if the exception is an instance of exc """ 

return isinstance(self.value, exc) 

 

def _getreprcrash(self): 

exconly = self.exconly(tryshort=True) 

entry = self.traceback.getcrashentry() 

path, lineno = entry.frame.code.raw.co_filename, entry.lineno 

return ReprFileLocation(path, lineno + 1, exconly) 

 

def getrepr( 

self, 

showlocals=False, 

style="long", 

abspath=False, 

tbfilter=True, 

funcargs=False, 

truncate_locals=True, 

chain=True, 

): 

""" 

Return str()able representation of this exception info. 

 

:param bool showlocals: 

Show locals per traceback entry. 

Ignored if ``style=="native"``. 

 

:param str style: long|short|no|native traceback style 

 

:param bool abspath: 

If paths should be changed to absolute or left unchanged. 

 

:param bool tbfilter: 

Hide entries that contain a local variable ``__tracebackhide__==True``. 

Ignored if ``style=="native"``. 

 

:param bool funcargs: 

Show fixtures ("funcargs" for legacy purposes) per traceback entry. 

 

:param bool truncate_locals: 

With ``showlocals==True``, make sure locals can be safely represented as strings. 

 

:param bool chain: if chained exceptions in Python 3 should be shown. 

 

.. versionchanged:: 3.9 

 

Added the ``chain`` parameter. 

""" 

if style == "native": 

return ReprExceptionInfo( 

ReprTracebackNative( 

traceback.format_exception( 

self.type, self.value, self.traceback[0]._rawentry 

) 

), 

self._getreprcrash(), 

) 

 

fmt = FormattedExcinfo( 

showlocals=showlocals, 

style=style, 

abspath=abspath, 

tbfilter=tbfilter, 

funcargs=funcargs, 

truncate_locals=truncate_locals, 

chain=chain, 

) 

return fmt.repr_excinfo(self) 

 

def __str__(self): 

if self._excinfo is None: 

return repr(self) 

entry = self.traceback[-1] 

loc = ReprFileLocation(entry.path, entry.lineno + 1, self.exconly()) 

return str(loc) 

 

def __unicode__(self): 

entry = self.traceback[-1] 

loc = ReprFileLocation(entry.path, entry.lineno + 1, self.exconly()) 

return text_type(loc) 

 

def match(self, regexp): 

""" 

Match the regular expression 'regexp' on the string representation of 

the exception. If it matches then True is returned (so that it is 

possible to write 'assert excinfo.match()'). If it doesn't match an 

AssertionError is raised. 

""" 

__tracebackhide__ = True 

if not re.search(regexp, str(self.value)): 

assert 0, "Pattern '{!s}' not found in '{!s}'".format(regexp, self.value) 

return True 

 

 

@attr.s 

class FormattedExcinfo(object): 

""" presenting information about failing Functions and Generators. """ 

 

# for traceback entries 

flow_marker = ">" 

fail_marker = "E" 

 

showlocals = attr.ib(default=False) 

style = attr.ib(default="long") 

abspath = attr.ib(default=True) 

tbfilter = attr.ib(default=True) 

funcargs = attr.ib(default=False) 

truncate_locals = attr.ib(default=True) 

chain = attr.ib(default=True) 

astcache = attr.ib(default=attr.Factory(dict), init=False, repr=False) 

 

def _getindent(self, source): 

# figure out indent for given source 

try: 

s = str(source.getstatement(len(source) - 1)) 

except KeyboardInterrupt: 

raise 

except: # noqa 

try: 

s = str(source[-1]) 

except KeyboardInterrupt: 

raise 

except: # noqa 

return 0 

return 4 + (len(s) - len(s.lstrip())) 

 

def _getentrysource(self, entry): 

source = entry.getsource(self.astcache) 

if source is not None: 

source = source.deindent() 

return source 

 

def _saferepr(self, obj): 

return saferepr(obj) 

 

def repr_args(self, entry): 

if self.funcargs: 

args = [] 

for argname, argvalue in entry.frame.getargs(var=True): 

args.append((argname, self._saferepr(argvalue))) 

return ReprFuncArgs(args) 

 

def get_source(self, source, line_index=-1, excinfo=None, short=False): 

""" return formatted and marked up source lines. """ 

import _pytest._code 

 

lines = [] 

if source is None or line_index >= len(source.lines): 

source = _pytest._code.Source("???") 

line_index = 0 

if line_index < 0: 

line_index += len(source) 

space_prefix = " " 

if short: 

lines.append(space_prefix + source.lines[line_index].strip()) 

else: 

for line in source.lines[:line_index]: 

lines.append(space_prefix + line) 

lines.append(self.flow_marker + " " + source.lines[line_index]) 

for line in source.lines[line_index + 1 :]: 

lines.append(space_prefix + line) 

if excinfo is not None: 

indent = 4 if short else self._getindent(source) 

lines.extend(self.get_exconly(excinfo, indent=indent, markall=True)) 

return lines 

 

def get_exconly(self, excinfo, indent=4, markall=False): 

lines = [] 

indent = " " * indent 

# get the real exception information out 

exlines = excinfo.exconly(tryshort=True).split("\n") 

failindent = self.fail_marker + indent[1:] 

for line in exlines: 

lines.append(failindent + line) 

if not markall: 

failindent = indent 

return lines 

 

def repr_locals(self, locals): 

if self.showlocals: 

lines = [] 

keys = [loc for loc in locals if loc[0] != "@"] 

keys.sort() 

for name in keys: 

value = locals[name] 

if name == "__builtins__": 

lines.append("__builtins__ = <builtins>") 

else: 

# This formatting could all be handled by the 

# _repr() function, which is only reprlib.Repr in 

# disguise, so is very configurable. 

if self.truncate_locals: 

str_repr = self._saferepr(value) 

else: 

str_repr = pprint.pformat(value) 

# if len(str_repr) < 70 or not isinstance(value, 

# (list, tuple, dict)): 

lines.append("%-10s = %s" % (name, str_repr)) 

# else: 

# self._line("%-10s =\\" % (name,)) 

# # XXX 

# pprint.pprint(value, stream=self.excinfowriter) 

return ReprLocals(lines) 

 

def repr_traceback_entry(self, entry, excinfo=None): 

import _pytest._code 

 

source = self._getentrysource(entry) 

if source is None: 

source = _pytest._code.Source("???") 

line_index = 0 

else: 

# entry.getfirstlinesource() can be -1, should be 0 on jython 

line_index = entry.lineno - max(entry.getfirstlinesource(), 0) 

 

lines = [] 

style = entry._repr_style 

if style is None: 

style = self.style 

if style in ("short", "long"): 

short = style == "short" 

reprargs = self.repr_args(entry) if not short else None 

s = self.get_source(source, line_index, excinfo, short=short) 

lines.extend(s) 

if short: 

message = "in %s" % (entry.name) 

else: 

message = excinfo and excinfo.typename or "" 

path = self._makepath(entry.path) 

filelocrepr = ReprFileLocation(path, entry.lineno + 1, message) 

localsrepr = None 

if not short: 

localsrepr = self.repr_locals(entry.locals) 

return ReprEntry(lines, reprargs, localsrepr, filelocrepr, style) 

if excinfo: 

lines.extend(self.get_exconly(excinfo, indent=4)) 

return ReprEntry(lines, None, None, None, style) 

 

def _makepath(self, path): 

if not self.abspath: 

try: 

np = py.path.local().bestrelpath(path) 

except OSError: 

return path 

if len(np) < len(str(path)): 

path = np 

return path 

 

def repr_traceback(self, excinfo): 

traceback = excinfo.traceback 

if self.tbfilter: 

traceback = traceback.filter() 

 

if is_recursion_error(excinfo): 

traceback, extraline = self._truncate_recursive_traceback(traceback) 

else: 

extraline = None 

 

last = traceback[-1] 

entries = [] 

for index, entry in enumerate(traceback): 

einfo = (last == entry) and excinfo or None 

reprentry = self.repr_traceback_entry(entry, einfo) 

entries.append(reprentry) 

return ReprTraceback(entries, extraline, style=self.style) 

 

def _truncate_recursive_traceback(self, traceback): 

""" 

Truncate the given recursive traceback trying to find the starting point 

of the recursion. 

 

The detection is done by going through each traceback entry and finding the 

point in which the locals of the frame are equal to the locals of a previous frame (see ``recursionindex()``. 

 

Handle the situation where the recursion process might raise an exception (for example 

comparing numpy arrays using equality raises a TypeError), in which case we do our best to 

warn the user of the error and show a limited traceback. 

""" 

try: 

recursionindex = traceback.recursionindex() 

except Exception as e: 

max_frames = 10 

extraline = ( 

"!!! Recursion error detected, but an error occurred locating the origin of recursion.\n" 

" The following exception happened when comparing locals in the stack frame:\n" 

" {exc_type}: {exc_msg}\n" 

" Displaying first and last {max_frames} stack frames out of {total}." 

).format( 

exc_type=type(e).__name__, 

exc_msg=safe_str(e), 

max_frames=max_frames, 

total=len(traceback), 

) 

traceback = traceback[:max_frames] + traceback[-max_frames:] 

else: 

if recursionindex is not None: 

extraline = "!!! Recursion detected (same locals & position)" 

traceback = traceback[: recursionindex + 1] 

else: 

extraline = None 

 

return traceback, extraline 

 

def repr_excinfo(self, excinfo): 

if _PY2: 

reprtraceback = self.repr_traceback(excinfo) 

reprcrash = excinfo._getreprcrash() 

 

return ReprExceptionInfo(reprtraceback, reprcrash) 

else: 

repr_chain = [] 

e = excinfo.value 

descr = None 

seen = set() 

while e is not None and id(e) not in seen: 

seen.add(id(e)) 

if excinfo: 

reprtraceback = self.repr_traceback(excinfo) 

reprcrash = excinfo._getreprcrash() 

else: 

# fallback to native repr if the exception doesn't have a traceback: 

# ExceptionInfo objects require a full traceback to work 

reprtraceback = ReprTracebackNative( 

traceback.format_exception(type(e), e, None) 

) 

reprcrash = None 

 

repr_chain += [(reprtraceback, reprcrash, descr)] 

if e.__cause__ is not None and self.chain: 

e = e.__cause__ 

excinfo = ( 

ExceptionInfo((type(e), e, e.__traceback__)) 

if e.__traceback__ 

else None 

) 

descr = "The above exception was the direct cause of the following exception:" 

elif ( 

e.__context__ is not None 

and not e.__suppress_context__ 

and self.chain 

): 

e = e.__context__ 

excinfo = ( 

ExceptionInfo((type(e), e, e.__traceback__)) 

if e.__traceback__ 

else None 

) 

descr = "During handling of the above exception, another exception occurred:" 

else: 

e = None 

repr_chain.reverse() 

return ExceptionChainRepr(repr_chain) 

 

 

class TerminalRepr(object): 

def __str__(self): 

s = self.__unicode__() 

if _PY2: 

s = s.encode("utf-8") 

return s 

 

def __unicode__(self): 

# FYI this is called from pytest-xdist's serialization of exception 

# information. 

io = py.io.TextIO() 

tw = py.io.TerminalWriter(file=io) 

self.toterminal(tw) 

return io.getvalue().strip() 

 

def __repr__(self): 

return "<%s instance at %0x>" % (self.__class__, id(self)) 

 

 

class ExceptionRepr(TerminalRepr): 

def __init__(self): 

self.sections = [] 

 

def addsection(self, name, content, sep="-"): 

self.sections.append((name, content, sep)) 

 

def toterminal(self, tw): 

for name, content, sep in self.sections: 

tw.sep(sep, name) 

tw.line(content) 

 

 

class ExceptionChainRepr(ExceptionRepr): 

def __init__(self, chain): 

super(ExceptionChainRepr, self).__init__() 

self.chain = chain 

# reprcrash and reprtraceback of the outermost (the newest) exception 

# in the chain 

self.reprtraceback = chain[-1][0] 

self.reprcrash = chain[-1][1] 

 

def toterminal(self, tw): 

for element in self.chain: 

element[0].toterminal(tw) 

if element[2] is not None: 

tw.line("") 

tw.line(element[2], yellow=True) 

super(ExceptionChainRepr, self).toterminal(tw) 

 

 

class ReprExceptionInfo(ExceptionRepr): 

def __init__(self, reprtraceback, reprcrash): 

super(ReprExceptionInfo, self).__init__() 

self.reprtraceback = reprtraceback 

self.reprcrash = reprcrash 

 

def toterminal(self, tw): 

self.reprtraceback.toterminal(tw) 

super(ReprExceptionInfo, self).toterminal(tw) 

 

 

class ReprTraceback(TerminalRepr): 

entrysep = "_ " 

 

def __init__(self, reprentries, extraline, style): 

self.reprentries = reprentries 

self.extraline = extraline 

self.style = style 

 

def toterminal(self, tw): 

# the entries might have different styles 

for i, entry in enumerate(self.reprentries): 

if entry.style == "long": 

tw.line("") 

entry.toterminal(tw) 

if i < len(self.reprentries) - 1: 

next_entry = self.reprentries[i + 1] 

if ( 

entry.style == "long" 

or entry.style == "short" 

and next_entry.style == "long" 

): 

tw.sep(self.entrysep) 

 

if self.extraline: 

tw.line(self.extraline) 

 

 

class ReprTracebackNative(ReprTraceback): 

def __init__(self, tblines): 

self.style = "native" 

self.reprentries = [ReprEntryNative(tblines)] 

self.extraline = None 

 

 

class ReprEntryNative(TerminalRepr): 

style = "native" 

 

def __init__(self, tblines): 

self.lines = tblines 

 

def toterminal(self, tw): 

tw.write("".join(self.lines)) 

 

 

class ReprEntry(TerminalRepr): 

def __init__(self, lines, reprfuncargs, reprlocals, filelocrepr, style): 

self.lines = lines 

self.reprfuncargs = reprfuncargs 

self.reprlocals = reprlocals 

self.reprfileloc = filelocrepr 

self.style = style 

 

def toterminal(self, tw): 

if self.style == "short": 

self.reprfileloc.toterminal(tw) 

for line in self.lines: 

red = line.startswith("E ") 

tw.line(line, bold=True, red=red) 

# tw.line("") 

return 

if self.reprfuncargs: 

self.reprfuncargs.toterminal(tw) 

for line in self.lines: 

red = line.startswith("E ") 

tw.line(line, bold=True, red=red) 

if self.reprlocals: 

tw.line("") 

self.reprlocals.toterminal(tw) 

if self.reprfileloc: 

if self.lines: 

tw.line("") 

self.reprfileloc.toterminal(tw) 

 

def __str__(self): 

return "%s\n%s\n%s" % ("\n".join(self.lines), self.reprlocals, self.reprfileloc) 

 

 

class ReprFileLocation(TerminalRepr): 

def __init__(self, path, lineno, message): 

self.path = str(path) 

self.lineno = lineno 

self.message = message 

 

def toterminal(self, tw): 

# filename and lineno output for each entry, 

# using an output format that most editors unterstand 

msg = self.message 

i = msg.find("\n") 

if i != -1: 

msg = msg[:i] 

tw.write(self.path, bold=True, red=True) 

tw.line(":%s: %s" % (self.lineno, msg)) 

 

 

class ReprLocals(TerminalRepr): 

def __init__(self, lines): 

self.lines = lines 

 

def toterminal(self, tw): 

for line in self.lines: 

tw.line(line) 

 

 

class ReprFuncArgs(TerminalRepr): 

def __init__(self, args): 

self.args = args 

 

def toterminal(self, tw): 

if self.args: 

linesofar = "" 

for name, value in self.args: 

ns = "%s = %s" % (safe_str(name), safe_str(value)) 

if len(ns) + len(linesofar) + 2 > tw.fullwidth: 

if linesofar: 

tw.line(linesofar) 

linesofar = ns 

else: 

if linesofar: 

linesofar += ", " + ns 

else: 

linesofar = ns 

if linesofar: 

tw.line(linesofar) 

tw.line("") 

 

 

def getrawcode(obj, trycall=True): 

""" return code object for given function. """ 

try: 

return obj.__code__ 

except AttributeError: 

obj = getattr(obj, "im_func", obj) 

obj = getattr(obj, "func_code", obj) 

obj = getattr(obj, "f_code", obj) 

obj = getattr(obj, "__code__", obj) 

if trycall and not hasattr(obj, "co_firstlineno"): 

if hasattr(obj, "__call__") and not inspect.isclass(obj): 

x = getrawcode(obj.__call__, trycall=False) 

if hasattr(x, "co_firstlineno"): 

return x 

return obj 

 

 

if PY35: # RecursionError introduced in 3.5 

 

def is_recursion_error(excinfo): 

return excinfo.errisinstance(RecursionError) # noqa 

 

 

else: 

 

def is_recursion_error(excinfo): 

if not excinfo.errisinstance(RuntimeError): 

return False 

try: 

return "maximum recursion depth exceeded" in str(excinfo.value) 

except UnicodeError: 

return False 

 

 

# relative paths that we use to filter traceback entries from appearing to the user; 

# see filter_traceback 

# note: if we need to add more paths than what we have now we should probably use a list 

# for better maintenance 

 

_PLUGGY_DIR = py.path.local(pluggy.__file__.rstrip("oc")) 

# pluggy is either a package or a single module depending on the version 

if _PLUGGY_DIR.basename == "__init__.py": 

_PLUGGY_DIR = _PLUGGY_DIR.dirpath() 

_PYTEST_DIR = py.path.local(_pytest.__file__).dirpath() 

_PY_DIR = py.path.local(py.__file__).dirpath() 

 

 

def filter_traceback(entry): 

"""Return True if a TracebackEntry instance should be removed from tracebacks: 

* dynamically generated code (no code to show up for it); 

* internal traceback from pytest or its internal libraries, py and pluggy. 

""" 

# entry.path might sometimes return a str object when the entry 

# points to dynamically generated code 

# see https://bitbucket.org/pytest-dev/py/issues/71 

raw_filename = entry.frame.code.raw.co_filename 

is_generated = "<" in raw_filename and ">" in raw_filename 

if is_generated: 

return False 

# entry.path might point to a non-existing file, in which case it will 

# also return a str object. see #1133 

p = py.path.local(entry.path) 

return ( 

not p.relto(_PLUGGY_DIR) and not p.relto(_PYTEST_DIR) and not p.relto(_PY_DIR) 

)