import{_ as n,o as s,c as a,e}from"./app-BtEtfm2z.js";const t={},p=e(`

def get_bot() -> LiteyukiBot

获取轻雪实例

Returns:

LiteyukiBot: 当前的轻雪实例
源代码
def get_bot() -> LiteyukiBot:
    """
    获取轻雪实例

    Returns:
        LiteyukiBot: 当前的轻雪实例
    """
    if IS_MAIN_PROCESS:
        if _BOT_INSTANCE is None:
            raise RuntimeError('Liteyuki instance not initialized.')
        return _BOT_INSTANCE
    else:
        raise RuntimeError("Can't get bot instance in sub process.")

def get_config(key: str, default: Any) -> Any

获取配置

Args:

key: 配置键

default: 默认值

Returns:

Any: 配置值
源代码
def get_config(key: str, default: Any=None) -> Any:
    """
    获取配置
    Args:
        key: 配置键
        default: 默认值

    Returns:
        Any: 配置值
    """
    return get_bot().config.get(key, default)

def get_config_with_compat(key: str, compat_keys: tuple[str], default: Any) -> Any

获取配置,兼容旧版本

Args:

key: 配置键

compat_keys: 兼容键

default: 默认值

Returns:

Any: 配置值
源代码
def get_config_with_compat(key: str, compat_keys: tuple[str], default: Any=None) -> Any:
    """
    获取配置,兼容旧版本
    Args:
        key: 配置键
        compat_keys: 兼容键
        default: 默认值

    Returns:
        Any: 配置值
    """
    if key in get_bot().config:
        return get_bot().config[key]
    for compat_key in compat_keys:
        if compat_key in get_bot().config:
            logger.warning(f'Config key "{compat_key}" will be deprecated, use "{key}" instead.')
            return get_bot().config[compat_key]
    return default

def print_logo() -> None

源代码
def print_logo():
    print('\\x1b[34m' + '\\n     __        ______  ________  ________  __      __  __    __  __    __  ______ \\n    /  |      /      |/        |/        |/  \\\\    /  |/  |  /  |/  |  /  |/      |\\n    $$ |      $$$$$$/ $$$$$$$$/ $$$$$$$$/ $$  \\\\  /$$/ $$ |  $$ |$$ | /$$/ $$$$$$/ \\n    $$ |        $$ |     $$ |   $$ |__     $$  \\\\/$$/  $$ |  $$ |$$ |/$$/    $$ |  \\n    $$ |        $$ |     $$ |   $$    |     $$  $$/   $$ |  $$ |$$  $$<     $$ |  \\n    $$ |        $$ |     $$ |   $$$$$/       $$$$/    $$ |  $$ |$$$$$  \\\\    $$ |  \\n    $$ |_____  _$$ |_    $$ |   $$ |_____     $$ |    $$ \\\\__$$ |$$ |$$  \\\\  _$$ |_ \\n    $$       |/ $$   |   $$ |   $$       |    $$ |    $$    $$/ $$ | $$  |/ $$   |\\n    $$$$$$$$/ $$$$$$/    $$/    $$$$$$$$/     $$/      $$$$$$/  $$/   $$/ $$$$$$/ \\n                ' + '\\x1b[0m')

class LiteyukiBot

def __init__(self) -> None

 初始化轻雪实例

Args:

*args:

**kwargs: 配置
源代码
def __init__(self, *args, **kwargs) -> None:
    """
        初始化轻雪实例
        Args:
            *args:
            **kwargs: 配置

        """
    '常规操作'
    print_logo()
    global _BOT_INSTANCE
    _BOT_INSTANCE = self
    '配置'
    self.config: dict[str, Any] = kwargs
    '初始化'
    self.init(**self.config)
    logger.info('Liteyuki is initializing...')
    '生命周期管理'
    self.lifespan = Lifespan()
    self.process_manager: ProcessManager = ProcessManager(lifespan=self.lifespan)
    '事件循环'
    self.loop = asyncio.new_event_loop()
    asyncio.set_event_loop(self.loop)
    self.stop_event = threading.Event()
    self.call_restart_count = 0
    '加载插件加载器'
    load_plugin('liteyuki.plugins.plugin_loader')
    '信号处理'
    signal.signal(signal.SIGINT, self._handle_exit)
    signal.signal(signal.SIGTERM, self._handle_exit)
    atexit.register(self.process_manager.terminate_all)

def run(self) -> None

 启动逻辑

源代码
def run(self):
    """
        启动逻辑
        """
    self.lifespan.before_start()
    self.process_manager.start_all()
    self.lifespan.after_start()
    self.keep_alive()

def keep_alive(self) -> None

 保持轻雪运行

Returns:

源代码
def keep_alive(self):
    """
        保持轻雪运行
        Returns:

        """
    try:
        while not self.stop_event.is_set():
            time.sleep(0.5)
    except KeyboardInterrupt:
        logger.info('Liteyuki is stopping...')
        self.stop()

def restart(self, delay: int) -> None

 重启轻雪本体

Returns:

源代码
def restart(self, delay: int=0):
    """
        重启轻雪本体
        Returns:

        """
    if self.call_restart_count < 1:
        executable = sys.executable
        args = sys.argv
        logger.info('Restarting LiteyukiBot...')
        time.sleep(delay)
        if platform.system() == 'Windows':
            cmd = 'start'
        elif platform.system() == 'Linux':
            cmd = 'nohup'
        elif platform.system() == 'Darwin':
            cmd = 'open'
        else:
            cmd = 'nohup'
        self.process_manager.terminate_all()
        threading.Thread(target=os.system, args=(f"{cmd} {executable} {' '.join(args)}",)).start()
        sys.exit(0)
    self.call_restart_count += 1

def restart_process(self, name: Optional[str]) -> None

 停止轻雪

Args:

name: 进程名称, 默认为None, 所有进程

Returns:

源代码
def restart_process(self, name: Optional[str]=None):
    """
        停止轻雪
        Args:
            name: 进程名称, 默认为None, 所有进程
        Returns:
        """
    self.lifespan.before_process_shutdown()
    self.lifespan.before_process_shutdown()
    if name is not None:
        chan_active = get_channel(f'{name}-active')
        chan_active.send(1)
    else:
        for process_name in self.process_manager.processes:
            chan_active = get_channel(f'{process_name}-active')
            chan_active.send(1)

def init(self) -> None

 初始化轻雪, 自动调用

Returns:

源代码
def init(self, *args, **kwargs):
    """
        初始化轻雪, 自动调用
        Returns:

        """
    self.init_logger()

def init_logger(self) -> None

源代码
def init_logger(self):
    init_log(config=self.config)

def stop(self) -> None

 停止轻雪

Returns:

源代码
def stop(self):
    """
        停止轻雪
        Returns:

        """
    self.stop_event.set()
    self.loop.stop()

def on_before_start(self, func: LIFESPAN_FUNC) -> None

 注册启动前的函数

Args:

func:

Returns:

源代码
def on_before_start(self, func: LIFESPAN_FUNC):
    """
        注册启动前的函数
        Args:
            func:

        Returns:

        """
    return self.lifespan.on_before_start(func)

def on_after_start(self, func: LIFESPAN_FUNC) -> None

 注册启动后的函数

Args:

func:

Returns:

源代码
def on_after_start(self, func: LIFESPAN_FUNC):
    """
        注册启动后的函数
        Args:
            func:

        Returns:

        """
    return self.lifespan.on_after_start(func)

def on_after_shutdown(self, func: LIFESPAN_FUNC) -> None

 注册停止后的函数:未实现

Args:

func:

Returns:

源代码
def on_after_shutdown(self, func: LIFESPAN_FUNC):
    """
        注册停止后的函数:未实现
        Args:
            func:

        Returns:

        """
    return self.lifespan.on_after_shutdown(func)

def on_before_process_shutdown(self, func: LIFESPAN_FUNC) -> None

 注册进程停止前的函数,为子进程停止时调用

Args:

func:

Returns:

源代码
def on_before_process_shutdown(self, func: LIFESPAN_FUNC):
    """
        注册进程停止前的函数,为子进程停止时调用
        Args:
            func:

        Returns:

        """
    return self.lifespan.on_before_process_shutdown(func)

def on_before_process_restart(self, func: LIFESPAN_FUNC) -> None

 注册进程重启前的函数,为子进程重启时调用

Args:

func:

Returns:

源代码
def on_before_process_restart(self, func: LIFESPAN_FUNC):
    """
        注册进程重启前的函数,为子进程重启时调用
        Args:
            func:

        Returns:

        """
    return self.lifespan.on_before_process_restart(func)

def on_after_restart(self, func: LIFESPAN_FUNC) -> None

 注册重启后的函数:未实现

Args:

func:

Returns:

源代码
def on_after_restart(self, func: LIFESPAN_FUNC):
    """
        注册重启后的函数:未实现
        Args:
            func:

        Returns:

        """
    return self.lifespan.on_after_restart(func)

def on_after_nonebot_init(self, func: LIFESPAN_FUNC) -> None

 注册nonebot初始化后的函数

Args:

func:

Returns:

源代码
def on_after_nonebot_init(self, func: LIFESPAN_FUNC):
    """
        注册nonebot初始化后的函数
        Args:
            func:

        Returns:

        """
    return self.lifespan.on_after_nonebot_init(func)

var executable = sys.executable

var args = sys.argv

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

var cmd = 'start'

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

var cmd = 'nohup'

var cmd = 'open'

var cmd = 'nohup'

`,105),o=[p];function i(l,c){return s(),a("div",null,o)}const r=n(t,[["render",i],["__file","index.html.vue"]]),d=JSON.parse(`{"path":"/en/dev/api/bot/","title":"liteyuki.bot","lang":"en-US","frontmatter":{"title":"liteyuki.bot","index":true,"icon":"laptop-code","category":"API","description":"def get_bot() -> LiteyukiBot 获取轻雪实例 Returns: 源代码 def get_config(key: str, default: Any) -> Any 获取配置 Args: Returns: 源代码 def get_config_with_compat(key: str, compat_keys: tuple[st...","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://vuepress-theme-hope-docs-demo.netlify.app/dev/api/bot/"}],["meta",{"property":"og:url","content":"https://vuepress-theme-hope-docs-demo.netlify.app/en/dev/api/bot/"}],["meta",{"property":"og:site_name","content":"LiteyukiBot"}],["meta",{"property":"og:title","content":"liteyuki.bot"}],["meta",{"property":"og:description","content":"def get_bot() -> LiteyukiBot 获取轻雪实例 Returns: 源代码 def get_config(key: str, default: Any) -> Any 获取配置 Args: Returns: 源代码 def get_config_with_compat(key: str, compat_keys: tuple[st..."}],["meta",{"property":"og:type","content":"article"}],["meta",{"property":"og:locale","content":"en-US"}],["meta",{"property":"og:locale:alternate","content":"zh-CN"}],["meta",{"property":"og:updated_time","content":"2024-08-21T09:59:21.000Z"}],["meta",{"property":"article:modified_time","content":"2024-08-21T09:59:21.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"liteyuki.bot\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2024-08-21T09:59:21.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":3,"title":"def get_bot() -> LiteyukiBot","slug":"def-get-bot-liteyukibot","link":"#def-get-bot-liteyukibot","children":[]},{"level":3,"title":"def get_config(key: str, default: Any) -> Any","slug":"def-get-config-key-str-default-any-any","link":"#def-get-config-key-str-default-any-any","children":[]},{"level":3,"title":"def get_config_with_compat(key: str, compat_keys: tuple[str], default: Any) -> Any","slug":"def-get-config-with-compat-key-str-compat-keys-tuple-str-default-any-any","link":"#def-get-config-with-compat-key-str-compat-keys-tuple-str-default-any-any","children":[]},{"level":3,"title":"def print_logo() -> None","slug":"def-print-logo-none","link":"#def-print-logo-none","children":[]},{"level":3,"title":"class LiteyukiBot","slug":"class-liteyukibot","link":"#class-liteyukibot","children":[]},{"level":3,"title":"def __init__(self) -> None","slug":"def-init-self-none","link":"#def-init-self-none","children":[]},{"level":3,"title":"def run(self) -> None","slug":"def-run-self-none","link":"#def-run-self-none","children":[]},{"level":3,"title":"def keep_alive(self) -> None","slug":"def-keep-alive-self-none","link":"#def-keep-alive-self-none","children":[]},{"level":3,"title":"def restart(self, delay: int) -> None","slug":"def-restart-self-delay-int-none","link":"#def-restart-self-delay-int-none","children":[]},{"level":3,"title":"def restart_process(self, name: Optional[str]) -> None","slug":"def-restart-process-self-name-optional-str-none","link":"#def-restart-process-self-name-optional-str-none","children":[]},{"level":3,"title":"def init(self) -> None","slug":"def-init-self-none-1","link":"#def-init-self-none-1","children":[]},{"level":3,"title":"def init_logger(self) -> None","slug":"def-init-logger-self-none","link":"#def-init-logger-self-none","children":[]},{"level":3,"title":"def stop(self) -> None","slug":"def-stop-self-none","link":"#def-stop-self-none","children":[]},{"level":3,"title":"def on_before_start(self, func: LIFESPAN_FUNC) -> None","slug":"def-on-before-start-self-func-lifespan-func-none","link":"#def-on-before-start-self-func-lifespan-func-none","children":[]},{"level":3,"title":"def on_after_start(self, func: LIFESPAN_FUNC) -> None","slug":"def-on-after-start-self-func-lifespan-func-none","link":"#def-on-after-start-self-func-lifespan-func-none","children":[]},{"level":3,"title":"def on_after_shutdown(self, func: LIFESPAN_FUNC) -> None","slug":"def-on-after-shutdown-self-func-lifespan-func-none","link":"#def-on-after-shutdown-self-func-lifespan-func-none","children":[]},{"level":3,"title":"def on_before_process_shutdown(self, func: LIFESPAN_FUNC) -> None","slug":"def-on-before-process-shutdown-self-func-lifespan-func-none","link":"#def-on-before-process-shutdown-self-func-lifespan-func-none","children":[]},{"level":3,"title":"def on_before_process_restart(self, func: LIFESPAN_FUNC) -> None","slug":"def-on-before-process-restart-self-func-lifespan-func-none","link":"#def-on-before-process-restart-self-func-lifespan-func-none","children":[]},{"level":3,"title":"def on_after_restart(self, func: LIFESPAN_FUNC) -> None","slug":"def-on-after-restart-self-func-lifespan-func-none","link":"#def-on-after-restart-self-func-lifespan-func-none","children":[]},{"level":3,"title":"def on_after_nonebot_init(self, func: LIFESPAN_FUNC) -> None","slug":"def-on-after-nonebot-init-self-func-lifespan-func-none","link":"#def-on-after-nonebot-init-self-func-lifespan-func-none","children":[]},{"level":3,"title":"var executable = sys.executable","slug":"var-executable-sys-executable","link":"#var-executable-sys-executable","children":[]},{"level":3,"title":"var args = sys.argv","slug":"var-args-sys-argv","link":"#var-args-sys-argv","children":[]},{"level":3,"title":"var chan_active = get_channel(f'{name}-active')","slug":"var-chan-active-get-channel-f-name-active","link":"#var-chan-active-get-channel-f-name-active","children":[]},{"level":3,"title":"var cmd = 'start'","slug":"var-cmd-start","link":"#var-cmd-start","children":[]},{"level":3,"title":"var chan_active = get_channel(f'{process_name}-active')","slug":"var-chan-active-get-channel-f-process-name-active","link":"#var-chan-active-get-channel-f-process-name-active","children":[]},{"level":3,"title":"var cmd = 'nohup'","slug":"var-cmd-nohup","link":"#var-cmd-nohup","children":[]},{"level":3,"title":"var cmd = 'open'","slug":"var-cmd-open","link":"#var-cmd-open","children":[]},{"level":3,"title":"var cmd = 'nohup'","slug":"var-cmd-nohup-1","link":"#var-cmd-nohup-1","children":[]}],"git":{"createdTime":1724234361000,"updatedTime":1724234361000,"contributors":[{"name":"snowy","email":"snowykami@outlook.com","commits":1}]},"readingTime":{"minutes":4.02,"words":1205},"filePathRelative":"en/dev/api/bot/README.md","localizedDate":"August 21, 2024","autoDesc":true}`);export{r as comp,d as data};