autogen/autogen/io/base.py
Davor Runje 21a7eb3115
Fix iostream on new thread (#2181)
* fixed get_stream in new thread by introducing a global default

* fixed get_stream in new thread by introducing a global default

---------

Co-authored-by: Chi Wang <wang.chi@microsoft.com>
2024-03-28 14:26:01 +00:00

99 lines
3.1 KiB
Python

from contextlib import contextmanager
from contextvars import ContextVar
import logging
from typing import Any, Iterator, Optional, Protocol, runtime_checkable
__all__ = ("OutputStream", "InputStream", "IOStream")
logger = logging.getLogger(__name__)
@runtime_checkable
class OutputStream(Protocol):
def print(self, *objects: Any, sep: str = " ", end: str = "\n", flush: bool = False) -> None:
"""Print data to the output stream.
Args:
objects (any): The data to print.
sep (str, optional): The separator between objects. Defaults to " ".
end (str, optional): The end of the output. Defaults to "\n".
flush (bool, optional): Whether to flush the output. Defaults to False.
"""
... # pragma: no cover
@runtime_checkable
class InputStream(Protocol):
def input(self, prompt: str = "", *, password: bool = False) -> str:
"""Read a line from the input stream.
Args:
prompt (str, optional): The prompt to display. Defaults to "".
password (bool, optional): Whether to read a password. Defaults to False.
Returns:
str: The line read from the input stream.
"""
... # pragma: no cover
@runtime_checkable
class IOStream(InputStream, OutputStream, Protocol):
"""A protocol for input/output streams."""
# ContextVar must be used in multithreaded or async environments
_default_io_stream: ContextVar[Optional["IOStream"]] = ContextVar("default_iostream", default=None)
_default_io_stream.set(None)
_global_default: Optional["IOStream"] = None
@staticmethod
def set_global_default(stream: "IOStream") -> None:
"""Set the default input/output stream.
Args:
stream (IOStream): The input/output stream to set as the default.
"""
IOStream._global_default = stream
@staticmethod
def get_global_default() -> "IOStream":
"""Get the default input/output stream.
Returns:
IOStream: The default input/output stream.
"""
if IOStream._global_default is None:
raise RuntimeError("No global default IOStream has been set")
return IOStream._global_default
@staticmethod
def get_default() -> "IOStream":
"""Get the default input/output stream.
Returns:
IOStream: The default input/output stream.
"""
iostream = IOStream._default_io_stream.get()
if iostream is None:
logger.warning("No default IOStream has been set, defaulting to IOConsole.")
return IOStream.get_global_default()
return iostream
@staticmethod
@contextmanager
def set_default(stream: Optional["IOStream"]) -> Iterator[None]:
"""Set the default input/output stream.
Args:
stream (IOStream): The input/output stream to set as the default.
"""
global _default_io_stream
try:
token = IOStream._default_io_stream.set(stream)
yield
finally:
IOStream._default_io_stream.reset(token)
return