Difficulty levels

README.md

@@ -106,6 +106,7 @@ Argument | Description
 **‑‑new-format**              |  the argument determines whether the tool should use the _new format_. _New format_ means separating the result by the files to allow getting quality and observed issues for each file separately. The default value is `False`.
 **‑‑history**                 |  JSON string with a list of issues for each language. For each issue its class and quantity are specified. Example: `--history "{\"python\": [{\"origin_class\": \"SC200\", \"number\": 20}, {\"origin_class\": \"WPS314\", \"number\": 3}]}"`
 **‑‑with‑all‑categories** | Without this flag, all issues will be categorized into 5 main categories: `CODE_STYLE`, `BEST_PRACTICES`, `ERROR_PRONE`, `COMPLEXITY`, `INFO`.
+**‑‑group‑by‑difficulty** | With this flag, the final grade and influence on penalty will be grouped by the issue difficulty.
 
 The output examples:
 
@@ -127,6 +128,7 @@ The output examples:
       "line_number": 54,
       "column_number": 0,
       "category": "FUNC_LEN",
+      "difficulty": "EASY",
       "influence_on_penalty": 0 
     },
     ...
@@ -157,6 +159,7 @@ The output examples:
           "line_number": 174,
           "column_number": 12,
           "category": "BEST_PRACTICES", 
+          "difficulty": "MEDIUM",
           "influence_on_penalty": 0 
         },
         ...

src/python/common/tool_arguments.py

@@ -82,6 +82,9 @@ class RunToolArgument(Enum):
                                         'Without this flag, all issues will be categorized into 5 main categories: '
                                         'CODE_STYLE, BEST_PRACTICES, ERROR_PRONE, COMPLEXITY, INFO.')
 
+    GROUP_BY_DIFFICULTY = ArgumentsInfo(None, '--group-by-difficulty',
+                                        'With this flag, the final grade will be grouped by the issue difficulty.')
+
     SOLUTIONS_FILE_PATH = ArgumentsInfo(None, 'solutions_file_path',
                                         'Local XLSX-file or CSV-file path. '
                                         'Your file must include column-names: '

src/python/evaluation/issues_statistics/common/raw_issue_encoder_decoder.py

@@ -7,6 +7,7 @@
     CodeIssue,
     get_issue_class_by_issue_type,
     IssueData,
+    IssueDifficulty,
     IssueType,
     Measurable,
     MEASURABLE_ISSUE_TYPE_TO_MEASURE_NAME,
@@ -32,6 +33,7 @@ def default(self, obj):
                 IssueData.LINE_NUMBER.value: obj.line_no,
                 IssueData.COLUMN_NUMBER.value: obj.column_no,
                 IssueData.INSPECTOR_TYPE.value: obj.inspector_type.value,
+                IssueData.DIFFICULTY.value: obj.difficulty.value,
             }
 
             if isinstance(obj, Measurable):
@@ -50,6 +52,10 @@ def object_hook(self, json_dict):
         json_dict[IssueData.ISSUE_TYPE.value] = IssueType(json_dict[IssueData.ISSUE_TYPE.value])
         json_dict[IssueData.INSPECTOR_TYPE.value] = InspectorType(json_dict[IssueData.INSPECTOR_TYPE.value])
         json_dict[IssueData.FILE_PATH.value] = Path(json_dict[IssueData.FILE_PATH.value])
+        # TODO: remove get after analyzing raw issue statistics
+        json_dict[IssueData.DIFFICULTY.value] = IssueDifficulty(
+            json_dict.get(IssueData.DIFFICULTY.value, IssueDifficulty.HARD.value),
+        )
 
         issue_type = json_dict[IssueData.ISSUE_TYPE.value]
         if issue_type in MEASURABLE_ISSUE_TYPE_TO_MEASURE_NAME.keys():

src/python/review/application_config.py

@@ -17,6 +17,7 @@ class ApplicationConfig:
     end_line: Optional[int] = None
     new_format: bool = False
     history: Optional[str] = None
+    group_by_difficulty: bool = False
 
 
 @unique

src/python/review/inspectors/checkstyle/checkstyle.py

@@ -7,7 +7,7 @@
 from src.python.review.inspectors.base_inspector import BaseInspector
 from src.python.review.inspectors.checkstyle.issue_types import CHECK_CLASS_NAME_TO_ISSUE_TYPE
 from src.python.review.inspectors.inspector_type import InspectorType
-from src.python.review.inspectors.issue import BaseIssue, IssueType
+from src.python.review.inspectors.issue import BaseIssue, IssueDifficulty, IssueType
 from src.python.review.inspectors.parsers.checkstyle_parser import parse_checkstyle_file_result
 
 logger = logging.getLogger(__name__)
@@ -51,6 +51,7 @@ def inspect(self, path: Path, config: Dict[str, Any]) -> List[BaseIssue]:
             return parse_checkstyle_file_result(Path(output_path),
                                                 self.inspector_type,
                                                 self.choose_issue_type,
+                                                IssueDifficulty.get_by_issue_type,
                                                 self.origin_class_to_pattern)
 
     @classmethod

src/python/review/inspectors/detekt/detekt.py

@@ -7,7 +7,7 @@
 from src.python.review.inspectors.base_inspector import BaseInspector
 from src.python.review.inspectors.detekt.issue_types import DETECT_CLASS_NAME_TO_ISSUE_TYPE
 from src.python.review.inspectors.inspector_type import InspectorType
-from src.python.review.inspectors.issue import BaseIssue, IssueType
+from src.python.review.inspectors.issue import BaseIssue, IssueDifficulty, IssueType
 from src.python.review.inspectors.parsers.checkstyle_parser import parse_checkstyle_file_result
 
 logger = logging.getLogger(__name__)
@@ -50,6 +50,7 @@ def inspect(self, path: Path, config: Dict[str, Any]) -> List[BaseIssue]:
             return parse_checkstyle_file_result(output_path,
                                                 self.inspector_type,
                                                 self.choose_issue_type,
+                                                IssueDifficulty.get_by_issue_type,
                                                 self.origin_class_to_pattern)
 
     @classmethod

src/python/review/inspectors/eslint/eslint.py

@@ -6,7 +6,7 @@
 from src.python.review.inspectors.base_inspector import BaseInspector
 from src.python.review.inspectors.eslint.issue_types import ESLINT_CLASS_NAME_TO_ISSUE_TYPE
 from src.python.review.inspectors.inspector_type import InspectorType
-from src.python.review.inspectors.issue import BaseIssue, IssueType
+from src.python.review.inspectors.issue import BaseIssue, IssueDifficulty, IssueType
 from src.python.review.inspectors.parsers.checkstyle_parser import parse_checkstyle_file_result
 
 PATH_ESLINT_CONFIG = Path(__file__).parent / '.eslintrc'
@@ -41,6 +41,7 @@ def inspect(self, path: Path, config: Dict[str, Any]) -> List[BaseIssue]:
             issues = parse_checkstyle_file_result(output_path,
                                                   self.inspector_type,
                                                   self.choose_issue_type,
+                                                  IssueDifficulty.get_by_issue_type,
                                                   self.origin_class_to_pattern)
 
             output_path.unlink()

src/python/review/inspectors/flake8/flake8.py

@@ -14,6 +14,7 @@
     CohesionIssue,
     CyclomaticComplexityIssue,
     IssueData,
+    IssueDifficulty,
     IssueType,
     LineLenIssue,
 )
@@ -71,25 +72,32 @@ def parse(cls, output: str) -> List[BaseIssue]:
                                                             column_number=column_number,
                                                             origin_class=origin_class)
             if cc_match is not None:  # mccabe: cyclomatic complexity
+                issue_type = IssueType.CYCLOMATIC_COMPLEXITY
                 issue_data[IssueData.DESCRIPTION.value] = get_cyclomatic_complexity_tip()
                 issue_data[IssueData.CYCLOMATIC_COMPLEXITY.value] = int(cc_match.groups()[1])
-                issue_data[IssueData.ISSUE_TYPE.value] = IssueType.CYCLOMATIC_COMPLEXITY
+                issue_data[IssueData.ISSUE_TYPE.value] = issue_type
+                issue_data[IssueData.DIFFICULTY.value] = IssueDifficulty.get_by_issue_type(issue_type)
                 issues.append(CyclomaticComplexityIssue(**issue_data))
             elif cohesion_match is not None:  # flake8-cohesion
+                issue_type = IssueType.COHESION
                 issue_data[IssueData.DESCRIPTION.value] = description  # TODO: Add tip
                 issue_data[IssueData.COHESION_LACK.value] = convert_percentage_of_value_to_lack_of_value(
                     float(cohesion_match.group(1)),
                 )
-                issue_data[IssueData.ISSUE_TYPE.value] = IssueType.COHESION
+                issue_data[IssueData.ISSUE_TYPE.value] = issue_type
+                issue_data[IssueData.DIFFICULTY.value] = IssueDifficulty.get_by_issue_type(issue_type)
                 issues.append(CohesionIssue(**issue_data))
             elif line_len_match is not None:
+                issue_type = IssueType.LINE_LEN
                 issue_data[IssueData.DESCRIPTION.value] = get_line_len_tip()
                 issue_data[IssueData.LINE_LEN.value] = int(line_len_match.groups()[0])
                 issue_data[IssueData.ISSUE_TYPE.value] = IssueType.LINE_LEN
+                issue_data[IssueData.DIFFICULTY.value] = IssueDifficulty.get_by_issue_type(issue_type)
                 issues.append(LineLenIssue(**issue_data))
             else:
                 issue_type = cls.choose_issue_type(origin_class)
                 issue_data[IssueData.ISSUE_TYPE.value] = issue_type
+                issue_data[IssueData.DIFFICULTY.value] = IssueDifficulty.get_by_issue_type(issue_type)
                 issue_data[IssueData.DESCRIPTION.value] = description
                 issues.append(CodeIssue(**issue_data))
 

src/python/review/inspectors/intellij/intellij.py

@@ -10,7 +10,7 @@
 from src.python.review.inspectors.base_inspector import BaseInspector
 from src.python.review.inspectors.inspector_type import InspectorType
 from src.python.review.inspectors.intellij.issue_types import ISSUE_CLASS_TO_ISSUE_TYPE
-from src.python.review.inspectors.issue import BaseIssue, CodeIssue, IssueType
+from src.python.review.inspectors.issue import BaseIssue, CodeIssue, IssueDifficulty, IssueType
 
 logger = logging.getLogger(__name__)
 
@@ -161,6 +161,7 @@ def parse(cls, out_dir_path: Path,
                             origin_class=issue_class,
                             inspector_type=cls.inspector_type,
                             type=issue_type,
+                            difficulty=IssueDifficulty.get_by_issue_type(issue_type),
                         ))
 
         return issues

src/python/review/inspectors/issue.py

@@ -1,4 +1,5 @@
 import abc
+import logging
 from collections import defaultdict
 from dataclasses import dataclass
 from enum import Enum, unique
@@ -7,6 +8,8 @@
 
 from src.python.review.inspectors.inspector_type import InspectorType
 
+logger = logging.getLogger(__name__)
+
 
 @unique
 class IssueType(Enum):
@@ -118,6 +121,7 @@ class IssueData(Enum):
     # Additional fields
     ISSUE_TYPE = 'type'
     DESCRIPTION = 'description'
+    DIFFICULTY = 'difficulty'
 
     LINE_LEN = 'line_len'
     FUNCTION_LEN = 'func_len'
@@ -142,6 +146,48 @@ def get_base_issue_data_dict(cls,
         }
 
 
+@unique
+class IssueDifficulty(Enum):
+    EASY = 'EASY'
+    MEDIUM = 'MEDIUM'
+    HARD = 'HARD'
+
+    @classmethod
+    def get_by_issue_type(cls, issue_type: IssueType) -> 'IssueDifficulty':
+        issue_type_to_difficulty = {
+            # Easy
+            IssueType.CODE_STYLE: cls.EASY,
+            IssueType.LINE_LEN: cls.EASY,
+            IssueType.FUNC_LEN: cls.EASY,
+            IssueType.BOOL_EXPR_LEN: cls.EASY,
+            IssueType.INFO: cls.EASY,  # Because INFO should always be shown on the platforms
+
+            # Medium
+            IssueType.BEST_PRACTICES: cls.MEDIUM,
+
+            # Hard
+            IssueType.CLASS_RESPONSE: cls.HARD,
+            IssueType.METHOD_NUMBER: cls.HARD,
+            IssueType.ERROR_PRONE: cls.HARD,
+            IssueType.COMPLEXITY: cls.HARD,
+            IssueType.CYCLOMATIC_COMPLEXITY: cls.HARD,
+            IssueType.INHERITANCE_DEPTH: cls.HARD,
+            IssueType.CHILDREN_NUMBER: cls.HARD,
+            IssueType.WEIGHTED_METHOD: cls.HARD,
+            IssueType.COUPLING: cls.HARD,
+            IssueType.COHESION: cls.HARD,
+            IssueType.MAINTAINABILITY: cls.HARD,
+            IssueType.UNDEFINED: cls.HARD,
+            IssueType.ARCHITECTURE: cls.HARD,
+        }
+
+        if issue_type not in issue_type_to_difficulty:
+            logger.warning(f'IssueDifficulty: {issue_type} - unknown issue type.')
+            return cls.HARD
+
+        return issue_type_to_difficulty[issue_type]
+
+
 @dataclass(frozen=True, eq=True)
 class ShortIssue:
     origin_class: str
@@ -158,6 +204,7 @@ class BaseIssue(ShortIssue):
     column_no: int
 
     inspector_type: InspectorType
+    difficulty: IssueDifficulty
 
 
 class Measurable(abc.ABC):

src/python/review/inspectors/parsers/checkstyle_parser.py

@@ -13,6 +13,7 @@
     CyclomaticComplexityIssue,
     FuncLenIssue,
     IssueData,
+    IssueDifficulty,
     IssueType,
     LineLenIssue,
 )
@@ -101,6 +102,7 @@ def parse_checkstyle_file_result(
         file_path: Path,
         inspector_type: InspectorType,
         issue_type_selector: Callable[[str], IssueType],
+        difficulty_selector: Callable[[IssueType], IssueDifficulty],
         origin_class_to_description: Dict[str, str]) -> List[BaseIssue]:
     """
     Parses the output, which is a xml file, and returns a list of the issues found there.
@@ -137,6 +139,7 @@ def parse_checkstyle_file_result(
 
             issue_type = issue_type_selector(origin_class)
             issue_data[IssueData.ISSUE_TYPE.value] = issue_type
+            issue_data[IssueData.DIFFICULTY.value] = difficulty_selector(issue_type)
 
             if origin_class in origin_class_to_description:
                 pattern = origin_class_to_description.get(origin_class)

src/python/review/inspectors/pmd/pmd.py

@@ -10,7 +10,7 @@
 from src.python.review.inspectors.base_inspector import BaseInspector
 from src.python.review.inspectors.common import remove_prefix
 from src.python.review.inspectors.inspector_type import InspectorType
-from src.python.review.inspectors.issue import BaseIssue, CodeIssue, IssueType
+from src.python.review.inspectors.issue import BaseIssue, CodeIssue, IssueDifficulty, IssueType
 from src.python.review.inspectors.pmd.issue_types import PMD_RULE_TO_ISSUE_TYPE
 
 logger = logging.getLogger(__name__)
@@ -78,6 +78,7 @@ def parse_output(self, output_path: Path) -> List[BaseIssue]:
                     origin_class=row['Rule'],
                     description=row['Description'],
                     inspector_type=self.inspector_type,
+                    difficulty=IssueDifficulty.get_by_issue_type(self.choose_issue_type(row['Rule'])),
                 ) for row in reader]
 
     @classmethod

src/python/review/inspectors/pyast/python_ast.py

@@ -8,7 +8,7 @@
 from src.python.review.common.language import Language
 from src.python.review.inspectors.base_inspector import BaseInspector
 from src.python.review.inspectors.inspector_type import InspectorType
-from src.python.review.inspectors.issue import BaseIssue, BoolExprLenIssue, FuncLenIssue, IssueType
+from src.python.review.inspectors.issue import BaseIssue, BoolExprLenIssue, FuncLenIssue, IssueDifficulty, IssueType
 from src.python.review.inspectors.tips import get_bool_expr_len_tip, get_func_len_tip
 
 BOOL_EXPR_LEN_ORIGIN_CLASS = 'C001'
@@ -32,6 +32,8 @@ def visit(self, node: ast.AST):
             if isinstance(inner_node, ast.BoolOp):
                 length += len(inner_node.values) - 1
 
+        issue_type = PythonAstInspector.choose_issue_type(BOOL_EXPR_LEN_ORIGIN_CLASS)
+
         self.bool_expression_lens.append(BoolExprLenIssue(
             file_path=self._file_path,
             line_no=node.lineno,
@@ -40,7 +42,8 @@ def visit(self, node: ast.AST):
             origin_class=BOOL_EXPR_LEN_ORIGIN_CLASS,
             inspector_type=self._inspector_type,
             bool_expr_len=length,
-            type=PythonAstInspector.choose_issue_type(BOOL_EXPR_LEN_ORIGIN_CLASS),
+            type=issue_type,
+            difficulty=IssueDifficulty.get_by_issue_type(issue_type),
         ))
 
 
@@ -61,6 +64,8 @@ def visit(self, node):
                 self._previous_node.lineno, node.lineno,
             )
 
+            issue_type = PythonAstInspector.choose_issue_type(FUNC_LEN_ORIGIN_CLASS)
+
             self._function_lens.append(FuncLenIssue(
                 file_path=self._file_path,
                 line_no=self._previous_node.lineno,
@@ -69,7 +74,8 @@ def visit(self, node):
                 origin_class=FUNC_LEN_ORIGIN_CLASS,
                 inspector_type=self._inspector_type,
                 func_len=func_length,
-                type=PythonAstInspector.choose_issue_type(FUNC_LEN_ORIGIN_CLASS),
+                type=issue_type,
+                difficulty=IssueDifficulty.get_by_issue_type(issue_type),
             ))
 
         self._previous_node = node
@@ -83,6 +89,8 @@ def function_lens(self) -> List[FuncLenIssue]:
                 self._previous_node.lineno, self._n_lines + 1,
             )
 
+            issue_type = PythonAstInspector.choose_issue_type(FUNC_LEN_ORIGIN_CLASS)
+
             self._function_lens.append(FuncLenIssue(
                 file_path=self._file_path,
                 line_no=self._previous_node.lineno,
@@ -91,7 +99,8 @@ def function_lens(self) -> List[FuncLenIssue]:
                 origin_class=FUNC_LEN_ORIGIN_CLASS,
                 inspector_type=self._inspector_type,
                 func_len=func_length,
-                type=PythonAstInspector.choose_issue_type(FUNC_LEN_ORIGIN_CLASS),
+                type=issue_type,
+                difficulty=IssueDifficulty.get_by_issue_type(issue_type),
             ))
 
         self._previous_node = None

src/python/review/inspectors/pylint/pylint.py

@@ -6,7 +6,7 @@
 from src.python.review.common.subprocess_runner import run_in_subprocess
 from src.python.review.inspectors.base_inspector import BaseInspector
 from src.python.review.inspectors.inspector_type import InspectorType
-from src.python.review.inspectors.issue import CodeIssue, IssueType
+from src.python.review.inspectors.issue import CodeIssue, IssueDifficulty, IssueType
 from src.python.review.inspectors.pylint.issue_types import CATEGORY_TO_ISSUE_TYPE, CODE_TO_ISSUE_TYPE
 from src.python.review.inspectors.tips import add_complexity_tip
 
@@ -71,6 +71,7 @@ def parse(cls, output: str) -> List[CodeIssue]:
                 description=description,
                 inspector_type=cls.inspector_type,
                 type=issue_type,
+                difficulty=IssueDifficulty.get_by_issue_type(issue_type),
             ))
 
         return issues