Skip to content
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.

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

implement formatter functions to py-linter-formatter #1906

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
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
46 changes: 40 additions & 6 deletions app/main.py
Original file line number Diff line number Diff line change
@@ -1,13 +1,47 @@
def format_linter_error(error: dict) -> dict:
# write your code here
pass

return {
"line": error["line_number"],
"column": error["column_number"],
"message": error["text"],
"name": error["code"],
"source": "flake8"
}


def format_single_linter_file(file_path: str, errors: list) -> dict:
# write your code here
pass

return {
"errors":
[
{
"line": err_single_file["line_number"],
"column": err_single_file["column_number"],
"message": err_single_file["text"],
"name": err_single_file["code"],
"source": "flake8"
} for err_single_file in errors
Comment on lines +15 to +23

Choose a reason for hiding this comment

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

The logic for formatting errors in format_single_linter_file is similar to the one in format_linter_report. Consider refactoring this logic into a separate function to avoid redundancy and improve maintainability.


],
"path": file_path,
"status": "failed" if errors else "passed"
}


def format_linter_report(linter_report: dict) -> list:
# write your code here
pass

return [
{
"errors": [
{
"line": single_error["line_number"],
"column": single_error["column_number"],
"message": single_error["text"],
"name": single_error["code"],
"source": "flake8"
} for single_error in file_errors
Comment on lines +35 to +42

Choose a reason for hiding this comment

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

The error formatting logic here is repeated from format_single_linter_file. It would be beneficial to extract this into a helper function to reduce code duplication.

],
"path": file,
"status": "failed" if file_errors else "passed"
} for file, file_errors in linter_report.items()
]
Loading