LiteyukiBot/docs/dev/api/core/manager.md

276 lines
6.1 KiB
Markdown
Raw Normal View History

2024-08-19 01:43:46 +00:00
---
title: liteyuki.core.manager
order: 1
icon: laptop-code
category: API
---
2024-08-19 01:55:47 +00:00
### ***class*** `ChannelDeliver`
2024-08-19 01:43:46 +00:00
2024-08-21 09:59:21 +00:00
###   ***def*** `__init__(self, active: Channel[Any], passive: Channel[Any], channel_deliver_active: Channel[Channel[Any]], channel_deliver_passive: Channel[tuple[str, dict]], publish: Channel[tuple[str, Any]]) -> None`
 
2024-08-21 09:59:21 +00:00
<details>
<summary>源代码</summary>
```python
def __init__(self, active: Channel[Any], passive: Channel[Any], channel_deliver_active: Channel[Channel[Any]], channel_deliver_passive: Channel[tuple[str, dict]], publish: Channel[tuple[str, Any]]):
self.active = active
self.passive = passive
self.channel_deliver_active = channel_deliver_active
self.channel_deliver_passive = channel_deliver_passive
self.publish = publish
```
</details>
2024-08-19 01:55:47 +00:00
### ***class*** `ProcessManager`
2024-08-19 01:43:46 +00:00
2024-08-19 01:55:47 +00:00
进程管理器
2024-08-19 01:43:46 +00:00
### &emsp; ***def*** `__init__(self, lifespan: 'Lifespan') -> None`
&emsp;
2024-08-21 09:59:21 +00:00
<details>
<summary>源代码</summary>
```python
def __init__(self, lifespan: 'Lifespan'):
self.lifespan = lifespan
self.targets: dict[str, tuple[Callable, tuple, dict]] = {}
self.processes: dict[str, Process] = {}
```
</details>
### &emsp; ***def*** `start(self, name: str) -> None`
2024-08-19 01:43:46 +00:00
2024-08-19 01:55:47 +00:00
&emsp;开启后自动监控进程,并添加到进程字典中
2024-08-19 01:43:46 +00:00
Args:
2024-08-19 01:55:47 +00:00
2024-08-19 01:43:46 +00:00
name:
Returns:
2024-08-21 09:59:21 +00:00
<details>
<summary>源代码</summary>
```python
def start(self, name: str):
"""
开启后自动监控进程,并添加到进程字典中
Args:
name:
Returns:
"""
if name not in self.targets:
raise KeyError(f'Process {name} not found.')
chan_active = get_channel(f'{name}-active')
def _start_process():
process = Process(target=self.targets[name][0], args=self.targets[name][1], kwargs=self.targets[name][2], daemon=True)
self.processes[name] = process
process.start()
_start_process()
while True:
data = chan_active.receive()
if data == 0:
logger.info(f'Stopping process {name}')
self.lifespan.before_process_shutdown()
self.terminate(name)
break
elif data == 1:
logger.info(f'Restarting process {name}')
self.lifespan.before_process_shutdown()
self.lifespan.before_process_restart()
self.terminate(name)
_start_process()
continue
else:
logger.warning('Unknown data received, ignored.')
```
</details>
### &emsp; ***def*** `start_all(self) -> None`
2024-08-19 01:43:46 +00:00
2024-08-19 01:55:47 +00:00
&emsp;启动所有进程
2024-08-19 01:43:46 +00:00
2024-08-21 09:59:21 +00:00
<details>
<summary>源代码</summary>
```python
def start_all(self):
"""
启动所有进程
"""
for name in self.targets:
threading.Thread(target=self.start, args=(name,), daemon=True).start()
```
</details>
### &emsp; ***def*** `add_target(self, name: str, target: TARGET_FUNC, args: tuple, kwargs: Any) -> None`
2024-08-19 01:43:46 +00:00
2024-08-19 01:55:47 +00:00
&emsp;添加进程
2024-08-19 01:43:46 +00:00
Args:
2024-08-19 01:55:47 +00:00
name: 进程名,用于获取和唯一标识
2024-08-19 01:43:46 +00:00
2024-08-19 01:55:47 +00:00
target: 进程函数
2024-08-19 01:43:46 +00:00
2024-08-19 01:55:47 +00:00
args: 进程函数参数
2024-08-19 01:43:46 +00:00
2024-08-19 01:55:47 +00:00
kwargs: 进程函数关键字参数通常会默认传入chan_active和chan_passive
2024-08-19 01:43:46 +00:00
2024-08-21 09:59:21 +00:00
<details>
<summary>源代码</summary>
```python
def add_target(self, name: str, target: TARGET_FUNC, args: tuple=(), kwargs=None):
"""
添加进程
Args:
name: 进程名,用于获取和唯一标识
target: 进程函数
args: 进程函数参数
kwargs: 进程函数关键字参数通常会默认传入chan_active和chan_passive
"""
if kwargs is None:
kwargs = {}
chan_active: Channel = Channel(_id=f'{name}-active')
chan_passive: Channel = Channel(_id=f'{name}-passive')
channel_deliver = ChannelDeliver(active=chan_active, passive=chan_passive, channel_deliver_active=channel_deliver_active_channel, channel_deliver_passive=channel_deliver_passive_channel, publish=publish_channel)
self.targets[name] = (_delivery_channel_wrapper, (target, channel_deliver, shared_memory, *args), kwargs)
set_channels({f'{name}-active': chan_active, f'{name}-passive': chan_passive})
```
</details>
### &emsp; ***def*** `join_all(self) -> None`
2024-08-19 01:43:46 +00:00
2024-08-19 01:55:47 +00:00
&emsp;
2024-08-21 09:59:21 +00:00
<details>
<summary>源代码</summary>
```python
def join_all(self):
for name, process in self.targets:
process.join()
```
</details>
### &emsp; ***def*** `terminate(self, name: str) -> None`
2024-08-19 01:43:46 +00:00
2024-08-19 01:55:47 +00:00
&emsp;终止进程并从进程字典中删除
2024-08-19 01:43:46 +00:00
Args:
2024-08-19 01:55:47 +00:00
2024-08-19 01:43:46 +00:00
name:
2024-08-19 01:55:47 +00:00
Returns:
2024-08-19 01:43:46 +00:00
2024-08-21 09:59:21 +00:00
<details>
<summary>源代码</summary>
```python
def terminate(self, name: str):
"""
终止进程并从进程字典中删除
Args:
name:
Returns:
"""
if name not in self.processes:
logger.warning(f'Process {name} not found.')
return
process = self.processes[name]
process.terminate()
process.join(TIMEOUT)
if process.is_alive():
process.kill()
logger.success(f'Process {name} terminated.')
```
</details>
### &emsp; ***def*** `terminate_all(self) -> None`
2024-08-19 01:43:46 +00:00
2024-08-19 01:55:47 +00:00
&emsp;
2024-08-19 01:43:46 +00:00
2024-08-21 09:59:21 +00:00
<details>
<summary>源代码</summary>
```python
def terminate_all(self):
for name in self.targets:
self.terminate(name)
```
</details>
### &emsp; ***def*** `is_process_alive(self, name: str) -> bool`
2024-08-19 01:43:46 +00:00
2024-08-19 01:55:47 +00:00
&emsp;检查进程是否存活
2024-08-19 01:43:46 +00:00
Args:
2024-08-19 01:55:47 +00:00
name:
2024-08-19 01:43:46 +00:00
Returns:
2024-08-21 09:59:21 +00:00
<details>
<summary>源代码</summary>
```python
def is_process_alive(self, name: str) -> bool:
"""
检查进程是否存活
Args:
name:
Returns:
"""
if name not in self.targets:
logger.warning(f'Process {name} not found.')
return self.processes[name].is_alive()
```
</details>
### ***var*** `TIMEOUT = 10`
### ***var*** `chan_active = get_channel(f'{name}-active')`
2024-08-21 09:59:21 +00:00
### ***var*** `channel_deliver = ChannelDeliver(active=chan_active, passive=chan_passive, channel_deliver_active=channel_deliver_active_channel, channel_deliver_passive=channel_deliver_passive_channel, publish=publish_channel)`
### ***var*** `process = self.processes[name]`
### ***var*** `process = Process(target=self.targets[name][0], args=self.targets[name][1], kwargs=self.targets[name][2], daemon=True)`
### ***var*** `data = chan_active.receive()`
### ***var*** `kwargs = {}`