forked from LiteyukiStudio/LiteyukiBot
169 lines
3.0 KiB
Markdown
169 lines
3.0 KiB
Markdown
---
|
|
title: liteyuki.utils
|
|
---
|
|
### *func* `is_coroutine_callable() -> bool`
|
|
|
|
|
|
|
|
**说明**: 判断是否为协程可调用对象
|
|
|
|
**参数**:
|
|
> - call: 可调用对象
|
|
|
|
**返回**: bool: 是否为协程可调用对象
|
|
|
|
|
|
<details>
|
|
<summary> <b>源代码</b> </summary>
|
|
|
|
```python
|
|
def is_coroutine_callable(call: Callable[..., Any]) -> bool:
|
|
"""
|
|
判断是否为协程可调用对象
|
|
Args:
|
|
call: 可调用对象
|
|
Returns:
|
|
bool: 是否为协程可调用对象
|
|
"""
|
|
if inspect.isroutine(call):
|
|
return inspect.iscoroutinefunction(call)
|
|
if inspect.isclass(call):
|
|
return False
|
|
func_ = getattr(call, '__call__', None)
|
|
return inspect.iscoroutinefunction(func_)
|
|
```
|
|
</details>
|
|
|
|
### *func* `run_coroutine()`
|
|
|
|
|
|
|
|
**说明**: 运行协程
|
|
|
|
**参数**:
|
|
> - coro:
|
|
|
|
|
|
<details>
|
|
<summary> <b>源代码</b> </summary>
|
|
|
|
```python
|
|
def run_coroutine(*coro: Coroutine):
|
|
"""
|
|
运行协程
|
|
Args:
|
|
coro:
|
|
|
|
Returns:
|
|
|
|
"""
|
|
try:
|
|
loop = asyncio.get_event_loop()
|
|
if loop.is_running():
|
|
for c in coro:
|
|
asyncio.ensure_future(c)
|
|
else:
|
|
for c in coro:
|
|
loop.run_until_complete(c)
|
|
except RuntimeError:
|
|
loop = asyncio.new_event_loop()
|
|
asyncio.set_event_loop(loop)
|
|
loop.run_until_complete(asyncio.gather(*coro))
|
|
loop.close()
|
|
except Exception as e:
|
|
logger.error(f'Exception occurred: {e}')
|
|
```
|
|
</details>
|
|
|
|
### *func* `run_coroutine_in_thread()`
|
|
|
|
|
|
|
|
**说明**: 在新线程中运行协程
|
|
|
|
**参数**:
|
|
> - coro:
|
|
|
|
|
|
<details>
|
|
<summary> <b>源代码</b> </summary>
|
|
|
|
```python
|
|
def run_coroutine_in_thread(*coro: Coroutine):
|
|
"""
|
|
在新线程中运行协程
|
|
Args:
|
|
coro:
|
|
|
|
Returns:
|
|
|
|
"""
|
|
threading.Thread(target=run_coroutine, args=coro, daemon=True).start()
|
|
```
|
|
</details>
|
|
|
|
### *func* `path_to_module_name() -> str`
|
|
|
|
|
|
|
|
**说明**: 转换路径为模块名
|
|
|
|
**参数**:
|
|
> - path: 路径a/b/c/d -> a.b.c.d
|
|
|
|
**返回**: str: 模块名
|
|
|
|
|
|
<details>
|
|
<summary> <b>源代码</b> </summary>
|
|
|
|
```python
|
|
def path_to_module_name(path: Path) -> str:
|
|
"""
|
|
转换路径为模块名
|
|
Args:
|
|
path: 路径a/b/c/d -> a.b.c.d
|
|
Returns:
|
|
str: 模块名
|
|
"""
|
|
rel_path = path.resolve().relative_to(Path.cwd().resolve())
|
|
if rel_path.stem == '__init__':
|
|
return '.'.join(rel_path.parts[:-1])
|
|
else:
|
|
return '.'.join(rel_path.parts[:-1] + (rel_path.stem,))
|
|
```
|
|
</details>
|
|
|
|
### *func* `async_wrapper() -> Callable[..., Coroutine]`
|
|
|
|
|
|
|
|
**说明**: 异步包装器
|
|
|
|
**参数**:
|
|
> - func: Sync Callable
|
|
|
|
**返回**: Coroutine: Asynchronous Callable
|
|
|
|
|
|
<details>
|
|
<summary> <b>源代码</b> </summary>
|
|
|
|
```python
|
|
def async_wrapper(func: Callable[..., Any]) -> Callable[..., Coroutine]:
|
|
"""
|
|
异步包装器
|
|
Args:
|
|
func: Sync Callable
|
|
Returns:
|
|
Coroutine: Asynchronous Callable
|
|
"""
|
|
|
|
async def wrapper(*args, **kwargs):
|
|
return func(*args, **kwargs)
|
|
wrapper.__signature__ = inspect.signature(func)
|
|
return wrapper
|
|
```
|
|
</details>
|
|
|