Skip to content

# Module `liteyuki.message.rule` ​

Copyright (C) 2020-2024 LiteyukiStudio. All Rights Reserved

@Time : 2024/8/19 下午10:55 @Author : snowykami @Email : snowykami@outlook.com @File : rule.py @Software: PyCharm

### var `RuleHandlerFunc` ​

- Description: 规则函数签名

- Type: `TypeAlias`

- Default: `Callable[[MessageEvent], Coroutine[None, None, bool]]`

### class `Rule` ​

#### func `__init__(self, handler: RuleHandlerFunc)` ​

Source code or View on GitHub
python

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

#### func `self | other: Rule => Rule` ​

Source code or View on GitHub
python

    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)

#### func `self & other: Rule => Rule` ​

Source code or View on GitHub
python

    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 func `self () event: MessageEvent => bool` ​

Source code or View on GitHub
python

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

`@Rule`

### async func `empty_rule(event: MessageEvent) -> bool` ​

Source code or View on GitHub
python

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

`@Rule`

### async func `is_su_rule(event: MessageEvent) -> bool` ​

Source code or View on GitHub
python

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