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
|
# Copyright 2014 Michal Nowikowski.
#
# This program is free software; you can redistribute it and/or modify it under
# the terms of the GNU General Public License as published by the Free Software
# Foundation; either version 2 of the License, or (at your option) any later
# version.
#
# This program is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along with
# this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
"""Unittest for the spelling checker."""
import unittest
from astroid import test_utils
from pylint.checkers import spelling
from pylint.testutils import (
CheckerTestCase, Message, set_config, tokenize_str,
)
# try to create enchant dictionary
try:
import enchant
except ImportError:
enchant = None
spell_dict = None
if enchant is not None:
try:
enchant.Dict("en_US")
spell_dict = "en_US"
except enchant.DictNotFoundError:
pass
class SpellingCheckerTest(CheckerTestCase):
CHECKER_CLASS = spelling.SpellingChecker
@unittest.skipIf(spell_dict is None,
"missing python-enchant package or missing "
"spelling dictionaries")
@set_config(spelling_dict=spell_dict)
def test_check_bad_coment(self):
with self.assertAddsMessages(
Message('wrong-spelling-in-comment', line=1,
args=('coment', '# bad coment',
' ^^^^^^',
"comet' or 'comment' or 'moment' or 'foment"))):
self.checker.process_tokens(tokenize_str("# bad coment"))
@unittest.skipIf(spell_dict is None,
"missing python-enchant package or missing "
"spelling dictionaries")
@set_config(spelling_dict=spell_dict)
def test_check_bad_docstring(self):
stmt = test_utils.extract_node(
'def fff():\n """bad coment"""\n pass')
with self.assertAddsMessages(
Message('wrong-spelling-in-docstring', line=2,
args=('coment', 'bad coment',
' ^^^^^^',
"comet' or 'comment' or 'moment' or 'foment"))):
self.checker.visit_function(stmt)
stmt = test_utils.extract_node(
'class Abc(object):\n """bad coment"""\n pass')
with self.assertAddsMessages(
Message('wrong-spelling-in-docstring', line=2,
args=('coment', 'bad coment',
' ^^^^^^',
"comet' or 'comment' or 'moment' or 'foment"))):
self.checker.visit_class(stmt)
@unittest.skipIf(spell_dict is None,
"missing python-enchant package or missing "
"spelling dictionaries")
@set_config(spelling_dict=spell_dict)
def test_invalid_docstring_characters(self):
stmt = test_utils.extract_node(
'def fff():\n """test\\x00"""\n pass')
with self.assertAddsMessages(
Message('invalid-characters-in-docstring', line=2,
args=('test\x00',))):
self.checker.visit_function(stmt)
if __name__ == '__main__':
unittest.main()
|
