tptimer/env/lib/python2.7/site-packages/pylint/test/unittest_checker_base.py

352 lines
12 KiB
Python

# Copyright (c) 2013-2015 LOGILAB S.A. (Paris, FRANCE) <contact@logilab.fr>
# Copyright (c) 2013-2014 Google, Inc.
# Copyright (c) 2015 Dmitry Pribysh <dmand@yandex.ru>
# Copyright (c) 2015-2016 Claudiu Popa <pcmanticore@gmail.com>
# Copyright (c) 2016 Yannack <yannack@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/master/COPYING
"""Unittest for the base checker."""
import re
import sys
import unittest
import astroid
from pylint.checkers import base
from pylint.testutils import CheckerTestCase, Message, set_config
class TestDocstring(CheckerTestCase):
CHECKER_CLASS = base.DocStringChecker
def test_missing_docstring_module(self):
module = astroid.parse("something")
message = Message('missing-docstring', node=module, args=('module',))
with self.assertAddsMessages(message):
self.checker.visit_module(module)
def test_missing_docstring_empty_module(self):
module = astroid.parse("")
with self.assertNoMessages():
self.checker.visit_module(module)
def test_empty_docstring_module(self):
module = astroid.parse("''''''")
message = Message('empty-docstring', node=module, args=('module',))
with self.assertAddsMessages(message):
self.checker.visit_module(module)
def test_empty_docstring_function(self):
func = astroid.extract_node("""
def func(tion):
pass""")
message = Message('missing-docstring', node=func, args=('function',))
with self.assertAddsMessages(message):
self.checker.visit_functiondef(func)
@set_config(docstring_min_length=2)
def test_short_function_no_docstring(self):
func = astroid.extract_node("""
def func(tion):
pass""")
with self.assertNoMessages():
self.checker.visit_functiondef(func)
@set_config(docstring_min_length=2)
def test_function_no_docstring_by_name(self):
func = astroid.extract_node("""
def __fun__(tion):
pass""")
with self.assertNoMessages():
self.checker.visit_functiondef(func)
def test_class_no_docstring(self):
klass = astroid.extract_node("""
class Klass(object):
pass""")
message = Message('missing-docstring', node=klass, args=('class',))
with self.assertAddsMessages(message):
self.checker.visit_classdef(klass)
class TestNameChecker(CheckerTestCase):
CHECKER_CLASS = base.NameChecker
CONFIG = {
'bad_names': set(),
}
@set_config(include_naming_hint=True)
def test_naming_hint(self):
const = astroid.extract_node("""
const = "CONSTANT" #@
""")
message = Message(
'invalid-name', node=const.targets[0],
args=('constant', 'const',
' (hint: (([A-Z_][A-Z0-9_]*)|(__.*__))$)'))
with self.assertAddsMessages(message):
self.checker.visit_assignname(const.targets[0])
@set_config(include_naming_hint=True, const_name_hint='CONSTANT')
def test_naming_hint_configured_hint(self):
const = astroid.extract_node("""
const = "CONSTANT" #@
""")
with self.assertAddsMessages(
Message('invalid-name', node=const.targets[0],
args=('constant', 'const', ' (hint: CONSTANT)'))):
self.checker.visit_assignname(const.targets[0])
@set_config(attr_rgx=re.compile('[A-Z]+'),
property_classes=('abc.abstractproperty', '.custom_prop'))
def test_property_names(self):
# If a method is annotated with @property, it's name should
# match the attr regex. Since by default the attribute regex is the same
# as the method regex, we override it here.
methods = astroid.extract_node("""
import abc
def custom_prop(f):
return property(f)
class FooClass(object):
@property
def FOO(self): #@
pass
@property
def bar(self): #@
pass
@abc.abstractproperty
def BAZ(self): #@
pass
@custom_prop
def QUX(self): #@
pass
""")
with self.assertNoMessages():
self.checker.visit_functiondef(methods[0])
self.checker.visit_functiondef(methods[2])
self.checker.visit_functiondef(methods[3])
with self.assertAddsMessages(Message('invalid-name', node=methods[1],
args=('attribute', 'bar', ''))):
self.checker.visit_functiondef(methods[1])
@set_config(attr_rgx=re.compile('[A-Z]+'))
def test_property_setters(self):
method = astroid.extract_node("""
class FooClass(object):
@property
def foo(self): pass
@foo.setter
def FOOSETTER(self): #@
pass
""")
with self.assertNoMessages():
self.checker.visit_functiondef(method)
def test_module_level_names(self):
assign = astroid.extract_node("""
import collections
Class = collections.namedtuple("a", ("b", "c")) #@
""")
with self.assertNoMessages():
self.checker.visit_assignname(assign.targets[0])
assign = astroid.extract_node("""
class ClassA(object):
pass
ClassB = ClassA
""")
with self.assertNoMessages():
self.checker.visit_assignname(assign.targets[0])
module = astroid.parse("""
def A():
return 1, 2, 3
CONSTA, CONSTB, CONSTC = A()
CONSTD = A()""")
with self.assertNoMessages():
self.checker.visit_assignname(module.body[1].targets[0].elts[0])
self.checker.visit_assignname(module.body[2].targets[0])
assign = astroid.extract_node("""
CONST = "12 34 ".rstrip().split()""")
with self.assertNoMessages():
self.checker.visit_assignname(assign.targets[0])
@unittest.skipIf(sys.version_info >= (3, 0), reason="Needs Python 2.x")
@set_config(const_rgx=re.compile(".+"))
def test_assign_to_new_keyword_py2(self):
ast = astroid.extract_node("""
True = 0 #@
False = 1 #@
""")
with self.assertAddsMessages(
Message(msg_id='assign-to-new-keyword', node=ast[0].targets[0], args=('True', '3.0'))
):
self.checker.visit_assignname(ast[0].targets[0])
with self.assertAddsMessages(
Message(msg_id='assign-to-new-keyword', node=ast[1].targets[0], args=('False', '3.0'))
):
self.checker.visit_assignname(ast[1].targets[0])
@unittest.skipIf(sys.version_info >= (3, 7), reason="Needs Python 3.6 or earlier")
@set_config(const_rgx=re.compile(".+"))
def test_assign_to_new_keyword_py3(self):
ast = astroid.extract_node("""
async = "foo" #@
await = "bar" #@
""")
with self.assertAddsMessages(
Message(msg_id='assign-to-new-keyword', node=ast[0].targets[0], args=('async', '3.7'))
):
self.checker.visit_assignname(ast[0].targets[0])
with self.assertAddsMessages(
Message(msg_id='assign-to-new-keyword', node=ast[1].targets[0], args=('await', '3.7'))
):
self.checker.visit_assignname(ast[1].targets[0])
class TestMultiNamingStyle(CheckerTestCase):
CHECKER_CLASS = base.NameChecker
MULTI_STYLE_RE = re.compile('(?:(?P<UP>[A-Z]+)|(?P<down>[a-z]+))$')
@set_config(class_rgx=MULTI_STYLE_RE)
def test_multi_name_detection_majority(self):
classes = astroid.extract_node("""
class classb(object): #@
pass
class CLASSA(object): #@
pass
class CLASSC(object): #@
pass
""")
message = Message('invalid-name',
node=classes[0],
args=('class', 'classb', ''))
with self.assertAddsMessages(message):
for cls in classes:
self.checker.visit_classdef(cls)
self.checker.leave_module(cls.root)
@set_config(class_rgx=MULTI_STYLE_RE)
def test_multi_name_detection_first_invalid(self):
classes = astroid.extract_node("""
class class_a(object): #@
pass
class classb(object): #@
pass
class CLASSC(object): #@
pass
""")
messages = [
Message('invalid-name', node=classes[0],
args=('class', 'class_a', '')),
Message('invalid-name', node=classes[2],
args=('class', 'CLASSC', ''))
]
with self.assertAddsMessages(*messages):
for cls in classes:
self.checker.visit_classdef(cls)
self.checker.leave_module(cls.root)
@set_config(method_rgx=MULTI_STYLE_RE,
function_rgx=MULTI_STYLE_RE,
name_group=('function:method',))
def test_multi_name_detection_group(self):
function_defs = astroid.extract_node("""
class First(object):
def func(self): #@
pass
def FUNC(): #@
pass
""", module_name='test')
message = Message('invalid-name', node=function_defs[1],
args=('function', 'FUNC', ''))
with self.assertAddsMessages(message):
for func in function_defs:
self.checker.visit_functiondef(func)
self.checker.leave_module(func.root)
@set_config(function_rgx=re.compile('(?:(?P<ignore>FOO)|(?P<UP>[A-Z]+)|(?P<down>[a-z]+))$'))
def test_multi_name_detection_exempt(self):
function_defs = astroid.extract_node("""
def FOO(): #@
pass
def lower(): #@
pass
def FOO(): #@
pass
def UPPER(): #@
pass
""")
message = Message('invalid-name', node=function_defs[3],
args=('function', 'UPPER', ''))
with self.assertAddsMessages(message):
for func in function_defs:
self.checker.visit_functiondef(func)
self.checker.leave_module(func.root)
class TestComparison(CheckerTestCase):
CHECKER_CLASS = base.ComparisonChecker
def test_comparison(self):
node = astroid.extract_node("foo == True")
message = Message('singleton-comparison',
node=node,
args=(True, "just 'expr' or 'expr is True'"))
with self.assertAddsMessages(message):
self.checker.visit_compare(node)
node = astroid.extract_node("foo == False")
message = Message('singleton-comparison',
node=node,
args=(False, "'not expr' or 'expr is False'"))
with self.assertAddsMessages(message):
self.checker.visit_compare(node)
node = astroid.extract_node("foo == None")
message = Message('singleton-comparison',
node=node,
args=(None, "'expr is None'"))
with self.assertAddsMessages(message):
self.checker.visit_compare(node)
node = astroid.extract_node("True == foo")
messages = (Message('misplaced-comparison-constant',
node=node,
args=('foo == True',)),
Message('singleton-comparison',
node=node,
args=(True, "just 'expr' or 'expr is True'")))
with self.assertAddsMessages(*messages):
self.checker.visit_compare(node)
node = astroid.extract_node("False == foo")
messages = (Message('misplaced-comparison-constant',
node=node,
args=('foo == False',)),
Message('singleton-comparison',
node=node,
args=(False, "'not expr' or 'expr is False'")))
with self.assertAddsMessages(*messages):
self.checker.visit_compare(node)
node = astroid.extract_node("None == foo")
messages = (Message('misplaced-comparison-constant',
node=node,
args=('foo == None',)),
Message('singleton-comparison',
node=node,
args=(None, "'expr is None'")))
with self.assertAddsMessages(*messages):
self.checker.visit_compare(node)