Read the guideline before starting.
The flake8 linter gives the following error report when checking a directory with source code files:
errors = {
"./test_source_code_2.py": [],
"./source_code_2.py": [
{
"code": "E501",
"filename": "./source_code_2.py",
"line_number": 18,
"column_number": 80,
"text": "line too long (99 > 79 characters)",
"physical_line": ' return f"I like to filter, rounding, doubling, '
"store and decorate numbers: {', '.join(items)}!\"",
},
{
"code": "W292",
"filename": "./source_code_2.py",
"line_number": 18,
"column_number": 100,
"text": "no newline at end of file",
"physical_line": ' return f"I like to filter, rounding, doubling, '
"store and decorate numbers: {', '.join(items)}!\"",
},
],
"./source_code_1.py": [
{
"code": "E702",
"filename": "./source_code_1.py",
"line_number": 3,
"column_number": 74,
"text": "multiple statements on one line (semicolon)",
"physical_line": ' new_items = [f"{key} -> {value}" for key, '
"value in items.items()]; return func(new_items)\n",
},
{
"code": "E501",
"filename": "./source_code_1.py",
"line_number": 3,
"column_number": 80,
"text": "line too long (97 > 79 characters)",
"physical_line": ' new_items = [f"{key} -> {value}" for key, '
"value in items.items()]; return func(new_items)\n",
},
{
"code": "E302",
"filename": "./source_code_1.py",
"line_number": 15,
"column_number": 1,
"text": "expected 2 blank lines, found 1",
"physical_line": "def number_filter(func):\n",
},
{
"code": "E303",
"filename": "./source_code_1.py",
"line_number": 27,
"column_number": 1,
"text": "too many blank lines (6)",
"physical_line": "@number_filter\n",
},
{
"code": "E501",
"filename": "./source_code_1.py",
"line_number": 31,
"column_number": 80,
"text": "line too long (99 > 79 characters)",
"physical_line": ' return f"I like to filter, rounding, doubling, '
"store and decorate numbers: {', '.join(items)}!\"\n",
},
],
"./test_source_code_1.py": [
{
"code": "E302",
"filename": "./test_source_code_1.py",
"line_number": 4,
"column_number": 1,
"text": "expected 2 blank lines, found 1",
"physical_line": "@pytest.mark.parametrize(\n",
},
{
"code": "E501",
"filename": "./test_source_code_1.py",
"line_number": 32,
"column_number": 80,
"text": "line too long (84 > 79 characters)",
"physical_line": ' "decorate numbers: 1 -> 2, 2 -> 4, 6 -> 12, -111 -> -222, -50 -> -100!",\n',
},
{
"code": "W292",
"filename": "./test_source_code_1.py",
"line_number": 112,
"column_number": 6,
"text": "no newline at end of file",
"physical_line": " )",
},
],
}Here errors is a dictionary, where the keys are the path to the file,
and the value of this key is a list of errors, where each is a dictionary.
But we store the execution results in a slightly different format. Write 3 functions to convert the report into the format we need:
format_linter_error- formats a single error:
error = {
"code": "E501",
"filename": "./source_code_2.py",
"line_number": 18,
"column_number": 80,
"text": "line too long (99 > 79 characters)",
"physical_line": ' return f"I like to filter, rounding, doubling, '
"store and decorate numbers: {', '.join(items)}!\"",
}
print(format_linter_error(error=error))
# The output will be:
{
"line": 18,
"column": 80,
"message": "line too long (99 > 79 characters)",
"name": "E501",
"source": "flake8"
}format_single_linter_file- formats all errors for a particular file and adds thepathkey — path to the file, and thestatuskey — "failed" if there are errors, "passed" if there are no errors:
errors = [
{
"code": "E501",
"filename": "./source_code_2.py",
"line_number": 18,
"column_number": 80,
"text": "line too long (99 > 79 characters)",
"physical_line": ' return f"I like to filter, rounding, doubling, '
"store and decorate numbers: {', '.join(items)}!\"",
},
{
"code": "W292",
"filename": "./source_code_2.py",
"line_number": 18,
"column_number": 100,
"text": "no newline at end of file",
"physical_line": ' return f"I like to filter, rounding, doubling, '
"store and decorate numbers: {', '.join(items)}!\"",
},
]
print(format_single_linter_file(file_path="./source_code_2.py", errors=errors))
# The output will be:
{
"errors":
[
{
"line": 18,
"column": 80,
"message": "line too long (99 > 79 characters)",
"name": "E501",
"source": "flake8"
},
{
"line": 18,
"column": 100,
"message": "no newline at end of file",
"name": "W292",
"source": "flake8"
}
],
"path": "./source_code_2.py",
"status": "failed"
}format_linter_report- formats all errors for all report files:
report_file = {
"./test_source_code_2.py": [],
"./source_code_2.py":
[
{
"code": "E501",
"filename": "./source_code_2.py",
"line_number": 18,
"column_number": 80,
"text": "line too long (99 > 79 characters)",
"physical_line": ' return f"I like to filter, rounding, doubling, '
"store and decorate numbers: {', '.join(items)}!\"",
},
{
"code": "W292",
"filename": "./source_code_2.py",
"line_number": 18,
"column_number": 100,
"text": "no newline at end of file",
"physical_line": ' return f"I like to filter, rounding, doubling, '
"store and decorate numbers: {', '.join(items)}!\"",
},
]
}
print(format_linter_report(linter_report=report_file))
# The output will be:
[
{
"errors": [],
"path": "./test_source_code_2.py",
"status": "passed"
},
{
"errors":
[
{
"line": 18,
"column": 80,
"message": "line too long (99 > 79 characters)",
"name": "E501",
"source": "flake8"
},
{
"line": 18,
"column": 100,
"message": "no newline at end of file",
"name": "W292",
"source": "flake8"
}
],
"path": "./source_code_2.py",
"status": "failed"
}
]All functions must contain only the return keyword.
Required storage format:
errors = [
{"errors": [], "path": "./test_source_code_2.py", "status": "passed"},
{
"errors": [
{
"line": 18,
"column": 80,
"message": "line too long (99 > 79 characters)",
"name": "E501",
"source": "flake8",
},
{
"line": 18,
"column": 100,
"message": "no newline at end of file",
"name": "W292",
"source": "flake8",
},
],
"path": "./source_code_2.py",
"status": "failed",
},
{
"errors": [
{
"line": 3,
"column": 74,
"message": "multiple statements on one line (semicolon)",
"name": "E702",
"source": "flake8",
},
{
"line": 3,
"column": 80,
"message": "line too long (97 > 79 characters)",
"name": "E501",
"source": "flake8",
},
{
"line": 15,
"column": 1,
"message": "expected 2 blank lines, found 1",
"name": "E302",
"source": "flake8",
},
{
"line": 27,
"column": 1,
"message": "too many blank lines (6)",
"name": "E303",
"source": "flake8",
},
{
"line": 31,
"column": 80,
"message": "line too long (99 > 79 characters)",
"name": "E501",
"source": "flake8",
},
],
"path": "./source_code_1.py",
"status": "failed",
},
{
"errors": [
{
"line": 4,
"column": 1,
"message": "expected 2 blank lines, found 1",
"name": "E302",
"source": "flake8",
},
{
"line": 32,
"column": 80,
"message": "line too long (84 > 79 characters)",
"name": "E501",
"source": "flake8",
},
{
"line": 112,
"column": 6,
"message": "no newline at end of file",
"name": "W292",
"source": "flake8",
},
],
"path": "./test_source_code_1.py",
"status": "failed",
},
]