orchestrata_tools.reviewer.models

Reference › orchestrata_tools › reviewer › models

This module holds the result types shared by the two review engines, code_reviewer and test_reviewer. Severity is a string enum with critical, high, medium, low and info. Issue records a rule name, message, severity, a location such as module.class.method, and a suggestion. ReviewReport collects the issues for one target: add appends an issue and increments a per-rule count in summary, and by_severity groups issues into a dictionary keyed by severity value.

At a glance

Class diagram

Dependency diagram

API

Classes

Severity (enum)

Bases: StrEnum · Line 9

Issue (dataclass)

Decorators: dataclass · Line 18

A single review issue.

ReviewReport (dataclass)

Decorators: dataclass · Line 29

Aggregate review report.

Source

Permalink: https://gitlab.com/MSamy/orchestrata-ultimate-architecture/-/blob/a4cbc2bdf/src/orchestrata_tools/reviewer/models.py

"""Shared models for review engines."""

from __future__ import annotations

from dataclasses import dataclass, field
from enum import StrEnum


class Severity(StrEnum):
    CRITICAL = "critical"
    HIGH = "high"
    MEDIUM = "medium"
    LOW = "low"
    INFO = "info"


@dataclass
class Issue:
    """A single review issue."""

    rule: str
    message: str
    severity: Severity
    location: str = ""  # e.g. "module.class.method"
    suggestion: str = ""


@dataclass
class ReviewReport:
    """Aggregate review report."""

    target: str = ""
    issues: list[Issue] = field(default_factory=list)
    summary: dict[str, int] = field(default_factory=dict)

    def by_severity(self) -> dict[str, list[Issue]]:
        result: dict[str, list[Issue]] = {
            "critical": [],
            "high": [],
            "medium": [],
            "low": [],
            "info": [],
        }
        for issue in self.issues:
            result[issue.severity.value].append(issue)
        return result

    def add(self, issue: Issue) -> None:
        self.issues.append(issue)
        self.summary[issue.rule] = self.summary.get(issue.rule, 0) + 1