Build applications that make decisions (chatbots, agents, simulations, etc...). Monitor, trace, persist, and execute on your own infrastructure.
Python aiburrchatbot-frameworkdagsgenerative-aigraphshacktoberfestllmopsllmsmlopspersistent-data-structurestate-machinestate-managementvisibility
fix: allow union types in streaming_action.pydantic stream_type parameter (#732)
Matt Van Horn5e0ab348e791
diff --git a/burr/core/action.py b/burr/core/action.pyindex 7f3360e3..00830fe5 100644--- a/burr/core/action.py+++ b/burr/core/action.py@@ -24,6 +24,19 @@ import sysimport textwrapimport typesimport typing++# types.UnionType was added in Python 3.10 to represent PEP 604 `X | Y`+# syntax. Burr supports Python >= 3.9, so on 3.9 we fall back to a sentinel+# type that keeps Union annotations well-formed. No PEP 604 union can ever+# exist on 3.9, so isinstance() checks against it simply never match.+if sys.version_info >= (3, 10):+ UnionType = types.UnionType+else: # pragma: no cover - exercised on Python 3.9 CI only++ class UnionType: # type: ignore[no-redef]+ """Placeholder for ``types.UnionType`` on Python < 3.10."""++from collections.abc import AsyncIteratorfrom typing import (TYPE_CHECKING,@@ -1922,7 +1935,7 @@ class streaming_action:writes: List[str],state_input_type: Type["BaseModel"],state_output_type: Type["BaseModel"],- stream_type: Union[Type["BaseModel"], Type[dict]],+ stream_type: Union[Type["BaseModel"], Type[dict], UnionType],tags: Optional[List[str]] = None,) -> Callable:"""Creates a streaming action that uses pydantic models.diff --git a/burr/integrations/pydantic.py b/burr/integrations/pydantic.pyindex 300cbb6a..54c175b8 100644--- a/burr/integrations/pydantic.py+++ b/burr/integrations/pydantic.py@@ -41,6 +41,7 @@ from burr.core import Action, Graph, Statefrom burr.core.action import (FunctionBasedAction,FunctionBasedStreamingAction,+ UnionType,bind,derive_inputs_from_fn,)@@ -269,7 +270,7 @@ def pydantic_action(return decorator-PartialType = Union[Type[pydantic.BaseModel], Type[dict]]+PartialType = Union[Type[pydantic.BaseModel], Type[dict], UnionType]PydanticStreamingActionFunctionSync = Callable[..., Generator[Tuple[Union[pydantic.BaseModel, dict], Optional[pydantic.BaseModel]], None, None]@@ -290,11 +291,13 @@ PydanticStreamingActionFunctionVar = TypeVar(def _validate_and_extract_signature_types_streaming(fn: PydanticStreamingActionFunction,- stream_type: Optional[Union[Type[pydantic.BaseModel], Type[dict]]],+ stream_type: Optional[Union[Type[pydantic.BaseModel], Type[dict], UnionType]],state_input_type: Optional[Type[pydantic.BaseModel]] = None,state_output_type: Optional[Type[pydantic.BaseModel]] = None,) -> Tuple[- Type[pydantic.BaseModel], Type[pydantic.BaseModel], Union[Type[dict], Type[pydantic.BaseModel]]+ Type[pydantic.BaseModel],+ Type[pydantic.BaseModel],+ Union[Type[dict], Type[pydantic.BaseModel], UnionType],]:if stream_type is None:# TODO -- derive from the signaturediff --git a/tests/integrations/test_burr_pydantic.py b/tests/integrations/test_burr_pydantic.pyindex 567f8be6..662ecb51 100644--- a/tests/integrations/test_burr_pydantic.py+++ b/tests/integrations/test_burr_pydantic.py@@ -16,6 +16,7 @@# under the License.import asyncio+import sysimport warningsfrom typing import AsyncGenerator, Generator, List, Optional, Tuple@@ -449,6 +450,50 @@ def test_streaming_pydantic_action_same_io():assert final_state.data.times_called == 1[email protected](sys.version_info < (3, 10), reason="PEP 604 union syntax requires Python 3.10+")+def test_streaming_pydantic_action_union_stream_type():+ class IntermediateUnionModelOne(BaseModel):+ result: int++ class IntermediateUnionModelTwo(BaseModel):+ message: str++ @pydantic_streaming_action(+ reads=["count", "times_called"],+ writes=["count", "times_called"],+ stream_type=IntermediateUnionModelOne | IntermediateUnionModelTwo,+ state_input_type=AppStateModel,+ state_output_type=AppStateModel,+ )+ def act(+ state: AppStateModel, total_count: int+ ) -> Generator[Tuple[IntermediateUnionModelOne, Optional[AppStateModel]], None, None]:+ initial_value = state.count+ for i in range(initial_value, initial_value + total_count):+ yield IntermediateUnionModelOne(result=i), None+ state.count = i+ state.times_called += 1+ yield IntermediateUnionModelOne(result=state.count), state++ assert hasattr(act, "bind") # has to have bind+ assert (action_function := getattr(act, FunctionBasedAction.ACTION_FUNCTION, None)) is not None+ assert action_function.inputs == (["total_count"], [])+ gen = action_function.fn(+ State(dict(count=1, times_called=0), typing_system=PydanticTypingSystem(AppStateModel)),+ total_count=5,+ )+ result = list(gen)+ assert len(result) == 6+ assert [item[0].result for item in result] == [1, 2, 3, 4, 5, 5]+ assert all([isinstance(item[0], IntermediateUnionModelOne) for item in result])+ assert all([item[1] is None for item in result[:-1]])+ assert isinstance(final_state := result[-1][1], State)+ assert final_state["count"] == 5+ assert final_state["times_called"] == 1+ assert final_state.data.count == 5+ assert final_state.data.times_called == 1++async def test_streaming_pydantic_action_same_io_async():@pydantic_streaming_action(reads=["count", "times_called"],