📝 生成了api文档

This commit is contained in:
2024-08-19 09:55:47 +08:00
parent 943e0c2665
commit 85a3a9ad52
26 changed files with 634 additions and 850 deletions

View File

@ -5,42 +5,6 @@ icon: laptop-code
category: API
---
### ***def*** `set(self: Any, key: str, value: Any) -> None`
设置键值对
Args:
key: 键
value: 值
### ***def*** `get(self: Any, key: str, default: Optional[Any]) -> Optional[Any]`
获取键值对
Args:
key: 键
default: 默认值
Returns:
Any: 值
### ***def*** `delete(self: Any, key: str, ignore_key_error: bool) -> None`
删除键值对
Args:
key: 键
ignore_key_error: 是否忽略键不存在的错误
Returns:
### ***def*** `get_all(self: Any) -> dict[str, Any]`
获取所有键值对
Returns:
dict[str, Any]: 键值对
### ***def*** `get_instance(cls: Any) -> None`
### ***def*** `on_get(data: tuple[str, dict[str, Any]]) -> None`
@ -61,53 +25,64 @@ Returns:
####   ***def*** `set(self: Any, key: str, value: Any) -> None`
###   ***def*** `set(self: Any, key: str, value: Any) -> None`
 设置键值对
设置键值对
Args:
key: 键
value: 值
####   ***def*** `get(self: Any, key: str, default: Optional[Any]) -> Optional[Any]`
###   ***def*** `get(self: Any, key: str, default: Optional[Any]) -> Optional[Any]`
 获取键值对
获取键值对
Args:
key: 键
default: 默认值
Returns:
Any: 值
####   ***def*** `delete(self: Any, key: str, ignore_key_error: bool) -> None`
###   ***def*** `delete(self: Any, key: str, ignore_key_error: bool) -> None`
 删除键值对
删除键值对
Args:
key: 键
ignore_key_error: 是否忽略键不存在的错误
Returns:
####   ***def*** `get_all(self: Any) -> dict[str, Any]`
###   ***def*** `get_all(self: Any) -> dict[str, Any]`
 获取所有键值对
获取所有键值对
Returns:
dict[str, Any]: 键值对
### ***class*** `GlobalKeyValueStore`
#### `@classmethod`
###   ***@classmethod***
###   ***def*** `get_instance(cls: Any) -> None`
####   ***def*** `get_instance(cls: Any) -> None`
 
###   ***attr*** `_instance: None`
####   ***attr*** `_instance`
Type: None
####   ***attr*** `_lock`
Type: threading.Lock()
###   ***attr*** `_lock: threading.Lock()`