LiteyukiBot/docs/en/dev/api/core/manager.md

title	order	icon	category
liteyuki.core.manager	1	laptop-code	API

class ChannelDeliver

  def __init__(self, active: Channel[Any], passive: Channel[Any], channel_deliver_active: Channel[Channel[Any]], channel_deliver_passive: Channel[tuple[str, dict]], publish: Channel[tuple[str, Any]]) -> None

 

源代码

def __init__(self, active: Channel[Any], passive: Channel[Any], channel_deliver_active: Channel[Channel[Any]], channel_deliver_passive: Channel[tuple[str, dict]], publish: Channel[tuple[str, Any]]):
    self.active = active
    self.passive = passive
    self.channel_deliver_active = channel_deliver_active
    self.channel_deliver_passive = channel_deliver_passive
    self.publish = publish

class ProcessManager

进程管理器

  def __init__(self, lifespan: 'Lifespan') -> None

 

源代码

def __init__(self, lifespan: 'Lifespan'):
    self.lifespan = lifespan
    self.targets: dict[str, tuple[Callable, tuple, dict]] = {}
    self.processes: dict[str, Process] = {}

  def start(self, name: str) -> None

 开启后自动监控进程，并添加到进程字典中

Args:

name:

Returns:

源代码

def start(self, name: str):
    """
        开启后自动监控进程，并添加到进程字典中
        Args:
            name:
        Returns:

        """
    if name not in self.targets:
        raise KeyError(f'Process {name} not found.')
    chan_active = get_channel(f'{name}-active')

    def _start_process():
        process = Process(target=self.targets[name][0], args=self.targets[name][1], kwargs=self.targets[name][2], daemon=True)
        self.processes[name] = process
        process.start()
    _start_process()
    while True:
        data = chan_active.receive()
        if data == 0:
            logger.info(f'Stopping process {name}')
            self.lifespan.before_process_shutdown()
            self.terminate(name)
            break
        elif data == 1:
            logger.info(f'Restarting process {name}')
            self.lifespan.before_process_shutdown()
            self.lifespan.before_process_restart()
            self.terminate(name)
            _start_process()
            continue
        else:
            logger.warning('Unknown data received, ignored.')

  def start_all(self) -> None

 启动所有进程

源代码

def start_all(self):
    """
        启动所有进程
        """
    for name in self.targets:
        threading.Thread(target=self.start, args=(name,), daemon=True).start()

  def add_target(self, name: str, target: TARGET_FUNC, args: tuple, kwargs: Any) -> None

 添加进程

Args:

name: 进程名，用于获取和唯一标识

target: 进程函数

args: 进程函数参数

kwargs: 进程函数关键字参数，通常会默认传入chan_active和chan_passive

源代码

def add_target(self, name: str, target: TARGET_FUNC, args: tuple=(), kwargs=None):
    """
        添加进程
        Args:
            name: 进程名，用于获取和唯一标识
            target: 进程函数
            args: 进程函数参数
            kwargs: 进程函数关键字参数，通常会默认传入chan_active和chan_passive
        """
    if kwargs is None:
        kwargs = {}
    chan_active: Channel = Channel(_id=f'{name}-active')
    chan_passive: Channel = Channel(_id=f'{name}-passive')
    channel_deliver = ChannelDeliver(active=chan_active, passive=chan_passive, channel_deliver_active=channel_deliver_active_channel, channel_deliver_passive=channel_deliver_passive_channel, publish=publish_channel)
    self.targets[name] = (_delivery_channel_wrapper, (target, channel_deliver, shared_memory, *args), kwargs)
    set_channels({f'{name}-active': chan_active, f'{name}-passive': chan_passive})

  def join_all(self) -> None

 

源代码

def join_all(self):
    for name, process in self.targets:
        process.join()

  def terminate(self, name: str) -> None

 终止进程并从进程字典中删除

Args:

name:

Returns:

源代码

def terminate(self, name: str):
    """
        终止进程并从进程字典中删除
        Args:
            name:

        Returns:

        """
    if name not in self.processes:
        logger.warning(f'Process {name} not found.')
        return
    process = self.processes[name]
    process.terminate()
    process.join(TIMEOUT)
    if process.is_alive():
        process.kill()
    logger.success(f'Process {name} terminated.')

  def terminate_all(self) -> None

 

源代码

def terminate_all(self):
    for name in self.targets:
        self.terminate(name)

  def is_process_alive(self, name: str) -> bool

 检查进程是否存活

Args:

name:

Returns:

源代码

def is_process_alive(self, name: str) -> bool:
    """
        检查进程是否存活
        Args:
            name:

        Returns:

        """
    if name not in self.targets:
        logger.warning(f'Process {name} not found.')
    return self.processes[name].is_alive()

var TIMEOUT = 10

var chan_active = get_channel(f'{name}-active')

var channel_deliver = ChannelDeliver(active=chan_active, passive=chan_passive, channel_deliver_active=channel_deliver_active_channel, channel_deliver_passive=channel_deliver_passive_channel, publish=publish_channel)

var process = self.processes[name]

var process = Process(target=self.targets[name][0], args=self.targets[name][1], kwargs=self.targets[name][2], daemon=True)

var data = chan_active.receive()

var kwargs = {}