typing
Ariadne 的类型标注
SendMessageAction
🔗
Bases: Generic[T, R]
表示 SendMessage 的 action
Source code in src/graia/ariadne/typing.py
76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 |
|
exception(item)
async
staticmethod
🔗
发生异常时进行处理,可以选择不返回而是直接引发异常
Parameters:
Name | Type | Description | Default |
---|---|---|---|
item |
SendMessageException
|
发生的异常 |
required |
Returns:
Name | Type | Description |
---|---|---|
T |
Optional[T]
|
将作为 sendMessage 的返回值 |
Source code in src/graia/ariadne/typing.py
103 104 105 106 107 108 109 110 111 112 113 |
|
param(item)
async
staticmethod
🔗
传入 SendMessageDict 作为参数, 传出 SendMessageDict 作为结果
Parameters:
Name | Type | Description | Default |
---|---|---|---|
item |
SendMessageDict
|
调用参数 |
required |
Returns:
Name | Type | Description |
---|---|---|
SendMessageDict |
SendMessageDict
|
修改后的调用参数 |
Source code in src/graia/ariadne/typing.py
79 80 81 82 83 84 85 86 87 88 89 |
|
result(item)
async
staticmethod
🔗
处理返回结果
Parameters:
Name | Type | Description | Default |
---|---|---|---|
item |
ActiveMessage
|
SendMessage 成功时的结果 |
required |
Returns:
Name | Type | Description |
---|---|---|
R |
R
|
要实际由 SendMessage 返回的数据 |
Source code in src/graia/ariadne/typing.py
91 92 93 94 95 96 97 98 99 100 101 |
|
SendMessageDict
🔗
Bases: TypedDict
使用 SendMessage 时, 对 action 传入的字典
Source code in src/graia/ariadne/typing.py
57 58 59 60 61 62 |
|
SendMessageException
🔗
Bases: Exception
携带了 SendMessageDict 的 Exception
Source code in src/graia/ariadne/typing.py
67 68 69 70 |
|
class_property
🔗
Bases: Generic[T]
Class-level property. Link: https://stackoverflow.com/a/13624858/1280629
Source code in src/graia/ariadne/typing.py
204 205 206 207 208 209 210 211 212 213 |
|
generic_isinstance(obj, par)
🔗
检查 obj 是否是 args 中的一个类型, 支持泛型, Any, Union
Parameters:
Name | Type | Description | Default |
---|---|---|---|
obj |
Any
|
要检查的对象 |
required |
par |
Union[type, Any, Tuple[type, ...]]
|
要检查的对象的类型 |
required |
Returns:
Name | Type | Description |
---|---|---|
bool |
bool
|
是否是类型 |
Source code in src/graia/ariadne/typing.py
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 |
|
generic_issubclass(cls, par)
🔗
检查 cls 是否是 args 中的一个子类, 支持泛型, Any, Union
Parameters:
Name | Type | Description | Default |
---|---|---|---|
cls |
type
|
要检查的类 |
required |
par |
Union[type, Any, Tuple[type, ...]]
|
要检查的类的父类 |
required |
Returns:
Name | Type | Description |
---|---|---|
bool |
bool
|
是否是父类 |
Source code in src/graia/ariadne/typing.py
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 |
|