2013-06-18 16:35:34 +00:00
|
|
|
"""Unittest for the base checker."""
|
|
|
|
|
|
|
|
from astroid import test_utils
|
|
|
|
from pylint.checkers import base
|
|
|
|
from pylint.testutils import CheckerTestCase, Message
|
|
|
|
|
|
|
|
|
|
|
|
class DocstringTest(CheckerTestCase):
|
|
|
|
CHECKER_CLASS = base.DocStringChecker
|
|
|
|
|
|
|
|
def testMissingDocstringModule(self):
|
|
|
|
module = test_utils.build_module("")
|
2013-06-19 13:23:06 +00:00
|
|
|
with self.assertAddsMessages(Message('missing-docstring', node=module, args=('module',))):
|
2013-06-18 16:35:34 +00:00
|
|
|
self.checker.visit_module(module)
|
|
|
|
|
|
|
|
def testEmptyDocstringModule(self):
|
|
|
|
module = test_utils.build_module("''''''")
|
2013-06-19 13:23:06 +00:00
|
|
|
with self.assertAddsMessages(Message('empty-docstring', node=module, args=('module',))):
|
2013-06-18 16:35:34 +00:00
|
|
|
self.checker.visit_module(module)
|
|
|
|
|
|
|
|
def testEmptyDocstringFunction(self):
|
|
|
|
func = test_utils.extract_node("""
|
|
|
|
def func(tion):
|
|
|
|
pass""")
|
2013-06-19 13:23:06 +00:00
|
|
|
with self.assertAddsMessages(Message('missing-docstring', node=func, args=('function',))):
|
2013-06-18 16:35:34 +00:00
|
|
|
self.checker.visit_function(func)
|
|
|
|
|
|
|
|
def testShortFunctionNoDocstring(self):
|
|
|
|
self.checker.config.docstring_min_length = 2
|
|
|
|
func = test_utils.extract_node("""
|
|
|
|
def func(tion):
|
|
|
|
pass""")
|
|
|
|
with self.assertNoMessages():
|
|
|
|
self.checker.visit_function(func)
|
|
|
|
|
|
|
|
def testFunctionNoDocstringByName(self):
|
|
|
|
self.checker.config.docstring_min_length = 2
|
|
|
|
func = test_utils.extract_node("""
|
|
|
|
def __fun__(tion):
|
|
|
|
pass""")
|
|
|
|
with self.assertNoMessages():
|
|
|
|
self.checker.visit_function(func)
|
|
|
|
|
|
|
|
def testClassNoDocstring(self):
|
|
|
|
klass = test_utils.extract_node("""
|
|
|
|
class Klass(object):
|
|
|
|
pass""")
|
2013-06-19 13:23:06 +00:00
|
|
|
with self.assertAddsMessages(Message('missing-docstring', node=klass, args=('class',))):
|
2013-06-18 16:35:34 +00:00
|
|
|
self.checker.visit_class(klass)
|
2013-06-19 12:39:22 +00:00
|
|
|
|
|
|
|
|
|
|
|
class NameCheckerTest(CheckerTestCase):
|
|
|
|
CHECKER_CLASS = base.NameChecker
|
|
|
|
|
|
|
|
def testModuleLevelNames(self):
|
|
|
|
assign = test_utils.extract_node("""
|
|
|
|
import collections
|
|
|
|
Class = collections.namedtuple("a", ("b", "c")) #@
|
|
|
|
""")
|
|
|
|
with self.assertNoMessages():
|
|
|
|
self.checker.visit_assname(assign.targets[0])
|
|
|
|
|
|
|
|
assign = test_utils.extract_node("""
|
|
|
|
class ClassA(object):
|
|
|
|
pass
|
|
|
|
ClassB = ClassA
|
|
|
|
""")
|
|
|
|
with self.assertNoMessages():
|
|
|
|
self.checker.visit_assname(assign.targets[0])
|
|
|
|
|
|
|
|
module = test_utils.build_module("""
|
|
|
|
def A():
|
|
|
|
return 1, 2, 3
|
|
|
|
CONSTA, CONSTB, CONSTC = A()
|
|
|
|
CONSTD = A()""")
|
|
|
|
with self.assertNoMessages():
|
|
|
|
self.checker.visit_assname(module.body[1].targets[0].elts[0])
|
|
|
|
self.checker.visit_assname(module.body[2].targets[0])
|
|
|
|
|
|
|
|
assign = test_utils.extract_node("""
|
|
|
|
CONST = "12 34 ".rstrip().split()""")
|
|
|
|
with self.assertNoMessages():
|
|
|
|
self.checker.visit_assname(assign.targets[0])
|
|
|
|
|