adapt to new EvaluationResult schema

Author: khvn26

flag_engine/result/types.py

@@ -1,22 +1,18 @@
 # generated by datamodel-codegen:
-#   filename:  result.json
-#   timestamp: 2025-08-11T11:47:46+00:00
+#   filename:  https://raw.githubusercontent.com/Flagsmith/flagsmith/refs/heads/chore/improve-evaluation-result/sdk/evaluation-result.json  # noqa: E501
+#   timestamp: 2025-10-01T11:31:34+00:00
 
 from __future__ import annotations
 
-from typing import Any, List, Optional, TypedDict
-
-from typing_extensions import NotRequired
-
-from flag_engine.context.types import EvaluationContext
+from typing import Any, Dict, List, TypedDict
 
 
 class FlagResult(TypedDict):
-    name: str
     feature_key: str
+    name: str
     enabled: bool
-    value: NotRequired[Optional[Any]]
-    reason: NotRequired[str]
+    value: Any
+    reason: str
 
 
 class SegmentResult(TypedDict):
@@ -25,6 +21,5 @@ class SegmentResult(TypedDict):
 
 
 class EvaluationResult(TypedDict):
-    context: EvaluationContext
-    flags: List[FlagResult]
+    flags: Dict[str, FlagResult]
     segments: List[SegmentResult]

flag_engine/segments/constants.py

@@ -21,5 +21,5 @@
 IS_NOT_SET: ConditionOperator = "IS_NOT_SET"
 IN: ConditionOperator = "IN"
 
-# Lowest possible priority for segment overrides
+# Weakest possible priority for segment overrides
 DEFAULT_PRIORITY = float("inf")

flag_engine/segments/evaluator.py

@@ -40,7 +40,7 @@ def get_evaluation_result(context: EvaluationContext) -> EvaluationResult:
     :return: EvaluationResult containing the context, flags, and segments
     """
     segments: list[SegmentResult] = []
-    flags: list[FlagResult] = []
+    flags: dict[str, FlagResult] = {}
 
     segment_feature_contexts: dict[SupportsStr, FeatureContextWithSegmentName] = {}
 
@@ -82,29 +82,25 @@ def get_evaluation_result(context: EvaluationContext) -> EvaluationResult:
         else None
     )
     for feature_context in (context.get("features") or {}).values():
+        feature_name = feature_context["name"]
         if feature_context_with_segment_name := segment_feature_contexts.get(
             feature_context["feature_key"],
         ):
             feature_context = feature_context_with_segment_name["feature_context"]
-            flags.append(
-                {
-                    "enabled": feature_context["enabled"],
-                    "feature_key": feature_context["feature_key"],
-                    "name": feature_context["name"],
-                    "reason": f"TARGETING_MATCH; segment={feature_context_with_segment_name['segment_name']}",
-                    "value": feature_context.get("value"),
-                }
-            )
+            flags[feature_name] = {
+                "enabled": feature_context["enabled"],
+                "feature_key": feature_context["feature_key"],
+                "name": feature_context["name"],
+                "reason": f"TARGETING_MATCH; segment={feature_context_with_segment_name['segment_name']}",
+                "value": feature_context.get("value"),
+            }
             continue
-        flags.append(
-            get_flag_result_from_feature_context(
-                feature_context=feature_context,
-                key=identity_key,
-            )
+        flags[feature_name] = get_flag_result_from_feature_context(
+            feature_context=feature_context,
+            key=identity_key,
         )
 
     return {
-        "context": context,
         "flags": flags,
         "segments": segments,
     }

tests/engine_tests/engine-test-data

@@ -2,6 +2,7 @@
 
 from flag_engine.context.types import EvaluationContext, IdentityContext, SegmentContext
 from flag_engine.engine import get_evaluation_result
+from flag_engine.result.types import EvaluationResult
 
 
 def test_get_evaluation_result__no_overrides__returns_expected(
@@ -11,26 +12,25 @@ def test_get_evaluation_result__no_overrides__returns_expected(
     result = get_evaluation_result(context)
 
     # Then
-    assert result == {
-        "context": context,
-        "flags": [
-            {
+    assert result == EvaluationResult(
+        flags={
+            "feature_1": {
                 "enabled": True,
                 "feature_key": "1",
                 "name": "feature_1",
                 "reason": "DEFAULT",
                 "value": None,
             },
-            {
+            "feature_2": {
                 "enabled": False,
                 "feature_key": "2",
                 "name": "feature_2",
                 "reason": "DEFAULT",
                 "value": None,
             },
-        ],
-        "segments": [],
-    }
+        },
+        segments=[],
+    )
 
 
 def test_get_evaluation_result__segment_override__returns_expected(
@@ -41,23 +41,22 @@ def test_get_evaluation_result__segment_override__returns_expected(
 
     # Then
     assert result == {
-        "context": context_in_segment,
-        "flags": [
-            {
+        "flags": {
+            "feature_1": {
                 "enabled": False,
                 "feature_key": "1",
                 "name": "feature_1",
                 "reason": "TARGETING_MATCH; segment=my_segment",
                 "value": "segment_override",
             },
-            {
+            "feature_2": {
                 "enabled": False,
                 "feature_key": "2",
                 "name": "feature_2",
                 "reason": "DEFAULT",
                 "value": None,
             },
-        ],
+        },
         "segments": [{"key": "1", "name": "my_segment"}],
     }
 
@@ -99,23 +98,22 @@ def test_get_evaluation_result__identity_override__returns_expected(
 
     # Then
     assert result == {
-        "context": context,
-        "flags": [
-            {
+        "flags": {
+            "feature_1": {
                 "enabled": True,
                 "feature_key": "1",
                 "name": "feature_1",
                 "reason": "TARGETING_MATCH; segment=identity_overrides",
                 "value": "overridden_for_identity",
             },
-            {
+            "feature_2": {
                 "enabled": False,
                 "feature_key": "2",
                 "name": "feature_2",
                 "reason": "DEFAULT",
                 "value": None,
             },
-        ],
+        },
         "segments": [
             {
                 "key": "",
@@ -207,23 +205,22 @@ def test_get_evaluation_result__two_segments_override_same_feature__returns_expe
 
     # Then
     assert result == {
-        "context": context_in_segments,
-        "flags": [
-            {
+        "flags": {
+            "feature_1": {
                 "enabled": True,
                 "feature_key": "1",
                 "name": "feature_1",
                 "reason": "TARGETING_MATCH; segment=higher_priority_segment",
                 "value": "segment_override_other",
             },
-            {
+            "feature_2": {
                 "enabled": False,
                 "feature_key": "2",
                 "name": "feature_2",
                 "reason": "DEFAULT",
                 "value": None,
             },
-        ],
+        },
         "segments": [
             {"key": "1", "name": "my_segment"},
             {"key": "3", "name": "higher_priority_segment"},
@@ -338,23 +335,22 @@ def test_get_evaluation_result__segment_override__no_priority__returns_expected(
 
     # Then
     assert result == {
-        "context": context,
-        "flags": [
-            {
+        "flags": {
+            "feature_1": {
                 "enabled": True,
                 "feature_key": "1",
                 "name": "feature_1",
                 "reason": "TARGETING_MATCH; segment=segment_with_override_priority",
                 "value": "overridden_with_priority",
             },
-            {
+            "feature_2": {
                 "enabled": False,
                 "feature_key": "2",
                 "name": "feature_2",
                 "reason": "TARGETING_MATCH; segment=another_segment",
                 "value": "moose",
             },
-        ],
+        },
         "segments": [
             {"key": "1", "name": "segment_without_override_priority"},
             {"key": "2", "name": "segment_with_override_priority"},