chain
Ariadne 消息链的实现
MessageChain 🔗
Bases: BaseMessageChain
, AriadneBaseModel
即 "消息链", 被用于承载整个消息内容的数据结构, 包含有一有序列表, 包含有元素实例.
Source code in src/graia/ariadne/message/chain.py
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 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 114 115 116 117 118 119 120 121 122 123 124 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 150 151 152 153 154 155 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 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 |
|
safe_display
property
🔗
safe_display: str
__getitem__ 🔗
__getitem__(
item: Union[Tuple[Type[Element], int], Type[Element], int, slice]
) -> Any
可通过切片取出子消息链, 或元素.
通过 type, count
型元组取出前 count
个 type
元素组成的列表
通过 type
取出属于 type
的元素列表
通过 int
取出对应位置元素.
Parameters:
Returns:
-
Any
–Union[List[Element], Element, MessageChain]: 索引结果.
Source code in src/graia/ariadne/message/chain.py
164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 |
|
__init__ 🔗
__init__(
__root__: MessageContainer,
*elements: MessageContainer,
inline: bool = False
) -> None
创建消息链.
Parameters:
Returns:
-
MessageChain(
None
) –创建的消息链
Source code in src/graia/ariadne/message/chain.py
119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 |
|
as_persistent_string 🔗
as_persistent_string(
*,
binary: bool = True,
include: Iterable[Type[Element]] = (),
exclude: Iterable[Type[Element]] = ()
) -> str
转换为持久化字符串.
Parameters:
-
binary
(
bool
) –是否附带图片或声音的二进制. 默认为 True.
-
include
(
Iterable[Type[Element]]
) –筛选, 只包含本参数提供的元素类型.
-
exclude
(
Iterable[Type[Element]]
) –筛选, 排除本参数提供的元素类型.
Raises:
-
ValueError
–同时提供 include 与 exclude
Returns:
-
str(
str
) –持久化字符串. 不是 Mirai Code.
Source code in src/graia/ariadne/message/chain.py
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 |
|
as_sendable 🔗
as_sendable() -> Self
将消息链转换为可发送形式 (去除 File)
Returns:
-
MessageChain(
Self
) –转换后的消息链.
Source code in src/graia/ariadne/message/chain.py
183 184 185 186 187 188 189 |
|
build_chain
staticmethod
🔗
build_chain(obj: Union[List[Dict], MessageContainer]) -> List[Element]
内部接口, 会自动反序列化对象并生成.
Parameters:
-
obj
(
_Parsable
) –需要反序列化的对象
Returns:
Source code in src/graia/ariadne/message/chain.py
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 |
|
download_binary
async
🔗
download_binary() -> Self
下载消息中所有的二进制数据并保存在元素实例内
Source code in src/graia/ariadne/message/chain.py
265 266 267 268 269 270 |
|
from_persistent_string
classmethod
🔗
from_persistent_string(string: str) -> Self
从持久化字符串生成消息链.
Returns:
-
MessageChain(
Self
) –还原的消息链.
Source code in src/graia/ariadne/message/chain.py
272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 |
|
parse_obj
classmethod
🔗
parse_obj(obj: Union[List[dict], List[Element]]) -> Self
解析 MessageChain.
Parameters:
-
obj
(
List[T]
) –需要反序列化的对象
Returns:
-
MessageChain(
Self
) –内部承载有尽量有效的消息元素的消息链
Source code in src/graia/ariadne/message/chain.py
99 100 101 102 103 104 105 106 107 108 109 |
|
removeprefix 🔗
removeprefix(
prefix: str, *, copy: bool = True, skip_header: bool = True
) -> Self
移除消息链前缀.
Parameters:
-
prefix
(
str
) –要移除的前缀.
-
copy
(
bool
) –是否在副本上修改, 默认为 True.
-
skip_header
(
bool
) –是否要忽略 Source 与 Quote 类型查找, 默认为 True. (移除后仍会带上 Source 与 Quote)
Returns:
-
MessageChain(
Self
) –修改后的消息链, 若未移除则原样返回.
Source code in src/graia/ariadne/message/chain.py
354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 |
|
removesuffix 🔗
removesuffix(suffix: str, *, copy: bool = True) -> Self
移除消息链后缀.
Parameters:
Returns:
-
MessageChain(
Self
) –修改后的消息链, 若未移除则原样返回.
Source code in src/graia/ariadne/message/chain.py
389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 |
|
replace 🔗
replace(old: MessageContainer, new: MessageContainer) -> Self
替换消息链中的一部分. (在副本上操作)
Parameters:
-
old
(
MessageChain
) –要替换的消息链.
-
new
(
MessageChain
) –替换后的消息链.
Returns:
-
MessageChain(
Self
) –修改后的消息链, 若未替换则原样返回.
Source code in src/graia/ariadne/message/chain.py
411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 |
|