LiteyukiBot/docs/en/dev/api/message/rule.md

title
liteyuki.message.rule

@Rule

async func empty_rule() -> bool

Source code

@Rule
async def empty_rule(event: MessageEvent) -> bool:
    return True

@Rule

async func is_su_rule() -> bool

Source code

@Rule
async def is_su_rule(event: MessageEvent) -> bool:
    return str(event.user_id) in _superusers

class Rule

method __init__(self, handler: RuleHandlerFunc)

Source code

def __init__(self, handler: RuleHandlerFunc):
    self.handler = handler

method __or__(self, other: Rule) -> Rule

Source code

def __or__(self, other: 'Rule') -> 'Rule':

    async def combined_handler(event: MessageEvent) -> bool:
        return await self.handler(event) or await other.handler(event)
    return Rule(combined_handler)

method __and__(self, other: Rule) -> Rule

Source code

def __and__(self, other: 'Rule') -> 'Rule':

    async def combined_handler(event: MessageEvent) -> bool:
        return await self.handler(event) and await other.handler(event)
    return Rule(combined_handler)

async method __call__(self, event: MessageEvent) -> bool

Source code

async def __call__(self, event: MessageEvent) -> bool:
    if self.handler is None:
        return True
    return await self.handler(event)

var _superusers = get_config('liteyuki.superusers', [])

• Type: list[str]

var RuleHandlerFunc = Callable[[MessageEvent], Coroutine[None, None, bool]]

• Type: TypeAlias

• Description: 规则函数签名