Merge branch 'feat/support-evaluation-tracking-api' of github.com:Flagsmith/flagsmith-python-client into feat/support-evaluation-tracking-api

Author: Zaimwa9

flagsmith/analytics.py

@@ -193,7 +193,9 @@ def _handle_flush_result(
             response = future.result()
             response.raise_for_status()
         except Exception:
-            logger.warning("Failed to flush pipeline analytics, re-queuing events", exc_info=True)
+            logger.warning(
+                "Failed to flush pipeline analytics, re-queuing events", exc_info=True
+            )
             with self._lock:
                 self._buffer = events + self._buffer
                 self._buffer = self._buffer[: self._max_buffer]
@@ -207,9 +209,7 @@ def stop(self) -> None:
         self.flush()
 
     def _schedule_flush(self) -> None:
-        self._timer = threading.Timer(
-            self._flush_interval_seconds, self._timer_flush
-        )
+        self._timer = threading.Timer(self._flush_interval_seconds, self._timer_flush)
         self._timer.daemon = True
         self._timer.start()
 

flagsmith/flagsmith.py

@@ -114,7 +114,9 @@ def __init__(
         self.default_flag_handler = default_flag_handler
         self.enable_realtime_updates = enable_realtime_updates
         self._analytics_processor: typing.Optional[AnalyticsProcessor] = None
-        self._pipeline_analytics_processor: typing.Optional[PipelineAnalyticsProcessor] = None
+        self._pipeline_analytics_processor: typing.Optional[
+            PipelineAnalyticsProcessor
+        ] = None
         self._evaluation_context: typing.Optional[SDKEvaluationContext] = None
         self._environment_updated_at: typing.Optional[datetime] = None
 
@@ -496,5 +498,8 @@ def __del__(self) -> None:
         if hasattr(self, "event_stream_thread"):
             self.event_stream_thread.stop()
 
-        if hasattr(self, "_pipeline_analytics_processor") and self._pipeline_analytics_processor:
+        if (
+            hasattr(self, "_pipeline_analytics_processor")
+            and self._pipeline_analytics_processor
+        ):
             self._pipeline_analytics_processor.stop()

flagsmith/models.py

@@ -67,7 +67,9 @@ def from_evaluation_result(
         evaluation_result: SDKEvaluationResult,
         analytics_processor: typing.Optional[AnalyticsProcessor],
         default_flag_handler: typing.Optional[typing.Callable[[str], DefaultFlag]],
-        pipeline_analytics_processor: typing.Optional[PipelineAnalyticsProcessor] = None,
+        pipeline_analytics_processor: typing.Optional[
+            PipelineAnalyticsProcessor
+        ] = None,
         identity_identifier: typing.Optional[str] = None,
         traits: typing.Optional[typing.Dict[str, typing.Any]] = None,
     ) -> Flags:
@@ -90,7 +92,9 @@ def from_api_flags(
         api_flags: typing.Sequence[typing.Mapping[str, typing.Any]],
         analytics_processor: typing.Optional[AnalyticsProcessor],
         default_flag_handler: typing.Optional[typing.Callable[[str], DefaultFlag]],
-        pipeline_analytics_processor: typing.Optional[PipelineAnalyticsProcessor] = None,
+        pipeline_analytics_processor: typing.Optional[
+            PipelineAnalyticsProcessor
+        ] = None,
         identity_identifier: typing.Optional[str] = None,
         traits: typing.Optional[typing.Dict[str, typing.Any]] = None,
     ) -> Flags:

tests/test_flagsmith.py

@@ -985,9 +985,7 @@ def test_get_identity_flags_passes_identity_and_traits(
     )
 
     responses.add(method="POST", url=flagsmith.identities_url, body=identities_json)
-    flags = flagsmith.get_identity_flags(
-        "user123", traits={"plan": "premium"}
-    )
+    flags = flagsmith.get_identity_flags("user123", traits={"plan": "premium"})
     flags.get_flag("some_feature")
 
     mock_record.assert_called_once_with(

tests/test_models.py

@@ -157,13 +157,19 @@ def test_get_flag_records_pipeline_evaluation_event(
     pipeline_analytics_processor: PipelineAnalyticsProcessor,
 ) -> None:
     flags = Flags(
-        flags={"my_feature": Flag(enabled=True, value="v1", feature_name="my_feature", feature_id=1)},
+        flags={
+            "my_feature": Flag(
+                enabled=True, value="v1", feature_name="my_feature", feature_id=1
+            )
+        },
         _pipeline_analytics_processor=pipeline_analytics_processor,
         _identity_identifier="user123",
         _traits={"plan": "premium"},
     )
 
-    with mock.patch.object(pipeline_analytics_processor, "record_evaluation_event") as mock_record:
+    with mock.patch.object(
+        pipeline_analytics_processor, "record_evaluation_event"
+    ) as mock_record:
         flags.get_flag("my_feature")
 
     mock_record.assert_called_once_with(
@@ -177,7 +183,11 @@ def test_get_flag_records_pipeline_evaluation_event(
 
 def test_get_flag_without_pipeline_processor() -> None:
     flags = Flags(
-        flags={"my_feature": Flag(enabled=True, value="v1", feature_name="my_feature", feature_id=1)},
+        flags={
+            "my_feature": Flag(
+                enabled=True, value="v1", feature_name="my_feature", feature_id=1
+            )
+        },
     )
     flag = flags.get_flag("my_feature")
     assert flag.enabled is True

tests/test_pipeline_analytics.py

@@ -36,7 +36,7 @@ def test_record_evaluation_event_buffers_event(
 @pytest.mark.parametrize(
     "second_enabled, expected_count",
     [
-        (True, 1),   # same fingerprint -> deduplicated
+        (True, 1),  # same fingerprint -> deduplicated
         (False, 2),  # different fingerprint -> both kept
     ],
 )
@@ -49,7 +49,10 @@ def test_evaluation_event_deduplication(
         flag_key="my_flag", enabled=True, value="v1", identity_identifier="user1"
     )
     pipeline_analytics_processor.record_evaluation_event(
-        flag_key="my_flag", enabled=second_enabled, value="v1", identity_identifier="user1"
+        flag_key="my_flag",
+        enabled=second_enabled,
+        value="v1",
+        identity_identifier="user1",
     )
 
     assert len(pipeline_analytics_processor._buffer) == expected_count
@@ -72,9 +75,7 @@ def test_dedup_keys_cleared_after_flush(
 
 
 def test_auto_flush_on_buffer_full() -> None:
-    config = PipelineAnalyticsConfig(
-        analytics_server_url="http://test/", max_buffer=5
-    )
+    config = PipelineAnalyticsConfig(analytics_server_url="http://test/", max_buffer=5)
     processor = PipelineAnalyticsProcessor(config=config, environment_key="key")
 
     with mock.patch("flagsmith.analytics.session"):
@@ -186,9 +187,7 @@ def test_start_stop_lifecycle() -> None:
     assert processor._timer.is_alive()
 
     with mock.patch("flagsmith.analytics.session"):
-        processor.record_evaluation_event(
-            flag_key="my_flag", enabled=True, value="v1"
-        )
+        processor.record_evaluation_event(flag_key="my_flag", enabled=True, value="v1")
         processor.stop()
 
     assert len(processor._buffer) == 0