feat: Add reviewResult in AbstactAnnotation class (#1122)

Closes #1121 .

### Summary of Changes

added field reviewResult in AbstractAnnotation and changes all relevated
json files, dicts, and instantiation

### Testing Instructions

view and run the changed `test_annotations.py` file or import and export
api data with the existing commands (api, migrate, etc.).

Co-authored-by: Aclrian <[email protected]>
Co-authored-by: Lars Reimann <[email protected]>

Author: Aclrian

package-parser/package_parser/processing/annotations/_generate_boundary_annotations.py

@@ -3,6 +3,7 @@
 from package_parser.processing.annotations.model import (
     AnnotationStore,
     BoundaryAnnotation,
+    EnumReviewResult,
     Interval,
     ValueAnnotation,
 )
@@ -17,6 +18,7 @@ def _generate_boundary_annotations(api: API, annotations: AnnotationStore) -> No
     :param api: Description of the API
     :param annotations: AnnotationStore, that holds all annotations
     """
+    # pylint: disable=duplicate-code
     for _, parameter in api.parameters().items():
 
         # Don't add boundary annotation to constant parameters
@@ -73,5 +75,6 @@ def _generate_boundary_annotations(api: API, annotations: AnnotationStore) -> No
                 reviewers=[],
                 comment=f"I turned this into a bounded number because the description contained {boundary_type.full_match}.",
                 interval=interval,
+                reviewResult=EnumReviewResult.NONE,
             )
             annotations.boundaryAnnotations.append(boundary)

package-parser/package_parser/processing/annotations/_generate_enum_annotations.py

@@ -4,6 +4,7 @@
     AnnotationStore,
     EnumAnnotation,
     EnumPair,
+    EnumReviewResult,
     ValueAnnotation,
 )
 from package_parser.processing.api.model import API, EnumType
@@ -17,6 +18,7 @@ def _generate_enum_annotations(api: API, annotations: AnnotationStore) -> None:
     :param api: API object for usages
     :param annotations: AnnotationStore object
     """
+    # pylint: disable=duplicate-code
     for _, parameter in api.parameters().items():
 
         # Don't add enum annotation to constant parameters
@@ -47,6 +49,7 @@ def _generate_enum_annotations(api: API, annotations: AnnotationStore) -> None:
                     comment=f"I turned this into an enum because the type in the documentation contained {full_match}.",
                     enumName=enum_name,
                     pairs=pairs,
+                    reviewResult=EnumReviewResult.NONE,
                 )
             )
 

package-parser/package_parser/processing/annotations/_generate_remove_annotations.py

@@ -1,5 +1,6 @@
 from package_parser.processing.annotations.model import (
     AnnotationStore,
+    EnumReviewResult,
     RemoveAnnotation,
 )
 from package_parser.processing.api.model import API
@@ -26,6 +27,7 @@ def _generate_remove_annotations(
                     authors=[autogen_author],
                     reviewers=[],
                     comment=_create_explanation("class", n_class_usages),
+                    reviewResult=EnumReviewResult.NONE,
                 )
             )
 
@@ -38,6 +40,7 @@ def _generate_remove_annotations(
                     authors=[autogen_author],
                     reviewers=[],
                     comment=_create_explanation("function", n_function_usages),
+                    reviewResult=EnumReviewResult.NONE,
                 )
             )
 

package-parser/package_parser/processing/annotations/_generate_value_annotations.py

@@ -3,6 +3,7 @@
 from package_parser.processing.annotations.model import (
     AnnotationStore,
     ConstantAnnotation,
+    EnumReviewResult,
     OmittedAnnotation,
     OptionalAnnotation,
     RequiredAnnotation,
@@ -22,9 +23,9 @@ def _generate_value_annotations(
     for parameter in api.parameters().values():
 
         # Don't create annotations for variadic parameters
-        if (
-            parameter.assigned_by == ParameterAssignment.POSITIONAL_VARARG
-            or parameter.assigned_by == ParameterAssignment.NAMED_VARARG
+        if parameter.assigned_by in (
+            ParameterAssignment.POSITIONAL_VARARG,
+            ParameterAssignment.NAMED_VARARG,
         ):
             continue
 
@@ -54,6 +55,7 @@ def _generate_constant_annotation(
                 authors=[autogen_author],
                 reviewers=[],
                 comment=f"I omitted this parameter because it is always set to the original default value ({parameter.default_value}).",
+                reviewResult=EnumReviewResult.NONE,
             )
         )
         return
@@ -68,6 +70,7 @@ def _generate_constant_annotation(
                 authors=[autogen_author],
                 reviewers=[],
                 comment=f"I replaced this parameter with a constant because it is always set to the same literal value ({sole_stringified_value}).",
+                reviewResult=EnumReviewResult.NONE,
                 defaultValueType=default_value_type,
                 defaultValue=default_value,
             )
@@ -79,6 +82,7 @@ def _generate_constant_annotation(
                 authors=[autogen_author],
                 reviewers=[],
                 comment=f"I made this parameter required because, even though it is always set to the same value ({sole_stringified_value}), that value is not a literal.",
+                reviewResult=EnumReviewResult.NONE,
             )
         )
 
@@ -98,6 +102,7 @@ def _generate_required_or_optional_annotation(
                 authors=[autogen_author],
                 reviewers=[],
                 comment=f"I made this parameter required because the most common value ({most_common_values[0]}) is not a literal.",
+                reviewResult=EnumReviewResult.NONE,
             )
         )
         return
@@ -122,6 +127,7 @@ def _generate_required_or_optional_annotation(
                 authors=[autogen_author],
                 reviewers=[],
                 comment=comment,
+                reviewResult=EnumReviewResult.NONE,
             )
         )
     else:
@@ -136,6 +142,7 @@ def _generate_required_or_optional_annotation(
                     authors=[autogen_author],
                     reviewers=[],
                     comment=comment,
+                    reviewResult=EnumReviewResult.NONE,
                     defaultValueType=default_value_type,
                     defaultValue=default_value,
                 )
@@ -186,11 +193,10 @@ def _should_be_required(
             False,
             f"I made this parameter optional because there is a statistically significant most common value (p-value {p_value:.2%} <= significance level {significance_level:.0%}).",
         )
-    else:
-        return (
-            True,
-            f"I made this parameter required because there is no statistically significant most common value (p-value ({p_value:.2%}) > significance level ({significance_level:.0%}).",
-        )
+    return (
+        True,
+        f"I made this parameter required because there is no statistically significant most common value (p-value ({p_value:.2%}) > significance level ({significance_level:.0%}).",
+    )
 
 
 def _is_stringified_literal(stringified_value: str) -> bool:
@@ -203,14 +209,13 @@ def _get_type_and_value_for_stringified_value(
 ) -> tuple[Optional[ValueAnnotation.DefaultValueType], Any]:
     if stringified_value == "None":
         return ValueAnnotation.DefaultValueType.NONE, None
-    elif stringified_value == "True" or stringified_value == "False":
+    if stringified_value in ("True", "False"):
         return ValueAnnotation.DefaultValueType.BOOLEAN, stringified_value == "True"
-    elif _is_float(stringified_value):
+    if _is_float(stringified_value):
         return ValueAnnotation.DefaultValueType.NUMBER, float(stringified_value)
-    elif stringified_value[0] == "'" and stringified_value[-1] == "'":
+    if stringified_value[0] == "'" and stringified_value[-1] == "'":
         return ValueAnnotation.DefaultValueType.STRING, stringified_value[1:-1]
-    else:
-        return None, None
+    return None, None
 
 
 def _is_float(stringified_value: str) -> bool:

package-parser/package_parser/processing/annotations/model/__init__.py

@@ -8,6 +8,7 @@
     DescriptionAnnotation,
     EnumAnnotation,
     EnumPair,
+    EnumReviewResult,
     ExpertAnnotation,
     GroupAnnotation,
     Interval,