wehub-resource-sync
35 lines
1.0 KiB
Python
35 lines
1.0 KiB
Python
from pathlib import Path
|
|
|
|
from clint.config import Config
|
|
from clint.index import SymbolIndex
|
|
from clint.linter import Position, Range, lint_file
|
|
from clint.rules.extraneous_docstring_param import ExtraneousDocstringParam
|
|
|
|
|
|
def test_extraneous_docstring_param(index: SymbolIndex) -> None:
|
|
code = '''
|
|
def bad_function(param1: str) -> None:
|
|
"""
|
|
Example function docstring.
|
|
|
|
Args:
|
|
param1: First parameter
|
|
param2: This parameter doesn't exist in function signature
|
|
param3: Another non-existent parameter
|
|
"""
|
|
|
|
def good_function(param1: str, param2: int) -> None:
|
|
"""
|
|
Good function with matching parameters.
|
|
|
|
Args:
|
|
param1: First parameter
|
|
param2: Second parameter
|
|
"""
|
|
'''
|
|
config = Config(select={ExtraneousDocstringParam.name})
|
|
violations = lint_file(Path("test.py"), code, config, index)
|
|
assert len(violations) == 1
|
|
assert all(isinstance(v.rule, ExtraneousDocstringParam) for v in violations)
|
|
assert violations[0].range == Range(Position(1, 0))
|