Skip to content

types

Configuration dataclass

Options to control the output of the post processor.

Source code in m/ci/celt/core/types.py 
81
82
83
84
85
86
87
88
89
@dataclass
class Configuration:
    """Options to control the output of the post processor."""

    max_lines: int = 5
    full_message: bool = False
    ignore_error_allowance: bool = False
    file_regex: Optional[str] = None
    file_prefix: Optional[str] = None

ExitCode

Bases: Enum

One of the possible exit codes.

Source code in m/ci/celt/core/types.py 
 8
 9
10
11
12
13
class ExitCode(enum.Enum):
    """One of the possible exit codes."""

    ok = 0
    error = 1
    needs_readjustment = 2

FileReport dataclass

Collection of violations triggered in a single file.

Source code in m/ci/celt/core/types.py 
27
28
29
30
31
32
@dataclass
class FileReport:
    """Collection of violations triggered in a single file."""

    file_path: str
    violations: List[Violation]

ProjectStatus dataclass

Overview of a project.

Source code in m/ci/celt/core/types.py 
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
@dataclass
class ProjectStatus:
    """Overview of a project."""

    status: ExitCode
    payload: str
    rules: Dict[str, RuleInfo]
    files: Dict[str, List[Violation]]
    total_found: int = field(init=False)
    total_allowed: int = field(init=False)
    error_msg: str = field(init=False)

    def __post_init__(self):
        """Compute the rest of non initialized variables."""
        rules = self.rules.values()
        total_found = sum((s.found for s in rules if not s.ignored))
        total_allowed = sum((s.allowed for s in rules if not s.ignored))
        error_msg = ''
        if self.status == ExitCode.error:
            diff = sum((
                d
                for s in rules
                for d in (s.found - s.allowed,)
                if d > 0 and not s.ignored
            ))
            error_msg = f'{diff} extra errors were introduced'
        elif self.status == ExitCode.needs_readjustment:
            diff = total_allowed - total_found
            error_msg = f'{diff} errors were removed - lower error allowance'

        self.total_found = total_found  # noqa: WPS601
        self.total_allowed = total_allowed  # noqa: WPS601
        self.error_msg = error_msg  # noqa: WPS601

__post_init__()

Compute the rest of non initialized variables.

Source code in m/ci/celt/core/types.py 
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
def __post_init__(self):
    """Compute the rest of non initialized variables."""
    rules = self.rules.values()
    total_found = sum((s.found for s in rules if not s.ignored))
    total_allowed = sum((s.allowed for s in rules if not s.ignored))
    error_msg = ''
    if self.status == ExitCode.error:
        diff = sum((
            d
            for s in rules
            for d in (s.found - s.allowed,)
            if d > 0 and not s.ignored
        ))
        error_msg = f'{diff} extra errors were introduced'
    elif self.status == ExitCode.needs_readjustment:
        diff = total_allowed - total_found
        error_msg = f'{diff} errors were removed - lower error allowance'

    self.total_found = total_found  # noqa: WPS601
    self.total_allowed = total_allowed  # noqa: WPS601
    self.error_msg = error_msg  # noqa: WPS601

RuleInfo dataclass

Stats on a rule.

Source code in m/ci/celt/core/types.py 
35
36
37
38
39
40
41
42
43
@dataclass
class RuleInfo:
    """Stats on a rule."""

    rule_id: str
    violations: List[Violation]
    found: int
    allowed: int = 0
    ignored: bool = False

Violation dataclass

An error/warning/message provided by a compiler or linter.

Source code in m/ci/celt/core/types.py 
16
17
18
19
20
21
22
23
24
@dataclass
class Violation:
    """An error/warning/message provided by a compiler or linter."""

    rule_id: str
    message: str
    line: int
    column: int
    file_path: str