Skip to content

add rule metadata to results set #940

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

Closed
clavedeluna wants to merge 1 commit into from
Closed

add rule metadata to results set #940

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
28 changes: 22 additions & 6 deletions src/codemodder/result.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@
from libcst._position import CodeRange
from typing_extensions import Self

from codemodder.codetf import Finding, Rule
from codemodder.codetf import Finding
from codemodder.codetf import Rule as CodetfRule

from .utils.abc_dataclass import ABCDataclass

Expand Down Expand Up @@ -176,18 +177,33 @@ def fuzzy_column_match(pos: CodeRange, location: Location) -> bool:
)


class ResultSet(dict[str, dict[Path, list[Result]]]):
results_for_rule: dict[str, list[Result]]
class Rule(CodetfRule):
Copy link
Member

@drdavella drdavella Dec 4, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@clavedeluna what if instead of being prescriptive about the specific metadata fields here, we instead add a field with an abstract type that conforms to some API like get_metadata_summary() -> str and allow each tool to define the way they want to present it?

I also don't want to overengineer this without having a lot of examples to work with.

short_description: str = ""
full_description: str = ""
help: str = ""


def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.results_for_rule = {}
class ResultSet(dict[str, dict[Path, list[Result]]]):
results_for_rule: dict[str, list[Result]] = {}
metadata_for_rule: dict[str, list[Rule]] = {}

def add_result(self, result: Result):
self.results_for_rule.setdefault(result.rule_id, []).append(result)
for loc in result.locations:
self.setdefault(result.rule_id, {}).setdefault(loc.file, []).append(result)

def add_rule_metadata(self, rule_data: dict):
if (rule_id := rule_data["id"]) not in self.metadata_for_rule:
rule = Rule(
id=rule_id,
name=rule_data["name"],
short_description=rule_data.get("shortDescription", {}).get("text", ""),
full_description=rule_data.get("fullDescription", {}).get("text", ""),
help=rule_data.get("help", {}).get("text", "")
or rule_data.get("help", {}).get("markdown", ""),
)
self.metadata_for_rule[rule_id] = rule

def results_for_rule_and_file(
self, context: CodemodExecutionContext, rule_id: str, file: Path
) -> list[Result]:
Expand Down
Loading