Skip to content

feat(version-scanner): implement targeted namespaced ignore pragmas #17540

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
chalmerlowe wants to merge 1 commit into
base: feat/version-scanner-pr2
Choose a base branch
from
+38 −1
Draft

feat(version-scanner): implement targeted namespaced ignore pragmas #17540

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions scripts/version_scanner/tests/unit/test_version_scanner.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,38 @@ def test_scan_file_ignores_pragma(tmp_path):
results = scan_file(str(test_file), rules)
assert len(results) == 0


def test_scan_file_ignores_targeted_pragma(tmp_path):
test_file = tmp_path / "test.py"
test_file.write_text("python_requires = '>=3.7' # version-scanner: ignore-rule=python_requires_check:3.7\n")

rules = [
{
"name": "python_requires_check",
"pattern": re.compile(r"python_requires\s*=\s*['\"]>=3\.7['\"]"),
"version": "3.7"
}
]

results = scan_file(str(test_file), rules)
assert len(results) == 0


def test_scan_file_does_not_ignore_mismatched_targeted_pragma(tmp_path):
test_file = tmp_path / "test.py"
test_file.write_text("python_requires = '>=3.7' # version-scanner: ignore-rule=python_requires_check:3.8\n")

rules = [
{
"name": "python_requires_check",
"pattern": re.compile(r"python_requires\s*=\s*['\"]>=3\.7['\"]"),
"version": "3.7"
}
]

results = scan_file(str(test_file), rules)
assert len(results) == 1

def test_scan_file_ignores_next_line(tmp_path):
test_file = tmp_path / "test.py"
test_file.write_text("# version-scanner: ignore-next-line\npython_requires = '>=3.7'\n")
Expand Down
7 changes: 6 additions & 1 deletion scripts/version_scanner/version_scanner.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,11 +214,16 @@ def scan_file(file_path: str, compiled_rules: List[Dict[str, re.Pattern]]) -> Li
if "version-scanner: ignore-next-line" in line:
skip_next = True
continue
if "version-scanner: ignore" in line:
if "version-scanner: ignore" in line and "version-scanner: ignore-rule" not in line and "version-scanner: ignore-next-line" not in line:
continue
for rule in compiled_rules:
match = rule["pattern"].search(line)
if match:
version = rule.get("version")
if version:
pragma_pattern = rf"version-scanner\s*:\s*ignore-rule\s*=\s*{re.escape(rule['name'])}\s*:\s*{re.escape(version)}"
if re.search(pragma_pattern, line, re.IGNORECASE):
continue
Comment thread
chalmerlowe marked this conversation as resolved.
results.append({
"rule_name": rule["name"],
"line_number": line_num,
Expand Down
Loading