💡 add utils docstring

This commit is contained in:
yanyongyu
2020-09-13 00:43:31 +08:00
parent 60c70804ed
commit ce2700c1d2
6 changed files with 101 additions and 0 deletions

View File

@ -10,6 +10,14 @@ from nonebot.typing import Any, Callable, Awaitable, overrides
def run_sync(func: Callable[..., Any]) -> Callable[..., Awaitable[Any]]:
"""
:说明:
一个用于包装 sync function 为 async function 的装饰器
:参数:
* ``func: Callable[..., Any]``: 被装饰的同步函数
:返回:
- Callable[..., Awaitable[Any]]
"""
@wraps(func)
async def _wrapper(*args: Any, **kwargs: Any) -> Any:
@ -22,6 +30,12 @@ def run_sync(func: Callable[..., Any]) -> Callable[..., Awaitable[Any]]:
class DataclassEncoder(json.JSONEncoder):
"""
:类型:
``json.JSONEncoder``
:说明:
``JSONEncoder`` used when encoding ``Message`` (List of dataclasses)
"""
@overrides(json.JSONEncoder)
def default(self, o):