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

from __future__ import generators 

 

from bisect import bisect_right 

import sys 

import inspect, tokenize 

import py 

from types import ModuleType 

cpy_compile = compile 

 

try: 

    import _ast 

    from _ast import PyCF_ONLY_AST as _AST_FLAG 

except ImportError: 

    _AST_FLAG = 0 

    _ast = None 

 

 

class Source(object): 

    """ a immutable object holding a source code fragment, 

        possibly deindenting it. 

    """ 

    _compilecounter = 0 

    def __init__(self, *parts, **kwargs): 

        self.lines = lines = [] 

        de = kwargs.get('deindent', True) 

        rstrip = kwargs.get('rstrip', True) 

28        for part in parts: 

            if not part: 

                partlines = [] 

            if isinstance(part, Source): 

                partlines = part.lines 

            elif isinstance(part, (tuple, list)): 

                partlines = [x.rstrip("\n") for x in part] 

            elif isinstance(part, py.builtin._basestring): 

                partlines = part.split('\n') 

                if rstrip: 

                    while partlines: 

                        if partlines[-1].strip(): 

                            break 

                        partlines.pop() 

            else: 

                partlines = getsource(part, deindent=de).lines 

            if de: 

                partlines = deindent(partlines) 

            lines.extend(partlines) 

 

    def __eq__(self, other): 

        try: 

            return self.lines == other.lines 

        except AttributeError: 

            if isinstance(other, str): 

                return str(self) == other 

            return False 

 

    def __getitem__(self, key): 

        if isinstance(key, int): 

            return self.lines[key] 

        else: 

            if key.step not in (None, 1): 

                raise IndexError("cannot slice a Source with a step") 

            return self.__getslice__(key.start, key.stop) 

 

    def __len__(self): 

        return len(self.lines) 

 

    def __getslice__(self, start, end): 

        newsource = Source() 

        newsource.lines = self.lines[start:end] 

        return newsource 

 

    def strip(self): 

        """ return new source object with trailing 

            and leading blank lines removed. 

        """ 

        start, end = 0, len(self) 

        while start < end and not self.lines[start].strip(): 

            start += 1 

        while end > start and not self.lines[end-1].strip(): 

            end -= 1 

        source = Source() 

        source.lines[:] = self.lines[start:end] 

        return source 

 

    def putaround(self, before='', after='', indent=' ' * 4): 

        """ return a copy of the source object with 

            'before' and 'after' wrapped around it. 

        """ 

        before = Source(before) 

        after = Source(after) 

        newsource = Source() 

        lines = [ (indent + line) for line in self.lines] 

        newsource.lines = before.lines + lines +  after.lines 

        return newsource 

 

    def indent(self, indent=' ' * 4): 

        """ return a copy of the source object with 

            all lines indented by the given indent-string. 

        """ 

        newsource = Source() 

        newsource.lines = [(indent+line) for line in self.lines] 

        return newsource 

 

    def getstatement(self, lineno, assertion=False): 

        """ return Source statement which contains the 

            given linenumber (counted from 0). 

        """ 

        start, end = self.getstatementrange(lineno, assertion) 

        return self[start:end] 

 

    def getstatementrange(self, lineno, assertion=False): 

        """ return (start, end) tuple which spans the minimal 

            statement region which containing the given lineno. 

        """ 

115        if not (0 <= lineno < len(self)): 

            raise IndexError("lineno out of range") 

        ast, start, end = getstatementrange_ast(lineno, self) 

        return start, end 

 

    def deindent(self, offset=None): 

        """ return a new source object deindented by offset. 

            If offset is None then guess an indentation offset from 

            the first non-blank line.  Subsequent lines which have a 

            lower indentation offset will be copied verbatim as 

            they are assumed to be part of multilines. 

        """ 

        # XXX maybe use the tokenizer to properly handle multiline 

        #     strings etc.pp? 

        newsource = Source() 

        newsource.lines[:] = deindent(self.lines, offset) 

        return newsource 

 

    def isparseable(self, deindent=True): 

        """ return True if source is parseable, heuristically 

            deindenting it by default. 

        """ 

        try: 

            import parser 

        except ImportError: 

            syntax_checker = lambda x: compile(x, 'asd', 'exec') 

        else: 

            syntax_checker = parser.suite 

 

        if deindent: 

            source = str(self.deindent()) 

        else: 

            source = str(self) 

        try: 

            #compile(source+'\n', "x", "exec") 

            syntax_checker(source+'\n') 

        except KeyboardInterrupt: 

            raise 

        except Exception: 

            return False 

        else: 

            return True 

 

    def __str__(self): 

        return "\n".join(self.lines) 

 

    def compile(self, filename=None, mode='exec', 

                flag=generators.compiler_flag, 

                dont_inherit=0, _genframe=None): 

        """ return compiled code object. if filename is None 

            invent an artificial filename which displays 

            the source/line position of the caller frame. 

        """ 

        if not filename or py.path.local(filename).check(file=0): 

            if _genframe is None: 

                _genframe = sys._getframe(1) # the caller 

            fn,lineno = _genframe.f_code.co_filename, _genframe.f_lineno 

            base = "<%d-codegen " % self._compilecounter 

            self.__class__._compilecounter += 1 

            if not filename: 

                filename = base + '%s:%d>' % (fn, lineno) 

            else: 

                filename = base + '%r %s:%d>' % (filename, fn, lineno) 

        source = "\n".join(self.lines) + '\n' 

        try: 

            co = cpy_compile(source, filename, mode, flag) 

        except SyntaxError: 

            ex = sys.exc_info()[1] 

            # re-represent syntax errors from parsing python strings 

            msglines = self.lines[:ex.lineno] 

            if ex.offset: 

                msglines.append(" "*ex.offset + '^') 

            msglines.append("(code was compiled probably from here: %s)" % filename) 

            newex = SyntaxError('\n'.join(msglines)) 

            newex.offset = ex.offset 

            newex.lineno = ex.lineno 

            newex.text = ex.text 

            raise newex 

        else: 

            if flag & _AST_FLAG: 

                return co 

            lines = [(x + "\n") for x in self.lines] 

            if sys.version_info[0] >= 3: 

                # XXX py3's inspect.getsourcefile() checks for a module 

                # and a pep302 __loader__ ... we don't have a module 

                # at code compile-time so we need to fake it here 

                m = ModuleType("_pycodecompile_pseudo_module") 

                py.std.inspect.modulesbyfile[filename] = None 

                py.std.sys.modules[None] = m 

                m.__loader__ = 1 

            py.std.linecache.cache[filename] = (1, None, lines, filename) 

            return co 

 

# 

# public API shortcut functions 

# 

 

def compile_(source, filename=None, mode='exec', flags= 

            generators.compiler_flag, dont_inherit=0): 

    """ compile the given source to a raw code object, 

        and maintain an internal cache which allows later 

        retrieval of the source code for the code object 

        and any recursively created code objects. 

    """ 

    if _ast is not None and isinstance(source, _ast.AST): 

        # XXX should Source support having AST? 

        return cpy_compile(source, filename, mode, flags, dont_inherit) 

    _genframe = sys._getframe(1) # the caller 

    s = Source(source) 

    co = s.compile(filename, mode, flags, _genframe=_genframe) 

    return co 

 

 

def getfslineno(obj): 

    """ Return source location (path, lineno) for the given object. 

    If the source cannot be determined return ("", -1) 

    """ 

    import _pytest._code 

    try: 

        code = _pytest._code.Code(obj) 

    except TypeError: 

        try: 

            fn = (py.std.inspect.getsourcefile(obj) or 

                  py.std.inspect.getfile(obj)) 

        except TypeError: 

            return "", -1 

 

        fspath = fn and py.path.local(fn) or None 

        lineno = -1 

251        if fspath: 

            try: 

                _, lineno = findsource(obj) 

            except IOError: 

                pass 

    else: 

        fspath = code.path 

        lineno = code.firstlineno 

    assert isinstance(lineno, int) 

    return fspath, lineno 

 

# 

# helper functions 

# 

 

def findsource(obj): 

    try: 

        sourcelines, lineno = py.std.inspect.findsource(obj) 

    except py.builtin._sysex: 

        raise 

    except: 

        return None, -1 

    source = Source() 

    source.lines = [line.rstrip() for line in sourcelines] 

    return source, lineno 

 

def getsource(obj, **kwargs): 

    import _pytest._code 

    obj = _pytest._code.getrawcode(obj) 

    try: 

        strsrc = inspect.getsource(obj) 

    except IndentationError: 

        strsrc = "\"Buggy python version consider upgrading, cannot get source\"" 

    assert isinstance(strsrc, str) 

    return Source(strsrc, **kwargs) 

 

def deindent(lines, offset=None): 

289    if offset is None: 

288        for line in lines: 

            line = line.expandtabs() 

            s = line.lstrip() 

281            if s: 

                offset = len(line)-len(s) 

                break 

        else: 

            offset = 0 

290    if offset == 0: 

        return list(lines) 

    newlines = [] 

    def readline_generator(lines): 

        for line in lines: 

            yield line + '\n' 

        while True: 

            yield '' 

 

    it = readline_generator(lines) 

 

    try: 

317        for _, _, (sline, _), (eline, _), _ in tokenize.generate_tokens(lambda: next(it)): 

            if sline > len(lines): 

                break # End of input reached 

            if sline > len(newlines): 

                line = lines[sline - 1].expandtabs() 

308                if line.lstrip() and line[:offset].isspace(): 

                    line = line[offset:] # Deindent 

                newlines.append(line) 

 

313            for i in range(sline, eline): 

                # Don't deindent continuing lines of 

                # multiline tokens (i.e. multiline strings) 

                newlines.append(lines[i]) 

    except (IndentationError, tokenize.TokenError): 

        pass 

    # Add any lines we didn't see. E.g. if an exception was raised. 

    newlines.extend(lines[len(newlines):]) 

    return newlines 

 

 

def get_statement_startend2(lineno, node): 

    import ast 

    # flatten all statements and except handlers into one lineno-list 

    # AST's line numbers start indexing at 1 

    l = [] 

    for x in ast.walk(node): 

        if isinstance(x, _ast.stmt) or isinstance(x, _ast.ExceptHandler): 

            l.append(x.lineno - 1) 

            for name in "finalbody", "orelse": 

                val = getattr(x, name, None) 

                if val: 

                    # treat the finally/orelse part as its own statement 

                    l.append(val[0].lineno - 1 - 1) 

    l.sort() 

    insert_index = bisect_right(l, lineno) 

    start = l[insert_index - 1] 

338    if insert_index >= len(l): 

        end = None 

    else: 

        end = l[insert_index] 

    return start, end 

 

 

def getstatementrange_ast(lineno, source, assertion=False, astnode=None): 

354    if astnode is None: 

        content = str(source) 

348        if sys.version_info < (2,7): 

            content += "\n" 

        try: 

            astnode = compile(content, "source", "exec", 1024)  # 1024 for AST 

        except ValueError: 

            start, end = getstatementrange_old(lineno, source, assertion) 

            return None, start, end 

    start, end = get_statement_startend2(lineno, astnode) 

    # we need to correct the end: 

    # - ast-parsing strips comments 

    # - there might be empty lines 

    # - we might have lesser indented code blocks at the end 

360    if end is None: 

        end = len(source.lines) 

 

365    if end > start + 1: 

        # make sure we don't span differently indented code blocks 

        # by using the BlockFinder helper used which inspect.getsource() uses itself 

        block_finder = inspect.BlockFinder() 

        # if we start with an indented line, put blockfinder to "started" mode 

        block_finder.started = source.lines[start][0].isspace() 

        it = ((x + "\n") for x in source.lines[start:end]) 

        try: 

            for tok in tokenize.generate_tokens(lambda: next(it)): 

                block_finder.tokeneater(*tok) 

        except (inspect.EndOfBlock, IndentationError): 

            end = block_finder.last + start 

        except Exception: 

            pass 

 

    # the end might still point to a comment or empty line, correct it 

384    while end: 

        line = source.lines[end - 1].lstrip() 

381        if line.startswith("#") or not line: 

            end -= 1 

        else: 

            break 

    return astnode, start, end 

 

 

def getstatementrange_old(lineno, source, assertion=False): 

    """ return (start, end) tuple which spans the minimal 

        statement region which containing the given lineno. 

        raise an IndexError if no such statementrange can be found. 

    """ 

    # XXX this logic is only used on python2.4 and below 

    # 1. find the start of the statement 

    from codeop import compile_command 

    for start in range(lineno, -1, -1): 

        if assertion: 

            line = source.lines[start] 

            # the following lines are not fully tested, change with care 

            if 'super' in line and 'self' in line and '__init__' in line: 

                raise IndexError("likely a subclass") 

            if "assert" not in line and "raise" not in line: 

                continue 

        trylines = source.lines[start:lineno+1] 

        # quick hack to prepare parsing an indented line with 

        # compile_command() (which errors on "return" outside defs) 

        trylines.insert(0, 'def xxx():') 

        trysource = '\n '.join(trylines) 

        #              ^ space here 

        try: 

            compile_command(trysource) 

        except (SyntaxError, OverflowError, ValueError): 

            continue 

 

        # 2. find the end of the statement 

        for end in range(lineno+1, len(source)+1): 

            trysource = source[start:end] 

            if trysource.isparseable(): 

                return start, end 

    raise SyntaxError("no valid source range around line %d " % (lineno,))