• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

pyta-uoft / pyta / 15244663429

26 May 2025 02:09AM UTC coverage: 93.516% (+0.07%) from 93.449%
15244663429

Pull #1178

github

web-flow
Merge 125866bf1 into fc1c64f4d
Pull Request #1178: Refactor render pep8 errors mapping

10 of 11 new or added lines in 1 file covered. (90.91%)

1 existing line in 1 file now uncovered.

3404 of 3640 relevant lines covered (93.52%)

17.7 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

86.02
/python_ta/reporters/node_printers.py
1
"""Specify how errors should be rendered."""
2

3
import re
20✔
4
from enum import Enum
20✔
5

6
from astroid import nodes
20✔
7

8
NEW_BLANK_LINE_MESSAGE = "# INSERT NEW BLANK LINE HERE"
20✔
9

10

11
def render_message(msg, node, source_lines):
20✔
12
    """Render a message based on type."""
13
    renderer = CUSTOM_MESSAGES.get(msg.symbol, render_generic)
20✔
14
    yield from renderer(msg, node, source_lines)
20✔
15

16

17
def render_generic(msg, node=None, source_lines=None):
20✔
18
    """Default rendering for a message."""
19
    if node is not None:
20✔
20
        start_line, start_col = node.fromlineno, node.col_offset
20✔
21

22
        if isinstance(node, (nodes.FunctionDef, nodes.ClassDef)):
20✔
23
            end_line, end_col = start_line, None
20✔
24
        else:
25
            end_line, end_col = node.end_lineno, node.end_col_offset
20✔
26

27
        # Display up to 2 lines before node for context:
28
        yield from render_context(start_line - 2, start_line, source_lines)
20✔
29

30
        if start_line == end_line:
20✔
31
            yield (
20✔
32
                start_line,
33
                slice(start_col, end_col),
34
                LineType.ERROR,
35
                source_lines[start_line - 1],
36
            )
37
        else:
38
            yield (start_line, slice(start_col, None), LineType.ERROR, source_lines[start_line - 1])
20✔
39
            yield from (
20✔
40
                (line, slice(None, None), LineType.ERROR, source_lines[line - 1])
41
                for line in range(start_line + 1, end_line)
42
            )
43
            yield (end_line, slice(None, end_col), LineType.ERROR, source_lines[end_line - 1])
20✔
44

45
        # Display up to 2 lines after node for context:
46
        yield from render_context(end_line + 1, end_line + 3, source_lines)
20✔
47

48
    else:
49
        line = msg.line
20✔
50
        yield from render_context(line - 2, line, source_lines)
20✔
51
        yield (line, slice(None, None), LineType.ERROR, source_lines[line - 1])
20✔
52
        yield from render_context(line + 1, line + 3, source_lines)
20✔
53

54

55
def render_missing_docstring(_msg, node, source_lines=None):
20✔
56
    """Render a missing docstring message."""
57
    if isinstance(node, nodes.Module):
20✔
58
        yield (None, slice(None, None), LineType.DOCSTRING, '"""YOUR DOCSTRING HERE"""')
20✔
59
        yield from render_context(1, 3, source_lines)
20✔
60
    elif isinstance(node, nodes.ClassDef) or isinstance(node, nodes.FunctionDef):
20✔
61
        start = node.fromlineno
20✔
62
        end = node.body[0].fromlineno
20✔
63
        yield from render_context(start, end, source_lines)
20✔
64
        # Calculate indentation
65
        body = source_lines[end - 1]
20✔
66
        indentation = len(body) - len(body.lstrip())
20✔
67
        yield (
20✔
68
            None,
69
            slice(None, None),
70
            LineType.DOCSTRING,
71
            body[:indentation] + '"""YOUR DOCSTRING HERE"""',
72
        )
73
        yield from render_context(end, end + 2, source_lines)
20✔
74

75

76
def render_trailing_newlines(msg, _node, source_lines=None):
20✔
77
    """Render a trailing newlines message."""
78
    start_line = msg.line - 1
20✔
79
    yield from render_context(start_line - 2, start_line, source_lines)
20✔
80
    yield from (
20✔
81
        (line, slice(None, None), LineType.OTHER, source_lines[line - 1])
82
        for line in range(start_line, len(source_lines) + 1)
83
    )
84

85

86
def render_trailing_whitespace(msg, _node, source_lines=None):
20✔
87
    """Render a trailing whitespace message."""
88
    line = msg.line
20✔
89
    start_index, end_index = len(source_lines[line - 1].rstrip()), len(source_lines[line - 1])
20✔
90
    yield from render_context(line - 1, line, source_lines)
20✔
91
    yield (line, slice(start_index, end_index), LineType.ERROR, source_lines[line - 1])
20✔
92
    yield from render_context(line + 1, line + 2, source_lines)
20✔
93

94

95
def render_context(start, stop, source_lines):
20✔
96
    """Helper for rendering context lines."""
97
    start, stop = max(start, 1), min(stop, len(source_lines))
20✔
98
    yield from (
20✔
99
        (line, slice(None, None), LineType.CONTEXT, source_lines[line - 1])
100
        for line in range(start, stop)
101
    )
102

103

104
def render_missing_return_type(_msg, node, source_lines=None):
20✔
105
    """Render a type annotation return message."""
106
    start_line, start_col = node.fromlineno, node.parent.col_offset
20✔
107
    end_line, end_col = node.end_lineno, node.end_col_offset
20✔
108

109
    # Display up to 2 lines before node for context:
110
    yield from render_context(start_line - 2, start_line, source_lines)
20✔
111
    yield from (
20✔
112
        (line, slice(None, end_col + 1), LineType.ERROR, source_lines[line - 1])
113
        for line in range(start_line, end_line + 1)
114
    )
115
    # Display up to 2 lines after node for context:
116
    yield from render_context(end_line + 1, end_line + 3, source_lines)
20✔
117

118

119
def render_too_many_arguments(msg, node, source_lines=None):
20✔
120
    """Render a too many arguments message."""
121
    # node is a FunctionDef node so replace it with its Arguments child
122
    yield from render_generic(msg, node.args, source_lines)
20✔
123

124

125
def render_missing_space_in_doctest(msg, _node, source_lines=None):
20✔
126
    """Render a missing space in doctest message"""
127
    line = msg.line
20✔
128

129
    # Display 2 lines before and after the erroneous line
130
    yield from render_context(line - 2, line, source_lines)
20✔
131
    yield (line, slice(None, None), LineType.ERROR, source_lines[line - 1])
20✔
132
    yield from render_context(line + 1, line + 3, source_lines)
20✔
133

134

135
def render_pep8_errors(msg, _node, source_lines=None):
20✔
136
    """Render a PEP8 error message."""
137
    # Extract the error text from msg (called in tests as msg.message and msg.msg)
138
    raw_msg = getattr(msg, "msg", None) or getattr(msg, "message", None)
20✔
139

140
    # If the error text is not present, yeild from
141
    if not raw_msg:
20✔
UNCOV
142
        yield from render_generic(msg, _node, source_lines)
×
NEW
143
        return
×
144

145
    # Search for the first appearance of the error code
146
    matched_error = re.search(r"(E\d{3})", raw_msg)
20✔
147
    if matched_error:
20✔
148
        error_code = matched_error.group(1)
20✔
149
        # Render the appropriate Error using the RENDERERS dict
150
        if error_code in RENDERERS:
20✔
151
            yield from RENDERERS[error_code](msg, _node, source_lines)
20✔
152
            return
20✔
153

154
    # If none of the error codes were present, render a generic message
155
    yield from render_generic(msg, _node, source_lines)
20✔
156

157

158
def render_blank_line(line):
20✔
159
    """Render a blank line for a PEP8 error message."""
160
    yield (line + 1, slice(None, None), LineType.ERROR, " " * 28)
20✔
161

162

163
def render_pep8_errors_e101_and_e123(msg, _node, source_lines=None):
20✔
164
    """Render a PEP8 indentation contains mixed spaces and tabs message
165
    AND a PEP8 closing bracket does not match indentation of opening bracket's line message."""
166
    line = msg.line
20✔
167
    curr_idx = len(source_lines[line - 1]) - len(source_lines[line - 1].lstrip())
20✔
168
    yield from render_context(line - 2, line, source_lines)
20✔
169
    yield (line, slice(0, curr_idx), LineType.ERROR, source_lines[line - 1])
20✔
170
    yield from render_context(line + 1, line + 3, source_lines)
20✔
171

172

173
def render_pep8_errors_e115(msg, _node, source_lines=None):
20✔
174
    """Render a PEP8 expected an indented block (comment) message."""
175
    line = msg.line
20✔
176

177
    yield from render_context(line - 2, line, source_lines)
20✔
178
    yield (
20✔
179
        line,
180
        slice(0, len(source_lines[line - 1])),
181
        LineType.ERROR,
182
        source_lines[line - 1] + "  # INDENT THIS LINE",
183
    )
184
    yield from render_context(line + 1, line + 3, source_lines)
20✔
185

186

187
def render_pep8_errors_e116(msg, _node, source_lines=None):
20✔
188
    """Render a PEP8 unexpected indentation (comment) message"""
189
    line = msg.line
20✔
190
    curr_idx = len(source_lines[line - 1]) - len(source_lines[line - 1].lstrip())
20✔
191
    yield from render_context(line - 2, line, source_lines)
20✔
192
    yield (
20✔
193
        line,
194
        slice(0, curr_idx),
195
        LineType.ERROR,
196
        source_lines[line - 1],
197
    )
198
    yield from render_context(line + 1, line + 3, source_lines)
20✔
199

200

201
def render_pep8_errors_e122_and_e127_and_e131(msg, _node, source_lines=None):
20✔
202
    """
203
    Render a PEP8 continuation line missing indentation or outdented message, a line over-indented for visual indent
204
    message, and a continuation line unaligned for hanging indent message.
205
    """
206
    line = msg.line
20✔
207
    curr_line_start_index = len(source_lines[line - 1]) - len(source_lines[line - 1].lstrip())
20✔
208
    end_index = curr_line_start_index if curr_line_start_index > 0 else len(source_lines[line - 1])
20✔
209
    yield from render_context(line - 2, line, source_lines)
20✔
210
    yield (
20✔
211
        line,
212
        slice(0, end_index),
213
        LineType.ERROR,
214
        source_lines[line - 1],
215
    )
216
    yield from render_context(line + 1, line + 3, source_lines)
20✔
217

218

219
def render_pep8_errors_e124(msg, _node, source_lines=None):
20✔
220
    """Render a PEP8 closing bracket does not match visual indentation message."""
221
    line = msg.line
×
222
    res = re.search(r"column (\d+)", msg.msg)
×
223
    col = int(res.group().split()[-1])
×
224
    yield from render_context(line - 2, line, source_lines)
×
225
    yield (line, slice(col, col + 1), LineType.ERROR, source_lines[line - 1])
×
226
    yield from render_context(line + 1, line + 3, source_lines)
×
227

228

229
def render_pep8_errors_e125_and_e129(msg, _node, source_lines=None):
20✔
230
    """Render a PEP8 continuation line with same indent as next logical line message
231
    AND a PEP8 visually indented line with same indent as next logical line messsage"""
232
    line = msg.line
20✔
233
    curr_idx = len(source_lines[line - 1]) - len(source_lines[line - 1].lstrip())
20✔
234

235
    yield from render_context(line - 2, line, source_lines)
20✔
236
    yield (
20✔
237
        line,
238
        slice(curr_idx, len(source_lines[line - 1])),
239
        LineType.ERROR,
240
        source_lines[line - 1] + " " * 2 + "# INDENT THIS LINE",
241
    )
242
    yield from render_context(line + 1, line + 3, source_lines)
20✔
243

244

245
def render_pep8_errors_e128(msg, _node, source_lines):
20✔
246
    """Render a PEP8 continuation line under-indented for visual indent message."""
247
    line = msg.line
×
248
    res = re.search(r"column (\d+)", msg.msg)
×
249
    col = int(res.group().split()[-1])
×
250

251
    yield from render_context(line - 2, line, source_lines)
×
252
    yield (line, slice(0, col if col != 0 else None), LineType.ERROR, source_lines[line - 1])
×
253
    yield from render_context(line + 1, line + 3, source_lines)
×
254

255

256
def render_pep8_errors_e201_e202_e203_e211(msg, _node, source_lines=None):
20✔
257
    """Render a PEP8 whitespace after '(' message,
258
    a PEP8 whitespace before ')' message,
259
    a PEP8 whitespace before ‘,’, ‘;’, or ‘:’ message,
260
    AND a PEP8 whitespace before '(' message.."""
261
    line = msg.line
20✔
262
    res = re.search(r"column (\d+)", msg.msg)
20✔
263
    col = int(res.group().split()[-1])
20✔
264
    curr_idx = col + len(source_lines[line - 1][col:]) - len(source_lines[line - 1][col:].lstrip())
20✔
265

266
    yield from render_context(line - 2, line, source_lines)
20✔
267
    yield (line, slice(col, curr_idx), LineType.ERROR, source_lines[line - 1])
20✔
268
    yield from render_context(line + 1, line + 3, source_lines)
20✔
269

270

271
def render_pep8_errors_e221(msg, _node, source_lines=None):
20✔
272
    """Render a PEP8 multiple spaces before operator message."""
273
    line = msg.line
×
274
    res = re.search(r"column (\d+)", msg.msg)
×
275
    col = int(res.group().split()[-1])
×
276
    curr_idx = col + len(source_lines[line - 1][col:]) - len(source_lines[line - 1][col:].lstrip())
×
277

278
    yield from render_context(line - 2, line, source_lines)
×
279
    yield (line, slice(col, curr_idx), LineType.ERROR, source_lines[line - 1])
×
280
    yield from render_context(line + 1, line + 3, source_lines)
×
281

282

283
def render_pep8_errors_e222(msg, _node, source_lines=None):
20✔
284
    """Render a PEP8 multiple spaces after operator message"""
285
    line = msg.line
20✔
286
    res = re.search(r"column (\d+)", msg.msg)
20✔
287
    col = int(res.group().split()[-1])
20✔
288

289
    curr_idx = col + len(source_lines[line - 1][col:]) - len(source_lines[line - 1][col:].lstrip())
20✔
290
    yield from render_context(line - 2, line, source_lines)
20✔
291
    yield (line, slice(col, curr_idx), LineType.ERROR, source_lines[line - 1])
20✔
292
    yield from render_context(line + 1, line + 3, source_lines)
20✔
293

294

295
def render_pep8_errors_e223(msg, _node, source_lines=None):
20✔
296
    """Render a PEP8 tab before operator message."""
297
    line = msg.line
20✔
298
    res = re.search(r"column (\d+)", msg.msg)
20✔
299
    col = int(res.group().split()[-1])
20✔
300
    curr_idx = (
20✔
301
        col + len(source_lines[line - 1][col:]) - len(source_lines[line - 1][col:].lstrip("\t"))
302
    )
303

304
    yield from render_context(line - 2, line, source_lines)
20✔
305
    yield (line, slice(col, curr_idx), LineType.ERROR, source_lines[line - 1])
20✔
306
    yield from render_context(line + 1, line + 3, source_lines)
20✔
307

308

309
def render_pep8_errors_e224_and_e273(msg, _node, source_lines):
20✔
310
    """Render a PEP8 tab after operator message and a PEP8 tab after keyword message."""
311
    line = msg.line
20✔
312
    res = re.search(r"column (\d+)", msg.msg)
20✔
313
    col = int(res.group().split()[-1])
20✔
314
    curr_idx = (
20✔
315
        col + len(source_lines[line - 1][col:]) - len(source_lines[line - 1][col:].lstrip("\t"))
316
    )
317

318
    yield from render_context(line - 2, line, source_lines)
20✔
319
    yield (line, slice(col, curr_idx), LineType.ERROR, source_lines[line - 1])
20✔
320
    yield from render_context(line + 1, line + 3, source_lines)
20✔
321

322

323
def render_pep8_errors_e226(msg, _node, source_lines):
20✔
324
    """Render a PEP8 missing whitespace around arithmetic operator message"""
325
    line = msg.line
20✔
326
    res = re.search(r"column (\d+)", msg.msg)
20✔
327
    col = int(res.group().split()[-1])
20✔
328
    end_idx = col + 1
20✔
329

330
    yield from render_context(line - 2, line, source_lines)
20✔
331
    yield (line, slice(col, end_idx), LineType.ERROR, source_lines[line - 1])
20✔
332
    yield from render_context(line + 1, line + 3, source_lines)
20✔
333

334

335
def render_pep8_errors_e227(msg, _node, source_lines=None):
20✔
336
    """Render a PEP8 missing whitespace around bitwise or shift operator message."""
337
    line = msg.line
20✔
338
    res = re.search(r"column (\d+)", msg.msg)
20✔
339
    col = int(res.group().split()[-1])
20✔
340
    # Check which operator to get the correct range of the line to highlight.
341
    # Default highlight is one character, but may be updated to two.
342
    # Note that only binary bitwise operators that are more than one character are included.
343
    operators = {">>", "<<"}
20✔
344
    end_idx = col + 1
20✔
345
    end_idx = end_idx + 1 if source_lines[line - 1][col : col + 2] in operators else end_idx
20✔
346

347
    yield from render_context(line - 2, line, source_lines)
20✔
348
    yield (line, slice(col, end_idx), LineType.ERROR, source_lines[line - 1])
20✔
349
    yield from render_context(line + 1, line + 3, source_lines)
20✔
350

351

352
def render_pep8_errors_e228(msg, _node, source_lines=None):
20✔
353
    """Render a PEP8 missing whitespace around modulo operator message."""
354
    line = msg.line
20✔
355
    res = re.search(r"column (\d+)", msg.msg)
20✔
356
    col = int(res.group().split()[-1])
20✔
357

358
    yield from render_context(line - 2, line, source_lines)
20✔
359
    yield (
20✔
360
        line,
361
        slice(col, col + 1),
362
        LineType.ERROR,
363
        source_lines[line - 1] + "  # INSERT A SPACE BEFORE AND AFTER THE % OPERATOR",
364
    )
365
    yield from render_context(line + 1, line + 3, source_lines)
20✔
366

367

368
def render_pep8_errors_e251(msg, _node, source_lines=None):
20✔
369
    """Render a PEP8 unexpected spaces around keyword / parameter equals message."""
370
    line = msg.line
×
371
    res = re.search(r"column (\d+)", msg.msg)
×
372
    col = int(res.group().split()[-1])
×
373
    equals_sign_idx = source_lines[line - 1][col:].find("=")
×
374
    code = source_lines[line - 1][col : col + equals_sign_idx if equals_sign_idx != -1 else None]
×
375
    end_idx = col + len(code) - len(code.lstrip())
×
376

377
    yield from render_context(line - 2, line, source_lines)
×
378
    yield (line, slice(col, end_idx), LineType.ERROR, source_lines[line - 1])
×
379
    yield from render_context(line + 1, line + 3, source_lines)
×
380

381

382
def render_pep8_errors_e261(msg, _node, source_lines=None):
20✔
383
    """Render a PEP8 at least two spaces before inline comment message."""
384
    line = msg.line
20✔
385
    res = re.search(r"column (\d+)", msg.msg)
20✔
386
    col = int(res.group().split()[-1])
20✔
387

388
    yield from render_context(line - 2, line, source_lines)
20✔
389
    yield (
20✔
390
        line,
391
        slice(col, len(source_lines[line - 1])),
392
        LineType.ERROR,
393
        source_lines[line - 1] + "  # INSERT TWO SPACES BEFORE THE '#'",
394
    )
395
    yield from render_context(line + 1, line + 3, source_lines)
20✔
396

397

398
def render_pep8_errors_e262(msg, _node, source_lines=None):
20✔
399
    """Render a PEP8 inline comment should start with '# ' message"""
400
    line = msg.line
20✔
401
    res = re.search(r"column (\d+)", msg.msg)
20✔
402
    col = int(res.group().split()[-1])
20✔
403

404
    source_line = source_lines[line - 1]
20✔
405
    keyword_idx = len(source_line) - len(source_line[col:].lstrip("# \t"))
20✔
406

407
    yield from render_context(line - 2, line, source_lines)
20✔
408
    yield (line, slice(col, keyword_idx), LineType.ERROR, source_line)
20✔
409
    yield from render_context(line + 1, line + 3, source_lines)
20✔
410

411

412
def render_pep8_errors_e265(msg, _node, source_lines=None):
20✔
413
    """Render a PEP8 block comment should start with '# ' message."""
414
    line = msg.line
20✔
415
    yield from render_context(line - 2, line, source_lines)
20✔
416
    yield (
20✔
417
        line,
418
        slice(0, len(source_lines[line - 1])),
419
        LineType.ERROR,
420
        source_lines[line - 1] + "  # INSERT SPACE AFTER THE '#'",
421
    )
422
    yield from render_context(line + 1, line + 3, source_lines)
20✔
423

424

425
def render_pep8_errors_e266(msg, _node, source_lines=None):
20✔
426
    """Render a PEP8 too many leading ‘#’ for block comment message."""
427
    line = msg.line
20✔
428
    res = re.search(r"column (\d+)", msg.msg)
20✔
429
    col = int(res.group().split()[-1])
20✔
430
    curr_idx = (
20✔
431
        col + len(source_lines[line - 1][col:]) - len(source_lines[line - 1][col:].lstrip("#"))
432
    )
433

434
    yield from render_context(line - 2, line, source_lines)
20✔
435
    yield (
20✔
436
        line,
437
        slice(col, curr_idx),
438
        LineType.ERROR,
439
        source_lines[line - 1] + "  # THERE SHOULD ONLY BE ONE '#'",
440
    )
441
    yield from render_context(line + 1, line + 3, source_lines)
20✔
442

443

444
def render_pep8_errors_e272(msg, _node, source_lines=None):
20✔
445
    """Render a PEP8 multiple spaces before keyword message."""
446
    line = msg.line
×
447
    res = re.search(r"column (\d+)", msg.msg)
×
448
    col = int(res.group().split()[-1])
×
449
    curr_idx = col + len(source_lines[line - 1][col:]) - len(source_lines[line - 1][col:].lstrip())
×
450

451
    yield from render_context(line - 2, line, source_lines)
×
452
    yield (line, slice(col, curr_idx), LineType.ERROR, source_lines[line - 1])
×
453
    yield from render_context(line + 1, line + 3, source_lines)
×
454

455

456
def render_pep8_errors_e275(msg, _node, source_lines=None):
20✔
457
    """Render a PEP8 missing whitespace after keyword message."""
458
    line = msg.line
20✔
459
    res = re.search(r"column (\d+)", msg.msg)
20✔
460
    col = int(res.group().split()[-1])
20✔
461

462
    # Get the range for highlighting the corresponding keyword.
463
    keyword = source_lines[line - 1][:col].split()[-1]
20✔
464
    keyword_idx = source_lines[line - 1].index(keyword)
20✔
465

466
    yield from render_context(line - 2, line, source_lines)
20✔
467
    yield (
20✔
468
        line,
469
        slice(keyword_idx, col),
470
        LineType.ERROR,
471
        source_lines[line - 1] + "  # INSERT SPACE AFTER KEYWORD",
472
    )
473
    yield from render_context(line + 1, line + 3, source_lines)
20✔
474

475

476
def render_pep8_errors_e301(msg, _node, source_lines=None):
20✔
477
    """Render a PEP8 expected 1 blank line message."""
478
    line = msg.line - 1
20✔
479
    yield from render_context(line - 1, line + 1, source_lines)
20✔
480
    body = source_lines[line]
20✔
481
    indentation = len(body) - len(body.lstrip())
20✔
482
    yield (
20✔
483
        None,
484
        slice(None, None),
485
        LineType.ERROR,
486
        body[:indentation] + NEW_BLANK_LINE_MESSAGE,
487
    )
488
    yield from render_context(msg.line, msg.line + 2, source_lines)
20✔
489

490

491
def render_pep8_errors_e302(msg, _node, source_lines=None):
20✔
492
    """Render a PEP8 expected 2 blank lines message."""
493
    line = msg.line - 1
20✔
494
    if "found 0" in msg.msg:
20✔
495
        yield from render_context(line - 1, line + 1, source_lines)
20✔
496
        yield from (
20✔
497
            (
498
                None,
499
                slice(None, None),
500
                LineType.ERROR,
501
                NEW_BLANK_LINE_MESSAGE,
502
            )
503
            for _ in range(0, 2)
504
        )
505
    else:
506
        line -= 1
20✔
507
        yield from render_context(line - 1, line + 1, source_lines)
20✔
508
        yield from render_blank_line(line)
20✔
509
        yield (None, slice(None, None), LineType.ERROR, NEW_BLANK_LINE_MESSAGE)
20✔
510
    yield from render_context(msg.line, msg.line + 2, source_lines)
20✔
511

512

513
def render_pep8_errors_e303(msg, _node, source_lines=None):
20✔
514
    """Render a PEP8 too many blank lines message."""
515
    line = msg.line - 1
20✔
516
    while source_lines[line - 1].strip() == "":
20✔
517
        line -= 1
20✔
518
    yield from render_context(line - 1, line + 1, source_lines)
20✔
519
    body = source_lines[msg.line - 1]
20✔
520
    indentation = len(body) - len(body.lstrip())
20✔
521
    yield from (
20✔
522
        (curr_line, slice(None, None), LineType.ERROR, " " * (indentation + 28))
523
        for curr_line in range(line + 1, msg.line)
524
    )
525
    yield from render_context(msg.line, msg.line + 2, source_lines)
20✔
526

527

528
def render_pep8_errors_e304(msg, _node, source_lines=None):
20✔
529
    """Render a PEP8 blank lines found after function decorator message."""
530
    line = msg.line - 1
20✔
531
    while source_lines[line - 1].strip() == "":
20✔
532
        line -= 1
20✔
533
    yield from render_context(line - 1, line + 1, source_lines)
20✔
534
    yield from (
20✔
535
        (curr_line, slice(None, None), LineType.ERROR, " " * 28)
536
        for curr_line in range(line + 1, msg.line)
537
    )
538
    yield from render_context(msg.line, msg.line + 2, source_lines)
20✔
539

540

541
def render_pep8_errors_e305(msg, _node, source_lines=None):
20✔
542
    """Render a PEP8 expected 2 blank lines after class or function definition message."""
543
    line = msg.line - 1
20✔
544
    if "found 0" in msg.msg:
20✔
545
        yield from render_context(line - 1, line + 1, source_lines)
×
546
        yield from (
×
547
            (
548
                None,
549
                slice(None, None),
550
                LineType.ERROR,
551
                NEW_BLANK_LINE_MESSAGE,
552
            )
553
            for _ in range(0, 2)
554
        )
555
    else:
556
        line -= 1
20✔
557
        yield from render_context(line - 1, line + 1, source_lines)
20✔
558
        yield from render_blank_line(line)
20✔
559
        yield (None, slice(None, None), LineType.ERROR, NEW_BLANK_LINE_MESSAGE)
20✔
560
    yield from render_context(msg.line, msg.line + 2, source_lines)
20✔
561

562

563
def render_pep8_errors_e306(msg, _node, source_lines=None):
20✔
564
    """Render a PEP8 expected 1 blank line before a nested definition message."""
565
    line = msg.line - 1
×
566
    yield from render_context(line - 1, line + 1, source_lines)
×
567
    body = source_lines[line]
×
568
    indentation = len(body) - len(body.lstrip())
×
569
    yield (
×
570
        None,
571
        slice(None, None),
572
        LineType.ERROR,
573
        body[:indentation] + NEW_BLANK_LINE_MESSAGE,
574
    )
575
    yield from render_context(msg.line, msg.line + 2, source_lines)
×
576

577

578
def render_missing_return_statement(msg, node, source_lines=None):
20✔
579
    """
580
    Render a missing return statements message
581
    """
582
    yield from render_context(msg.line, msg.end_line + 1, source_lines)
20✔
583

584
    # calculate indentation for the insertion point
585
    body = source_lines[msg.end_line - 1]
20✔
586
    indentation = len(source_lines[msg.line - 1]) - len(source_lines[msg.line - 1].lstrip())
20✔
587

588
    # determine whether reaching the end of function
589
    first_statement_line = node.end_lineno if len(node.body) == 0 else node.body[0].lineno
20✔
590
    function_indentation = len(source_lines[first_statement_line - 1]) - len(
20✔
591
        source_lines[first_statement_line - 1].lstrip()
592
    )
593

594
    if msg.end_line == node.end_lineno and indentation == function_indentation:
20✔
595
        insertion_text = body[:indentation] + "# INSERT RETURN STATEMENT HERE"
20✔
596
    else:
597
        insertion_text = body[:indentation] + "# INSERT RETURN STATEMENT HERE (OR BELOW)"
20✔
598

599
    # insert the message
600
    yield (
20✔
601
        None,
602
        slice(indentation, None),
603
        LineType.ERROR,
604
        insertion_text,
605
    )
606

607
    yield from render_context(msg.end_line + 1, msg.end_line + 3, source_lines)
20✔
608

609

610
def render_static_type_checker_errors(msg, _node=None, source_lines=None):
20✔
611
    """Render a message for incompatible argument types."""
612
    start_line = msg.line
20✔
613
    start_col = msg.column
20✔
614
    end_line = msg.end_line
20✔
615
    end_col = msg.end_column
20✔
616
    yield from render_context(start_line - 2, start_line, source_lines)
20✔
617

618
    if start_line == end_line:
20✔
619
        yield (
20✔
620
            start_line,
621
            slice(start_col - 1, end_col),
622
            LineType.ERROR,
623
            source_lines[start_line - 1],
624
        )
625
    else:
626
        yield (start_line, slice(start_col - 1, None), LineType.ERROR, source_lines[start_line - 1])
20✔
627
        yield from (
20✔
628
            (line, slice(None, None), LineType.ERROR, source_lines[line - 1])
629
            for line in range(start_line + 1, end_line)
630
        )
631
        yield (end_line, slice(None, end_col), LineType.ERROR, source_lines[end_line - 1])
20✔
632
    yield from render_context(end_line + 1, end_line + 3, source_lines)
20✔
633

634

635
CUSTOM_MESSAGES = {
20✔
636
    "missing-module-docstring": render_missing_docstring,
637
    "missing-class-docstring": render_missing_docstring,
638
    "missing-function-docstring": render_missing_docstring,
639
    "trailing-newlines": render_trailing_newlines,
640
    "trailing-whitespace": render_trailing_whitespace,
641
    "missing-return-type": render_missing_return_type,
642
    "too-many-arguments": render_too_many_arguments,
643
    "missing-space-in-doctest": render_missing_space_in_doctest,
644
    "pep8-errors": render_pep8_errors,
645
    "missing-return-statement": render_missing_return_statement,
646
    "incompatible-argument-type": render_static_type_checker_errors,
647
    "incompatible-assignment": render_static_type_checker_errors,
648
    "list-item-type-mismatch": render_static_type_checker_errors,
649
    "unsupported-operand-types": render_static_type_checker_errors,
650
    "union-attr-error": render_static_type_checker_errors,
651
    "dict-item-type-mismatch": render_static_type_checker_errors,
652
}
653

654
RENDERERS = {
20✔
655
    "E101": render_pep8_errors_e101_and_e123,
656
    "E123": render_pep8_errors_e101_and_e123,
657
    "E115": render_pep8_errors_e115,
658
    "E116": render_pep8_errors_e116,
659
    "E122": render_pep8_errors_e122_and_e127_and_e131,
660
    "E127": render_pep8_errors_e122_and_e127_and_e131,
661
    "E131": render_pep8_errors_e122_and_e127_and_e131,
662
    "E124": render_pep8_errors_e124,
663
    "E125": render_pep8_errors_e125_and_e129,
664
    "E129": render_pep8_errors_e125_and_e129,
665
    "E128": render_pep8_errors_e128,
666
    "E201": render_pep8_errors_e201_e202_e203_e211,
667
    "E202": render_pep8_errors_e201_e202_e203_e211,
668
    "E203": render_pep8_errors_e201_e202_e203_e211,
669
    "E221": render_pep8_errors_e221,
670
    "E222": render_pep8_errors_e222,
671
    "E223": render_pep8_errors_e223,
672
    "E224": render_pep8_errors_e224_and_e273,
673
    "E273": render_pep8_errors_e224_and_e273,
674
    "E226": render_pep8_errors_e226,
675
    "E227": render_pep8_errors_e227,
676
    "E228": render_pep8_errors_e228,
677
    "E251": render_pep8_errors_e251,
678
    "E261": render_pep8_errors_e261,
679
    "E262": render_pep8_errors_e262,
680
    "E265": render_pep8_errors_e265,
681
    "E266": render_pep8_errors_e266,
682
    "E272": render_pep8_errors_e272,
683
    "E275": render_pep8_errors_e275,
684
    "E301": render_pep8_errors_e301,
685
    "E302": render_pep8_errors_e302,
686
    "E303": render_pep8_errors_e303,
687
    "E304": render_pep8_errors_e304,
688
    "E305": render_pep8_errors_e305,
689
    "E306": render_pep8_errors_e306,
690
}
691

692

693
class LineType(Enum):
20✔
694
    """An enumeration for _add_line method line types."""
695

696
    ERROR = 1  # line with error
20✔
697
    CONTEXT = 2  # non-error/other line added for context
20✔
698
    OTHER = 3  # line included in source but not error
20✔
699
    ELLIPSIS = 5  # code replaced with ellipsis
20✔
700
    DOCSTRING = 6  # docstring needed warning
20✔
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2026 Coveralls, Inc