def test_finds_import_from(self):
checker_test_object = testutils.CheckerTestCase()
checker_test_object.CHECKER_CLASS = (
custom_lint_checks.ImportOnlyModulesChecker)
checker_test_object.setup_method()
importfrom_node1 = astroid.extract_node("""
from os import path #@
import sys
""")
with checker_test_object.assertNoMessages():
checker_test_object.checker.visit_importfrom(importfrom_node1)
importfrom_node2 = astroid.extract_node("""
from os import error #@
import sys
""")
with checker_test_object.assertAddsMessages(
testutils.Message(
msg_id='import-only-modules',
node=importfrom_node2,
args=('error', 'os')
),
):
checker_test_object.checker.visit_importfrom(
importfrom_node2)
def test_finds_function_def(self):
checker_test_object = testutils.CheckerTestCase()
checker_test_object.CHECKER_CLASS = (
pylint_extensions.FunctionArgsOrderChecker)
checker_test_object.setup_method()
functiondef_node1 = astroid.extract_node("""
def test(self,test_var_one, test_var_two): #@
result = test_var_one + test_var_two
return result
""")
with checker_test_object.assertNoMessages():
checker_test_object.checker.visit_functiondef(functiondef_node1)
functiondef_node2 = astroid.extract_node("""
def test(test_var_one, test_var_two, self): #@
result = test_var_one + test_var_two
return result
""")
with checker_test_object.assertAddsMessages(
testutils.Message(msg_id='function-args-order-self',
node=functiondef_node2), ):
checker_test_object.checker.visit_functiondef(functiondef_node2)
functiondef_node3 = astroid.extract_node("""
def test(test_var_one, test_var_two, cls): #@
result = test_var_one + test_var_two
return result
""")
with checker_test_object.assertAddsMessages(
testutils.Message(msg_id='function-args-order-cls',
node=functiondef_node3), ):
checker_test_object.checker.visit_functiondef(functiondef_node3)
def test_finds_non_explicit_kwargs(self):
checker_test_object = testutils.CheckerTestCase()
checker_test_object.CHECKER_CLASS = (
custom_lint_checks.ExplicitKwargsChecker)
checker_test_object.setup_method()
func_node = astroid.extract_node("""
def test(test_var_one, test_var_two=4, test_var_three=5, test_var_four="test_checker"): #@
test_var_five = test_var_two + test_var_three
return test_var_five
""")
checker_test_object.checker.visit_functiondef(func_node)
func_args = func_node.args
checker_test_object.checker.visit_arguments(func_args)
func_call_node_one, func_call_node_two, func_call_node_three = (
astroid.extract_node("""
test(2, 5, 6) #@
test(2) #@
test(2, 5, 6, test_var_four="test_string") #@
"""))
with checker_test_object.assertAddsMessages(
testutils.Message(
msg_id='non-explicit-kwargs',
node=func_call_node_one,
), ):
checker_test_object.checker.visit_call(func_call_node_one)
with checker_test_object.assertNoMessages():
checker_test_object.checker.visit_call(func_call_node_two)
with checker_test_object.assertAddsMessages(
testutils.Message(
msg_id='non-explicit-kwargs',
node=func_call_node_three,
), ):
checker_test_object.checker.visit_call(func_call_node_three)
def test_finds_backslash_continuation(self):
checker_test_object = testutils.CheckerTestCase()
checker_test_object.CHECKER_CLASS = (
pylint_extensions.BackslashContinuationChecker)
checker_test_object.setup_method()
node = astroid.scoped_nodes.Module(name='test', doc='Custom test')
temp_file = tempfile.NamedTemporaryFile()
filename = temp_file.name
with python_utils.open_file(filename, 'w') as tmp:
tmp.write(u"""message1 = 'abc'\\\n""" # pylint: disable=backslash-continuation
"""'cde'\\\n""" # pylint: disable=backslash-continuation
"""'xyz'
message2 = 'abc\\\\'
message3 = (
'abc\\\\'
'xyz\\\\'
)
""")
node.file = filename
node.path = filename
checker_test_object.checker.process_module(node)
with checker_test_object.assertAddsMessages(
testutils.Message(msg_id='backslash-continuation', line=1),
testutils.Message(msg_id='backslash-continuation', line=2),
):
temp_file.close()
def test_finds_non_explicit_keyword_args(self):
checker_test_object = testutils.CheckerTestCase()
checker_test_object.CHECKER_CLASS = (
custom_lint_checks.ExplicitKeywordArgsChecker)
checker_test_object.setup_method()
func_call_node_one, func_call_node_two, func_call_node_three = (
astroid.extract_node("""
def test(test_var_one, test_var_two=4, test_var_three=5, test_var_four="test_checker"):
test_var_five = test_var_two + test_var_three
return test_var_five
test(2, 5, test_var_three=6) #@
test(2) #@
test(2, 6, test_var_two=5, test_var_four="test_checker") #@
"""))
with checker_test_object.assertAddsMessages(
testutils.Message(msg_id='non-explicit-keyword-args',
node=func_call_node_one,
args=("'test_var_two'", 'function',
'test')), ):
checker_test_object.checker.visit_call(func_call_node_one)
with checker_test_object.assertNoMessages():
checker_test_object.checker.visit_call(func_call_node_two)
with checker_test_object.assertAddsMessages(
testutils.Message(msg_id='non-explicit-keyword-args',
node=func_call_node_three,
args=("'test_var_three'", 'function',
'test'))):
checker_test_object.checker.visit_call(func_call_node_three)
def test_finds_non_explicit_keyword_args(self):
checker_test_object = testutils.CheckerTestCase()
checker_test_object.CHECKER_CLASS = (
pylint_extensions.ExplicitKeywordArgsChecker)
checker_test_object.setup_method()
(func_call_node_one, func_call_node_two, func_call_node_three,
func_call_node_four, func_call_node_five, func_call_node_six,
class_call_node) = astroid.extract_node("""
class TestClass():
pass
def test(test_var_one, test_var_two=4, test_var_three=5, test_var_four="test_checker"):
test_var_five = test_var_two + test_var_three
return test_var_five
def test_1(test_var_one, test_var_one):
pass
def test_2((a, b)):
pass
test(2, 5, test_var_three=6) #@
test(2) #@
test(2, 6, test_var_two=5, test_var_four="test_checker") #@
max(5, 1) #@
test_1(1, 2) #@
test_2((1, 2)) #@
TestClass() #@
""")
with checker_test_object.assertAddsMessages(
testutils.Message(msg_id='non-explicit-keyword-args',
node=func_call_node_one,
args=('\'test_var_two\'', 'function',
'test')), ):
checker_test_object.checker.visit_call(func_call_node_one)
with checker_test_object.assertNoMessages():
checker_test_object.checker.visit_call(func_call_node_two)
with checker_test_object.assertAddsMessages(
testutils.Message(msg_id='non-explicit-keyword-args',
node=func_call_node_three,
args=('\'test_var_three\'', 'function',
'test'))):
checker_test_object.checker.visit_call(func_call_node_three)
with checker_test_object.assertNoMessages():
checker_test_object.checker.visit_call(class_call_node)
with checker_test_object.assertNoMessages():
checker_test_object.checker.visit_call(func_call_node_four)
with checker_test_object.assertNoMessages():
checker_test_object.checker.visit_call(func_call_node_five)
with checker_test_object.assertNoMessages():
checker_test_object.checker.visit_call(func_call_node_six)
def test_finds_import_from(self):
checker_test_object = testutils.CheckerTestCase()
checker_test_object.CHECKER_CLASS = (
pylint_extensions.ImportOnlyModulesChecker)
checker_test_object.setup_method()
importfrom_node1 = astroid.extract_node("""
from os import path #@
import sys
""")
with checker_test_object.assertNoMessages():
checker_test_object.checker.visit_importfrom(importfrom_node1)
importfrom_node2 = astroid.extract_node("""
from os import error #@
import sys
""")
with checker_test_object.assertAddsMessages(
testutils.Message(
msg_id='import-only-modules',
node=importfrom_node2,
args=('error', 'os')
),
):
checker_test_object.checker.visit_importfrom(
importfrom_node2)
importfrom_node3 = astroid.extract_node("""
from invalid_module import invalid_module #@
""")
with checker_test_object.assertNoMessages():
checker_test_object.checker.visit_importfrom(importfrom_node3)
importfrom_node4 = astroid.extract_node("""
from constants import constants #@
""")
with checker_test_object.assertNoMessages():
checker_test_object.checker.visit_importfrom(importfrom_node4)
importfrom_node5 = astroid.extract_node("""
from os import invalid_module #@
""")
with checker_test_object.assertAddsMessages(
testutils.Message(
msg_id='import-only-modules',
node=importfrom_node5,
args=('invalid_module', 'os')
),
):
checker_test_object.checker.visit_importfrom(importfrom_node5)
importfrom_node6 = astroid.extract_node("""
from .constants import constants #@
""", module_name='.constants')
with checker_test_object.assertNoMessages():
checker_test_object.checker.visit_importfrom(importfrom_node6)
def test_checks_single_char_and_newline_eof(self):
checker_test_object = testutils.CheckerTestCase()
checker_test_object.CHECKER_CLASS = (
pylint_extensions.SingleCharAndNewlineAtEOFChecker)
checker_test_object.setup_method()
node_missing_newline_at_eof = astroid.scoped_nodes.Module(
name='test', doc='Custom test')
temp_file = tempfile.NamedTemporaryFile()
filename = temp_file.name
with python_utils.open_file(filename, 'w') as tmp:
tmp.write(u"""c = 'something dummy'
""")
node_missing_newline_at_eof.file = filename
node_missing_newline_at_eof.path = filename
checker_test_object.checker.process_module(node_missing_newline_at_eof)
with checker_test_object.assertAddsMessages(
testutils.Message(msg_id='newline-at-eof', line=2), ):
temp_file.close()
node_single_char_file = astroid.scoped_nodes.Module(name='test',
doc='Custom test')
temp_file = tempfile.NamedTemporaryFile()
filename = temp_file.name
with python_utils.open_file(filename, 'w') as tmp:
tmp.write(u"""1""")
node_single_char_file.file = filename
node_single_char_file.path = filename
checker_test_object.checker.process_module(node_single_char_file)
with checker_test_object.assertAddsMessages(
testutils.Message(msg_id='only-one-character', line=1), ):
temp_file.close()
node_with_no_error_message = astroid.scoped_nodes.Module(
name='test', doc='Custom test')
temp_file = tempfile.NamedTemporaryFile()
filename = temp_file.name
with python_utils.open_file(filename, 'w') as tmp:
tmp.write(u"""x = 'something dummy'""")
node_with_no_error_message.file = filename
node_with_no_error_message.path = filename
checker_test_object.checker.process_module(node_with_no_error_message)
with checker_test_object.assertNoMessages():
temp_file.close()
def test_finds_hanging_indent(self):
checker_test_object = testutils.CheckerTestCase()
checker_test_object.CHECKER_CLASS = (
pylint_extensions.HangingIndentChecker)
checker_test_object.setup_method()
node_break_after_hanging_indent = astroid.scoped_nodes.Module(
name='test',
doc='Custom test')
temp_file = tempfile.NamedTemporaryFile()
filename = temp_file.name
with open(filename, 'w') as tmp:
tmp.write(
"""self.post_json('/ml/trainedclassifierhandler',
self.payload, expect_errors=True, expected_status_int=401)
""")
node_break_after_hanging_indent.file = filename
node_break_after_hanging_indent.path = filename
checker_test_object.checker.process_module(
node_break_after_hanging_indent)
with checker_test_object.assertAddsMessages(
testutils.Message(
msg_id='no-break-after-hanging-indent',
line=1
),
):
temp_file.close()
node_no_err_message = astroid.scoped_nodes.Module(
name='test',
doc='Custom test')
temp_file = tempfile.NamedTemporaryFile()
filename = temp_file.name
with open(filename, 'w') as tmp:
tmp.write(
"""master_translation_dict = json.loads(
utils.get_file_contents(os.path.join(
os.getcwd(), 'assets', 'i18n', 'en.json')))
""")
node_no_err_message.file = filename
node_no_err_message.path = filename
checker_test_object.checker.process_module(node_no_err_message)
with checker_test_object.assertNoMessages():
temp_file.close()
def test_finds_docstring_parameter(self):
checker_test_object = testutils.CheckerTestCase()
checker_test_object.CHECKER_CLASS = (
custom_lint_checks.DocstringParameterChecker)
checker_test_object.setup_method()
func_node = astroid.extract_node("""
def test(test_var_one, test_var_two): #@
\"\"\"Function to test docstring parameters.
Args:
test_var_one: int. First test variable.
test_var_two: str. Second test variable.
Returns:
int. The test result.
\"\"\"
result = test_var_one + test_var_two
return result
""")
with checker_test_object.assertNoMessages():
checker_test_object.checker.visit_functiondef(func_node)
def test_detect_restricted_import(self):
checker_test_object = testutils.CheckerTestCase()
checker_test_object.CHECKER_CLASS = (
pylint_extensions.RestrictedImportChecker)
checker_test_object.setup_method()
# Tests the case wherein storage layer imports domain layer
# in import statements.
node_err_import = astroid.extract_node("""
import core.domain.activity_domain #@
""")
node_err_import.root().name = 'oppia.core.storage.topic'
with checker_test_object.assertAddsMessages(
testutils.Message(
msg_id='invalid-import',
node=node_err_import,
args=('domain', 'storage'),
), ):
checker_test_object.checker.visit_import(node_err_import)
# Tests the case wherein storage layer does not import domain layer
# in import statements.
node_no_err_import = astroid.extract_node("""
import core.platform.email.gae_email_services #@
""")
node_no_err_import.root().name = 'oppia.core.storage.topic'
with checker_test_object.assertNoMessages():
checker_test_object.checker.visit_import(node_no_err_import)
# Tests the case wherein storage layer imports domain layer
# in import-from statements.
node_err_importfrom = astroid.extract_node("""
from core.domain import activity_domain #@
""")
node_err_importfrom.root().name = 'oppia.core.storage.topic'
with checker_test_object.assertAddsMessages(
testutils.Message(
msg_id='invalid-import',
node=node_err_importfrom,
args=('domain', 'storage'),
)):
checker_test_object.checker.visit_importfrom(node_err_importfrom)
# Tests the case wherein storage layer does not import domain layer
# in import-from statements.
node_no_err_importfrom = astroid.extract_node("""
from core.platform.email import gae_email_services #@
""")
node_no_err_importfrom.root().name = 'oppia.core.storage.topicl'
with checker_test_object.assertNoMessages():
checker_test_object.checker.visit_importfrom(
node_no_err_importfrom)
# Tests the case wherein domain layer imports controller layer
# in import statements.
node_err_import = astroid.extract_node("""
import core.controllers.acl_decorators #@
""")
node_err_import.root().name = 'oppia.core.domain'
with checker_test_object.assertAddsMessages(
testutils.Message(
msg_id='invalid-import',
node=node_err_import,
args=('controller', 'domain'),
), ):
checker_test_object.checker.visit_import(node_err_import)
# Tests the case wherein domain layer does not import controller layer
# in import statements.
node_no_err_import = astroid.extract_node("""
import core.platform.email.gae_email_services_test #@
""")
node_no_err_import.root().name = 'oppia.core.domain'
with checker_test_object.assertNoMessages():
checker_test_object.checker.visit_import(node_no_err_import)
# Tests the case wherein domain layer imports controller layer
# in import-from statements.
node_err_importfrom = astroid.extract_node("""
from core.controllers import acl_decorators #@
""")
node_err_importfrom.root().name = 'oppia.core.domain'
with checker_test_object.assertAddsMessages(
testutils.Message(
msg_id='invalid-import',
node=node_err_importfrom,
args=('controller', 'domain'),
)):
checker_test_object.checker.visit_importfrom(node_err_importfrom)
# Tests the case wherein domain layer does not import controller layer
# in import-from statements.
node_no_err_importfrom = astroid.extract_node("""
from core.platform.email import gae_email_services_test #@
""")
node_no_err_importfrom.root().name = 'oppia.core.domain'
with checker_test_object.assertNoMessages():
checker_test_object.checker.visit_importfrom(
node_no_err_importfrom)
def test_finds_docstring_parameter(self):
self.checker_test_object = testutils.CheckerTestCase()
self.checker_test_object.CHECKER_CLASS = (
pylint_extensions.DocstringParameterChecker)
self.checker_test_object.setup_method()
valid_func_node, valid_return_node = astroid.extract_node("""
def test(test_var_one, test_var_two): #@
\"\"\"Function to test docstring parameters.
Args:
test_var_one: int. First test variable.
test_var_two: str. Second test variable.
Returns:
int. The test result.
\"\"\"
result = test_var_one + test_var_two
return result #@
""")
with self.checker_test_object.assertNoMessages():
self.checker_test_object.checker.visit_functiondef(valid_func_node)
with self.checker_test_object.assertNoMessages():
self.checker_test_object.checker.visit_return(valid_return_node)
valid_func_node, valid_yield_node = astroid.extract_node("""
def test(test_var_one, test_var_two): #@
\"\"\"Function to test docstring parameters.\"\"\"
result = test_var_one + test_var_two
yield result #@
""")
with self.checker_test_object.assertNoMessages():
self.checker_test_object.checker.visit_functiondef(valid_func_node)
with self.checker_test_object.assertNoMessages():
self.checker_test_object.checker.visit_yield(valid_yield_node)
with self.checker_test_object.assertNoMessages():
self.checker_test_object.checker.visit_return(valid_yield_node)
(missing_yield_type_func_node,
missing_yield_type_yield_node) = astroid.extract_node("""
class Test(python_utils.OBJECT):
def __init__(self, test_var_one, test_var_two): #@
\"\"\"Function to test docstring parameters.
Args:
test_var_one: int. First test variable.
test_var_two: str. Second test variable.
Returns:
int. The test result.
\"\"\"
result = test_var_one + test_var_two
yield result #@
""")
with self.checker_test_object.assertAddsMessages(
testutils.Message(msg_id='redundant-returns-doc',
node=missing_yield_type_func_node), ):
self.checker_test_object.checker.visit_functiondef(
missing_yield_type_func_node)
with self.checker_test_object.assertAddsMessages(
testutils.Message(msg_id='missing-yield-doc',
node=missing_yield_type_func_node),
testutils.Message(msg_id='missing-yield-type-doc',
node=missing_yield_type_func_node),
):
self.checker_test_object.checker.visit_yieldfrom(
missing_yield_type_yield_node)
with self.checker_test_object.assertNoMessages():
self.checker_test_object.checker.visit_return(
missing_yield_type_yield_node)
(missing_return_type_func_node,
missing_return_type_return_node) = astroid.extract_node("""
class Test(python_utils.OBJECT):
def __init__(self, test_var_one, test_var_two): #@
\"\"\"Function to test docstring parameters.
Args:
test_var_one: int. First test variable.
test_var_two: str. Second test variable.
Yields:
int. The test result.
\"\"\"
result = test_var_one + test_var_two
return result #@
""")
with self.checker_test_object.assertAddsMessages(
testutils.Message(msg_id='redundant-yields-doc',
node=missing_return_type_func_node), ):
self.checker_test_object.checker.visit_functiondef(
missing_return_type_func_node)
with self.checker_test_object.assertAddsMessages(
testutils.Message(msg_id='missing-return-doc',
node=missing_return_type_func_node),
testutils.Message(msg_id='missing-return-type-doc',
node=missing_return_type_func_node),
):
self.checker_test_object.checker.visit_return(
missing_return_type_return_node)
with self.checker_test_object.assertNoMessages():
self.checker_test_object.checker.visit_yield(
missing_return_type_return_node)
valid_raise_node = astroid.extract_node("""
def func(test_var_one, test_var_two):
\"\"\"Function to test docstring parameters.
Args:
test_var_one: int. First test variable.
test_var_two: str. Second test variable.
Raises:
Exception: An exception.
\"\"\"
raise Exception #@
""")
with self.checker_test_object.assertNoMessages():
self.checker_test_object.checker.visit_raise(valid_raise_node)
(missing_raise_type_func_node,
missing_raise_type_raise_node) = astroid.extract_node("""
def func(test_var_one, test_var_two): #@
\"\"\"Function to test raising exceptions.
Args:
test_var_one: int. First test variable.
test_var_two: str. Second test variable.
\"\"\"
raise Exception #@
""")
with self.checker_test_object.assertAddsMessages(
testutils.Message(msg_id='missing-raises-doc',
args=('Exception', ),
node=missing_raise_type_func_node), ):
self.checker_test_object.checker.visit_raise(
missing_raise_type_raise_node)
valid_raise_node = astroid.extract_node("""
class Test(python_utils.OBJECT):
raise Exception #@
""")
with self.checker_test_object.assertNoMessages():
self.checker_test_object.checker.visit_raise(valid_raise_node)
valid_raise_node = astroid.extract_node("""
class Test():
@property
def decorator_func(self):
pass
@decorator_func.setter
@property
def func(self):
raise Exception #@
""")
with self.checker_test_object.assertNoMessages():
self.checker_test_object.checker.visit_raise(valid_raise_node)
valid_raise_node = astroid.extract_node("""
class Test():
def func(self):
raise Exception #@
""")
with self.checker_test_object.assertNoMessages():
self.checker_test_object.checker.visit_raise(valid_raise_node)
valid_raise_node = astroid.extract_node("""
def func():
try:
raise Exception #@
except Exception:
pass
""")
with self.checker_test_object.assertNoMessages():
self.checker_test_object.checker.visit_raise(valid_raise_node)
valid_raise_node = astroid.extract_node("""
def func():
\"\"\"Function to test raising exceptions.\"\"\"
raise Exception #@
""")
with self.checker_test_object.assertNoMessages():
self.checker_test_object.checker.visit_raise(valid_raise_node)
valid_raise_node = astroid.extract_node("""
def my_func(self):
\"\"\"This is a docstring.
:raises NameError: Never.
\"\"\"
def ex_func(val):
return RuntimeError(val)
raise ex_func('hi') #@
raise NameError('hi')
""")
with self.checker_test_object.assertNoMessages():
self.checker_test_object.checker.visit_raise(valid_raise_node)
valid_raise_node = astroid.extract_node("""
from unknown import Unknown
def my_func(self):
\"\"\"This is a docstring.
:raises NameError: Never.
\"\"\"
raise Unknown('hi') #@
raise NameError('hi')
""")
with self.checker_test_object.assertNoMessages():
self.checker_test_object.checker.visit_raise(valid_raise_node)
valid_raise_node = astroid.extract_node("""
def my_func(self):
\"\"\"This is a docstring.
:raises NameError: Never.
\"\"\"
def ex_func(val):
def inner_func(value):
return OSError(value)
return RuntimeError(val)
raise ex_func('hi') #@
raise NameError('hi')
""")
with self.checker_test_object.assertNoMessages():
self.checker_test_object.checker.visit_raise(valid_raise_node)
valid_return_node = astroid.extract_node("""
def func():
\"\"\"Function to test return values.\"\"\"
return None #@
""")
with self.checker_test_object.assertNoMessages():
self.checker_test_object.checker.visit_return(valid_return_node)
valid_return_node = astroid.extract_node("""
def func():
\"\"\"Function to test return values.\"\"\"
return #@
""")
with self.checker_test_object.assertNoMessages():
self.checker_test_object.checker.visit_return(valid_return_node)
missing_param_func_node = astroid.extract_node("""
def func(test_var_one, test_var_two, *args, **kwargs): #@
\"\"\"Function to test docstring parameters.
Args:
test_var_one: int. First test variable.
test_var_two: str. Second test variable.
Returns:
int. The test result.
\"\"\"
result = test_var_one + test_var_two
return result
""")
with self.checker_test_object.assertAddsMessages(
testutils.Message(
msg_id='missing-param-doc',
node=missing_param_func_node,
args=('args, kwargs', ),
), ):
self.checker_test_object.checker.visit_functiondef(
missing_param_func_node)
missing_param_func_node = astroid.extract_node("""
def func(test_var_one, test_var_two): #@
\"\"\"Function to test docstring parameters.
Args:
test_var_one: int. First test variable.
invalid_var_name: str. Second test variable.
Returns:
int. The test result.
\"\"\"
result = test_var_one + test_var_two
return result
""")
with self.checker_test_object.assertAddsMessages(
testutils.Message(
msg_id='missing-param-doc',
node=missing_param_func_node,
args=('test_var_two', ),
),
testutils.Message(
msg_id='missing-type-doc',
node=missing_param_func_node,
args=('test_var_two', ),
),
testutils.Message(
msg_id='differing-param-doc',
node=missing_param_func_node,
args=('invalid_var_name', ),
),
testutils.Message(
msg_id='differing-type-doc',
node=missing_param_func_node,
args=('invalid_var_name', ),
),
):
self.checker_test_object.checker.visit_functiondef(
missing_param_func_node)
class_node, multiple_constructor_func_node = astroid.extract_node("""
class Test(): #@
\"\"\"Function to test docstring parameters.
Args:
test_var_one: int. First test variable.
test_var_two: str. Second test variable.
Returns:
int. The test result.
\"\"\"
def __init__(self, test_var_one, test_var_two): #@
\"\"\"Function to test docstring parameters.
Args:
test_var_one: int. First test variable.
test_var_two: str. Second test variable.
Returns:
int. The test result.
\"\"\"
result = test_var_one + test_var_two
return result
""")
with self.checker_test_object.assertAddsMessages(
testutils.Message(
msg_id='multiple-constructor-doc',
node=class_node,
args=(class_node.name, ),
), ):
self.checker_test_object.checker.visit_functiondef(
multiple_constructor_func_node)
def setUp(self):
super(DocstringParameterCheckerTests, self).setUp()
self.checker_test_object = testutils.CheckerTestCase()
self.checker_test_object.CHECKER_CLASS = (
pylint_extensions.DocstringParameterChecker)
self.checker_test_object.setup_method()
def setUp(self):
super(SingleSpaceAfterYieldTests, self).setUp()
self.checker_test_object = testutils.CheckerTestCase()
self.checker_test_object.CHECKER_CLASS = (
pylint_extensions.SingleSpaceAfterYieldChecker)
self.checker_test_object.setup_method()
def test_checks_excessive_empty_lines(self):
checker_test_object = testutils.CheckerTestCase()
checker_test_object.CHECKER_CLASS = (
pylint_extensions.ExcessiveEmptyLinesChecker)
checker_test_object.setup_method()
node_excessive_empty_lines = astroid.scoped_nodes.Module(
name='test',
doc='Custom test')
temp_file = tempfile.NamedTemporaryFile()
filename = temp_file.name
with python_utils.open_file(filename, 'w') as tmp:
tmp.write(
u"""def func1():
returns_something
def func2():
returns_something
""")
node_excessive_empty_lines.file = filename
node_excessive_empty_lines.path = filename
checker_test_object.checker.process_module(node_excessive_empty_lines)
with checker_test_object.assertAddsMessages(
testutils.Message(
msg_id='excessive-new-lines',
line=5
),
):
temp_file.close()
node_method_with_decorator = astroid.scoped_nodes.Module(
name='test',
doc='Custom test')
temp_file = tempfile.NamedTemporaryFile()
filename = temp_file.name
with python_utils.open_file(filename, 'w') as tmp:
tmp.write(
u"""def func0():
returns_something
@something
def func1():
returns_something
""")
node_method_with_decorator.file = filename
node_method_with_decorator.path = filename
checker_test_object.checker.process_module(node_method_with_decorator)
with checker_test_object.assertAddsMessages(
testutils.Message(
msg_id='excessive-new-lines',
line=5
),
):
temp_file.close()
node_with_no_error_message = astroid.scoped_nodes.Module(
name='test',
doc='Custom test')
temp_file = tempfile.NamedTemporaryFile()
filename = temp_file.name
with python_utils.open_file(filename, 'w') as tmp:
tmp.write(
u"""def func0():
returns_something
def func1():
returns_something
def func2():
returns_something
@something
def func3():
returns_something
""")
node_with_no_error_message.file = filename
node_with_no_error_message.path = filename
checker_test_object.checker.process_module(node_with_no_error_message)
with checker_test_object.assertNoMessages():
temp_file.close()
def setUp(self):
super(HttpRequestCheckerTests, self).setUp()
self.checker_test_object = testutils.CheckerTestCase()
self.checker_test_object.CHECKER_CLASS = (
pylint_extensions.HttpRequestChecker)
self.checker_test_object.setup_method()
