调整缩进

This commit is contained in:
hemengyang 2022-01-12 19:10:29 +08:00
parent 6d21cbed55
commit 0e97022d3b
18 changed files with 309 additions and 319 deletions

View File

@ -129,7 +129,6 @@ class Bot(abc.ABC):
参数:
event: 上报事件
message: 要发送的消息
**kwargs
"""
raise NotImplementedError

View File

@ -40,9 +40,6 @@ class BlockDriver(Driver):
def on_startup(self, func: STARTUP_FUNC) -> STARTUP_FUNC:
"""
注册一个启动时执行的函数
参数:
func
"""
self.startup_funcs.add(func)
return func
@ -51,9 +48,6 @@ class BlockDriver(Driver):
def on_shutdown(self, func: SHUTDOWN_FUNC) -> SHUTDOWN_FUNC:
"""
注册一个停止时执行的函数
参数:
func
"""
self.shutdown_funcs.add(func)
return func

View File

@ -21,10 +21,6 @@ class NoneBotException(Exception):
class ParserExit(NoneBotException):
"""
`shell command` 处理消息失败时返回的异常
参数:
status
message
"""
def __init__(self, status: int = 0, message: Optional[str] = None):

View File

@ -412,12 +412,11 @@ class Matcher(metaclass=MatcherMeta):
parameterless: Optional[List[Any]] = None,
) -> Callable[[T_Handler], T_Handler]:
"""
装饰一个函数来指示 NoneBot 当要获取的 `key` 不存在时接收用户新的一条消息并经过 `ArgsParser` 处理后再运行该函数如果 `key` 已存在则直接继续运行
装饰一个函数来指示 NoneBot 当要获取的 `key` 不存在时接收用户新的一条消息再运行该函数如果 `key` 已存在则直接继续运行
参数:
key: 参数名
prompt: 在参数不存在时向用户发送的消息
args_parser: 可选参数解析函数空则使用默认解析函数
parameterless: 非参数类型依赖列表
"""
@ -459,7 +458,7 @@ class Matcher(metaclass=MatcherMeta):
参数:
message: 消息内容
**kwargs`bot.send` 的参数请参考对应 adapter bot 对象 api
**kwargs: `bot.send` 的参数请参考对应 adapter bot 对象 api
"""
bot = current_bot.get()
event = current_event.get()
@ -481,7 +480,7 @@ class Matcher(metaclass=MatcherMeta):
参数:
message: 消息内容
**kwargs`bot.send` 的参数请参考对应 adapter bot 对象 api
**kwargs: `bot.send` 的参数请参考对应 adapter bot 对象 api
"""
if message is not None:
await cls.send(message, **kwargs)
@ -498,7 +497,7 @@ class Matcher(metaclass=MatcherMeta):
参数:
prompt: 消息内容
**kwargs`bot.send` 的参数请参考对应 adapter bot 对象 api
**kwargs`: bot.send` 的参数请参考对应 adapter bot 对象 api
"""
if prompt is not None:
await cls.send(prompt, **kwargs)
@ -515,7 +514,7 @@ class Matcher(metaclass=MatcherMeta):
参数:
prompt: 消息内容
**kwargs`bot.send` 的参数请参考对应 adapter bot 对象 api
**kwargs: `bot.send` 的参数请参考对应 adapter bot 对象 api
"""
if prompt is not None:
await cls.send(prompt, **kwargs)
@ -534,7 +533,7 @@ class Matcher(metaclass=MatcherMeta):
参数:
key: 参数名
prompt: 消息内容
**kwargs`bot.send` 的参数请参考对应 adapter bot 对象 api
**kwargs: `bot.send` 的参数请参考对应 adapter bot 对象 api
"""
matcher = current_matcher.get()
matcher.set_target(ARG_KEY.format(key=key))
@ -555,7 +554,7 @@ class Matcher(metaclass=MatcherMeta):
参数:
id: 消息 id
prompt: 消息内容
**kwargs`bot.send` 的参数请参考对应 adapter bot 对象 api
**kwargs: `bot.send` 的参数请参考对应 adapter bot 对象 api
"""
matcher = current_matcher.get()
matcher.set_target(RECEIVE_KEY.format(id=id))

View File

@ -56,7 +56,8 @@ def load_from_json(file_path: str, encoding: str = "utf-8") -> Set[Plugin]:
参数:
file_path: 指定 json 文件路径
encoding: 指定 json 文件编码"""
encoding: 指定 json 文件编码
"""
with open(file_path, "r", encoding=encoding) as f:
data = json.load(f)
plugins = data.get("plugins")
@ -73,7 +74,8 @@ def load_from_toml(file_path: str, encoding: str = "utf-8") -> Set[Plugin]:
参数:
file_path: 指定 toml 文件路径
encoding: 指定 toml 文件编码"""
encoding: 指定 toml 文件编码
"""
with open(file_path, "r", encoding=encoding) as f:
data = tomlkit.parse(f.read()) # type: ignore

View File

@ -403,7 +403,7 @@ class CommandGroup:
"""
参数:
cmd: 命令前缀
**kwargs`on_command` 的参数默认值参考 `on_command <#on-command-cmd-rule-none-aliases-none-kwargs>`_
**kwargs: `on_command` 的参数默认值参考 `on_command <#on-command-cmd-rule-none-aliases-none-kwargs>`_
"""
self.basecmd: Tuple[str, ...] = (cmd,) if isinstance(cmd, str) else cmd
"""
@ -422,7 +422,7 @@ class CommandGroup:
参数:
cmd: 命令前缀
**kwargs`on_command` 的参数将会覆盖命令组默认值
**kwargs: `on_command` 的参数将会覆盖命令组默认值
"""
sub_cmd = (cmd,) if isinstance(cmd, str) else cmd
cmd = self.basecmd + sub_cmd
@ -439,7 +439,7 @@ class CommandGroup:
参数:
cmd: 命令前缀
**kwargs`on_shell_command` 的参数将会覆盖命令组默认值
**kwargs: `on_shell_command` 的参数将会覆盖命令组默认值
"""
sub_cmd = (cmd,) if isinstance(cmd, str) else cmd
cmd = self.basecmd + sub_cmd