liteyuki.bot.lifespan

class `Lifespan`

method `init(self) -> None`

说明: 轻雪生命周期管理，启动、停止、重启

源代码

def __init__(self) -> None:
    """
        轻雪生命周期管理，启动、停止、重启
        """
    self.life_flag: int = 0
    self._before_start_funcs: list[LIFESPAN_FUNC] = []
    self._after_start_funcs: list[LIFESPAN_FUNC] = []
    self._before_process_shutdown_funcs: list[LIFESPAN_FUNC] = []
    self._after_shutdown_funcs: list[LIFESPAN_FUNC] = []
    self._before_process_restart_funcs: list[LIFESPAN_FUNC] = []
    self._after_restart_funcs: list[LIFESPAN_FUNC] = []

`@staticmethod`

async method `run_funcs(funcs: list[ASYNC_LIFESPAN_FUNC | PROCESS_LIFESPAN_FUNC]) -> None`

说明: 并发运行异步函数

参数:

funcs:

源代码

@staticmethod
async def run_funcs(funcs: list[ASYNC_LIFESPAN_FUNC | PROCESS_LIFESPAN_FUNC], *args, **kwargs) -> None:
    """
        并发运行异步函数
        Args:
            funcs:
        Returns:
        """
    loop = asyncio.get_running_loop()
    tasks = [func(*args, **kwargs) if is_coroutine_callable(func) else async_wrapper(func)(*args, **kwargs) for func in funcs]
    await asyncio.gather(*tasks)

method `on_before_start(self, func: LIFESPAN_FUNC) -> LIFESPAN_FUNC`

说明: 注册启动时的函数

返回: LIFESPAN_FUNC:

参数:

func:

源代码

def on_before_start(self, func: LIFESPAN_FUNC) -> LIFESPAN_FUNC:
    """
        注册启动时的函数
        Args:
            func:
        Returns:
            LIFESPAN_FUNC:
        """
    self._before_start_funcs.append(func)
    return func

method `on_after_start(self, func: LIFESPAN_FUNC) -> LIFESPAN_FUNC`

说明: 注册启动时的函数

返回: LIFESPAN_FUNC:

参数:

func:

源代码

def on_after_start(self, func: LIFESPAN_FUNC) -> LIFESPAN_FUNC:
    """
        注册启动时的函数
        Args:
            func:
        Returns:
            LIFESPAN_FUNC:
        """
    self._after_start_funcs.append(func)
    return func

method `on_before_process_shutdown(self, func: LIFESPAN_FUNC) -> LIFESPAN_FUNC`

说明: 注册停止前的函数

返回: LIFESPAN_FUNC:

参数:

func:

源代码

def on_before_process_shutdown(self, func: LIFESPAN_FUNC) -> LIFESPAN_FUNC:
    """
        注册停止前的函数
        Args:
            func:
        Returns:
            LIFESPAN_FUNC:
        """
    self._before_process_shutdown_funcs.append(func)
    return func

method `on_after_shutdown(self, func: LIFESPAN_FUNC) -> LIFESPAN_FUNC`

说明: 注册停止后的函数

返回: LIFESPAN_FUNC:

参数:

func:

源代码

def on_after_shutdown(self, func: LIFESPAN_FUNC) -> LIFESPAN_FUNC:
    """
        注册停止后的函数
        Args:
            func:

        Returns:
            LIFESPAN_FUNC:

        """
    self._after_shutdown_funcs.append(func)
    return func

method `on_before_process_restart(self, func: LIFESPAN_FUNC) -> LIFESPAN_FUNC`

说明: 注册重启时的函数

返回: LIFESPAN_FUNC:

参数:

func:

源代码

def on_before_process_restart(self, func: LIFESPAN_FUNC) -> LIFESPAN_FUNC:
    """
        注册重启时的函数
        Args:
            func:
        Returns:
            LIFESPAN_FUNC:
        """
    self._before_process_restart_funcs.append(func)
    return func

method `on_after_restart(self, func: LIFESPAN_FUNC) -> LIFESPAN_FUNC`

说明: 注册重启后的函数

返回: LIFESPAN_FUNC:

参数:

func:

源代码

def on_after_restart(self, func: LIFESPAN_FUNC) -> LIFESPAN_FUNC:
    """
        注册重启后的函数
        Args:
            func:
        Returns:
            LIFESPAN_FUNC:
        """
    self._after_restart_funcs.append(func)
    return func

async method `before_start(self) -> None`

说明: 启动前

源代码

async def before_start(self) -> None:
    """
        启动前
        Returns:
        """
    logger.debug('Running before_start functions')
    await self.run_funcs(self._before_start_funcs)

async method `after_start(self) -> None`

说明: 启动后

源代码

async def after_start(self) -> None:
    """
        启动后
        Returns:
        """
    logger.debug('Running after_start functions')
    await self.run_funcs(self._after_start_funcs)

async method `before_process_shutdown(self) -> None`

说明: 停止前

源代码

async def before_process_shutdown(self) -> None:
    """
        停止前
        Returns:
        """
    logger.debug('Running before_shutdown functions')
    await self.run_funcs(self._before_process_shutdown_funcs)

async method `after_shutdown(self) -> None`

说明: 停止后

源代码

async def after_shutdown(self) -> None:
    """
        停止后
        Returns:
        """
    logger.debug('Running after_shutdown functions')
    await self.run_funcs(self._after_shutdown_funcs)

async method `before_process_restart(self) -> None`

说明: 重启前

源代码

async def before_process_restart(self) -> None:
    """
        重启前
        Returns:
        """
    logger.debug('Running before_restart functions')
    await self.run_funcs(self._before_process_restart_funcs)

async method `after_restart(self) -> None`

说明: 重启后

源代码

async def after_restart(self) -> None:
    """
        重启后
        Returns:

        """
    logger.debug('Running after_restart functions')
    await self.run_funcs(self._after_restart_funcs)

var `SYNC_LIFESPAN_FUNC = Callable[[], Any]`

类型: TypeAlias

var `ASYNC_LIFESPAN_FUNC = Callable[[], Awaitable[Any]]`

类型: TypeAlias

var `LIFESPAN_FUNC = SYNC_LIFESPAN_FUNC | ASYNC_LIFESPAN_FUNC`

类型: TypeAlias

var `SYNC_PROCESS_LIFESPAN_FUNC = Callable[[str], Any]`

类型: TypeAlias

var `ASYNC_PROCESS_LIFESPAN_FUNC = Callable[[str], Awaitable[Any]]`

类型: TypeAlias

var `PROCESS_LIFESPAN_FUNC = SYNC_PROCESS_LIFESPAN_FUNC | ASYNC_PROCESS_LIFESPAN_FUNC`

类型: TypeAlias