liteyuki.comm.channel

func `set_channel()`

Description: 设置通道实例

Arguments:

name: 通道名称
channel: 通道实例

Source code

def set_channel(name: str, channel: 'Channel'):
    """
    设置通道实例
    Args:
        name: 通道名称
        channel: 通道实例
    """
    if not isinstance(channel, Channel):
        raise TypeError(f'channel_ must be an instance of Channel, {type(channel)} found')
    if IS_MAIN_PROCESS:
        if name in _channel:
            raise ValueError(f'Channel {name} already exists')
        _channel[name] = channel
    else:
        channel_deliver_passive_channel.send(('set_channel', {'name': name, 'channel_': channel}))

func `set_channels()`

Description: 设置通道实例

Arguments:

channels: 通道名称

Source code

def set_channels(channels: dict[str, 'Channel']):
    """
    设置通道实例
    Args:
        channels: 通道名称
    """
    for (name, channel) in channels.items():
        set_channel(name, channel)

func `get_channel() -> Channel`

Description: 获取通道实例

Arguments:

name: 通道名称

Source code

def get_channel(name: str) -> 'Channel':
    """
    获取通道实例
    Args:
        name: 通道名称
    Returns:
    """
    if IS_MAIN_PROCESS:
        return _channel[name]
    else:
        recv_chan = Channel[Channel[Any]]('recv_chan')
        channel_deliver_passive_channel.send(('get_channel', {'name': name, 'recv_chan': recv_chan}))
        return recv_chan.receive()

func `get_channels() -> dict[str, Channel]`

Description: 获取通道实例

Source code

def get_channels() -> dict[str, 'Channel']:
    """
    获取通道实例
    Returns:
    """
    if IS_MAIN_PROCESS:
        return _channel
    else:
        recv_chan = Channel[dict[str, Channel[Any]]]('recv_chan')
        channel_deliver_passive_channel.send(('get_channels', {'recv_chan': recv_chan}))
        return recv_chan.receive()

`@channel_deliver_passive_channel.on_receive(filter_func=lambda data: data[0] == 'set_channel')`

func `on_set_channel()`

Source code

@channel_deliver_passive_channel.on_receive(filter_func=lambda data: data[0] == 'set_channel')
def on_set_channel(data: tuple[str, dict[str, Any]]):
    (name, channel) = (data[1]['name'], data[1]['channel_'])
    set_channel(name, channel)

`@channel_deliver_passive_channel.on_receive(filter_func=lambda data: data[0] == 'get_channel')`

func `on_get_channel()`

Source code

@channel_deliver_passive_channel.on_receive(filter_func=lambda data: data[0] == 'get_channel')
def on_get_channel(data: tuple[str, dict[str, Any]]):
    (name, recv_chan) = (data[1]['name'], data[1]['recv_chan'])
    recv_chan.send(get_channel(name))

`@channel_deliver_passive_channel.on_receive(filter_func=lambda data: data[0] == 'get_channels')`

func `on_get_channels()`

Source code

@channel_deliver_passive_channel.on_receive(filter_func=lambda data: data[0] == 'get_channels')
def on_get_channels(data: tuple[str, dict[str, Any]]):
    recv_chan = data[1]['recv_chan']
    recv_chan.send(get_channels())

class `Channel(Generic[T])`

method `init(self, name: str, type_check: Optional[bool] = None)`

Description: 初始化通道

Arguments:

name: 通道ID
type_check: 是否开启类型检查, 若为空，则传入泛型默认开启，否则默认关闭

Source code

def __init__(self, name: str, type_check: Optional[bool]=None):
    """
        初始化通道
        Args:
            name: 通道ID
            type_check: 是否开启类型检查, 若为空，则传入泛型默认开启，否则默认关闭
        """
    (self.conn_send, self.conn_recv) = Pipe()
    (self._conn_send_inner, self._conn_recv_inner) = Pipe()
    self._closed = False
    self._on_main_receive_func_ids: list[int] = []
    self._on_sub_receive_func_ids: list[int] = []
    self.name: str = name
    self.is_receive_loop_running = False
    if type_check is None:
        type_check = self._get_generic_type() is not None
    elif type_check:
        if self._get_generic_type() is None:
            raise TypeError('Type hint is required for enforcing type check.')
    self.type_check = type_check
    if name in _channel:
        raise ValueError(f'Channel {name} already exists')
    if IS_MAIN_PROCESS:
        if name in _channel:
            raise ValueError(f'Channel {name} already exists')
        _channel[name] = self
        logger.debug(f'Channel {name} initialized in main process')
    else:
        logger.debug(f'Channel {name} initialized in sub process, should manually set in main process')

method `_get_generic_type(self) -> Optional[type]`

Description: 获取通道传递泛型类型

Return: Optional[type]: 泛型类型

Source code

def _get_generic_type(self) -> Optional[type]:
    """
        获取通道传递泛型类型

        Returns:
            Optional[type]: 泛型类型
        """
    if hasattr(self, '__orig_class__'):
        return get_args(self.__orig_class__)[0]
    return None

method `_validate_structure(self, data: Any, structure: type) -> bool`

Description: 验证数据结构

Arguments:

data: 数据
structure: 结构

Return: bool: 是否通过验证

Source code

def _validate_structure(self, data: Any, structure: type) -> bool:
    """
        验证数据结构
        Args:
            data: 数据
            structure: 结构

        Returns:
            bool: 是否通过验证
        """
    if isinstance(structure, type):
        return isinstance(data, structure)
    elif isinstance(structure, tuple):
        if not isinstance(data, tuple) or len(data) != len(structure):
            return False
        return all((self._validate_structure(d, s) for (d, s) in zip(data, structure)))
    elif isinstance(structure, list):
        if not isinstance(data, list):
            return False
        return all((self._validate_structure(d, structure[0]) for d in data))
    elif isinstance(structure, dict):
        if not isinstance(data, dict):
            return False
        return all((k in data and self._validate_structure(data[k], structure[k]) for k in structure))
    return False

method `send(self, data: T)`

Description: 发送数据，发送函数为同步函数，没有异步的必要

Arguments:

data: 数据

Source code

def send(self, data: T):
    """
        发送数据，发送函数为同步函数，没有异步的必要
        Args:
            data: 数据
        """
    if self.type_check:
        _type = self._get_generic_type()
        if _type is not None and (not self._validate_structure(data, _type)):
            raise TypeError(f'Data must be an instance of {_type}, {type(data)} found')
    if self._closed:
        raise RuntimeError('Cannot send to a closed channel_')
    self.conn_send.send(data)

method `receive(self) -> T`

Description: 同步接收数据，会阻塞线程

Source code

def receive(self) -> T:
    """
        同步接收数据，会阻塞线程
        Args:
        """
    if self._closed:
        raise RuntimeError('Cannot receive from a closed channel_')
    while True:
        data = self.conn_recv.recv()
        return data

async method `async_receive(self) -> T`

Description: 异步接收数据，会挂起等待

Source code

async def async_receive(self) -> T:
    """
        异步接收数据，会挂起等待
        """
    print('等待接收数据')
    loop = asyncio.get_running_loop()
    data = await loop.run_in_executor(None, self.receive)
    print('接收到数据')
    return data

method `on_receive(self, filter_func: Optional[FILTER_FUNC] = None) -> Callable[[Callable[[T], Any]], Callable[[T], Any]]`

Description: 接收数据并执行函数

Arguments:

filter_func: 过滤函数，为None则不过滤

Return: 装饰器，装饰一个函数在接收到数据后执行

Source code

def on_receive(self, filter_func: Optional[FILTER_FUNC]=None) -> Callable[[Callable[[T], Any]], Callable[[T], Any]]:
    """
        接收数据并执行函数
        Args:
            filter_func: 过滤函数，为None则不过滤
        Returns:
            装饰器，装饰一个函数在接收到数据后执行
        """
    if not IS_MAIN_PROCESS:
        raise RuntimeError('on_receive can only be used in main process')

    def decorator(func: Callable[[T], Any]) -> Callable[[T], Any]:
        global _func_id

        async def wrapper(data: T) -> Any:
            if filter_func is not None:
                if is_coroutine_callable(filter_func):
                    if not await filter_func(data):
                        return
                elif not filter_func(data):
                    return
            if is_coroutine_callable(func):
                return await func(data)
            else:
                return func(data)
        _callback_funcs[_func_id] = wrapper
        if IS_MAIN_PROCESS:
            self._on_main_receive_func_ids.append(_func_id)
        else:
            self._on_sub_receive_func_ids.append(_func_id)
        _func_id += 1
        return func
    return decorator

async method `_run_on_receive_funcs(self, data: Any)`

Description: 运行接收函数

Arguments:

data: 数据

Source code

async def _run_on_receive_funcs(self, data: Any):
    """
        运行接收函数
        Args:
            data: 数据
        """
    if IS_MAIN_PROCESS:
        [asyncio.create_task(_callback_funcs[func_id](data)) for func_id in self._on_main_receive_func_ids]
    else:
        [asyncio.create_task(_callback_funcs[func_id](data)) for func_id in self._on_sub_receive_func_ids]

async method `start_receive_loop(self)`

Description: 开始接收数据会自动判断主进程和子进程，需要在对应进程都调度一次

Source code

async def start_receive_loop(self):
    """
        开始接收数据
        会自动判断主进程和子进程，需要在对应进程都调度一次
        """
    if len(self._on_main_receive_func_ids) == 0:
        logger.warning(f'No on_receive function registered for {self.name}')
        return
    self.is_receive_loop_running = True
    logger.debug(f'Starting receive loop for {self.name}')
    while not self._closed:
        data = await self.async_receive()
        await self._run_on_receive_funcs(data)

var `active_channel = Channel(name='active_channel')`

Type: Channel
Description: 子进程可用的主动和被动通道

var `publish_channel = Channel(name='publish_channel')`

Type: Channel[tuple[str, dict[str, Any]]]
Description: 通道传递通道，主进程创建单例，子进程初始化时实例化

var `channel_deliver_active_channel = NO_DEFAULT`

Type: Channel[Channel[Any]]
Description: 通道传递通道，主进程创建单例，子进程初始化时实例化