fix(beeai): handle removal of experimental features

Adds TYPE_CHECKING guards and try/except ImportError handling to gracefully
handle beeai-framework versions that removed experimental.agent and
experimental.requirements modules. This follows the existing pattern in
beeai's ProcessorLocator which uses contextlib.suppress(ImportError) to
handle optional framework components.

Unlike ProcessorLocator's optional registration pattern, these processors
require fallback values (None) when experimental features are unavailable,
making try/except more appropriate than contextlib.suppress.

Fixes mypy attr-defined errors in py311-ci-beeai and py311-ci-beeai-latest.

Signed-off-by: Adrian Cole <[email protected]>

Author: codefromthecrypt

python/instrumentation/openinference-instrumentation-beeai/src/openinference/instrumentation/beeai/processors/agents/requirement_agent.py

@@ -1,12 +1,30 @@
-from typing import Any
+from typing import TYPE_CHECKING, Any
+
+if TYPE_CHECKING:
+    from beeai_framework.agents.experimental.events import (  # type: ignore[attr-defined]
+        RequirementAgentStartEvent,
+        RequirementAgentSuccessEvent,
+    )
+    from beeai_framework.agents.experimental.types import (  # type: ignore[attr-defined]
+        RequirementAgentRunStateStep,
+    )
+    from beeai_framework.context import RunContextStartEvent
+    from beeai_framework.emitter import EventMeta
+else:
+    try:
+        from beeai_framework.agents.experimental.events import (
+            RequirementAgentStartEvent,
+            RequirementAgentSuccessEvent,
+        )
+        from beeai_framework.agents.experimental.types import RequirementAgentRunStateStep
+    except ImportError:
+        # beeai-framework removed experimental features
+        RequirementAgentStartEvent = None  # type: ignore
+        RequirementAgentSuccessEvent = None  # type: ignore
+        RequirementAgentRunStateStep = None  # type: ignore
+    from beeai_framework.context import RunContextStartEvent
+    from beeai_framework.emitter import EventMeta
 
-from beeai_framework.agents.experimental.events import (
-    RequirementAgentStartEvent,
-    RequirementAgentSuccessEvent,
-)
-from beeai_framework.agents.experimental.types import RequirementAgentRunStateStep
-from beeai_framework.context import RunContextStartEvent
-from beeai_framework.emitter import EventMeta
 from typing_extensions import override
 
 from openinference.instrumentation.beeai._utils import _unpack_object
@@ -28,27 +46,26 @@ async def update(
         await super().update(event, meta)
         self.span.add_event(f"{meta.name} ({meta.path})", timestamp=meta.created_at)
 
-        match event:
-            case RequirementAgentStartEvent():
-                self._sync_steps(event.state.steps)
-            case RequirementAgentSuccessEvent():
-                self._sync_steps(event.state.steps)
+        if RequirementAgentStartEvent is not None and isinstance(event, RequirementAgentStartEvent):
+            self._sync_steps(event.state.steps)
+        elif RequirementAgentSuccessEvent is not None and isinstance(
+            event, RequirementAgentSuccessEvent
+        ):
+            self._sync_steps(event.state.steps)
 
-                if event.state.answer is not None:
-                    self.span.set_attributes(
-                        {
-                            SpanAttributes.OUTPUT_VALUE: event.state.answer.text,
-                            SpanAttributes.OUTPUT_MIME_TYPE: OpenInferenceMimeTypeValues.TEXT.value,
-                        }
-                    )
-                if event.state.result is not None:
-                    self.span.set_attributes(
-                        _unpack_object(
-                            event.state.result, prefix=f"{SpanAttributes.METADATA}.result"
-                        )
-                    )
-            case _:
-                self.span.child(meta.name, event=(event, meta))
+            if event.state.answer is not None:
+                self.span.set_attributes(
+                    {
+                        SpanAttributes.OUTPUT_VALUE: event.state.answer.text,
+                        SpanAttributes.OUTPUT_MIME_TYPE: OpenInferenceMimeTypeValues.TEXT.value,
+                    }
+                )
+            if event.state.result is not None:
+                self.span.set_attributes(
+                    _unpack_object(event.state.result, prefix=f"{SpanAttributes.METADATA}.result")
+                )
+        else:
+            self.span.child(meta.name, event=(event, meta))
 
     def _sync_steps(self, steps: list["RequirementAgentRunStateStep"]) -> None:
         new_items = steps[len(self._steps) :]

python/instrumentation/openinference-instrumentation-beeai/src/openinference/instrumentation/beeai/processors/locator.py

@@ -47,14 +47,18 @@ def _load() -> None:
             ProcessorLocator.entries[ToolCallingAgent] = ToolCallingAgentProcessor
 
         with contextlib.suppress(ImportError):
-            from beeai_framework.agents.experimental.agent import RequirementAgent
+            from beeai_framework.agents.experimental.agent import (  # type: ignore[attr-defined]
+                RequirementAgent,
+            )
 
             from .agents.requirement_agent import RequirementAgentProcessor
 
             ProcessorLocator.entries[RequirementAgent] = RequirementAgentProcessor
 
         with contextlib.suppress(ImportError):
-            from beeai_framework.agents.experimental.requirements.requirement import Requirement
+            from beeai_framework.agents.experimental.requirements.requirement import (  # type: ignore[attr-defined]
+                Requirement,
+            )
 
             from openinference.instrumentation.beeai.processors.requirement import (
                 RequirementProcessor,

python/instrumentation/openinference-instrumentation-beeai/src/openinference/instrumentation/beeai/processors/requirement.py

@@ -1,11 +1,39 @@
-from typing import Any, ClassVar
+from typing import TYPE_CHECKING, Any, ClassVar
+
+if TYPE_CHECKING:
+    from beeai_framework.agents.experimental.requirements.ask_permission import (  # type: ignore[attr-defined]
+        AskPermissionRequirement,
+    )
+    from beeai_framework.agents.experimental.requirements.conditional import (  # type: ignore[attr-defined]
+        ConditionalRequirement,
+    )
+    from beeai_framework.agents.experimental.requirements.events import (  # type: ignore[attr-defined]
+        RequirementInitEvent,
+    )
+    from beeai_framework.agents.experimental.requirements.requirement import (  # type: ignore[attr-defined]
+        Requirement,
+    )
+    from beeai_framework.context import RunContext, RunContextStartEvent
+    from beeai_framework.emitter import EventMeta
+else:
+    try:
+        from beeai_framework.agents.experimental.requirements.ask_permission import (
+            AskPermissionRequirement,
+        )
+        from beeai_framework.agents.experimental.requirements.conditional import (
+            ConditionalRequirement,
+        )
+        from beeai_framework.agents.experimental.requirements.events import RequirementInitEvent
+        from beeai_framework.agents.experimental.requirements.requirement import Requirement
+    except ImportError:
+        # beeai-framework removed experimental features
+        AskPermissionRequirement = None  # type: ignore
+        ConditionalRequirement = None  # type: ignore
+        RequirementInitEvent = None  # type: ignore
+        Requirement = None  # type: ignore
+    from beeai_framework.context import RunContext, RunContextStartEvent
+    from beeai_framework.emitter import EventMeta
 
-from beeai_framework.agents.experimental.requirements.ask_permission import AskPermissionRequirement
-from beeai_framework.agents.experimental.requirements.conditional import ConditionalRequirement
-from beeai_framework.agents.experimental.requirements.events import RequirementInitEvent
-from beeai_framework.agents.experimental.requirements.requirement import Requirement
-from beeai_framework.context import RunContext, RunContextStartEvent
-from beeai_framework.emitter import EventMeta
 from typing_extensions import override
 
 from openinference.instrumentation.beeai._utils import _unpack_object
@@ -60,8 +88,7 @@ async def update(
 
         self.span.add_event(f"{meta.name} ({meta.path})", timestamp=meta.created_at)
 
-        match event:
-            case RequirementInitEvent():
-                pass
-            case _:
-                self.span.child(meta.name, event=(event, meta))
+        if RequirementInitEvent is not None and isinstance(event, RequirementInitEvent):
+            pass
+        else:
+            self.span.child(meta.name, event=(event, meta))