Skip to content

MemoryStream

autogen.beta.stream.MemoryStream #

MemoryStream(storage=None, *, id=None, persist_all=False)

Bases: ABCStream

Source code in autogen/beta/stream.py 
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
def __init__(
    self,
    storage: Storage | None = None,
    *,
    id: StreamId | None = None,
    persist_all: bool = False,
) -> None:
    self.id: StreamId = id or uuid4()

    self._subscribers: dict[SubId, tuple[Condition | None, CallModel]] = {}
    # ordered dict
    self._interrupters: dict[SubId, tuple[Condition | None, CallModel]] = {}

    storage = storage or MemoryStorage()
    self.history = History(self.id, storage)
    # Agent._execute populates this lazily on first turn — setting it
    # to None here so `getattr(..., None)` returns None instead of
    # hitting a slot-uninitialized AttributeError.
    self._ag2_turn_lock = None  # type: ignore[assignment]

    if persist_all:
        # Persist every event including transient ones (streaming chunks, lifecycle, etc.)
        self.subscribe(storage.save_event)
    else:
        # Default: skip events marked __transient__ (ModelMessageChunk, TaskProgress, etc.)
        # These are real-time streaming artifacts superseded by their final counterparts.
        self.subscribe(_FilteredStorage(storage).save_event)

id instance-attribute #

id = id or uuid4()

history instance-attribute #

history = History(id, storage)

subscribe #

subscribe(func: Callable[..., Any], *, interrupt: bool = False, sync_to_thread: bool = True, condition: Condition | None = None) -> SubId

subscribe(func: None = None, *, interrupt: bool = False, sync_to_thread: bool = True, condition: Condition | None = None) -> Callable[[Callable[..., Any]], SubId]

subscribe(func=None, *, interrupt=False, sync_to_thread=True, condition=None)
Source code in autogen/beta/stream.py 
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
def subscribe(
    self,
    func: Callable[..., Any] | None = None,
    *,
    interrupt: bool = False,
    sync_to_thread: bool = True,
    condition: Condition | None = None,
) -> Callable[[Callable[..., Any]], SubId] | SubId:
    def sub(s: Callable[..., Any]) -> SubId:
        sub_id = uuid4()
        model = build_model(s, sync_to_thread=sync_to_thread, serialize_result=False)
        if interrupt:
            self._interrupters[sub_id] = (condition, model)
        else:
            self._subscribers[sub_id] = (condition, model)
        return sub_id

    if func:
        return sub(func)
    return sub

unsubscribe #

unsubscribe(sub_id)
Source code in autogen/beta/stream.py 
184
185
186
def unsubscribe(self, sub_id: SubId) -> None:
    self._subscribers.pop(sub_id, None)
    self._interrupters.pop(sub_id, None)

send async #

send(event, context)
Source code in autogen/beta/stream.py 
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
async def send(self, event: BaseEvent, context: "ConversationContext") -> None:
    # interrupters should follow registration order
    for condition, interrupter in tuple(self._interrupters.values()):
        if condition and not condition(event):
            continue

        async with AsyncExitStack() as stack:
            if not (
                e := await interrupter.asolve(
                    event,
                    cache_dependencies={},
                    stack=stack,
                    dependency_provider=context.dependency_provider,
                    **{CONTEXT_OPTION_NAME: context},
                )
            ):
                return

        event = e

    # TODO: we need to publish under RWLock to prevent
    # subscribers dictionary mutation. Now it is protected by copy
    for condition, s in tuple(self._subscribers.values()):
        if condition and not condition(event):
            continue

        async with AsyncExitStack() as stack:
            await s.asolve(
                event,
                cache_dependencies={},
                stack=stack,
                dependency_provider=context.dependency_provider,
                **{CONTEXT_OPTION_NAME: context},
            )

where #

where(condition)
Source code in autogen/beta/stream.py 
67
68
69
70
71
72
73
def where(
    self,
    condition: ClassInfo | Condition,
) -> "Stream":
    if not isinstance(condition, Condition):
        condition = TypeCondition(condition)
    return SubStream(self, condition)

join #

join(*, max_events=None)
Source code in autogen/beta/stream.py 
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
@contextmanager
def join(self, *, max_events: int | None = None) -> Iterator[AsyncIterator[BaseEvent]]:
    queue = asyncio.Queue[BaseEvent]()

    async def write_events(event: BaseEvent) -> None:
        await queue.put(event)

    if max_events:

        async def listen_events() -> AsyncIterator[BaseEvent]:
            for _ in range(max_events):
                yield await queue.get()

    else:

        async def listen_events() -> AsyncIterator[BaseEvent]:
            while True:
                yield await queue.get()

    with self.sub_scope(write_events):
        yield listen_events()

sub_scope #

sub_scope(func, *, interrupt=False, sync_to_thread=True)
Source code in autogen/beta/stream.py 
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
@contextmanager
def sub_scope(
    self,
    func: Callable[..., Any],
    *,
    interrupt: bool = False,
    sync_to_thread: bool = True,
) -> Iterator[None]:
    sub_id = self.subscribe(
        func,
        interrupt=interrupt,
        sync_to_thread=sync_to_thread,
    )

    try:
        yield
    finally:
        self.unsubscribe(sub_id)

get async #

get(condition)
Source code in autogen/beta/stream.py 
75
76
77
78
79
80
81
82
83
84
85
86
@asynccontextmanager
async def get(
    self,
    condition: ClassInfo | Condition,
) -> AsyncIterator[asyncio.Future[BaseEvent]]:
    result = asyncio.Future[BaseEvent]()

    async def wait_result(event: BaseEvent) -> None:
        result.set_result(event)

    with self.where(condition).sub_scope(wait_result):
        yield result