import{_ as s,c as i,o as a,a4 as n}from"./chunks/framework.C3o_UkTa.js";const F=JSON.parse('{"title":"liteyuki.bot.lifespan","description":"","frontmatter":{"title":"liteyuki.bot.lifespan"},"headers":[],"relativePath":"dev/api/bot/lifespan.md","filePath":"zh/dev/api/bot/lifespan.md","lastUpdated":null}'),t={name:"dev/api/bot/lifespan.md"},e=n(`
说明: Copyright (C) 2020-2024 LiteyukiStudio. All Rights Reserved
@Time : 2024/7/23 下午8:24 @Author : snowykami @Email : snowykami@outlook.com @File : lifespan.py @Software: PyCharm
Lifespan
__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] = []
run_funcs(funcs: list[ASYNC_LIFESPAN_FUNC | PROCESS_LIFESPAN_FUNC], *args, **kwargs) -> 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)
on_before_start(self, func: LIFESPAN_FUNC) -> LIFESPAN_FUNC
说明: 注册启动时的函数
参数:
- func:
返回: LIFESPAN_FUNC:
def on_before_start(self, func: LIFESPAN_FUNC) -> LIFESPAN_FUNC:
"""
注册启动时的函数
Args:
func:
Returns:
LIFESPAN_FUNC:
"""
self._before_start_funcs.append(func)
return func
on_after_start(self, func: LIFESPAN_FUNC) -> LIFESPAN_FUNC
说明: 注册启动时的函数
参数:
- func:
返回: LIFESPAN_FUNC:
def on_after_start(self, func: LIFESPAN_FUNC) -> LIFESPAN_FUNC:
"""
注册启动时的函数
Args:
func:
Returns:
LIFESPAN_FUNC:
"""
self._after_start_funcs.append(func)
return func
on_before_process_shutdown(self, func: LIFESPAN_FUNC) -> LIFESPAN_FUNC
说明: 注册停止前的函数
参数:
- func:
返回: LIFESPAN_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
on_after_shutdown(self, func: LIFESPAN_FUNC) -> LIFESPAN_FUNC
说明: 注册停止后的函数
参数:
- func:
返回: LIFESPAN_FUNC:
def on_after_shutdown(self, func: LIFESPAN_FUNC) -> LIFESPAN_FUNC:
"""
注册停止后的函数
Args:
func:
Returns:
LIFESPAN_FUNC:
"""
self._after_shutdown_funcs.append(func)
return func
on_before_process_restart(self, func: LIFESPAN_FUNC) -> LIFESPAN_FUNC
说明: 注册重启时的函数
参数:
- func:
返回: LIFESPAN_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
on_after_restart(self, func: LIFESPAN_FUNC) -> LIFESPAN_FUNC
说明: 注册重启后的函数
参数:
- func:
返回: LIFESPAN_FUNC:
def on_after_restart(self, func: LIFESPAN_FUNC) -> LIFESPAN_FUNC:
"""
注册重启后的函数
Args:
func:
Returns:
LIFESPAN_FUNC:
"""
self._after_restart_funcs.append(func)
return func
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)
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)
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)
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)
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)
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)