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
|
# Copyright (c) 2016-2018, 2020 Claudiu Popa <pcmanticore@gmail.com>
# Copyright (c) 2016-2017 Derek Gustafson <degustaf@gmail.com>
# Copyright (c) 2016 Luis Escobar <lescobar@vauxoo.com>
# Copyright (c) 2019-2021 Pierre Sassoulas <pierre.sassoulas@gmail.com>
# Copyright (c) 2019 Ashley Whetter <ashley@awhetter.co.uk>
# Copyright (c) 2020 hippo91 <guillaume.peillex@gmail.com>
# Copyright (c) 2021 Daniël van Noord <13665637+DanielNoord@users.noreply.github.com>
# Copyright (c) 2021 Marc Mueller <30130371+cdce8p@users.noreply.github.com>
# Licensed under the GPL: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
# For details: https://github.com/PyCQA/pylint/blob/main/LICENSE
"""Tests for the pylint checker in :mod:`pylint.extensions.check_docstring
"""
from os.path import abspath, dirname, join
import pytest
from pylint.extensions.docstyle import DocStringStyleChecker
from pylint.lint.pylinter import PyLinter
EXPECTED_MSGS = [
"First line empty in function docstring",
"First line empty in class docstring",
"First line empty in method docstring",
"Bad docstring quotes in method, expected \"\"\", given '''",
'Bad docstring quotes in method, expected """, given "',
'Bad docstring quotes in method, expected """, given \'',
'Bad docstring quotes in method, expected """, given \'',
]
EXPECTED_SYMBOLS = [
"docstring-first-line-empty",
"docstring-first-line-empty",
"docstring-first-line-empty",
"bad-docstring-quotes",
"bad-docstring-quotes",
"bad-docstring-quotes",
"bad-docstring-quotes",
]
@pytest.fixture(scope="module")
def checker():
return DocStringStyleChecker
def test_docstring_message(linter: PyLinter) -> None:
docstring_test = join(dirname(abspath(__file__)), "data", "docstring.py")
linter.check([docstring_test])
msgs = linter.reporter.messages
assert len(msgs) == 7
for msg, expected_symbol, expected_msg in zip(
msgs, EXPECTED_SYMBOLS, EXPECTED_MSGS
):
assert msg.symbol == expected_symbol
assert msg.msg == expected_msg
|
