Skip to content

pycodestyle

read_payload(payload)

Transform a pycodestyle payload to a list of FileReport instances.

This function can be used with flake8 and other tools that emit similar output.

Parameters:

Name Type Description Default
payload str

The raw payload from pycodestyle.

 required

Returns:

Type Description
OneOf[Issue, List[FileReport]]

A OneOf containing an Issue or a list of FileReport instances.
Source code in m/ci/celt/post_processors/pycodestyle.py 
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
def read_payload(payload: str) -> OneOf[Issue, List[FileReport]]:
    """Transform a pycodestyle payload to a list of `FileReport` instances.

    This function can be used with flake8 and other tools that emit similar
    output.

    Args:
        payload: The raw payload from pycodestyle.

    Returns:
        A `OneOf` containing an `Issue` or a list of `FileReport` instances.
    """
    regex = r'(.*):(\d+):(\d+): (\w+) (.*)'
    report: Dict[str, List[Violation]] = {}
    for line in payload.splitlines():
        match = re.match(regex, line)
        if match:
            group = match.groups()
            violation = Violation(
                file_path=group[0],
                line=int(group[1]),
                column=int(group[2]),
                rule_id=group[3],
                message=group[4],
            )
            if violation.file_path not in report:
                report[violation.file_path] = []
            report[violation.file_path].append(violation)
    return Good([
        FileReport(file_path=name, violations=violations)
        for name, violations in report.items()
    ])