added generator for generate summaries from logs

Author: AlejandroEsquivel

guardrails/classes/validation/validation_summary.py

@@ -1,35 +1,42 @@
 # TODO Temp to update once generated class is in
-from typing import List, Optional
+from typing import Iterator, List
 
 from guardrails.classes.generic.arbitrary_model import ArbitraryModel
-from guardrails.classes.validation.validation_result import ErrorSpan, FailResult
+from guardrails.classes.validation.validation_result import FailResult
 from guardrails.classes.validation.validator_logs import ValidatorLogs
+from guardrails_api_client import ValidationSummary as IValidationSummary
 
 
-class ValidationSummary(ArbitraryModel):
-    validator_name: str
-    validator_status: str
-    failure_reason: Optional[str]
-    error_spans: Optional[List["ErrorSpan"]] = []
-    property_path: Optional[str]
-
+class ValidationSummary(IValidationSummary, ArbitraryModel):
     @staticmethod
-    def from_validator_logs(
+    def _generate_summaries_from_validator_logs(
         validator_logs: List[ValidatorLogs],
-    ) -> List["ValidationSummary"]:
-        summaries = []
+    ) -> Iterator["ValidationSummary"]:
+        """
+        Generate a list of ValidationSummary objects from a list of
+        ValidatorLogs objects. Using an iterator to allow serializing
+        the summaries to other formats.
+        """
         for log in validator_logs:
             validation_result = log.validation_result
             is_fail_result = isinstance(validation_result, FailResult)
             failure_reason = validation_result.error_message if is_fail_result else None
             error_spans = validation_result.error_spans if is_fail_result else []
-            summaries.append(
-                ValidationSummary(
-                    validator_name=log.validator_name,
-                    validator_status=log.validation_result.outcome,
-                    property_path=log.property_path,
-                    failure_reason=failure_reason,
-                    error_spans=error_spans,
-                )
+            yield ValidationSummary(
+                validatorName=log.validator_name,
+                validatorStatus=log.validation_result.outcome,  # type: ignore
+                propertyPath=log.property_path,
+                failureReason=failure_reason,
+                errorSpans=error_spans,  # type: ignore
             )
+
+    @staticmethod
+    def from_validator_logs(
+        validator_logs: List[ValidatorLogs],
+    ) -> List["ValidationSummary"]:
+        summaries = []
+        for summary in ValidationSummary._generate_summaries_from_validator_logs(
+            validator_logs
+        ):
+            summaries.append(summary)
         return summaries