此页由 Zensical 配合 mkdocstrings 根据源码自动生成,适合在以下场景使用:
- 查看公开模块和导出符号
- 确认方法签名、参数名和返回值
- 查询 Pydantic 模型字段
如果你更关注接入步骤和调用示例,优先阅读 Usage。
zzupy¤
zzupy
¤
Modules:
-
aio–各模块的异步实现
-
app–移动应用 API 抽象层
-
crypto–纯 Python 实现的轻量级 RSA 加密
-
exception–异常处理模块。
-
logging–zzupy 日志工具。
-
model– -
utils–工具函数库
-
web–Web API 客户端模块
Attributes:
-
logger– -
__version__– -
__all__–
aio
¤
各模块的异步实现
Modules:
app
¤
移动应用 API 抽象层
Modules:
-
auth–统一认证
-
eas– -
ecard–一卡通
-
interfaces–抽象接口
Classes:
-
CASClient–统一认证系统 (CAS) App 客户端。
-
ECardClient–一卡通客户端
-
UndergradEASClient–
CASClient
¤
Bases: ICASClient
flowchart TD
zzupy.aio.app.CASClient[CASClient]
zzupy.aio.app.interfaces.ICASClient[ICASClient]
zzupy.aio.app.interfaces.ICASClient --> zzupy.aio.app.CASClient
click zzupy.aio.app.CASClient href "" "zzupy.aio.app.CASClient"
click zzupy.aio.app.interfaces.ICASClient href "" "zzupy.aio.app.interfaces.ICASClient"
统一认证系统 (CAS) App 客户端。
Parameters:
Classes:
-
MFAClient–统一认证 MFA 异步辅助客户端。
Methods:
-
set_token–设置统一认证 Token。
-
set_device–设置认证请求使用的设备标识。
-
login–登录统一认证。
-
get_user_info–获取当前用户的聚合个人信息。
-
logout–登出账户,清除 Cookie 但保留连接池
-
close–清除 Cookie 和连接池
Attributes:
-
user_token(str | None) –当前会话的
userToken,约一个月有效期 -
refresh_token(str | None) –当前会话的
refreshToken,约两个月有效期 -
logged_in(bool) –当前会话是否已登录
Source code in zzupy/aio/app/auth.py
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 | |
MFAClient
¤
统一认证 MFA 异步辅助客户端。
本客户端由 CASClient 自动创建,通常通过
[CASClient.mfa][zzupy.aio.app.auth.CASClient.mfa] 访问。它负责检测 MFA
状态、发送手机号验证码并校验验证码。
Parameters:
Methods:
-
reset–清除当前 MFA 流程状态。
-
is_required–检测当前环境是否需要 MFA 验证。
-
request_sms_code–发送 MFA 短信验证码。
-
send_sms–request_sms_code()的别名。 -
verify_sms_code–校验 MFA 短信验证码。
-
verify_sms–verify_sms_code()的别名。
Source code in zzupy/aio/app/auth.py
217 218 219 220 221 222 223 224 225 226 227 228 229 230 | |
reset
¤
reset() -> None
清除当前 MFA 流程状态。
Source code in zzupy/aio/app/auth.py
232 233 234 235 236 237 238 239 | |
is_required
async
¤
is_required() -> bool
检测当前环境是否需要 MFA 验证。
Returns:
-
bool–是否需要 MFA 验证。
Raises:
-
OperationError–如果检测失败。
-
ParsingError–如果服务器响应无法解析。
-
NetworkError–如果出现网络错误。
Source code in zzupy/aio/app/auth.py
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 | |
request_sms_code
async
¤
request_sms_code() -> None
发送 MFA 短信验证码。
如果尚未初始化手机号 MFA,会自动调用内部初始化流程。
Raises:
-
LoginError–如果当前登录不需要 MFA 验证。
-
OperationError–如果短信发送失败。
-
ParsingError–如果服务器响应无法解析。
-
NetworkError–如果出现网络错误。
Source code in zzupy/aio/app/auth.py
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 | |
send_sms
async
¤
send_sms() -> None
request_sms_code() 的别名。
Source code in zzupy/aio/app/auth.py
478 479 480 | |
verify_sms_code
async
¤
校验 MFA 短信验证码。
调用前必须先发送 MFA 短信验证码。
校验成功后,CASClient.login()
会使用当前 MFA state 完成登录。
Parameters:
Returns:
-
str–可用于登录的 MFA state。
Raises:
-
MFAError–如果尚未发送 MFA 短信验证码。
-
LoginError–如果验证码校验失败。
-
OperationError–如果服务器返回失败状态。
-
ParsingError–如果服务器响应无法解析。
-
NetworkError–如果出现网络错误。
Source code in zzupy/aio/app/auth.py
482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 | |
verify_sms
async
¤
verify_sms_code() 的别名。
Source code in zzupy/aio/app/auth.py
565 566 567 | |
set_token
¤
set_token(user_token: str, refresh_token: str) -> None
设置统一认证 Token。
Parameters:
-
(user_token¤str) –userToken。对豫见郑大 APP 抓包获取,或账密登录后访问user_token获取 -
(refresh_token¤str) –refreshToken。对豫见郑大 APP 抓包获取,或账密登录后访问refresh_token获取
Source code in zzupy/aio/app/auth.py
76 77 78 79 80 81 82 83 84 | |
set_device
¤
login
async
¤
login(force_login: bool = False) -> None
登录统一认证。
成功后,userToken 和 refreshToken 会被存储在实例中.
若 user_token 和 refresh_token 已通过 set_token 设置且有效,则会跳过账密登录。
Parameters:
Raises:
-
MFAError–如果当前登录需要 MFA 但尚未完成验证。
-
LoginError–如果登录失败。
-
ParsingError–如果服务器响应无法解析。
-
NetworkError–如果出现网络错误。
Source code in zzupy/aio/app/auth.py
569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 | |
get_user_info
async
¤
get_user_info() -> PersonalInfo
获取当前用户的聚合个人信息。
返回学号、姓名、身份类型、学院、邮箱未读数、一卡通余额和科研信息数量。
Returns:
-
PersonalInfo–当前用户的个人信息
Raises:
-
NotLoggedInError–如果当前认证状态缺少 userToken。
-
OperationError–如果服务端返回失败结果。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/auth.py
671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 | |
logout
¤
logout() -> None
登出账户,清除 Cookie 但保留连接池
Source code in zzupy/aio/app/auth.py
797 798 799 800 801 802 803 804 805 806 807 808 | |
close
async
¤
close() -> None
清除 Cookie 和连接池
Source code in zzupy/aio/app/auth.py
810 811 812 813 814 | |
ECardClient
¤
ECardClient(cas_client: ICASClient)
一卡通客户端
Parameters:
-
(cas_client¤ICASClient) –已登录的 CASClient 实例
Methods:
-
login–登录到校园卡系统
-
get_default_room–获取账户默认房间
-
recharge_energy–为 room 充值电费
-
get_balance–获取校园卡余额
-
get_room_dict–获取房间的字典
-
get_remaining_energy–获取剩余电量
-
logout–登出账户,清除 Cookie 但保留连接池
-
close–清除 Cookie 和连接池
Source code in zzupy/aio/app/ecard.py
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 | |
login
async
¤
login() -> None
登录到校园卡系统
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/ecard.py
146 147 148 149 150 151 152 153 154 155 156 157 158 | |
get_default_room
async
¤
get_default_room() -> str
获取账户默认房间
Returns:
-
str–默认的房间
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/ecard.py
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 | |
recharge_energy
async
¤
为 room 充值电费
Parameters:
-
(payment_password¤str) –支付密码
-
(amt¤int) –充值金额
-
(room¤str) –房间 ID 。格式应为 'areaid-buildingid--unitid-roomid',可通过
get_room_dict()获取
Raises:
-
InvalidArgumentError–如果金额或房间参数不合法。
-
OperationError–如果充值失败。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/ecard.py
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 | |
get_balance
async
¤
get_balance() -> float
获取校园卡余额
Returns:
-
float–校园卡余额
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/ecard.py
464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 | |
get_room_dict
async
¤
获取房间的字典
Parameters:
Returns:
-
dict–对应的字典
Raises:
-
InvalidArgumentError–如果参数格式不正确。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/ecard.py
530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 | |
get_remaining_energy
async
¤
获取剩余电量
Parameters:
-
(room¤str | None, default:None) –房间 ID 。格式应为 'areaid-buildingid--unitid-roomid',可通过
get_room_dict()获取
Returns:
-
float–剩余电量
Raises:
-
InvalidArgumentError–如果房间参数不合法。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/ecard.py
645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 | |
logout
¤
logout() -> None
登出账户,清除 Cookie 但保留连接池
Source code in zzupy/aio/app/ecard.py
742 743 744 745 746 747 748 749 750 751 752 753 | |
close
async
¤
close() -> None
清除 Cookie 和连接池
Source code in zzupy/aio/app/ecard.py
755 756 757 758 759 760 761 762 | |
UndergradEASClient
¤
UndergradEASClient(cas_client: ICASClient)
Methods:
-
login–登录到新本科教务系统
-
get_teaching_week–获取 {semester_id} 号学期的第 {week_index} 教学周
-
get_teaching_weeks–获取 {semester_id} 号学期的全部教学周
-
get_week_index–获取指定日期的教学周序数
-
get_semesters–获取所有学期数据
-
logout–登出账户,清除 Cookie 但保留连接池
-
close–清除 Cookie 和连接池
Source code in zzupy/aio/app/eas/undergrad.py
51 52 53 54 55 56 57 58 59 60 61 62 63 | |
login
async
¤
login() -> None
登录到新本科教务系统
Raises:
-
OperationError–如果登录失败。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
get_teaching_week
async
¤
get_teaching_week(week: int, semester_id: int | None = None) -> TeachingWeek
获取 {semester_id} 号学期的第 {week_index} 教学周 Args: week: 教学周序数 semester_id: 学期 ID。不填写则为本学期。
Returns:
-
TeachingWeek(TeachingWeek) –教学周
Raises:
-
ParsingError–如果响应解析失败
-
NetworkError–如果网络请求失败
-
InvalidArgumentError–如果教学周序数不正确。
-
OperationError–如果服务器发生异常。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
get_teaching_weeks
async
¤
get_teaching_weeks(semester_id: int | None = None) -> TeachingWeeks
获取 {semester_id} 号学期的全部教学周 Args: semester_id: 学期 ID。不填写则为本学期。
Returns:
-
TeachingWeeks(TeachingWeeks) –由一个学期的全部教学周组成的列表模型。
Raises:
-
ParsingError–如果响应解析失败
-
NetworkError–如果网络请求失败
-
DataNotFoundError–如果学期不存在。
-
OperationError–如果服务器发生异常。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
get_week_index
async
¤
get_week_index(date: Date) -> int | None
获取指定日期的教学周序数
Returns:
-
int | None–int | None: 教学周序数
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
-
OperationError–如果服务器发生异常。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
get_semesters
async
¤
获取所有学期数据
Returns:
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
-
OperationError–如果服务器发生异常。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
logout
¤
logout() -> None
登出账户,清除 Cookie 但保留连接池
Source code in zzupy/aio/app/eas/undergrad.py
456 457 458 459 460 461 462 463 | |
close
async
¤
close() -> None
清除 Cookie 和连接池
Source code in zzupy/aio/app/eas/undergrad.py
465 466 467 468 469 470 | |
auth
¤
统一认证
Classes:
-
CASClient–统一认证系统 (CAS) App 客户端。
CASClient
¤
Bases: ICASClient
flowchart TD
zzupy.aio.app.auth.CASClient[CASClient]
zzupy.aio.app.interfaces.ICASClient[ICASClient]
zzupy.aio.app.interfaces.ICASClient --> zzupy.aio.app.auth.CASClient
click zzupy.aio.app.auth.CASClient href "" "zzupy.aio.app.auth.CASClient"
click zzupy.aio.app.interfaces.ICASClient href "" "zzupy.aio.app.interfaces.ICASClient"
统一认证系统 (CAS) App 客户端。
Parameters:
Classes:
-
MFAClient–统一认证 MFA 异步辅助客户端。
Methods:
-
set_token–设置统一认证 Token。
-
set_device–设置认证请求使用的设备标识。
-
login–登录统一认证。
-
get_user_info–获取当前用户的聚合个人信息。
-
logout–登出账户,清除 Cookie 但保留连接池
-
close–清除 Cookie 和连接池
Attributes:
-
user_token(str | None) –当前会话的
userToken,约一个月有效期 -
refresh_token(str | None) –当前会话的
refreshToken,约两个月有效期 -
logged_in(bool) –当前会话是否已登录
Source code in zzupy/aio/app/auth.py
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 | |
MFAClient
¤
统一认证 MFA 异步辅助客户端。
本客户端由 CASClient 自动创建,通常通过
[CASClient.mfa][zzupy.aio.app.auth.CASClient.mfa] 访问。它负责检测 MFA
状态、发送手机号验证码并校验验证码。
Parameters:
Methods:
-
reset–清除当前 MFA 流程状态。
-
is_required–检测当前环境是否需要 MFA 验证。
-
request_sms_code–发送 MFA 短信验证码。
-
send_sms–request_sms_code()的别名。 -
verify_sms_code–校验 MFA 短信验证码。
-
verify_sms–verify_sms_code()的别名。
Source code in zzupy/aio/app/auth.py
217 218 219 220 221 222 223 224 225 226 227 228 229 230 | |
reset
¤reset() -> None
清除当前 MFA 流程状态。
Source code in zzupy/aio/app/auth.py
232 233 234 235 236 237 238 239 | |
is_required
async
¤is_required() -> bool
检测当前环境是否需要 MFA 验证。
Returns:
-
bool–是否需要 MFA 验证。
Raises:
-
OperationError–如果检测失败。
-
ParsingError–如果服务器响应无法解析。
-
NetworkError–如果出现网络错误。
Source code in zzupy/aio/app/auth.py
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 | |
request_sms_code
async
¤request_sms_code() -> None
发送 MFA 短信验证码。
如果尚未初始化手机号 MFA,会自动调用内部初始化流程。
Raises:
-
LoginError–如果当前登录不需要 MFA 验证。
-
OperationError–如果短信发送失败。
-
ParsingError–如果服务器响应无法解析。
-
NetworkError–如果出现网络错误。
Source code in zzupy/aio/app/auth.py
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 | |
send_sms
async
¤send_sms() -> None
request_sms_code() 的别名。
Source code in zzupy/aio/app/auth.py
478 479 480 | |
verify_sms_code
async
¤校验 MFA 短信验证码。
调用前必须先发送 MFA 短信验证码。
校验成功后,CASClient.login()
会使用当前 MFA state 完成登录。
Parameters:
Returns:
-
str–可用于登录的 MFA state。
Raises:
-
MFAError–如果尚未发送 MFA 短信验证码。
-
LoginError–如果验证码校验失败。
-
OperationError–如果服务器返回失败状态。
-
ParsingError–如果服务器响应无法解析。
-
NetworkError–如果出现网络错误。
Source code in zzupy/aio/app/auth.py
482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 | |
verify_sms
async
¤verify_sms_code() 的别名。
Source code in zzupy/aio/app/auth.py
565 566 567 | |
set_token
¤
set_token(user_token: str, refresh_token: str) -> None
设置统一认证 Token。
Parameters:
-
(user_token¤str) –userToken。对豫见郑大 APP 抓包获取,或账密登录后访问user_token获取 -
(refresh_token¤str) –refreshToken。对豫见郑大 APP 抓包获取,或账密登录后访问refresh_token获取
Source code in zzupy/aio/app/auth.py
76 77 78 79 80 81 82 83 84 | |
set_device
¤
login
async
¤
login(force_login: bool = False) -> None
登录统一认证。
成功后,userToken 和 refreshToken 会被存储在实例中.
若 user_token 和 refresh_token 已通过 set_token 设置且有效,则会跳过账密登录。
Parameters:
Raises:
-
MFAError–如果当前登录需要 MFA 但尚未完成验证。
-
LoginError–如果登录失败。
-
ParsingError–如果服务器响应无法解析。
-
NetworkError–如果出现网络错误。
Source code in zzupy/aio/app/auth.py
569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 | |
get_user_info
async
¤
get_user_info() -> PersonalInfo
获取当前用户的聚合个人信息。
返回学号、姓名、身份类型、学院、邮箱未读数、一卡通余额和科研信息数量。
Returns:
-
PersonalInfo–当前用户的个人信息
Raises:
-
NotLoggedInError–如果当前认证状态缺少 userToken。
-
OperationError–如果服务端返回失败结果。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/auth.py
671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 | |
logout
¤
logout() -> None
登出账户,清除 Cookie 但保留连接池
Source code in zzupy/aio/app/auth.py
797 798 799 800 801 802 803 804 805 806 807 808 | |
close
async
¤
close() -> None
清除 Cookie 和连接池
Source code in zzupy/aio/app/auth.py
810 811 812 813 814 | |
eas
¤
Modules:
-
undergrad–140w 教务
Classes:
UndergradEASClient
¤
UndergradEASClient(cas_client: ICASClient)
Methods:
-
login–登录到新本科教务系统
-
get_teaching_week–获取 {semester_id} 号学期的第 {week_index} 教学周
-
get_teaching_weeks–获取 {semester_id} 号学期的全部教学周
-
get_week_index–获取指定日期的教学周序数
-
get_semesters–获取所有学期数据
-
logout–登出账户,清除 Cookie 但保留连接池
-
close–清除 Cookie 和连接池
Source code in zzupy/aio/app/eas/undergrad.py
51 52 53 54 55 56 57 58 59 60 61 62 63 | |
login
async
¤
login() -> None
登录到新本科教务系统
Raises:
-
OperationError–如果登录失败。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
get_teaching_week
async
¤
get_teaching_week(week: int, semester_id: int | None = None) -> TeachingWeek
获取 {semester_id} 号学期的第 {week_index} 教学周 Args: week: 教学周序数 semester_id: 学期 ID。不填写则为本学期。
Returns:
-
TeachingWeek(TeachingWeek) –教学周
Raises:
-
ParsingError–如果响应解析失败
-
NetworkError–如果网络请求失败
-
InvalidArgumentError–如果教学周序数不正确。
-
OperationError–如果服务器发生异常。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
get_teaching_weeks
async
¤
get_teaching_weeks(semester_id: int | None = None) -> TeachingWeeks
获取 {semester_id} 号学期的全部教学周 Args: semester_id: 学期 ID。不填写则为本学期。
Returns:
-
TeachingWeeks(TeachingWeeks) –由一个学期的全部教学周组成的列表模型。
Raises:
-
ParsingError–如果响应解析失败
-
NetworkError–如果网络请求失败
-
DataNotFoundError–如果学期不存在。
-
OperationError–如果服务器发生异常。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
get_week_index
async
¤
get_week_index(date: Date) -> int | None
获取指定日期的教学周序数
Returns:
-
int | None–int | None: 教学周序数
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
-
OperationError–如果服务器发生异常。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
get_semesters
async
¤
获取所有学期数据
Returns:
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
-
OperationError–如果服务器发生异常。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
logout
¤
logout() -> None
登出账户,清除 Cookie 但保留连接池
Source code in zzupy/aio/app/eas/undergrad.py
456 457 458 459 460 461 462 463 | |
close
async
¤
close() -> None
清除 Cookie 和连接池
Source code in zzupy/aio/app/eas/undergrad.py
465 466 467 468 469 470 | |
undergrad
¤
140w 教务
Classes:
UndergradEASClient
¤
UndergradEASClient(cas_client: ICASClient)
Methods:
-
login–登录到新本科教务系统
-
get_teaching_week–获取 {semester_id} 号学期的第 {week_index} 教学周
-
get_teaching_weeks–获取 {semester_id} 号学期的全部教学周
-
get_week_index–获取指定日期的教学周序数
-
get_semesters–获取所有学期数据
-
logout–登出账户,清除 Cookie 但保留连接池
-
close–清除 Cookie 和连接池
Source code in zzupy/aio/app/eas/undergrad.py
51 52 53 54 55 56 57 58 59 60 61 62 63 | |
login
async
¤login() -> None
登录到新本科教务系统
Raises:
-
OperationError–如果登录失败。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
get_teaching_week
async
¤get_teaching_week(week: int, semester_id: int | None = None) -> TeachingWeek
获取 {semester_id} 号学期的第 {week_index} 教学周 Args: week: 教学周序数 semester_id: 学期 ID。不填写则为本学期。
Returns:
-
TeachingWeek(TeachingWeek) –教学周
Raises:
-
ParsingError–如果响应解析失败
-
NetworkError–如果网络请求失败
-
InvalidArgumentError–如果教学周序数不正确。
-
OperationError–如果服务器发生异常。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
get_teaching_weeks
async
¤get_teaching_weeks(semester_id: int | None = None) -> TeachingWeeks
获取 {semester_id} 号学期的全部教学周 Args: semester_id: 学期 ID。不填写则为本学期。
Returns:
-
TeachingWeeks(TeachingWeeks) –由一个学期的全部教学周组成的列表模型。
Raises:
-
ParsingError–如果响应解析失败
-
NetworkError–如果网络请求失败
-
DataNotFoundError–如果学期不存在。
-
OperationError–如果服务器发生异常。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
get_week_index
async
¤get_week_index(date: Date) -> int | None
获取指定日期的教学周序数
Returns:
-
int | None–int | None: 教学周序数
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
-
OperationError–如果服务器发生异常。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
get_semesters
async
¤获取所有学期数据
Returns:
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
-
OperationError–如果服务器发生异常。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
logout
¤logout() -> None
登出账户,清除 Cookie 但保留连接池
Source code in zzupy/aio/app/eas/undergrad.py
456 457 458 459 460 461 462 463 | |
close
async
¤close() -> None
清除 Cookie 和连接池
Source code in zzupy/aio/app/eas/undergrad.py
465 466 467 468 469 470 | |
ecard
¤
一卡通
Classes:
-
ECardClient–一卡通客户端
ECardClient
¤
ECardClient(cas_client: ICASClient)
一卡通客户端
Parameters:
-
(cas_client¤ICASClient) –已登录的 CASClient 实例
Methods:
-
login–登录到校园卡系统
-
get_default_room–获取账户默认房间
-
recharge_energy–为 room 充值电费
-
get_balance–获取校园卡余额
-
get_room_dict–获取房间的字典
-
get_remaining_energy–获取剩余电量
-
logout–登出账户,清除 Cookie 但保留连接池
-
close–清除 Cookie 和连接池
Source code in zzupy/aio/app/ecard.py
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 | |
login
async
¤
login() -> None
登录到校园卡系统
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/ecard.py
146 147 148 149 150 151 152 153 154 155 156 157 158 | |
get_default_room
async
¤
get_default_room() -> str
获取账户默认房间
Returns:
-
str–默认的房间
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/ecard.py
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 | |
recharge_energy
async
¤
为 room 充值电费
Parameters:
-
(payment_password¤str) –支付密码
-
(amt¤int) –充值金额
-
(room¤str) –房间 ID 。格式应为 'areaid-buildingid--unitid-roomid',可通过
get_room_dict()获取
Raises:
-
InvalidArgumentError–如果金额或房间参数不合法。
-
OperationError–如果充值失败。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/ecard.py
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 | |
get_balance
async
¤
get_balance() -> float
获取校园卡余额
Returns:
-
float–校园卡余额
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/ecard.py
464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 | |
get_room_dict
async
¤
获取房间的字典
Parameters:
Returns:
-
dict–对应的字典
Raises:
-
InvalidArgumentError–如果参数格式不正确。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/ecard.py
530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 | |
get_remaining_energy
async
¤
获取剩余电量
Parameters:
-
(room¤str | None, default:None) –房间 ID 。格式应为 'areaid-buildingid--unitid-roomid',可通过
get_room_dict()获取
Returns:
-
float–剩余电量
Raises:
-
InvalidArgumentError–如果房间参数不合法。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/ecard.py
645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 | |
logout
¤
logout() -> None
登出账户,清除 Cookie 但保留连接池
Source code in zzupy/aio/app/ecard.py
742 743 744 745 746 747 748 749 750 751 752 753 | |
close
async
¤
close() -> None
清除 Cookie 和连接池
Source code in zzupy/aio/app/ecard.py
755 756 757 758 759 760 761 762 | |
interfaces
¤
抽象接口
web
¤
Web API 客户端模块
Modules:
-
network–校园网模块
Classes:
-
EPortalClient–Portal 认证客户端 / 校园网认证客户端
-
SelfServiceSystem–自助服务系统
Functions:
-
discover_portal_info–自动发现校园网Portal认证信息
EPortalClient
¤
EPortalClient(base_url: str, bind_address: str | None = None, force_bind: bool = False)
Portal 认证客户端 / 校园网认证客户端
Parameters:
-
(base_url¤str) –Portal 服务器的 Base URL
-
(bind_address¤str | None, default:None) –绑定的本地 IP
-
(force_bind¤bool, default:False) –即便 IP 绑定失败也在请求参数中使用该 IP。
如果你在路由器后使用本方法,则需要把
bind_address填写为路由器分配的内网 IP 并启用force_bind
Methods:
-
portal_auth–auth()的底层实现,允许完全自定义账户 -
auth–进行 Portal 认证
Source code in zzupy/aio/web/network.py
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 | |
portal_auth
async
¤
auth() 的底层实现,允许完全自定义账户
Parameters:
Returns:
-
AuthResult(AuthResult) –认证结果
Raises:
-
ParsingError–如果无法解析 API 响应。
-
NetworkError–如果发生网络错误。
Source code in zzupy/aio/web/network.py
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 | |
auth
async
¤
auth(account: str, password: str, isp_suffix: str | None = None, encrypt: bool = False) -> AuthResult
进行 Portal 认证
Parameters:
-
(account¤str) –账户
-
(password¤str) –密码
-
(isp_suffix¤str | None, default:None) –运营商后缀
-
(encrypt¤bool, default:False) –是否启用加密
Returns:
-
AuthResult(AuthResult) –认证结果
Source code in zzupy/aio/web/network.py
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 | |
SelfServiceSystem
¤
SelfServiceSystem(base_url: str)
自助服务系统
Methods:
-
login–登录
-
get_online_devices–获取当前在线设备
-
kick_device–将设备踢下线
-
logout–登出
Source code in zzupy/aio/web/network.py
293 294 295 | |
login
async
¤
登录
Parameters:
Raises:
-
LoginError–如果登录失败。
-
ParsingError–如果无法解析登录页面。
-
NetworkError–如果发生网络错误。
Source code in zzupy/aio/web/network.py
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 | |
get_online_devices
async
¤
get_online_devices() -> List[OnlineDevice]
获取当前在线设备
Returns:
-
List[OnlineDevice]–List[OnlineDevice]: 在线设备列表
Raises:
-
NotLoggedInError–如果未登录。
-
ParsingError–如果无法解析 API 返回数据。
-
NetworkError–如果发生网络错误。
Source code in zzupy/aio/web/network.py
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 | |
kick_device
async
¤
kick_device(session_id: str)
将设备踢下线
Parameters:
Raises:
-
NotLoggedInError–如果未登录
Source code in zzupy/aio/web/network.py
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 | |
logout
async
¤
logout()
登出
Raises:
-
NotLoggedInError–如果未登录
Source code in zzupy/aio/web/network.py
435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 | |
discover_portal_info
async
¤
discover_portal_info() -> PortalInfo
自动发现校园网Portal认证信息
Returns:
-
PortalInfo(PortalInfo) –Portal信息
Raises:
-
NetworkError–如果网络错误,或当前环境无法检测到 Portal 信息
-
ParsingError–如果响应格式异常
Source code in zzupy/aio/web/network.py
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 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 | |
network
¤
校园网模块
Classes:
-
EPortalClient–Portal 认证客户端 / 校园网认证客户端
-
SelfServiceSystem–自助服务系统
Functions:
-
discover_portal_info–自动发现校园网Portal认证信息
EPortalClient
¤
EPortalClient(base_url: str, bind_address: str | None = None, force_bind: bool = False)
Portal 认证客户端 / 校园网认证客户端
Parameters:
-
(base_url¤str) –Portal 服务器的 Base URL
-
(bind_address¤str | None, default:None) –绑定的本地 IP
-
(force_bind¤bool, default:False) –即便 IP 绑定失败也在请求参数中使用该 IP。
如果你在路由器后使用本方法,则需要把
bind_address填写为路由器分配的内网 IP 并启用force_bind
Methods:
-
portal_auth–auth()的底层实现,允许完全自定义账户 -
auth–进行 Portal 认证
Source code in zzupy/aio/web/network.py
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 | |
portal_auth
async
¤
auth() 的底层实现,允许完全自定义账户
Parameters:
Returns:
-
AuthResult(AuthResult) –认证结果
Raises:
-
ParsingError–如果无法解析 API 响应。
-
NetworkError–如果发生网络错误。
Source code in zzupy/aio/web/network.py
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 | |
auth
async
¤
auth(account: str, password: str, isp_suffix: str | None = None, encrypt: bool = False) -> AuthResult
进行 Portal 认证
Parameters:
-
(account¤str) –账户
-
(password¤str) –密码
-
(isp_suffix¤str | None, default:None) –运营商后缀
-
(encrypt¤bool, default:False) –是否启用加密
Returns:
-
AuthResult(AuthResult) –认证结果
Source code in zzupy/aio/web/network.py
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 | |
SelfServiceSystem
¤
SelfServiceSystem(base_url: str)
自助服务系统
Methods:
-
login–登录
-
get_online_devices–获取当前在线设备
-
kick_device–将设备踢下线
-
logout–登出
Source code in zzupy/aio/web/network.py
293 294 295 | |
login
async
¤
登录
Parameters:
Raises:
-
LoginError–如果登录失败。
-
ParsingError–如果无法解析登录页面。
-
NetworkError–如果发生网络错误。
Source code in zzupy/aio/web/network.py
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 | |
get_online_devices
async
¤
get_online_devices() -> List[OnlineDevice]
获取当前在线设备
Returns:
-
List[OnlineDevice]–List[OnlineDevice]: 在线设备列表
Raises:
-
NotLoggedInError–如果未登录。
-
ParsingError–如果无法解析 API 返回数据。
-
NetworkError–如果发生网络错误。
Source code in zzupy/aio/web/network.py
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 | |
kick_device
async
¤
kick_device(session_id: str)
将设备踢下线
Parameters:
Raises:
-
NotLoggedInError–如果未登录
Source code in zzupy/aio/web/network.py
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 | |
logout
async
¤
logout()
登出
Raises:
-
NotLoggedInError–如果未登录
Source code in zzupy/aio/web/network.py
435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 | |
discover_portal_info
async
¤
discover_portal_info() -> PortalInfo
自动发现校园网Portal认证信息
Returns:
-
PortalInfo(PortalInfo) –Portal信息
Raises:
-
NetworkError–如果网络错误,或当前环境无法检测到 Portal 信息
-
ParsingError–如果响应格式异常
Source code in zzupy/aio/web/network.py
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 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 | |
app
¤
移动应用 API 抽象层
Modules:
-
auth–统一认证
-
eas– -
ecard–一卡通
-
interfaces–抽象接口
Classes:
-
CASClient–统一认证系统 (CAS) App 客户端。
-
ECardClient–一卡通客户端
-
UndergradEASClient–
CASClient
¤
Bases: ICASClient
flowchart TD
zzupy.app.CASClient[CASClient]
zzupy.app.interfaces.ICASClient[ICASClient]
zzupy.app.interfaces.ICASClient --> zzupy.app.CASClient
click zzupy.app.CASClient href "" "zzupy.app.CASClient"
click zzupy.app.interfaces.ICASClient href "" "zzupy.app.interfaces.ICASClient"
统一认证系统 (CAS) App 客户端。
Parameters:
Classes:
-
MFAClient–统一认证 MFA 辅助客户端。
Methods:
-
set_token–设置统一认证 Token。
-
set_device–设置认证请求使用的设备标识。
-
login–登录统一认证。
-
get_user_info–获取当前用户的聚合个人信息。
-
logout–登出账户,清除 Cookie 但保留连接池
-
close–清除 Cookie 和连接池
Attributes:
-
user_token(str | None) –当前会话的
userToken,约一个月有效期 -
refresh_token(str | None) –当前会话的
refreshToken,约两个月有效期 -
logged_in(bool) –当前会话是否已登录
Source code in zzupy/app/auth.py
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 | |
MFAClient
¤
统一认证 MFA 辅助客户端。
本客户端由 CASClient 自动创建,通常通过
[CASClient.mfa][zzupy.app.auth.CASClient.mfa] 访问。它负责检测 MFA
状态、发送手机号验证码并校验验证码。
Parameters:
Methods:
-
reset–清除当前 MFA 流程状态。
-
is_required–检测当前环境是否需要 MFA 验证
-
request_sms_code–发送 MFA 短信验证码。
-
send_sms–request_sms_code()的别名。 -
verify_sms_code–校验 MFA 短信验证码。
-
verify_sms–verify_sms_code()的别名。
Source code in zzupy/app/auth.py
218 219 220 221 222 223 224 225 226 227 228 229 230 231 | |
reset
¤
reset() -> None
清除当前 MFA 流程状态。
Source code in zzupy/app/auth.py
233 234 235 236 237 238 239 240 | |
is_required
¤
is_required() -> bool
检测当前环境是否需要 MFA 验证
Returns:
-
bool–是否需要 MFA 验证
Raises:
-
OperationError–如果检测失败。
-
ParsingError–如果服务器响应无法解析。
-
NetworkError–如果出现网络错误。
Source code in zzupy/app/auth.py
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 | |
request_sms_code
¤
request_sms_code() -> None
发送 MFA 短信验证码。
如果尚未初始化手机号 MFA,会自动调用内部初始化流程。
Raises:
-
LoginError–如果当前登录不需要 MFA 验证。
-
OperationError–如果短信发送失败。
-
ParsingError–如果服务器响应无法解析。
-
NetworkError–如果出现网络错误。
Source code in zzupy/app/auth.py
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 | |
send_sms
¤
send_sms() -> None
request_sms_code() 的别名。
Source code in zzupy/app/auth.py
481 482 483 | |
verify_sms_code
¤
校验 MFA 短信验证码。
调用前必须先发送 MFA 短信验证码。
校验成功后,CASClient.login()
会使用当前 MFA state 完成登录。
Parameters:
Returns:
-
str–可用于登录的 MFA state。
Raises:
-
MFAError–如果尚未发送 MFA 短信验证码。
-
LoginError–如果验证码校验失败。
-
OperationError–如果服务器返回失败状态。
-
ParsingError–如果服务器响应无法解析。
-
NetworkError–如果出现网络错误。
Source code in zzupy/app/auth.py
485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 | |
verify_sms
¤
verify_sms_code() 的别名。
Source code in zzupy/app/auth.py
568 569 570 | |
set_token
¤
set_token(user_token: str, refresh_token: str) -> None
设置统一认证 Token。
Parameters:
-
(user_token¤str) –userToken。对豫见郑大 APP 抓包获取,或账密登录后访问user_token获取 -
(refresh_token¤str) –refreshToken。对豫见郑大 APP 抓包获取,或账密登录后访问refresh_token获取
Source code in zzupy/app/auth.py
74 75 76 77 78 79 80 81 82 | |
set_device
¤
login
¤
login(force_login: bool = False) -> None
登录统一认证。
成功后,userToken 和 refreshToken 会被存储在实例中.
若 user_token 和 refresh_token 已通过 set_token 设置且有效,则会跳过账密登录。
Parameters:
Raises:
-
MFAError–如果当前登录需要 MFA 但尚未完成验证。
-
LoginError–如果登录失败。
-
ParsingError–如果服务器响应无法解析。
-
NetworkError–如果出现网络错误。
Source code in zzupy/app/auth.py
572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 | |
get_user_info
¤
get_user_info() -> PersonalInfo
获取当前用户的聚合个人信息。
返回学号、姓名、身份类型、学院、邮箱未读数、一卡通余额和科研信息数量。
Returns:
-
PersonalInfo–当前用户的个人信息
Raises:
-
NotLoggedInError–如果当前认证状态缺少 userToken。
-
OperationError–如果服务端返回失败结果。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/app/auth.py
672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 | |
logout
¤
logout() -> None
登出账户,清除 Cookie 但保留连接池
Source code in zzupy/app/auth.py
798 799 800 801 802 803 804 805 806 807 808 809 | |
close
¤
close() -> None
清除 Cookie 和连接池
Source code in zzupy/app/auth.py
811 812 813 814 815 | |
ECardClient
¤
ECardClient(cas_client: ICASClient)
一卡通客户端
Parameters:
-
(cas_client¤ICASClient) –已登录的 CASClient 实例
Methods:
-
login–登录到校园卡系统
-
get_default_room–获取账户默认房间
-
recharge_energy–为 room 充值电费
-
get_balance–获取校园卡余额
-
get_room_dict–获取房间的字典
-
get_remaining_energy–获取剩余电量
-
logout–登出账户,清除 Cookie 但保留连接池
-
close–清除 Cookie 和连接池
Source code in zzupy/app/ecard.py
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 | |
login
¤
login() -> None
登录到校园卡系统
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/app/ecard.py
144 145 146 147 148 149 150 151 152 153 154 155 156 | |
get_default_room
¤
get_default_room() -> str
获取账户默认房间
Returns:
-
str–默认的房间
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/app/ecard.py
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 | |
recharge_energy
¤
为 room 充值电费
Parameters:
-
(payment_password¤str) –支付密码
-
(amt¤int) –充值金额
-
(room¤str) –房间 ID 。格式应为 'areaid-buildingid--unitid-roomid',可通过
get_room_dict()获取
Raises:
-
InvalidArgumentError–如果金额或房间参数不合法。
-
OperationError–如果充值失败。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/app/ecard.py
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 | |
get_balance
¤
get_balance() -> float
获取校园卡余额
Returns:
-
float–校园卡余额
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/app/ecard.py
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 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 | |
get_room_dict
¤
获取房间的字典
Parameters:
Returns:
-
dict–对应的字典
Raises:
-
InvalidArgumentError–如果参数格式不正确。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/app/ecard.py
520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 | |
get_remaining_energy
¤
获取剩余电量
Parameters:
-
(room¤str | None, default:None) –房间 ID 。格式应为 'areaid-buildingid--unitid-roomid',可通过
get_room_dict()获取
Returns:
-
float–剩余电量
Raises:
-
InvalidArgumentError–如果房间参数不合法。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/app/ecard.py
635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 | |
logout
¤
logout() -> None
登出账户,清除 Cookie 但保留连接池
Source code in zzupy/app/ecard.py
732 733 734 735 736 737 738 739 740 741 742 743 744 745 | |
close
¤
close() -> None
清除 Cookie 和连接池
Source code in zzupy/app/ecard.py
747 748 749 750 751 752 753 754 755 756 | |
UndergradEASClient
¤
UndergradEASClient(cas_client: ICASClient)
Methods:
-
login–登录到新本科教务系统
-
get_teaching_week–获取 {semester_id} 号学期的第 {week_index} 教学周
-
get_teaching_weeks–获取 {semester_id} 号学期的全部教学周
-
get_week_index–获取指定日期的教学周序数
-
get_semesters–获取所有学期数据
-
logout–登出账户,清除 Cookie 但保留连接池
-
close–清除 Cookie 和连接池
Source code in zzupy/app/eas/undergrad.py
51 52 53 54 55 56 57 58 59 60 61 | |
login
¤
login() -> None
登录到新本科教务系统
Raises:
-
OperationError–如果登录失败。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/app/eas/undergrad.py
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 | |
get_teaching_week
¤
get_teaching_week(week: int, semester_id: int | None = None) -> TeachingWeek
获取 {semester_id} 号学期的第 {week_index} 教学周 Args: week: 教学周序数 semester_id: 学期 ID。不填写则为本学期。
Returns:
-
TeachingWeek(TeachingWeek) –教学周
Raises:
-
ParsingError–如果响应解析失败
-
NetworkError–如果网络请求失败
-
InvalidArgumentError–如果教学周序数不正确。
-
OperationError–如果服务器发生异常。
Source code in zzupy/app/eas/undergrad.py
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 | |
get_teaching_weeks
¤
get_teaching_weeks(semester_id: int | None = None) -> TeachingWeeks
获取 {semester_id} 号学期的全部教学周 Args: semester_id: 学期 ID。不填写则为本学期。
Returns:
-
TeachingWeeks(TeachingWeeks) –由一个学期的全部教学周组成的列表模型。
Raises:
-
ParsingError–如果响应解析失败
-
NetworkError–如果网络请求失败
-
DataNotFoundError–如果学期不存在。
-
OperationError–如果服务器发生异常。
Source code in zzupy/app/eas/undergrad.py
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 | |
get_week_index
¤
get_week_index(date: Date) -> int | None
获取指定日期的教学周序数
Returns:
-
int | None–int | None: 教学周序数
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
-
OperationError–如果服务器发生异常。
Source code in zzupy/app/eas/undergrad.py
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 | |
get_semesters
¤
获取所有学期数据
Returns:
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
-
OperationError–如果服务器发生异常。
Source code in zzupy/app/eas/undergrad.py
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 | |
logout
¤
logout() -> None
登出账户,清除 Cookie 但保留连接池
Source code in zzupy/app/eas/undergrad.py
454 455 456 457 458 459 460 461 | |
close
¤
close() -> None
清除 Cookie 和连接池
Source code in zzupy/app/eas/undergrad.py
463 464 465 466 467 468 | |
auth
¤
统一认证
Classes:
-
CASClient–统一认证系统 (CAS) App 客户端。
CASClient
¤
Bases: ICASClient
flowchart TD
zzupy.app.auth.CASClient[CASClient]
zzupy.app.interfaces.ICASClient[ICASClient]
zzupy.app.interfaces.ICASClient --> zzupy.app.auth.CASClient
click zzupy.app.auth.CASClient href "" "zzupy.app.auth.CASClient"
click zzupy.app.interfaces.ICASClient href "" "zzupy.app.interfaces.ICASClient"
统一认证系统 (CAS) App 客户端。
Parameters:
Classes:
-
MFAClient–统一认证 MFA 辅助客户端。
Methods:
-
set_token–设置统一认证 Token。
-
set_device–设置认证请求使用的设备标识。
-
login–登录统一认证。
-
get_user_info–获取当前用户的聚合个人信息。
-
logout–登出账户,清除 Cookie 但保留连接池
-
close–清除 Cookie 和连接池
Attributes:
-
user_token(str | None) –当前会话的
userToken,约一个月有效期 -
refresh_token(str | None) –当前会话的
refreshToken,约两个月有效期 -
logged_in(bool) –当前会话是否已登录
Source code in zzupy/app/auth.py
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 | |
MFAClient
¤
统一认证 MFA 辅助客户端。
本客户端由 CASClient 自动创建,通常通过
[CASClient.mfa][zzupy.app.auth.CASClient.mfa] 访问。它负责检测 MFA
状态、发送手机号验证码并校验验证码。
Parameters:
Methods:
-
reset–清除当前 MFA 流程状态。
-
is_required–检测当前环境是否需要 MFA 验证
-
request_sms_code–发送 MFA 短信验证码。
-
send_sms–request_sms_code()的别名。 -
verify_sms_code–校验 MFA 短信验证码。
-
verify_sms–verify_sms_code()的别名。
Source code in zzupy/app/auth.py
218 219 220 221 222 223 224 225 226 227 228 229 230 231 | |
reset
¤
reset() -> None
清除当前 MFA 流程状态。
Source code in zzupy/app/auth.py
233 234 235 236 237 238 239 240 | |
is_required
¤
is_required() -> bool
检测当前环境是否需要 MFA 验证
Returns:
-
bool–是否需要 MFA 验证
Raises:
-
OperationError–如果检测失败。
-
ParsingError–如果服务器响应无法解析。
-
NetworkError–如果出现网络错误。
Source code in zzupy/app/auth.py
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 | |
request_sms_code
¤
request_sms_code() -> None
发送 MFA 短信验证码。
如果尚未初始化手机号 MFA,会自动调用内部初始化流程。
Raises:
-
LoginError–如果当前登录不需要 MFA 验证。
-
OperationError–如果短信发送失败。
-
ParsingError–如果服务器响应无法解析。
-
NetworkError–如果出现网络错误。
Source code in zzupy/app/auth.py
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 | |
send_sms
¤
send_sms() -> None
request_sms_code() 的别名。
Source code in zzupy/app/auth.py
481 482 483 | |
verify_sms_code
¤
校验 MFA 短信验证码。
调用前必须先发送 MFA 短信验证码。
校验成功后,CASClient.login()
会使用当前 MFA state 完成登录。
Parameters:
Returns:
-
str–可用于登录的 MFA state。
Raises:
-
MFAError–如果尚未发送 MFA 短信验证码。
-
LoginError–如果验证码校验失败。
-
OperationError–如果服务器返回失败状态。
-
ParsingError–如果服务器响应无法解析。
-
NetworkError–如果出现网络错误。
Source code in zzupy/app/auth.py
485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 | |
verify_sms
¤
verify_sms_code() 的别名。
Source code in zzupy/app/auth.py
568 569 570 | |
set_token
¤
set_token(user_token: str, refresh_token: str) -> None
设置统一认证 Token。
Parameters:
-
(user_token¤str) –userToken。对豫见郑大 APP 抓包获取,或账密登录后访问user_token获取 -
(refresh_token¤str) –refreshToken。对豫见郑大 APP 抓包获取,或账密登录后访问refresh_token获取
Source code in zzupy/app/auth.py
74 75 76 77 78 79 80 81 82 | |
set_device
¤
login
¤
login(force_login: bool = False) -> None
登录统一认证。
成功后,userToken 和 refreshToken 会被存储在实例中.
若 user_token 和 refresh_token 已通过 set_token 设置且有效,则会跳过账密登录。
Parameters:
Raises:
-
MFAError–如果当前登录需要 MFA 但尚未完成验证。
-
LoginError–如果登录失败。
-
ParsingError–如果服务器响应无法解析。
-
NetworkError–如果出现网络错误。
Source code in zzupy/app/auth.py
572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 | |
get_user_info
¤
get_user_info() -> PersonalInfo
获取当前用户的聚合个人信息。
返回学号、姓名、身份类型、学院、邮箱未读数、一卡通余额和科研信息数量。
Returns:
-
PersonalInfo–当前用户的个人信息
Raises:
-
NotLoggedInError–如果当前认证状态缺少 userToken。
-
OperationError–如果服务端返回失败结果。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/app/auth.py
672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 | |
logout
¤
logout() -> None
登出账户,清除 Cookie 但保留连接池
Source code in zzupy/app/auth.py
798 799 800 801 802 803 804 805 806 807 808 809 | |
close
¤
close() -> None
清除 Cookie 和连接池
Source code in zzupy/app/auth.py
811 812 813 814 815 | |
eas
¤
Modules:
-
undergrad–140w 教务
Classes:
UndergradEASClient
¤
UndergradEASClient(cas_client: ICASClient)
Methods:
-
login–登录到新本科教务系统
-
get_teaching_week–获取 {semester_id} 号学期的第 {week_index} 教学周
-
get_teaching_weeks–获取 {semester_id} 号学期的全部教学周
-
get_week_index–获取指定日期的教学周序数
-
get_semesters–获取所有学期数据
-
logout–登出账户,清除 Cookie 但保留连接池
-
close–清除 Cookie 和连接池
Source code in zzupy/app/eas/undergrad.py
51 52 53 54 55 56 57 58 59 60 61 | |
login
¤
login() -> None
登录到新本科教务系统
Raises:
-
OperationError–如果登录失败。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/app/eas/undergrad.py
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 | |
get_teaching_week
¤
get_teaching_week(week: int, semester_id: int | None = None) -> TeachingWeek
获取 {semester_id} 号学期的第 {week_index} 教学周 Args: week: 教学周序数 semester_id: 学期 ID。不填写则为本学期。
Returns:
-
TeachingWeek(TeachingWeek) –教学周
Raises:
-
ParsingError–如果响应解析失败
-
NetworkError–如果网络请求失败
-
InvalidArgumentError–如果教学周序数不正确。
-
OperationError–如果服务器发生异常。
Source code in zzupy/app/eas/undergrad.py
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 | |
get_teaching_weeks
¤
get_teaching_weeks(semester_id: int | None = None) -> TeachingWeeks
获取 {semester_id} 号学期的全部教学周 Args: semester_id: 学期 ID。不填写则为本学期。
Returns:
-
TeachingWeeks(TeachingWeeks) –由一个学期的全部教学周组成的列表模型。
Raises:
-
ParsingError–如果响应解析失败
-
NetworkError–如果网络请求失败
-
DataNotFoundError–如果学期不存在。
-
OperationError–如果服务器发生异常。
Source code in zzupy/app/eas/undergrad.py
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 | |
get_week_index
¤
get_week_index(date: Date) -> int | None
获取指定日期的教学周序数
Returns:
-
int | None–int | None: 教学周序数
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
-
OperationError–如果服务器发生异常。
Source code in zzupy/app/eas/undergrad.py
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 | |
get_semesters
¤
获取所有学期数据
Returns:
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
-
OperationError–如果服务器发生异常。
Source code in zzupy/app/eas/undergrad.py
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 | |
logout
¤
logout() -> None
登出账户,清除 Cookie 但保留连接池
Source code in zzupy/app/eas/undergrad.py
454 455 456 457 458 459 460 461 | |
close
¤
close() -> None
清除 Cookie 和连接池
Source code in zzupy/app/eas/undergrad.py
463 464 465 466 467 468 | |
undergrad
¤
140w 教务
Classes:
UndergradEASClient
¤
UndergradEASClient(cas_client: ICASClient)
Methods:
-
login–登录到新本科教务系统
-
get_teaching_week–获取 {semester_id} 号学期的第 {week_index} 教学周
-
get_teaching_weeks–获取 {semester_id} 号学期的全部教学周
-
get_week_index–获取指定日期的教学周序数
-
get_semesters–获取所有学期数据
-
logout–登出账户,清除 Cookie 但保留连接池
-
close–清除 Cookie 和连接池
Source code in zzupy/app/eas/undergrad.py
51 52 53 54 55 56 57 58 59 60 61 | |
login
¤
login() -> None
登录到新本科教务系统
Raises:
-
OperationError–如果登录失败。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/app/eas/undergrad.py
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 | |
get_teaching_week
¤
get_teaching_week(week: int, semester_id: int | None = None) -> TeachingWeek
获取 {semester_id} 号学期的第 {week_index} 教学周 Args: week: 教学周序数 semester_id: 学期 ID。不填写则为本学期。
Returns:
-
TeachingWeek(TeachingWeek) –教学周
Raises:
-
ParsingError–如果响应解析失败
-
NetworkError–如果网络请求失败
-
InvalidArgumentError–如果教学周序数不正确。
-
OperationError–如果服务器发生异常。
Source code in zzupy/app/eas/undergrad.py
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 | |
get_teaching_weeks
¤
get_teaching_weeks(semester_id: int | None = None) -> TeachingWeeks
获取 {semester_id} 号学期的全部教学周 Args: semester_id: 学期 ID。不填写则为本学期。
Returns:
-
TeachingWeeks(TeachingWeeks) –由一个学期的全部教学周组成的列表模型。
Raises:
-
ParsingError–如果响应解析失败
-
NetworkError–如果网络请求失败
-
DataNotFoundError–如果学期不存在。
-
OperationError–如果服务器发生异常。
Source code in zzupy/app/eas/undergrad.py
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 | |
get_week_index
¤
get_week_index(date: Date) -> int | None
获取指定日期的教学周序数
Returns:
-
int | None–int | None: 教学周序数
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
-
OperationError–如果服务器发生异常。
Source code in zzupy/app/eas/undergrad.py
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 | |
get_semesters
¤
获取所有学期数据
Returns:
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
-
OperationError–如果服务器发生异常。
Source code in zzupy/app/eas/undergrad.py
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 | |
logout
¤
logout() -> None
登出账户,清除 Cookie 但保留连接池
Source code in zzupy/app/eas/undergrad.py
454 455 456 457 458 459 460 461 | |
close
¤
close() -> None
清除 Cookie 和连接池
Source code in zzupy/app/eas/undergrad.py
463 464 465 466 467 468 | |
ecard
¤
一卡通
Classes:
-
ECardClient–一卡通客户端
ECardClient
¤
ECardClient(cas_client: ICASClient)
一卡通客户端
Parameters:
-
(cas_client¤ICASClient) –已登录的 CASClient 实例
Methods:
-
login–登录到校园卡系统
-
get_default_room–获取账户默认房间
-
recharge_energy–为 room 充值电费
-
get_balance–获取校园卡余额
-
get_room_dict–获取房间的字典
-
get_remaining_energy–获取剩余电量
-
logout–登出账户,清除 Cookie 但保留连接池
-
close–清除 Cookie 和连接池
Source code in zzupy/app/ecard.py
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 | |
login
¤
login() -> None
登录到校园卡系统
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/app/ecard.py
144 145 146 147 148 149 150 151 152 153 154 155 156 | |
get_default_room
¤
get_default_room() -> str
获取账户默认房间
Returns:
-
str–默认的房间
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/app/ecard.py
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 | |
recharge_energy
¤
为 room 充值电费
Parameters:
-
(payment_password¤str) –支付密码
-
(amt¤int) –充值金额
-
(room¤str) –房间 ID 。格式应为 'areaid-buildingid--unitid-roomid',可通过
get_room_dict()获取
Raises:
-
InvalidArgumentError–如果金额或房间参数不合法。
-
OperationError–如果充值失败。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/app/ecard.py
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 | |
get_balance
¤
get_balance() -> float
获取校园卡余额
Returns:
-
float–校园卡余额
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/app/ecard.py
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 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 | |
get_room_dict
¤
获取房间的字典
Parameters:
Returns:
-
dict–对应的字典
Raises:
-
InvalidArgumentError–如果参数格式不正确。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/app/ecard.py
520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 | |
get_remaining_energy
¤
获取剩余电量
Parameters:
-
(room¤str | None, default:None) –房间 ID 。格式应为 'areaid-buildingid--unitid-roomid',可通过
get_room_dict()获取
Returns:
-
float–剩余电量
Raises:
-
InvalidArgumentError–如果房间参数不合法。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/app/ecard.py
635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 | |
logout
¤
logout() -> None
登出账户,清除 Cookie 但保留连接池
Source code in zzupy/app/ecard.py
732 733 734 735 736 737 738 739 740 741 742 743 744 745 | |
close
¤
close() -> None
清除 Cookie 和连接池
Source code in zzupy/app/ecard.py
747 748 749 750 751 752 753 754 755 756 | |
interfaces
¤
抽象接口
crypto
¤
纯 Python 实现的轻量级 RSA 加密
Classes:
-
RSAPublicKey–轻量级 RSA 公钥实现
-
padding–填充方案命名空间(兼容 cryptography)
-
serialization–序列化命名空间(兼容 cryptography)
Functions:
-
load_pem_public_key–从 PEM 格式加载 RSA 公钥
RSAPublicKey
¤
轻量级 RSA 公钥实现
Parameters:
Methods:
-
encrypt–使用 PKCS#1 v1.5 填充进行 RSA 加密
-
verify_rs512–验证 RS512 (RSA-SHA512) 签名
Source code in zzupy/crypto.py
12 13 14 15 16 17 18 19 20 21 22 | |
encrypt
¤
encrypt(data: bytes, padding_scheme=None) -> bytes
使用 PKCS#1 v1.5 填充进行 RSA 加密
Parameters:
Returns:
-
bytes–加密后的字节数据
Source code in zzupy/crypto.py
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 | |
verify_rs512
¤
验证 RS512 (RSA-SHA512) 签名
Parameters:
Returns:
-
bool–签名是否有效
Source code in zzupy/crypto.py
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 | |
padding
¤
serialization
¤
序列化命名空间(兼容 cryptography)
Methods:
-
load_pem_public_key–加载 PEM 格式公钥(兼容 cryptography 接口)
load_pem_public_key
staticmethod
¤
load_pem_public_key(data: bytes) -> RSAPublicKey
加载 PEM 格式公钥(兼容 cryptography 接口)
Source code in zzupy/crypto.py
249 250 251 252 | |
load_pem_public_key
¤
load_pem_public_key(pem_data: bytes) -> RSAPublicKey
从 PEM 格式加载 RSA 公钥
Parameters:
Returns:
-
RSAPublicKey–RSAPublicKey 对象
Source code in zzupy/crypto.py
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 | |
exception
¤
异常处理模块。
Classes:
-
ZZUError–项目异常基类。
-
ClientStateError–客户端状态错误。
-
InvalidArgumentError–调用参数不合法。
-
NetworkError–网络请求失败或网络环境异常。
-
LoginError–登录失败。
-
ParsingError–响应解析或数据校验失败。
-
NotLoggedInError–在未登录状态下调用了需要登录的方法。
-
AuthenticationError–认证失败。
-
OperationError–服务端接受请求但业务处理失败。
-
DataNotFoundError–请求的数据不存在或当前上下文中无法找到。
-
MFAError–MFA 状态错误,当前会话可能需要 MFA 验证
ZZUError
¤
ZZUError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: Exception
flowchart TD
zzupy.exception.ZZUError[ZZUError]
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
项目异常基类。
除了人类可读的错误消息外,还会保留额外上下文,便于调用方记录日志、 序列化或调试。
Parameters:
-
(message¤str | None, default:None) –错误消息。
-
(context¤Mapping[str, Any] | None, default:None) –结构化上下文信息。
-
(error_code¤str | None, default:None) –可选错误代码。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
ClientStateError
¤
ClientStateError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: ZZUError, RuntimeError
flowchart TD
zzupy.exception.ClientStateError[ClientStateError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.ZZUError --> zzupy.exception.ClientStateError
click zzupy.exception.ClientStateError href "" "zzupy.exception.ClientStateError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
客户端状态错误。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
InvalidArgumentError
¤
InvalidArgumentError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: ZZUError, ValueError
flowchart TD
zzupy.exception.InvalidArgumentError[InvalidArgumentError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.ZZUError --> zzupy.exception.InvalidArgumentError
click zzupy.exception.InvalidArgumentError href "" "zzupy.exception.InvalidArgumentError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
调用参数不合法。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
NetworkError
¤
NetworkError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: ZZUError
flowchart TD
zzupy.exception.NetworkError[NetworkError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.ZZUError --> zzupy.exception.NetworkError
click zzupy.exception.NetworkError href "" "zzupy.exception.NetworkError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
网络请求失败或网络环境异常。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
LoginError
¤
LoginError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: ZZUError
flowchart TD
zzupy.exception.LoginError[LoginError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.ZZUError --> zzupy.exception.LoginError
click zzupy.exception.LoginError href "" "zzupy.exception.LoginError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
登录失败。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
ParsingError
¤
ParsingError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: ZZUError
flowchart TD
zzupy.exception.ParsingError[ParsingError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.ZZUError --> zzupy.exception.ParsingError
click zzupy.exception.ParsingError href "" "zzupy.exception.ParsingError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
响应解析或数据校验失败。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
NotLoggedInError
¤
NotLoggedInError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: ClientStateError
flowchart TD
zzupy.exception.NotLoggedInError[NotLoggedInError]
zzupy.exception.ClientStateError[ClientStateError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.ClientStateError --> zzupy.exception.NotLoggedInError
zzupy.exception.ZZUError --> zzupy.exception.ClientStateError
click zzupy.exception.NotLoggedInError href "" "zzupy.exception.NotLoggedInError"
click zzupy.exception.ClientStateError href "" "zzupy.exception.ClientStateError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
在未登录状态下调用了需要登录的方法。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
AuthenticationError
¤
AuthenticationError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: ClientStateError
flowchart TD
zzupy.exception.AuthenticationError[AuthenticationError]
zzupy.exception.ClientStateError[ClientStateError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.ClientStateError --> zzupy.exception.AuthenticationError
zzupy.exception.ZZUError --> zzupy.exception.ClientStateError
click zzupy.exception.AuthenticationError href "" "zzupy.exception.AuthenticationError"
click zzupy.exception.ClientStateError href "" "zzupy.exception.ClientStateError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
认证失败。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
OperationError
¤
OperationError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: ZZUError
flowchart TD
zzupy.exception.OperationError[OperationError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.ZZUError --> zzupy.exception.OperationError
click zzupy.exception.OperationError href "" "zzupy.exception.OperationError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
服务端接受请求但业务处理失败。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
DataNotFoundError
¤
DataNotFoundError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: OperationError, LookupError
flowchart TD
zzupy.exception.DataNotFoundError[DataNotFoundError]
zzupy.exception.OperationError[OperationError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.OperationError --> zzupy.exception.DataNotFoundError
zzupy.exception.ZZUError --> zzupy.exception.OperationError
click zzupy.exception.DataNotFoundError href "" "zzupy.exception.DataNotFoundError"
click zzupy.exception.OperationError href "" "zzupy.exception.OperationError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
请求的数据不存在或当前上下文中无法找到。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
MFAError
¤
MFAError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: LoginError
flowchart TD
zzupy.exception.MFAError[MFAError]
zzupy.exception.LoginError[LoginError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.LoginError --> zzupy.exception.MFAError
zzupy.exception.ZZUError --> zzupy.exception.LoginError
click zzupy.exception.MFAError href "" "zzupy.exception.MFAError"
click zzupy.exception.LoginError href "" "zzupy.exception.LoginError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
MFA 状态错误,当前会话可能需要 MFA 验证
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
logging
¤
zzupy 日志工具。
Functions:
-
sanitize_http_headers–脱敏并标准化 HTTP 头,便于安全输出到日志。
-
sanitize_http_url–脱敏 URL 查询参数。
-
sanitize_http_body–按内容类型对 HTTP Body 做脱敏与截断。
-
log_http_headers–输出脱敏后的 HTTP 头日志。
-
log_http_response_body–输出脱敏后的 HTTP 响应体日志。
-
build_http_event_hooks–创建带脱敏能力的 HTTP 请求/响应日志钩子。
sanitize_http_headers
¤
脱敏并标准化 HTTP 头,便于安全输出到日志。
Source code in zzupy/logging.py
70 71 72 73 74 75 | |
sanitize_http_url
¤
脱敏 URL 查询参数。
Source code in zzupy/logging.py
78 79 80 81 82 83 84 85 86 87 88 89 90 91 | |
sanitize_http_body
¤
sanitize_http_body(body: bytes | str | None, *, content_type: str | None = None, limit: int = _MAX_BODY_LENGTH) -> str
按内容类型对 HTTP Body 做脱敏与截断。
Source code in zzupy/logging.py
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 | |
log_http_headers
¤
输出脱敏后的 HTTP 头日志。
Source code in zzupy/logging.py
146 147 148 149 150 151 152 153 | |
log_http_response_body
¤
log_http_response_body(url: str | URL, text: str, *, content_type: str | None = None, level: str = 'TRACE') -> None
输出脱敏后的 HTTP 响应体日志。
Source code in zzupy/logging.py
156 157 158 159 160 161 162 163 164 165 166 167 168 169 | |
build_http_event_hooks
¤
创建带脱敏能力的 HTTP 请求/响应日志钩子。
Source code in zzupy/logging.py
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 | |
model
¤
Modules:
auth
¤
Classes:
-
PersonalInfoCardModel–‘我的’页中个人信息卡片 API 响应根模型
-
PersonalInfo–个人信息模型
-
PersonalInfoModel–个人信息 API 响应根模型
PersonalInfoCardModel
¤
Bases: BaseModel
flowchart TD
zzupy.model.auth.PersonalInfoCardModel[PersonalInfoCardModel]
click zzupy.model.auth.PersonalInfoCardModel href "" "zzupy.model.auth.PersonalInfoCardModel"
‘我的’页中个人信息卡片 API 响应根模型
Attributes:
PersonalInfo
¤
Bases: BaseModel
flowchart TD
zzupy.model.auth.PersonalInfo[PersonalInfo]
click zzupy.model.auth.PersonalInfo href "" "zzupy.model.auth.PersonalInfo"
个人信息模型
Attributes:
-
uid(str) –学号
-
name(str) –用户姓名
-
student_type(str) –学生类型。比如‘本科生’
-
student_type_id(str) –学生类型 ID
-
college(str) –学院
-
college_id(str) –学院 ID
-
unread_email_count(int) –邮箱未读邮件数
-
balance(float) –一卡通余额
-
research_count(int) –科研信息数量
PersonalInfoModel
¤
Bases: BaseModel
flowchart TD
zzupy.model.auth.PersonalInfoModel[PersonalInfoModel]
click zzupy.model.auth.PersonalInfoModel href "" "zzupy.model.auth.PersonalInfoModel"
个人信息 API 响应根模型
Classes:
-
Data–
Data
¤
Bases: BaseModel
flowchart TD
zzupy.model.auth.PersonalInfoModel.Data[Data]
click zzupy.model.auth.PersonalInfoModel.Data href "" "zzupy.model.auth.PersonalInfoModel.Data"
Classes:
Attributes:
Attributes
¤
Bases: BaseModel
flowchart TD
zzupy.model.auth.PersonalInfoModel.Data.Attributes[Attributes]
click zzupy.model.auth.PersonalInfoModel.Data.Attributes href "" "zzupy.model.auth.PersonalInfoModel.Data.Attributes"
Attributes:
-
organization_id(str) –学院 ID
-
organization_name(str) –学院名
-
identity_type_name(str) –学生类型
-
identity_type_id(str) –学生类型 ID
-
user_name(str) –学生姓名
-
user_uid(str) –学号
eas
¤
Classes:
-
Campus–校区信息
-
CultivateType–培养类型,如主修、辅修等
-
PeriodInfo–课时详情,描述一门课程各类学时的分配情况
-
Course–课程基本信息
-
OpenDepartment–开课院系
-
CourseType–课程类型,如必修课、选修课等
-
DateTimeText–上课时间的文字描述
-
DateTimePlaceText–上课时间与地点的文字描述,如「1~16周 星期四 3~4节 主校区 北3_111」
-
DateTimePlacePersonText–上课时间、地点与教师的文字描述,如「1~16周 星期四 3~4节 主校区 北3_111 王艳玲」
-
ScheduleText–教学班排课的综合文字描述,聚合了三个层次的描述信息
-
ScheduleGroup–排课组,将一个教学班的多次课归入同一组
-
Building–楼栋信息
-
Room–教室信息
-
Schedule–单次课程的具体排课记录
-
Datum–教学班信息,包含课程、排课等完整数据
-
LessonModel–课程表查询 API 响应根模型
-
Lesson–课表中的一节课
-
TeachingWeek–教学周课表,7 天 × 10 节的网格
-
TeachingWeeks– -
Semester–单个学期
-
SemesterModel–获取全部学期数据 API 响应根模型
-
CurrentSemesterModel–获取当前学期数据 API 响应根模型
-
WeekIndexModel–获取某日期的教学周序数 API 响应根模型
Campus
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.Campus[Campus]
click zzupy.model.eas.Campus href "" "zzupy.model.eas.Campus"
校区信息
Attributes:
CultivateType
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.CultivateType[CultivateType]
click zzupy.model.eas.CultivateType href "" "zzupy.model.eas.CultivateType"
培养类型,如主修、辅修等
Attributes:
PeriodInfo
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.PeriodInfo[PeriodInfo]
click zzupy.model.eas.PeriodInfo href "" "zzupy.model.eas.PeriodInfo"
课时详情,描述一门课程各类学时的分配情况
Attributes:
-
total(int) –总学时
-
weeks(int) –开课周数
-
theory(int | None) –理论学时数
-
theory_unit(str | None) –理论学时单位
-
require_theory(int | None) –要求完成的理论学时数
-
experiment(int | None) –实验学时数
-
experiment_unit(str | None) –实验学时单位
-
require_experiment(int | None) –要求完成的实验学时数
-
periods_per_week(int) –每周课时数
Course
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.Course[Course]
click zzupy.model.eas.Course href "" "zzupy.model.eas.Course"
课程基本信息
Attributes:
-
code(str) –课程编号
-
name_zh(str) –课程中文名
-
name_en(str | None) –课程英文名
-
credits(float) –学分
-
period_info(PeriodInfo) –课时详情
-
theory(bool) –是否含理论课
-
experiment(bool) –是否含实验课
-
practice(bool) –是否含实践课
-
test(bool) –是否含考试课时
-
machine(bool) –是否含上机课
-
design(bool) –是否含设计课
-
extra(bool) –是否含其他课时类型
OpenDepartment
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.OpenDepartment[OpenDepartment]
click zzupy.model.eas.OpenDepartment href "" "zzupy.model.eas.OpenDepartment"
开课院系
Attributes:
CourseType
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.CourseType[CourseType]
click zzupy.model.eas.CourseType href "" "zzupy.model.eas.CourseType"
课程类型,如必修课、选修课等
Attributes:
DateTimeText
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.DateTimeText[DateTimeText]
click zzupy.model.eas.DateTimeText href "" "zzupy.model.eas.DateTimeText"
上课时间的文字描述
Attributes:
DateTimePlaceText
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.DateTimePlaceText[DateTimePlaceText]
click zzupy.model.eas.DateTimePlaceText href "" "zzupy.model.eas.DateTimePlaceText"
上课时间与地点的文字描述,如「1~16周 星期四 3~4节 主校区 北3_111」
Attributes:
DateTimePlacePersonText
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.DateTimePlacePersonText[DateTimePlacePersonText]
click zzupy.model.eas.DateTimePlacePersonText href "" "zzupy.model.eas.DateTimePlacePersonText"
上课时间、地点与教师的文字描述,如「1~16周 星期四 3~4节 主校区 北3_111 王艳玲」
Attributes:
ScheduleText
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.ScheduleText[ScheduleText]
click zzupy.model.eas.ScheduleText href "" "zzupy.model.eas.ScheduleText"
教学班排课的综合文字描述,聚合了三个层次的描述信息
Attributes:
-
date_time_text(DateTimeText) –仅时间描述
-
date_time_place_text(DateTimePlaceText) –时间+地点描述
-
date_time_place_person_text(DateTimePlacePersonText) –时间+地点+教师描述
date_time_place_person_text
instance-attribute
¤
date_time_place_person_text: DateTimePlacePersonText
时间+地点+教师描述
ScheduleGroup
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.ScheduleGroup[ScheduleGroup]
click zzupy.model.eas.ScheduleGroup href "" "zzupy.model.eas.ScheduleGroup"
排课组,将一个教学班的多次课归入同一组
Attributes:
Building
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.Building[Building]
click zzupy.model.eas.Building href "" "zzupy.model.eas.Building"
楼栋信息
Attributes:
Room
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.Room[Room]
click zzupy.model.eas.Room href "" "zzupy.model.eas.Room"
教室信息
Attributes:
Schedule
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.Schedule[Schedule]
click zzupy.model.eas.Schedule href "" "zzupy.model.eas.Schedule"
单次课程的具体排课记录
Attributes:
-
schedule_group_id(int) –所属排课组 ID,关联 ScheduleGroup.id
-
date(Date) –上课日期,格式 "YYYY-MM-DD"
-
original_date(None | str) –原始日期
-
weekday(int) –星期几,1=周一,4=周四,7=周日
-
start_time(ZonedDateTime) –开始时间,格式 HHMM,如 1010 表示 10:10
-
end_time(ZonedDateTime) –结束时间,格式 HHMM,如 1150 表示 11:50
-
teacher_name(str) –授课教师中文姓名
-
teacher_name_en(str | None) –授课教师英文姓名
-
custom_place(None | str) –自定义上课地点
-
room(Room | None) –教室信息
-
start_unit(int) –开始节次,如 3(第3节)
-
end_unit(int) –结束节次,如 4(第4节)
-
state(str) –课程状态
-
week_index(int) –本次课所在教学周,如 1 表示第1周
-
lesson_type(str) –课时类型,如 "THEORY"(理论课)
-
periods(int) –本次课课时数,如 2
-
real_start_time(ZonedDateTime) –实际开始时间,格式同 startTime
-
real_end_time(ZonedDateTime) –实际结束时间,格式同 endTime
Datum
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.Datum[Datum]
click zzupy.model.eas.Datum href "" "zzupy.model.eas.Datum"
教学班信息,包含课程、排课等完整数据
Attributes:
-
id(int) –教学班 ID
-
biz_type_id(int) –业务类型 ID
-
campus(Campus) –开课校区
-
cultivate_type(CultivateType) –培养类型
-
code(str) –教学班编号
-
course(Course) –课程基本信息
-
remark(None | str) –备注
-
schedule_state(str) –排课状态
-
std_count(int) –选课学生人数
-
open_department(OpenDepartment) –开课院系
-
course_type(CourseType) –课程类型
-
teacher_assignment_list(list[str]) –授课教师中文姓名列表
-
teacher_assignment_en_list(list[str | None]) –授课教师英文姓名列表
-
schedule_text(ScheduleText) –排课文字描述(时间/地点/教师)
-
schedule_groups(list[ScheduleGroup]) –排课组列表
-
schedules(list[Schedule]) –每次课的具体排课记录列表
-
students(list[Any]) –学生列表
-
time_table_layout_assoc(int) –关联的课表布局 ID
-
suggest_schedule_weeks_info(None) –建议排课周信息
teacher_assignment_en_list
instance-attribute
¤
授课教师英文姓名列表
LessonModel
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.LessonModel[LessonModel]
click zzupy.model.eas.LessonModel href "" "zzupy.model.eas.LessonModel"
课程表查询 API 响应根模型
Attributes:
Lesson
¤
TeachingWeek
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.TeachingWeek[TeachingWeek]
click zzupy.model.eas.TeachingWeek href "" "zzupy.model.eas.TeachingWeek"
教学周课表,7 天 × 10 节的网格
Methods:
-
set–设置某天某节的课程
-
get–获取某天某节的课程
-
get_day–获取某天的全部课程
-
get_unit–获取某节 7 天的课程
-
to_calendar–将教学周的课表转换为符合 RFC 5545 的 Calendar 对象。
Attributes:
-
lessons(dict[tuple[int, int], Lesson]) –内部存储:仅存储非空课程,key 为 (weekday, unit),value 为 Lesson
-
grid(list[list[Lesson | None]]) –网格形式的课表,仅在访问时动态生成
lessons
class-attribute
instance-attribute
¤
内部存储:仅存储非空课程,key 为 (weekday, unit),value 为 Lesson
set
¤
设置某天某节的课程
Parameters:
Raises:
-
IndexError–如果 {weekday} 或 {unit} 超出范围
Source code in zzupy/model/eas.py
449 450 451 452 453 454 455 456 457 458 459 460 461 | |
get
¤
获取某天某节的课程
Parameters:
Returns:
-
Lesson | None–Lesson | None: 对应课程或 None
Raises:
-
IndexError–如果 {weekday} 或 {unit} 超出范围
Source code in zzupy/model/eas.py
463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 | |
get_day
¤
获取某天的全部课程
Parameters:
Returns:
Raises:
-
IndexError–如果 {weekday} 超出范围
Source code in zzupy/model/eas.py
479 480 481 482 483 484 485 486 487 488 489 490 491 492 | |
get_unit
¤
获取某节 7 天的课程
Parameters:
Returns:
Raises:
-
IndexError–如果 {unit} 超出范围
Source code in zzupy/model/eas.py
494 495 496 497 498 499 500 501 502 503 504 505 506 507 | |
to_calendar
¤
将教学周的课表转换为符合 RFC 5545 的 Calendar 对象。 可以使用以下代码将其写入 .ics 或对它做你想做的任何事
with open('my_schedule.ics', 'wb') as f:
f.write(aTeachingWeek.to_calendar().to_ical())
Parameters:
Returns:
-
Calendar–Calendar 对象。
Source code in zzupy/model/eas.py
517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 | |
TeachingWeeks
¤
Bases: RootModel
flowchart TD
zzupy.model.eas.TeachingWeeks[TeachingWeeks]
click zzupy.model.eas.TeachingWeeks href "" "zzupy.model.eas.TeachingWeeks"
Methods:
-
to_calendar–将教学周的课表转换为符合 RFC 5545 的 Calendar 对象。
to_calendar
¤
将教学周的课表转换为符合 RFC 5545 的 Calendar 对象。 可以使用以下代码将其写入 .ics 或对它做你想做的任何事
with open('my_schedule.ics', 'wb') as f:
f.write(aTeachingWeek.to_calendar().to_ical())
Parameters:
Returns:
-
Calendar–Calendar 对象。
Source code in zzupy/model/eas.py
610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 | |
Semester
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.Semester[Semester]
click zzupy.model.eas.Semester href "" "zzupy.model.eas.Semester"
单个学期
SemesterModel
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.SemesterModel[SemesterModel]
click zzupy.model.eas.SemesterModel href "" "zzupy.model.eas.SemesterModel"
获取全部学期数据 API 响应根模型
Attributes:
CurrentSemesterModel
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.CurrentSemesterModel[CurrentSemesterModel]
click zzupy.model.eas.CurrentSemesterModel href "" "zzupy.model.eas.CurrentSemesterModel"
获取当前学期数据 API 响应根模型
Attributes:
WeekIndexModel
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.WeekIndexModel[WeekIndexModel]
click zzupy.model.eas.WeekIndexModel href "" "zzupy.model.eas.WeekIndexModel"
获取某日期的教学周序数 API 响应根模型
Attributes:
ecard
¤
Classes:
-
ECardTemplate–一卡通模板项
-
ECardAccountData–一卡通账户数据
-
ECardAccountModel–一卡通账户 API 响应根模型
ECardTemplate
¤
Bases: BaseModel
flowchart TD
zzupy.model.ecard.ECardTemplate[ECardTemplate]
click zzupy.model.ecard.ECardTemplate href "" "zzupy.model.ecard.ECardTemplate"
一卡通模板项
ECardAccountData
¤
Bases: BaseModel
flowchart TD
zzupy.model.ecard.ECardAccountData[ECardAccountData]
click zzupy.model.ecard.ECardAccountData href "" "zzupy.model.ecard.ECardAccountData"
一卡通账户数据
ECardAccountModel
¤
Bases: BaseModel
flowchart TD
zzupy.model.ecard.ECardAccountModel[ECardAccountModel]
click zzupy.model.ecard.ECardAccountModel href "" "zzupy.model.ecard.ECardAccountModel"
一卡通账户 API 响应根模型
network
¤
Classes:
-
OnlineDevice–在线设备信息
-
AuthResult–Portal 认证结果
-
PortalInfo–探测出的 Portal 认证信息
OnlineDevice
¤
Bases: BaseModel
flowchart TD
zzupy.model.network.OnlineDevice[OnlineDevice]
click zzupy.model.network.OnlineDevice href "" "zzupy.model.network.OnlineDevice"
在线设备信息
Methods:
-
dump_json–格式化为JSON字符串
Attributes:
-
brasid(str) –BRAS ID
-
down_flow(str) –下行流量
-
host_name(str) –主机名
-
ip(str) –IP地址
-
login_time(str) –登录时间,格式为YYYY-MM-DD HH:MM:SS
-
mac(str) –MAC地址
-
session_id(str) –会话ID
-
terminal_type(str) –终端类型
-
up_flow(str) –上行流量
-
use_time(str) –使用时间(秒)
-
user_id(int) –用户ID
AuthResult
¤
Bases: BaseModel
flowchart TD
zzupy.model.network.AuthResult[AuthResult]
click zzupy.model.network.AuthResult href "" "zzupy.model.network.AuthResult"
Portal 认证结果
Attributes:
PortalInfo
¤
Bases: BaseModel
flowchart TD
zzupy.model.network.PortalInfo[PortalInfo]
click zzupy.model.network.PortalInfo href "" "zzupy.model.network.PortalInfo"
探测出的 Portal 认证信息
Attributes:
utils
¤
工具函数库
Classes:
-
XorCipher–一个使用异或 (XOR) 算法进行简单加密和解密的类。
-
JsonPParser–JsonP 格式数据解析器
Functions:
-
decode_jwt_payload–在不验证签名的情况下解析 JWT payload。
-
get_jwt_expiration–读取 JWT 的过期时间。
-
extract_first_html_attr–提取第一个匹配 HTML 标签的属性值。
-
get_sign–获取sign值
-
pkcs7_unpad–去除数据中的PKCS#7填充。
-
sm4_decrypt_ecb–SM4 解密,ECB模式
-
get_local_ip–获取用于连接到特定目标IP的本地IP地址。
-
require_auth–装饰器:确保调用方法前已登录
XorCipher
¤
XorCipher(key_string: str = '')
一个使用异或 (XOR) 算法进行简单加密和解密的类。
Methods:
Source code in zzupy/utils.py
223 224 | |
encrypt
¤
将明文与实例密钥进行异或运算,并转为十六进制字符串。
Parameters:
Source code in zzupy/utils.py
238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 | |
decrypt
¤
decrypt(hex_string: str) -> str
将十六进制字符串解密回原始密码。
Parameters:
Raises:
-
ValueError–如果十六进制字符串格式错误
Source code in zzupy/utils.py
255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 | |
JsonPParser
¤
JsonPParser(text: str)
JsonP 格式数据解析器
Source code in zzupy/utils.py
283 284 285 286 287 | |
decode_jwt_payload
¤
在不验证签名的情况下解析 JWT payload。
该函数只用于读取 CAS Token 的过期时间,不应作为 Token 身份验证手段。
Parameters:
Returns:
Raises:
-
ValueError–如果 Token 过长、结构无效或 JSON 内容不正确。
Source code in zzupy/utils.py
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 | |
get_jwt_expiration
¤
读取 JWT 的过期时间。
Parameters:
Returns:
-
datetime–JWT
exp对应的本地时间。
Raises:
-
ValueError–如果 Token 无效或缺少有效的
exp。
Source code in zzupy/utils.py
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 | |
extract_first_html_attr
¤
extract_first_html_attr(html_content: str, tag: str, attr: str, match_attrs: dict[str, str] | None = None) -> str | None
提取第一个匹配 HTML 标签的属性值。
Source code in zzupy/utils.py
111 112 113 114 115 116 117 118 119 120 121 | |
get_sign
¤
get_sign(dynamic_secret: str, params: str) -> str
获取sign值
Parameters:
Returns:
-
str(str) –sign 值
Source code in zzupy/utils.py
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 | |
pkcs7_unpad
¤
pkcs7_unpad(padded_data: bytes, block_size: int) -> bytes
去除数据中的PKCS#7填充。
Parameters:
Returns:
-
bytes(bytes) –去除填充后的数据
Raises:
-
ValueError–如果填充无效
Source code in zzupy/utils.py
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 | |
sm4_decrypt_ecb
¤
sm4_decrypt_ecb(ciphertext: bytes, key: bytes) -> str
SM4 解密,ECB模式
Parameters:
Returns:
-
str–明文 Hex
Source code in zzupy/utils.py
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 | |
get_local_ip
¤
获取用于连接到特定目标IP的本地IP地址。
Parameters:
Returns:
Source code in zzupy/utils.py
200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 | |
require_auth
¤
require_auth(func)
装饰器:确保调用方法前已登录
Raises:
-
NotLoggedInError–如果未登录
Source code in zzupy/utils.py
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 | |
web
¤
Web API 客户端模块
Modules:
-
network–校园网模块
Classes:
-
EPortalClient–Portal 认证客户端 / 校园网认证客户端
-
SelfServiceSystem–自助服务系统
Functions:
-
discover_portal_info–自动发现校园网Portal认证信息
EPortalClient
¤
EPortalClient(base_url: str, bind_address: str | None = None, force_bind: bool = False)
Portal 认证客户端 / 校园网认证客户端
Parameters:
-
(base_url¤str) –Portal 服务器的 Base URL
-
(bind_address¤str | None, default:None) –绑定的本地 IP
-
(force_bind¤bool, default:False) –即便 IP 绑定失败也在请求参数中使用该 IP。
如果你在路由器后使用本方法,则需要把
bind_address填写为路由器分配的内网 IP 并启用force_bind
Methods:
-
portal_auth–auth()的底层实现,允许完全自定义账户 -
auth–进行 Portal 认证
Source code in zzupy/web/network.py
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 | |
portal_auth
¤
auth() 的底层实现,允许完全自定义账户
Parameters:
Returns:
-
AuthResult(AuthResult) –认证结果
Raises:
-
ParsingError–如果无法解析 API 响应。
-
NetworkError–如果发生网络错误。
Source code in zzupy/web/network.py
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 | |
auth
¤
auth(account: str, password: str, isp_suffix: str | None = None, encrypt: bool = False) -> AuthResult
进行 Portal 认证
Parameters:
-
(account¤str) –账户
-
(password¤str) –密码
-
(isp_suffix¤str | None, default:None) –运营商后缀
-
(encrypt¤bool, default:False) –是否启用加密
Returns:
-
AuthResult(AuthResult) –认证结果
Source code in zzupy/web/network.py
268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 | |
SelfServiceSystem
¤
SelfServiceSystem(base_url: str)
自助服务系统
Methods:
-
login–登录
-
get_online_devices–获取当前在线设备
-
kick_device–将设备踢下线
-
logout–登出
Source code in zzupy/web/network.py
292 293 294 | |
login
¤
登录
Parameters:
Raises:
-
LoginError–如果登录失败。
-
ParsingError–如果无法解析登录页面。
-
NetworkError–如果发生网络错误。
Source code in zzupy/web/network.py
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 | |
get_online_devices
¤
get_online_devices() -> List[OnlineDevice]
获取当前在线设备
Returns:
-
List[OnlineDevice]–List[OnlineDevice]: 在线设备列表
Raises:
-
NotLoggedInError–如果未登录。
-
ParsingError–如果无法解析 API 返回数据。
-
NetworkError–如果发生网络错误。
Source code in zzupy/web/network.py
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 | |
kick_device
¤
kick_device(session_id: str) -> None
将设备踢下线
Parameters:
Raises:
-
NotLoggedInError–如果未登录
Source code in zzupy/web/network.py
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 | |
logout
¤
logout() -> None
登出
Raises:
-
NotLoggedInError–如果未登录
Source code in zzupy/web/network.py
434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 | |
discover_portal_info
¤
discover_portal_info() -> PortalInfo
自动发现校园网Portal认证信息
Returns:
-
PortalInfo(PortalInfo) –Portal信息
Raises:
-
NetworkError–如果网络错误,或当前环境无法检测到 Portal 信息
-
ParsingError–如果响应格式异常
Source code in zzupy/web/network.py
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 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 | |
network
¤
校园网模块
Classes:
-
EPortalClient–Portal 认证客户端 / 校园网认证客户端
-
SelfServiceSystem–自助服务系统
Functions:
-
discover_portal_info–自动发现校园网Portal认证信息
EPortalClient
¤
EPortalClient(base_url: str, bind_address: str | None = None, force_bind: bool = False)
Portal 认证客户端 / 校园网认证客户端
Parameters:
-
(base_url¤str) –Portal 服务器的 Base URL
-
(bind_address¤str | None, default:None) –绑定的本地 IP
-
(force_bind¤bool, default:False) –即便 IP 绑定失败也在请求参数中使用该 IP。
如果你在路由器后使用本方法,则需要把
bind_address填写为路由器分配的内网 IP 并启用force_bind
Methods:
-
portal_auth–auth()的底层实现,允许完全自定义账户 -
auth–进行 Portal 认证
Source code in zzupy/web/network.py
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 | |
portal_auth
¤
auth() 的底层实现,允许完全自定义账户
Parameters:
Returns:
-
AuthResult(AuthResult) –认证结果
Raises:
-
ParsingError–如果无法解析 API 响应。
-
NetworkError–如果发生网络错误。
Source code in zzupy/web/network.py
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 | |
auth
¤
auth(account: str, password: str, isp_suffix: str | None = None, encrypt: bool = False) -> AuthResult
进行 Portal 认证
Parameters:
-
(account¤str) –账户
-
(password¤str) –密码
-
(isp_suffix¤str | None, default:None) –运营商后缀
-
(encrypt¤bool, default:False) –是否启用加密
Returns:
-
AuthResult(AuthResult) –认证结果
Source code in zzupy/web/network.py
268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 | |
SelfServiceSystem
¤
SelfServiceSystem(base_url: str)
自助服务系统
Methods:
-
login–登录
-
get_online_devices–获取当前在线设备
-
kick_device–将设备踢下线
-
logout–登出
Source code in zzupy/web/network.py
292 293 294 | |
login
¤
登录
Parameters:
Raises:
-
LoginError–如果登录失败。
-
ParsingError–如果无法解析登录页面。
-
NetworkError–如果发生网络错误。
Source code in zzupy/web/network.py
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 | |
get_online_devices
¤
get_online_devices() -> List[OnlineDevice]
获取当前在线设备
Returns:
-
List[OnlineDevice]–List[OnlineDevice]: 在线设备列表
Raises:
-
NotLoggedInError–如果未登录。
-
ParsingError–如果无法解析 API 返回数据。
-
NetworkError–如果发生网络错误。
Source code in zzupy/web/network.py
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 | |
kick_device
¤
kick_device(session_id: str) -> None
将设备踢下线
Parameters:
Raises:
-
NotLoggedInError–如果未登录
Source code in zzupy/web/network.py
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 | |
logout
¤
logout() -> None
登出
Raises:
-
NotLoggedInError–如果未登录
Source code in zzupy/web/network.py
434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 | |
discover_portal_info
¤
discover_portal_info() -> PortalInfo
自动发现校园网Portal认证信息
Returns:
-
PortalInfo(PortalInfo) –Portal信息
Raises:
-
NetworkError–如果网络错误,或当前环境无法检测到 Portal 信息
-
ParsingError–如果响应格式异常
Source code in zzupy/web/network.py
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 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 | |
zzupy.aio¤
aio
¤
各模块的异步实现
Modules:
app
¤
移动应用 API 抽象层
Modules:
-
auth–统一认证
-
eas– -
ecard–一卡通
-
interfaces–抽象接口
Classes:
-
CASClient–统一认证系统 (CAS) App 客户端。
-
ECardClient–一卡通客户端
-
UndergradEASClient–
CASClient
¤
Bases: ICASClient
flowchart TD
zzupy.aio.app.CASClient[CASClient]
zzupy.aio.app.interfaces.ICASClient[ICASClient]
zzupy.aio.app.interfaces.ICASClient --> zzupy.aio.app.CASClient
click zzupy.aio.app.CASClient href "" "zzupy.aio.app.CASClient"
click zzupy.aio.app.interfaces.ICASClient href "" "zzupy.aio.app.interfaces.ICASClient"
统一认证系统 (CAS) App 客户端。
Parameters:
Classes:
-
MFAClient–统一认证 MFA 异步辅助客户端。
Methods:
-
set_token–设置统一认证 Token。
-
set_device–设置认证请求使用的设备标识。
-
login–登录统一认证。
-
get_user_info–获取当前用户的聚合个人信息。
-
logout–登出账户,清除 Cookie 但保留连接池
-
close–清除 Cookie 和连接池
Attributes:
-
user_token(str | None) –当前会话的
userToken,约一个月有效期 -
refresh_token(str | None) –当前会话的
refreshToken,约两个月有效期 -
logged_in(bool) –当前会话是否已登录
Source code in zzupy/aio/app/auth.py
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 | |
MFAClient
¤
统一认证 MFA 异步辅助客户端。
本客户端由 CASClient 自动创建,通常通过
[CASClient.mfa][zzupy.aio.app.auth.CASClient.mfa] 访问。它负责检测 MFA
状态、发送手机号验证码并校验验证码。
Parameters:
Methods:
-
reset–清除当前 MFA 流程状态。
-
is_required–检测当前环境是否需要 MFA 验证。
-
request_sms_code–发送 MFA 短信验证码。
-
send_sms–request_sms_code()的别名。 -
verify_sms_code–校验 MFA 短信验证码。
-
verify_sms–verify_sms_code()的别名。
Source code in zzupy/aio/app/auth.py
217 218 219 220 221 222 223 224 225 226 227 228 229 230 | |
reset
¤
reset() -> None
清除当前 MFA 流程状态。
Source code in zzupy/aio/app/auth.py
232 233 234 235 236 237 238 239 | |
is_required
async
¤
is_required() -> bool
检测当前环境是否需要 MFA 验证。
Returns:
-
bool–是否需要 MFA 验证。
Raises:
-
OperationError–如果检测失败。
-
ParsingError–如果服务器响应无法解析。
-
NetworkError–如果出现网络错误。
Source code in zzupy/aio/app/auth.py
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 | |
request_sms_code
async
¤
request_sms_code() -> None
发送 MFA 短信验证码。
如果尚未初始化手机号 MFA,会自动调用内部初始化流程。
Raises:
-
LoginError–如果当前登录不需要 MFA 验证。
-
OperationError–如果短信发送失败。
-
ParsingError–如果服务器响应无法解析。
-
NetworkError–如果出现网络错误。
Source code in zzupy/aio/app/auth.py
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 | |
send_sms
async
¤
send_sms() -> None
request_sms_code() 的别名。
Source code in zzupy/aio/app/auth.py
478 479 480 | |
verify_sms_code
async
¤
校验 MFA 短信验证码。
调用前必须先发送 MFA 短信验证码。
校验成功后,CASClient.login()
会使用当前 MFA state 完成登录。
Parameters:
Returns:
-
str–可用于登录的 MFA state。
Raises:
-
MFAError–如果尚未发送 MFA 短信验证码。
-
LoginError–如果验证码校验失败。
-
OperationError–如果服务器返回失败状态。
-
ParsingError–如果服务器响应无法解析。
-
NetworkError–如果出现网络错误。
Source code in zzupy/aio/app/auth.py
482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 | |
verify_sms
async
¤
verify_sms_code() 的别名。
Source code in zzupy/aio/app/auth.py
565 566 567 | |
set_token
¤
set_token(user_token: str, refresh_token: str) -> None
设置统一认证 Token。
Parameters:
-
(user_token¤str) –userToken。对豫见郑大 APP 抓包获取,或账密登录后访问user_token获取 -
(refresh_token¤str) –refreshToken。对豫见郑大 APP 抓包获取,或账密登录后访问refresh_token获取
Source code in zzupy/aio/app/auth.py
76 77 78 79 80 81 82 83 84 | |
set_device
¤
login
async
¤
login(force_login: bool = False) -> None
登录统一认证。
成功后,userToken 和 refreshToken 会被存储在实例中.
若 user_token 和 refresh_token 已通过 set_token 设置且有效,则会跳过账密登录。
Parameters:
Raises:
-
MFAError–如果当前登录需要 MFA 但尚未完成验证。
-
LoginError–如果登录失败。
-
ParsingError–如果服务器响应无法解析。
-
NetworkError–如果出现网络错误。
Source code in zzupy/aio/app/auth.py
569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 | |
get_user_info
async
¤
get_user_info() -> PersonalInfo
获取当前用户的聚合个人信息。
返回学号、姓名、身份类型、学院、邮箱未读数、一卡通余额和科研信息数量。
Returns:
-
PersonalInfo–当前用户的个人信息
Raises:
-
NotLoggedInError–如果当前认证状态缺少 userToken。
-
OperationError–如果服务端返回失败结果。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/auth.py
671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 | |
logout
¤
logout() -> None
登出账户,清除 Cookie 但保留连接池
Source code in zzupy/aio/app/auth.py
797 798 799 800 801 802 803 804 805 806 807 808 | |
close
async
¤
close() -> None
清除 Cookie 和连接池
Source code in zzupy/aio/app/auth.py
810 811 812 813 814 | |
ECardClient
¤
ECardClient(cas_client: ICASClient)
一卡通客户端
Parameters:
-
(cas_client¤ICASClient) –已登录的 CASClient 实例
Methods:
-
login–登录到校园卡系统
-
get_default_room–获取账户默认房间
-
recharge_energy–为 room 充值电费
-
get_balance–获取校园卡余额
-
get_room_dict–获取房间的字典
-
get_remaining_energy–获取剩余电量
-
logout–登出账户,清除 Cookie 但保留连接池
-
close–清除 Cookie 和连接池
Source code in zzupy/aio/app/ecard.py
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 | |
login
async
¤
login() -> None
登录到校园卡系统
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/ecard.py
146 147 148 149 150 151 152 153 154 155 156 157 158 | |
get_default_room
async
¤
get_default_room() -> str
获取账户默认房间
Returns:
-
str–默认的房间
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/ecard.py
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 | |
recharge_energy
async
¤
为 room 充值电费
Parameters:
-
(payment_password¤str) –支付密码
-
(amt¤int) –充值金额
-
(room¤str) –房间 ID 。格式应为 'areaid-buildingid--unitid-roomid',可通过
get_room_dict()获取
Raises:
-
InvalidArgumentError–如果金额或房间参数不合法。
-
OperationError–如果充值失败。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/ecard.py
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 | |
get_balance
async
¤
get_balance() -> float
获取校园卡余额
Returns:
-
float–校园卡余额
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/ecard.py
464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 | |
get_room_dict
async
¤
获取房间的字典
Parameters:
Returns:
-
dict–对应的字典
Raises:
-
InvalidArgumentError–如果参数格式不正确。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/ecard.py
530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 | |
get_remaining_energy
async
¤
获取剩余电量
Parameters:
-
(room¤str | None, default:None) –房间 ID 。格式应为 'areaid-buildingid--unitid-roomid',可通过
get_room_dict()获取
Returns:
-
float–剩余电量
Raises:
-
InvalidArgumentError–如果房间参数不合法。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/ecard.py
645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 | |
logout
¤
logout() -> None
登出账户,清除 Cookie 但保留连接池
Source code in zzupy/aio/app/ecard.py
742 743 744 745 746 747 748 749 750 751 752 753 | |
close
async
¤
close() -> None
清除 Cookie 和连接池
Source code in zzupy/aio/app/ecard.py
755 756 757 758 759 760 761 762 | |
UndergradEASClient
¤
UndergradEASClient(cas_client: ICASClient)
Methods:
-
login–登录到新本科教务系统
-
get_teaching_week–获取 {semester_id} 号学期的第 {week_index} 教学周
-
get_teaching_weeks–获取 {semester_id} 号学期的全部教学周
-
get_week_index–获取指定日期的教学周序数
-
get_semesters–获取所有学期数据
-
logout–登出账户,清除 Cookie 但保留连接池
-
close–清除 Cookie 和连接池
Source code in zzupy/aio/app/eas/undergrad.py
51 52 53 54 55 56 57 58 59 60 61 62 63 | |
login
async
¤
login() -> None
登录到新本科教务系统
Raises:
-
OperationError–如果登录失败。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
get_teaching_week
async
¤
get_teaching_week(week: int, semester_id: int | None = None) -> TeachingWeek
获取 {semester_id} 号学期的第 {week_index} 教学周 Args: week: 教学周序数 semester_id: 学期 ID。不填写则为本学期。
Returns:
-
TeachingWeek(TeachingWeek) –教学周
Raises:
-
ParsingError–如果响应解析失败
-
NetworkError–如果网络请求失败
-
InvalidArgumentError–如果教学周序数不正确。
-
OperationError–如果服务器发生异常。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
get_teaching_weeks
async
¤
get_teaching_weeks(semester_id: int | None = None) -> TeachingWeeks
获取 {semester_id} 号学期的全部教学周 Args: semester_id: 学期 ID。不填写则为本学期。
Returns:
-
TeachingWeeks(TeachingWeeks) –由一个学期的全部教学周组成的列表模型。
Raises:
-
ParsingError–如果响应解析失败
-
NetworkError–如果网络请求失败
-
DataNotFoundError–如果学期不存在。
-
OperationError–如果服务器发生异常。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
get_week_index
async
¤
get_week_index(date: Date) -> int | None
获取指定日期的教学周序数
Returns:
-
int | None–int | None: 教学周序数
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
-
OperationError–如果服务器发生异常。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
get_semesters
async
¤
获取所有学期数据
Returns:
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
-
OperationError–如果服务器发生异常。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
logout
¤
logout() -> None
登出账户,清除 Cookie 但保留连接池
Source code in zzupy/aio/app/eas/undergrad.py
456 457 458 459 460 461 462 463 | |
close
async
¤
close() -> None
清除 Cookie 和连接池
Source code in zzupy/aio/app/eas/undergrad.py
465 466 467 468 469 470 | |
auth
¤
统一认证
Classes:
-
CASClient–统一认证系统 (CAS) App 客户端。
CASClient
¤
Bases: ICASClient
flowchart TD
zzupy.aio.app.auth.CASClient[CASClient]
zzupy.aio.app.interfaces.ICASClient[ICASClient]
zzupy.aio.app.interfaces.ICASClient --> zzupy.aio.app.auth.CASClient
click zzupy.aio.app.auth.CASClient href "" "zzupy.aio.app.auth.CASClient"
click zzupy.aio.app.interfaces.ICASClient href "" "zzupy.aio.app.interfaces.ICASClient"
统一认证系统 (CAS) App 客户端。
Parameters:
Classes:
-
MFAClient–统一认证 MFA 异步辅助客户端。
Methods:
-
set_token–设置统一认证 Token。
-
set_device–设置认证请求使用的设备标识。
-
login–登录统一认证。
-
get_user_info–获取当前用户的聚合个人信息。
-
logout–登出账户,清除 Cookie 但保留连接池
-
close–清除 Cookie 和连接池
Attributes:
-
user_token(str | None) –当前会话的
userToken,约一个月有效期 -
refresh_token(str | None) –当前会话的
refreshToken,约两个月有效期 -
logged_in(bool) –当前会话是否已登录
Source code in zzupy/aio/app/auth.py
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 | |
MFAClient
¤
统一认证 MFA 异步辅助客户端。
本客户端由 CASClient 自动创建,通常通过
[CASClient.mfa][zzupy.aio.app.auth.CASClient.mfa] 访问。它负责检测 MFA
状态、发送手机号验证码并校验验证码。
Parameters:
Methods:
-
reset–清除当前 MFA 流程状态。
-
is_required–检测当前环境是否需要 MFA 验证。
-
request_sms_code–发送 MFA 短信验证码。
-
send_sms–request_sms_code()的别名。 -
verify_sms_code–校验 MFA 短信验证码。
-
verify_sms–verify_sms_code()的别名。
Source code in zzupy/aio/app/auth.py
217 218 219 220 221 222 223 224 225 226 227 228 229 230 | |
reset
¤
reset() -> None
清除当前 MFA 流程状态。
Source code in zzupy/aio/app/auth.py
232 233 234 235 236 237 238 239 | |
is_required
async
¤
is_required() -> bool
检测当前环境是否需要 MFA 验证。
Returns:
-
bool–是否需要 MFA 验证。
Raises:
-
OperationError–如果检测失败。
-
ParsingError–如果服务器响应无法解析。
-
NetworkError–如果出现网络错误。
Source code in zzupy/aio/app/auth.py
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 | |
request_sms_code
async
¤
request_sms_code() -> None
发送 MFA 短信验证码。
如果尚未初始化手机号 MFA,会自动调用内部初始化流程。
Raises:
-
LoginError–如果当前登录不需要 MFA 验证。
-
OperationError–如果短信发送失败。
-
ParsingError–如果服务器响应无法解析。
-
NetworkError–如果出现网络错误。
Source code in zzupy/aio/app/auth.py
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 | |
send_sms
async
¤
send_sms() -> None
request_sms_code() 的别名。
Source code in zzupy/aio/app/auth.py
478 479 480 | |
verify_sms_code
async
¤
校验 MFA 短信验证码。
调用前必须先发送 MFA 短信验证码。
校验成功后,CASClient.login()
会使用当前 MFA state 完成登录。
Parameters:
Returns:
-
str–可用于登录的 MFA state。
Raises:
-
MFAError–如果尚未发送 MFA 短信验证码。
-
LoginError–如果验证码校验失败。
-
OperationError–如果服务器返回失败状态。
-
ParsingError–如果服务器响应无法解析。
-
NetworkError–如果出现网络错误。
Source code in zzupy/aio/app/auth.py
482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 | |
verify_sms
async
¤
verify_sms_code() 的别名。
Source code in zzupy/aio/app/auth.py
565 566 567 | |
set_token
¤
set_token(user_token: str, refresh_token: str) -> None
设置统一认证 Token。
Parameters:
-
(user_token¤str) –userToken。对豫见郑大 APP 抓包获取,或账密登录后访问user_token获取 -
(refresh_token¤str) –refreshToken。对豫见郑大 APP 抓包获取,或账密登录后访问refresh_token获取
Source code in zzupy/aio/app/auth.py
76 77 78 79 80 81 82 83 84 | |
set_device
¤
login
async
¤
login(force_login: bool = False) -> None
登录统一认证。
成功后,userToken 和 refreshToken 会被存储在实例中.
若 user_token 和 refresh_token 已通过 set_token 设置且有效,则会跳过账密登录。
Parameters:
Raises:
-
MFAError–如果当前登录需要 MFA 但尚未完成验证。
-
LoginError–如果登录失败。
-
ParsingError–如果服务器响应无法解析。
-
NetworkError–如果出现网络错误。
Source code in zzupy/aio/app/auth.py
569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 | |
get_user_info
async
¤
get_user_info() -> PersonalInfo
获取当前用户的聚合个人信息。
返回学号、姓名、身份类型、学院、邮箱未读数、一卡通余额和科研信息数量。
Returns:
-
PersonalInfo–当前用户的个人信息
Raises:
-
NotLoggedInError–如果当前认证状态缺少 userToken。
-
OperationError–如果服务端返回失败结果。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/auth.py
671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 | |
logout
¤
logout() -> None
登出账户,清除 Cookie 但保留连接池
Source code in zzupy/aio/app/auth.py
797 798 799 800 801 802 803 804 805 806 807 808 | |
close
async
¤
close() -> None
清除 Cookie 和连接池
Source code in zzupy/aio/app/auth.py
810 811 812 813 814 | |
eas
¤
Modules:
-
undergrad–140w 教务
Classes:
UndergradEASClient
¤
UndergradEASClient(cas_client: ICASClient)
Methods:
-
login–登录到新本科教务系统
-
get_teaching_week–获取 {semester_id} 号学期的第 {week_index} 教学周
-
get_teaching_weeks–获取 {semester_id} 号学期的全部教学周
-
get_week_index–获取指定日期的教学周序数
-
get_semesters–获取所有学期数据
-
logout–登出账户,清除 Cookie 但保留连接池
-
close–清除 Cookie 和连接池
Source code in zzupy/aio/app/eas/undergrad.py
51 52 53 54 55 56 57 58 59 60 61 62 63 | |
login
async
¤
login() -> None
登录到新本科教务系统
Raises:
-
OperationError–如果登录失败。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
get_teaching_week
async
¤
get_teaching_week(week: int, semester_id: int | None = None) -> TeachingWeek
获取 {semester_id} 号学期的第 {week_index} 教学周 Args: week: 教学周序数 semester_id: 学期 ID。不填写则为本学期。
Returns:
-
TeachingWeek(TeachingWeek) –教学周
Raises:
-
ParsingError–如果响应解析失败
-
NetworkError–如果网络请求失败
-
InvalidArgumentError–如果教学周序数不正确。
-
OperationError–如果服务器发生异常。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
get_teaching_weeks
async
¤
get_teaching_weeks(semester_id: int | None = None) -> TeachingWeeks
获取 {semester_id} 号学期的全部教学周 Args: semester_id: 学期 ID。不填写则为本学期。
Returns:
-
TeachingWeeks(TeachingWeeks) –由一个学期的全部教学周组成的列表模型。
Raises:
-
ParsingError–如果响应解析失败
-
NetworkError–如果网络请求失败
-
DataNotFoundError–如果学期不存在。
-
OperationError–如果服务器发生异常。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
get_week_index
async
¤
get_week_index(date: Date) -> int | None
获取指定日期的教学周序数
Returns:
-
int | None–int | None: 教学周序数
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
-
OperationError–如果服务器发生异常。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
get_semesters
async
¤
获取所有学期数据
Returns:
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
-
OperationError–如果服务器发生异常。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
logout
¤
logout() -> None
登出账户,清除 Cookie 但保留连接池
Source code in zzupy/aio/app/eas/undergrad.py
456 457 458 459 460 461 462 463 | |
close
async
¤
close() -> None
清除 Cookie 和连接池
Source code in zzupy/aio/app/eas/undergrad.py
465 466 467 468 469 470 | |
undergrad
¤
140w 教务
Classes:
UndergradEASClient
¤
UndergradEASClient(cas_client: ICASClient)
Methods:
-
login–登录到新本科教务系统
-
get_teaching_week–获取 {semester_id} 号学期的第 {week_index} 教学周
-
get_teaching_weeks–获取 {semester_id} 号学期的全部教学周
-
get_week_index–获取指定日期的教学周序数
-
get_semesters–获取所有学期数据
-
logout–登出账户,清除 Cookie 但保留连接池
-
close–清除 Cookie 和连接池
Source code in zzupy/aio/app/eas/undergrad.py
51 52 53 54 55 56 57 58 59 60 61 62 63 | |
login
async
¤
login() -> None
登录到新本科教务系统
Raises:
-
OperationError–如果登录失败。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
get_teaching_week
async
¤
get_teaching_week(week: int, semester_id: int | None = None) -> TeachingWeek
获取 {semester_id} 号学期的第 {week_index} 教学周 Args: week: 教学周序数 semester_id: 学期 ID。不填写则为本学期。
Returns:
-
TeachingWeek(TeachingWeek) –教学周
Raises:
-
ParsingError–如果响应解析失败
-
NetworkError–如果网络请求失败
-
InvalidArgumentError–如果教学周序数不正确。
-
OperationError–如果服务器发生异常。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
get_teaching_weeks
async
¤
get_teaching_weeks(semester_id: int | None = None) -> TeachingWeeks
获取 {semester_id} 号学期的全部教学周 Args: semester_id: 学期 ID。不填写则为本学期。
Returns:
-
TeachingWeeks(TeachingWeeks) –由一个学期的全部教学周组成的列表模型。
Raises:
-
ParsingError–如果响应解析失败
-
NetworkError–如果网络请求失败
-
DataNotFoundError–如果学期不存在。
-
OperationError–如果服务器发生异常。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
get_week_index
async
¤
get_week_index(date: Date) -> int | None
获取指定日期的教学周序数
Returns:
-
int | None–int | None: 教学周序数
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
-
OperationError–如果服务器发生异常。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
get_semesters
async
¤
获取所有学期数据
Returns:
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
-
OperationError–如果服务器发生异常。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
logout
¤
logout() -> None
登出账户,清除 Cookie 但保留连接池
Source code in zzupy/aio/app/eas/undergrad.py
456 457 458 459 460 461 462 463 | |
close
async
¤
close() -> None
清除 Cookie 和连接池
Source code in zzupy/aio/app/eas/undergrad.py
465 466 467 468 469 470 | |
ecard
¤
一卡通
Classes:
-
ECardClient–一卡通客户端
ECardClient
¤
ECardClient(cas_client: ICASClient)
一卡通客户端
Parameters:
-
(cas_client¤ICASClient) –已登录的 CASClient 实例
Methods:
-
login–登录到校园卡系统
-
get_default_room–获取账户默认房间
-
recharge_energy–为 room 充值电费
-
get_balance–获取校园卡余额
-
get_room_dict–获取房间的字典
-
get_remaining_energy–获取剩余电量
-
logout–登出账户,清除 Cookie 但保留连接池
-
close–清除 Cookie 和连接池
Source code in zzupy/aio/app/ecard.py
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 | |
login
async
¤
login() -> None
登录到校园卡系统
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/ecard.py
146 147 148 149 150 151 152 153 154 155 156 157 158 | |
get_default_room
async
¤
get_default_room() -> str
获取账户默认房间
Returns:
-
str–默认的房间
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/ecard.py
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 | |
recharge_energy
async
¤
为 room 充值电费
Parameters:
-
(payment_password¤str) –支付密码
-
(amt¤int) –充值金额
-
(room¤str) –房间 ID 。格式应为 'areaid-buildingid--unitid-roomid',可通过
get_room_dict()获取
Raises:
-
InvalidArgumentError–如果金额或房间参数不合法。
-
OperationError–如果充值失败。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/ecard.py
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 | |
get_balance
async
¤
get_balance() -> float
获取校园卡余额
Returns:
-
float–校园卡余额
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/ecard.py
464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 | |
get_room_dict
async
¤
获取房间的字典
Parameters:
Returns:
-
dict–对应的字典
Raises:
-
InvalidArgumentError–如果参数格式不正确。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/ecard.py
530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 | |
get_remaining_energy
async
¤
获取剩余电量
Parameters:
-
(room¤str | None, default:None) –房间 ID 。格式应为 'areaid-buildingid--unitid-roomid',可通过
get_room_dict()获取
Returns:
-
float–剩余电量
Raises:
-
InvalidArgumentError–如果房间参数不合法。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/ecard.py
645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 | |
logout
¤
logout() -> None
登出账户,清除 Cookie 但保留连接池
Source code in zzupy/aio/app/ecard.py
742 743 744 745 746 747 748 749 750 751 752 753 | |
close
async
¤
close() -> None
清除 Cookie 和连接池
Source code in zzupy/aio/app/ecard.py
755 756 757 758 759 760 761 762 | |
interfaces
¤
抽象接口
web
¤
Web API 客户端模块
Modules:
-
network–校园网模块
Classes:
-
EPortalClient–Portal 认证客户端 / 校园网认证客户端
-
SelfServiceSystem–自助服务系统
Functions:
-
discover_portal_info–自动发现校园网Portal认证信息
EPortalClient
¤
EPortalClient(base_url: str, bind_address: str | None = None, force_bind: bool = False)
Portal 认证客户端 / 校园网认证客户端
Parameters:
-
(base_url¤str) –Portal 服务器的 Base URL
-
(bind_address¤str | None, default:None) –绑定的本地 IP
-
(force_bind¤bool, default:False) –即便 IP 绑定失败也在请求参数中使用该 IP。
如果你在路由器后使用本方法,则需要把
bind_address填写为路由器分配的内网 IP 并启用force_bind
Methods:
-
portal_auth–auth()的底层实现,允许完全自定义账户 -
auth–进行 Portal 认证
Source code in zzupy/aio/web/network.py
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 | |
portal_auth
async
¤
auth() 的底层实现,允许完全自定义账户
Parameters:
Returns:
-
AuthResult(AuthResult) –认证结果
Raises:
-
ParsingError–如果无法解析 API 响应。
-
NetworkError–如果发生网络错误。
Source code in zzupy/aio/web/network.py
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 | |
auth
async
¤
auth(account: str, password: str, isp_suffix: str | None = None, encrypt: bool = False) -> AuthResult
进行 Portal 认证
Parameters:
-
(account¤str) –账户
-
(password¤str) –密码
-
(isp_suffix¤str | None, default:None) –运营商后缀
-
(encrypt¤bool, default:False) –是否启用加密
Returns:
-
AuthResult(AuthResult) –认证结果
Source code in zzupy/aio/web/network.py
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 | |
SelfServiceSystem
¤
SelfServiceSystem(base_url: str)
自助服务系统
Methods:
-
login–登录
-
get_online_devices–获取当前在线设备
-
kick_device–将设备踢下线
-
logout–登出
Source code in zzupy/aio/web/network.py
293 294 295 | |
login
async
¤
登录
Parameters:
Raises:
-
LoginError–如果登录失败。
-
ParsingError–如果无法解析登录页面。
-
NetworkError–如果发生网络错误。
Source code in zzupy/aio/web/network.py
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 | |
get_online_devices
async
¤
get_online_devices() -> List[OnlineDevice]
获取当前在线设备
Returns:
-
List[OnlineDevice]–List[OnlineDevice]: 在线设备列表
Raises:
-
NotLoggedInError–如果未登录。
-
ParsingError–如果无法解析 API 返回数据。
-
NetworkError–如果发生网络错误。
Source code in zzupy/aio/web/network.py
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 | |
kick_device
async
¤
kick_device(session_id: str)
将设备踢下线
Parameters:
Raises:
-
NotLoggedInError–如果未登录
Source code in zzupy/aio/web/network.py
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 | |
logout
async
¤
logout()
登出
Raises:
-
NotLoggedInError–如果未登录
Source code in zzupy/aio/web/network.py
435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 | |
discover_portal_info
async
¤
discover_portal_info() -> PortalInfo
自动发现校园网Portal认证信息
Returns:
-
PortalInfo(PortalInfo) –Portal信息
Raises:
-
NetworkError–如果网络错误,或当前环境无法检测到 Portal 信息
-
ParsingError–如果响应格式异常
Source code in zzupy/aio/web/network.py
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 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 | |
network
¤
校园网模块
Classes:
-
EPortalClient–Portal 认证客户端 / 校园网认证客户端
-
SelfServiceSystem–自助服务系统
Functions:
-
discover_portal_info–自动发现校园网Portal认证信息
EPortalClient
¤
EPortalClient(base_url: str, bind_address: str | None = None, force_bind: bool = False)
Portal 认证客户端 / 校园网认证客户端
Parameters:
-
(base_url¤str) –Portal 服务器的 Base URL
-
(bind_address¤str | None, default:None) –绑定的本地 IP
-
(force_bind¤bool, default:False) –即便 IP 绑定失败也在请求参数中使用该 IP。
如果你在路由器后使用本方法,则需要把
bind_address填写为路由器分配的内网 IP 并启用force_bind
Methods:
-
portal_auth–auth()的底层实现,允许完全自定义账户 -
auth–进行 Portal 认证
Source code in zzupy/aio/web/network.py
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 | |
portal_auth
async
¤
auth() 的底层实现,允许完全自定义账户
Parameters:
Returns:
-
AuthResult(AuthResult) –认证结果
Raises:
-
ParsingError–如果无法解析 API 响应。
-
NetworkError–如果发生网络错误。
Source code in zzupy/aio/web/network.py
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 | |
auth
async
¤
auth(account: str, password: str, isp_suffix: str | None = None, encrypt: bool = False) -> AuthResult
进行 Portal 认证
Parameters:
-
(account¤str) –账户
-
(password¤str) –密码
-
(isp_suffix¤str | None, default:None) –运营商后缀
-
(encrypt¤bool, default:False) –是否启用加密
Returns:
-
AuthResult(AuthResult) –认证结果
Source code in zzupy/aio/web/network.py
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 | |
SelfServiceSystem
¤
SelfServiceSystem(base_url: str)
自助服务系统
Methods:
-
login–登录
-
get_online_devices–获取当前在线设备
-
kick_device–将设备踢下线
-
logout–登出
Source code in zzupy/aio/web/network.py
293 294 295 | |
login
async
¤
登录
Parameters:
Raises:
-
LoginError–如果登录失败。
-
ParsingError–如果无法解析登录页面。
-
NetworkError–如果发生网络错误。
Source code in zzupy/aio/web/network.py
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 | |
get_online_devices
async
¤
get_online_devices() -> List[OnlineDevice]
获取当前在线设备
Returns:
-
List[OnlineDevice]–List[OnlineDevice]: 在线设备列表
Raises:
-
NotLoggedInError–如果未登录。
-
ParsingError–如果无法解析 API 返回数据。
-
NetworkError–如果发生网络错误。
Source code in zzupy/aio/web/network.py
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 | |
kick_device
async
¤
kick_device(session_id: str)
将设备踢下线
Parameters:
Raises:
-
NotLoggedInError–如果未登录
Source code in zzupy/aio/web/network.py
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 | |
logout
async
¤
logout()
登出
Raises:
-
NotLoggedInError–如果未登录
Source code in zzupy/aio/web/network.py
435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 | |
discover_portal_info
async
¤
discover_portal_info() -> PortalInfo
自动发现校园网Portal认证信息
Returns:
-
PortalInfo(PortalInfo) –Portal信息
Raises:
-
NetworkError–如果网络错误,或当前环境无法检测到 Portal 信息
-
ParsingError–如果响应格式异常
Source code in zzupy/aio/web/network.py
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 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 | |
zzupy.aio.app¤
app
¤
移动应用 API 抽象层
Modules:
-
auth–统一认证
-
eas– -
ecard–一卡通
-
interfaces–抽象接口
Classes:
-
CASClient–统一认证系统 (CAS) App 客户端。
-
ECardClient–一卡通客户端
-
UndergradEASClient–
Attributes:
-
__all__–
CASClient
¤
Bases: ICASClient
flowchart TD
zzupy.aio.app.CASClient[CASClient]
zzupy.aio.app.interfaces.ICASClient[ICASClient]
zzupy.aio.app.interfaces.ICASClient --> zzupy.aio.app.CASClient
click zzupy.aio.app.CASClient href "" "zzupy.aio.app.CASClient"
click zzupy.aio.app.interfaces.ICASClient href "" "zzupy.aio.app.interfaces.ICASClient"
统一认证系统 (CAS) App 客户端。
Parameters:
Classes:
-
MFAClient–统一认证 MFA 异步辅助客户端。
Methods:
-
set_token–设置统一认证 Token。
-
set_device–设置认证请求使用的设备标识。
-
login–登录统一认证。
-
get_user_info–获取当前用户的聚合个人信息。
-
logout–登出账户,清除 Cookie 但保留连接池
-
close–清除 Cookie 和连接池
Attributes:
-
user_token(str | None) –当前会话的
userToken,约一个月有效期 -
refresh_token(str | None) –当前会话的
refreshToken,约两个月有效期 -
logged_in(bool) –当前会话是否已登录
Source code in zzupy/aio/app/auth.py
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 | |
MFAClient
¤
统一认证 MFA 异步辅助客户端。
本客户端由 CASClient 自动创建,通常通过
[CASClient.mfa][zzupy.aio.app.auth.CASClient.mfa] 访问。它负责检测 MFA
状态、发送手机号验证码并校验验证码。
Parameters:
Methods:
-
reset–清除当前 MFA 流程状态。
-
is_required–检测当前环境是否需要 MFA 验证。
-
request_sms_code–发送 MFA 短信验证码。
-
send_sms–request_sms_code()的别名。 -
verify_sms_code–校验 MFA 短信验证码。
-
verify_sms–verify_sms_code()的别名。
Source code in zzupy/aio/app/auth.py
217 218 219 220 221 222 223 224 225 226 227 228 229 230 | |
reset
¤
reset() -> None
清除当前 MFA 流程状态。
Source code in zzupy/aio/app/auth.py
232 233 234 235 236 237 238 239 | |
is_required
async
¤
is_required() -> bool
检测当前环境是否需要 MFA 验证。
Returns:
-
bool–是否需要 MFA 验证。
Raises:
-
OperationError–如果检测失败。
-
ParsingError–如果服务器响应无法解析。
-
NetworkError–如果出现网络错误。
Source code in zzupy/aio/app/auth.py
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 | |
request_sms_code
async
¤
request_sms_code() -> None
发送 MFA 短信验证码。
如果尚未初始化手机号 MFA,会自动调用内部初始化流程。
Raises:
-
LoginError–如果当前登录不需要 MFA 验证。
-
OperationError–如果短信发送失败。
-
ParsingError–如果服务器响应无法解析。
-
NetworkError–如果出现网络错误。
Source code in zzupy/aio/app/auth.py
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 | |
send_sms
async
¤
send_sms() -> None
request_sms_code() 的别名。
Source code in zzupy/aio/app/auth.py
478 479 480 | |
verify_sms_code
async
¤
校验 MFA 短信验证码。
调用前必须先发送 MFA 短信验证码。
校验成功后,CASClient.login()
会使用当前 MFA state 完成登录。
Parameters:
Returns:
-
str–可用于登录的 MFA state。
Raises:
-
MFAError–如果尚未发送 MFA 短信验证码。
-
LoginError–如果验证码校验失败。
-
OperationError–如果服务器返回失败状态。
-
ParsingError–如果服务器响应无法解析。
-
NetworkError–如果出现网络错误。
Source code in zzupy/aio/app/auth.py
482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 | |
verify_sms
async
¤
verify_sms_code() 的别名。
Source code in zzupy/aio/app/auth.py
565 566 567 | |
set_token
¤
set_token(user_token: str, refresh_token: str) -> None
设置统一认证 Token。
Parameters:
-
(user_token¤str) –userToken。对豫见郑大 APP 抓包获取,或账密登录后访问user_token获取 -
(refresh_token¤str) –refreshToken。对豫见郑大 APP 抓包获取,或账密登录后访问refresh_token获取
Source code in zzupy/aio/app/auth.py
76 77 78 79 80 81 82 83 84 | |
set_device
¤
login
async
¤
login(force_login: bool = False) -> None
登录统一认证。
成功后,userToken 和 refreshToken 会被存储在实例中.
若 user_token 和 refresh_token 已通过 set_token 设置且有效,则会跳过账密登录。
Parameters:
Raises:
-
MFAError–如果当前登录需要 MFA 但尚未完成验证。
-
LoginError–如果登录失败。
-
ParsingError–如果服务器响应无法解析。
-
NetworkError–如果出现网络错误。
Source code in zzupy/aio/app/auth.py
569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 | |
get_user_info
async
¤
get_user_info() -> PersonalInfo
获取当前用户的聚合个人信息。
返回学号、姓名、身份类型、学院、邮箱未读数、一卡通余额和科研信息数量。
Returns:
-
PersonalInfo–当前用户的个人信息
Raises:
-
NotLoggedInError–如果当前认证状态缺少 userToken。
-
OperationError–如果服务端返回失败结果。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/auth.py
671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 | |
logout
¤
logout() -> None
登出账户,清除 Cookie 但保留连接池
Source code in zzupy/aio/app/auth.py
797 798 799 800 801 802 803 804 805 806 807 808 | |
close
async
¤
close() -> None
清除 Cookie 和连接池
Source code in zzupy/aio/app/auth.py
810 811 812 813 814 | |
ECardClient
¤
ECardClient(cas_client: ICASClient)
一卡通客户端
Parameters:
-
(cas_client¤ICASClient) –已登录的 CASClient 实例
Methods:
-
login–登录到校园卡系统
-
get_default_room–获取账户默认房间
-
recharge_energy–为 room 充值电费
-
get_balance–获取校园卡余额
-
get_room_dict–获取房间的字典
-
get_remaining_energy–获取剩余电量
-
logout–登出账户,清除 Cookie 但保留连接池
-
close–清除 Cookie 和连接池
Source code in zzupy/aio/app/ecard.py
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 | |
login
async
¤
login() -> None
登录到校园卡系统
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/ecard.py
146 147 148 149 150 151 152 153 154 155 156 157 158 | |
get_default_room
async
¤
get_default_room() -> str
获取账户默认房间
Returns:
-
str–默认的房间
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/ecard.py
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 | |
recharge_energy
async
¤
为 room 充值电费
Parameters:
-
(payment_password¤str) –支付密码
-
(amt¤int) –充值金额
-
(room¤str) –房间 ID 。格式应为 'areaid-buildingid--unitid-roomid',可通过
get_room_dict()获取
Raises:
-
InvalidArgumentError–如果金额或房间参数不合法。
-
OperationError–如果充值失败。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/ecard.py
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 | |
get_balance
async
¤
get_balance() -> float
获取校园卡余额
Returns:
-
float–校园卡余额
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/ecard.py
464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 | |
get_room_dict
async
¤
获取房间的字典
Parameters:
Returns:
-
dict–对应的字典
Raises:
-
InvalidArgumentError–如果参数格式不正确。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/ecard.py
530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 | |
get_remaining_energy
async
¤
获取剩余电量
Parameters:
-
(room¤str | None, default:None) –房间 ID 。格式应为 'areaid-buildingid--unitid-roomid',可通过
get_room_dict()获取
Returns:
-
float–剩余电量
Raises:
-
InvalidArgumentError–如果房间参数不合法。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/ecard.py
645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 | |
logout
¤
logout() -> None
登出账户,清除 Cookie 但保留连接池
Source code in zzupy/aio/app/ecard.py
742 743 744 745 746 747 748 749 750 751 752 753 | |
close
async
¤
close() -> None
清除 Cookie 和连接池
Source code in zzupy/aio/app/ecard.py
755 756 757 758 759 760 761 762 | |
UndergradEASClient
¤
UndergradEASClient(cas_client: ICASClient)
Methods:
-
login–登录到新本科教务系统
-
get_teaching_week–获取 {semester_id} 号学期的第 {week_index} 教学周
-
get_teaching_weeks–获取 {semester_id} 号学期的全部教学周
-
get_week_index–获取指定日期的教学周序数
-
get_semesters–获取所有学期数据
-
logout–登出账户,清除 Cookie 但保留连接池
-
close–清除 Cookie 和连接池
Source code in zzupy/aio/app/eas/undergrad.py
51 52 53 54 55 56 57 58 59 60 61 62 63 | |
login
async
¤
login() -> None
登录到新本科教务系统
Raises:
-
OperationError–如果登录失败。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
get_teaching_week
async
¤
get_teaching_week(week: int, semester_id: int | None = None) -> TeachingWeek
获取 {semester_id} 号学期的第 {week_index} 教学周 Args: week: 教学周序数 semester_id: 学期 ID。不填写则为本学期。
Returns:
-
TeachingWeek(TeachingWeek) –教学周
Raises:
-
ParsingError–如果响应解析失败
-
NetworkError–如果网络请求失败
-
InvalidArgumentError–如果教学周序数不正确。
-
OperationError–如果服务器发生异常。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
get_teaching_weeks
async
¤
get_teaching_weeks(semester_id: int | None = None) -> TeachingWeeks
获取 {semester_id} 号学期的全部教学周 Args: semester_id: 学期 ID。不填写则为本学期。
Returns:
-
TeachingWeeks(TeachingWeeks) –由一个学期的全部教学周组成的列表模型。
Raises:
-
ParsingError–如果响应解析失败
-
NetworkError–如果网络请求失败
-
DataNotFoundError–如果学期不存在。
-
OperationError–如果服务器发生异常。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
get_week_index
async
¤
get_week_index(date: Date) -> int | None
获取指定日期的教学周序数
Returns:
-
int | None–int | None: 教学周序数
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
-
OperationError–如果服务器发生异常。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
get_semesters
async
¤
获取所有学期数据
Returns:
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
-
OperationError–如果服务器发生异常。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
logout
¤
logout() -> None
登出账户,清除 Cookie 但保留连接池
Source code in zzupy/aio/app/eas/undergrad.py
456 457 458 459 460 461 462 463 | |
close
async
¤
close() -> None
清除 Cookie 和连接池
Source code in zzupy/aio/app/eas/undergrad.py
465 466 467 468 469 470 | |
auth
¤
统一认证
Classes:
-
CASClient–统一认证系统 (CAS) App 客户端。
CASClient
¤
Bases: ICASClient
flowchart TD
zzupy.aio.app.auth.CASClient[CASClient]
zzupy.aio.app.interfaces.ICASClient[ICASClient]
zzupy.aio.app.interfaces.ICASClient --> zzupy.aio.app.auth.CASClient
click zzupy.aio.app.auth.CASClient href "" "zzupy.aio.app.auth.CASClient"
click zzupy.aio.app.interfaces.ICASClient href "" "zzupy.aio.app.interfaces.ICASClient"
统一认证系统 (CAS) App 客户端。
Parameters:
Classes:
-
MFAClient–统一认证 MFA 异步辅助客户端。
Methods:
-
set_token–设置统一认证 Token。
-
set_device–设置认证请求使用的设备标识。
-
login–登录统一认证。
-
get_user_info–获取当前用户的聚合个人信息。
-
logout–登出账户,清除 Cookie 但保留连接池
-
close–清除 Cookie 和连接池
Attributes:
-
user_token(str | None) –当前会话的
userToken,约一个月有效期 -
refresh_token(str | None) –当前会话的
refreshToken,约两个月有效期 -
logged_in(bool) –当前会话是否已登录
Source code in zzupy/aio/app/auth.py
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 | |
MFAClient
¤
统一认证 MFA 异步辅助客户端。
本客户端由 CASClient 自动创建,通常通过
[CASClient.mfa][zzupy.aio.app.auth.CASClient.mfa] 访问。它负责检测 MFA
状态、发送手机号验证码并校验验证码。
Parameters:
Methods:
-
reset–清除当前 MFA 流程状态。
-
is_required–检测当前环境是否需要 MFA 验证。
-
request_sms_code–发送 MFA 短信验证码。
-
send_sms–request_sms_code()的别名。 -
verify_sms_code–校验 MFA 短信验证码。
-
verify_sms–verify_sms_code()的别名。
Source code in zzupy/aio/app/auth.py
217 218 219 220 221 222 223 224 225 226 227 228 229 230 | |
reset
¤
reset() -> None
清除当前 MFA 流程状态。
Source code in zzupy/aio/app/auth.py
232 233 234 235 236 237 238 239 | |
is_required
async
¤
is_required() -> bool
检测当前环境是否需要 MFA 验证。
Returns:
-
bool–是否需要 MFA 验证。
Raises:
-
OperationError–如果检测失败。
-
ParsingError–如果服务器响应无法解析。
-
NetworkError–如果出现网络错误。
Source code in zzupy/aio/app/auth.py
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 | |
request_sms_code
async
¤
request_sms_code() -> None
发送 MFA 短信验证码。
如果尚未初始化手机号 MFA,会自动调用内部初始化流程。
Raises:
-
LoginError–如果当前登录不需要 MFA 验证。
-
OperationError–如果短信发送失败。
-
ParsingError–如果服务器响应无法解析。
-
NetworkError–如果出现网络错误。
Source code in zzupy/aio/app/auth.py
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 | |
send_sms
async
¤
send_sms() -> None
request_sms_code() 的别名。
Source code in zzupy/aio/app/auth.py
478 479 480 | |
verify_sms_code
async
¤
校验 MFA 短信验证码。
调用前必须先发送 MFA 短信验证码。
校验成功后,CASClient.login()
会使用当前 MFA state 完成登录。
Parameters:
Returns:
-
str–可用于登录的 MFA state。
Raises:
-
MFAError–如果尚未发送 MFA 短信验证码。
-
LoginError–如果验证码校验失败。
-
OperationError–如果服务器返回失败状态。
-
ParsingError–如果服务器响应无法解析。
-
NetworkError–如果出现网络错误。
Source code in zzupy/aio/app/auth.py
482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 | |
verify_sms
async
¤
verify_sms_code() 的别名。
Source code in zzupy/aio/app/auth.py
565 566 567 | |
set_token
¤
set_token(user_token: str, refresh_token: str) -> None
设置统一认证 Token。
Parameters:
-
(user_token¤str) –userToken。对豫见郑大 APP 抓包获取,或账密登录后访问user_token获取 -
(refresh_token¤str) –refreshToken。对豫见郑大 APP 抓包获取,或账密登录后访问refresh_token获取
Source code in zzupy/aio/app/auth.py
76 77 78 79 80 81 82 83 84 | |
set_device
¤
login
async
¤
login(force_login: bool = False) -> None
登录统一认证。
成功后,userToken 和 refreshToken 会被存储在实例中.
若 user_token 和 refresh_token 已通过 set_token 设置且有效,则会跳过账密登录。
Parameters:
Raises:
-
MFAError–如果当前登录需要 MFA 但尚未完成验证。
-
LoginError–如果登录失败。
-
ParsingError–如果服务器响应无法解析。
-
NetworkError–如果出现网络错误。
Source code in zzupy/aio/app/auth.py
569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 | |
get_user_info
async
¤
get_user_info() -> PersonalInfo
获取当前用户的聚合个人信息。
返回学号、姓名、身份类型、学院、邮箱未读数、一卡通余额和科研信息数量。
Returns:
-
PersonalInfo–当前用户的个人信息
Raises:
-
NotLoggedInError–如果当前认证状态缺少 userToken。
-
OperationError–如果服务端返回失败结果。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/auth.py
671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 | |
logout
¤
logout() -> None
登出账户,清除 Cookie 但保留连接池
Source code in zzupy/aio/app/auth.py
797 798 799 800 801 802 803 804 805 806 807 808 | |
close
async
¤
close() -> None
清除 Cookie 和连接池
Source code in zzupy/aio/app/auth.py
810 811 812 813 814 | |
eas
¤
Modules:
-
undergrad–140w 教务
Classes:
UndergradEASClient
¤
UndergradEASClient(cas_client: ICASClient)
Methods:
-
login–登录到新本科教务系统
-
get_teaching_week–获取 {semester_id} 号学期的第 {week_index} 教学周
-
get_teaching_weeks–获取 {semester_id} 号学期的全部教学周
-
get_week_index–获取指定日期的教学周序数
-
get_semesters–获取所有学期数据
-
logout–登出账户,清除 Cookie 但保留连接池
-
close–清除 Cookie 和连接池
Source code in zzupy/aio/app/eas/undergrad.py
51 52 53 54 55 56 57 58 59 60 61 62 63 | |
login
async
¤
login() -> None
登录到新本科教务系统
Raises:
-
OperationError–如果登录失败。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
get_teaching_week
async
¤
get_teaching_week(week: int, semester_id: int | None = None) -> TeachingWeek
获取 {semester_id} 号学期的第 {week_index} 教学周 Args: week: 教学周序数 semester_id: 学期 ID。不填写则为本学期。
Returns:
-
TeachingWeek(TeachingWeek) –教学周
Raises:
-
ParsingError–如果响应解析失败
-
NetworkError–如果网络请求失败
-
InvalidArgumentError–如果教学周序数不正确。
-
OperationError–如果服务器发生异常。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
get_teaching_weeks
async
¤
get_teaching_weeks(semester_id: int | None = None) -> TeachingWeeks
获取 {semester_id} 号学期的全部教学周 Args: semester_id: 学期 ID。不填写则为本学期。
Returns:
-
TeachingWeeks(TeachingWeeks) –由一个学期的全部教学周组成的列表模型。
Raises:
-
ParsingError–如果响应解析失败
-
NetworkError–如果网络请求失败
-
DataNotFoundError–如果学期不存在。
-
OperationError–如果服务器发生异常。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
get_week_index
async
¤
get_week_index(date: Date) -> int | None
获取指定日期的教学周序数
Returns:
-
int | None–int | None: 教学周序数
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
-
OperationError–如果服务器发生异常。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
get_semesters
async
¤
获取所有学期数据
Returns:
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
-
OperationError–如果服务器发生异常。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
logout
¤
logout() -> None
登出账户,清除 Cookie 但保留连接池
Source code in zzupy/aio/app/eas/undergrad.py
456 457 458 459 460 461 462 463 | |
close
async
¤
close() -> None
清除 Cookie 和连接池
Source code in zzupy/aio/app/eas/undergrad.py
465 466 467 468 469 470 | |
undergrad
¤
140w 教务
Classes:
UndergradEASClient
¤
UndergradEASClient(cas_client: ICASClient)
Methods:
-
login–登录到新本科教务系统
-
get_teaching_week–获取 {semester_id} 号学期的第 {week_index} 教学周
-
get_teaching_weeks–获取 {semester_id} 号学期的全部教学周
-
get_week_index–获取指定日期的教学周序数
-
get_semesters–获取所有学期数据
-
logout–登出账户,清除 Cookie 但保留连接池
-
close–清除 Cookie 和连接池
Source code in zzupy/aio/app/eas/undergrad.py
51 52 53 54 55 56 57 58 59 60 61 62 63 | |
login
async
¤
login() -> None
登录到新本科教务系统
Raises:
-
OperationError–如果登录失败。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
get_teaching_week
async
¤
get_teaching_week(week: int, semester_id: int | None = None) -> TeachingWeek
获取 {semester_id} 号学期的第 {week_index} 教学周 Args: week: 教学周序数 semester_id: 学期 ID。不填写则为本学期。
Returns:
-
TeachingWeek(TeachingWeek) –教学周
Raises:
-
ParsingError–如果响应解析失败
-
NetworkError–如果网络请求失败
-
InvalidArgumentError–如果教学周序数不正确。
-
OperationError–如果服务器发生异常。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
get_teaching_weeks
async
¤
get_teaching_weeks(semester_id: int | None = None) -> TeachingWeeks
获取 {semester_id} 号学期的全部教学周 Args: semester_id: 学期 ID。不填写则为本学期。
Returns:
-
TeachingWeeks(TeachingWeeks) –由一个学期的全部教学周组成的列表模型。
Raises:
-
ParsingError–如果响应解析失败
-
NetworkError–如果网络请求失败
-
DataNotFoundError–如果学期不存在。
-
OperationError–如果服务器发生异常。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
get_week_index
async
¤
get_week_index(date: Date) -> int | None
获取指定日期的教学周序数
Returns:
-
int | None–int | None: 教学周序数
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
-
OperationError–如果服务器发生异常。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
get_semesters
async
¤
获取所有学期数据
Returns:
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
-
OperationError–如果服务器发生异常。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
logout
¤
logout() -> None
登出账户,清除 Cookie 但保留连接池
Source code in zzupy/aio/app/eas/undergrad.py
456 457 458 459 460 461 462 463 | |
close
async
¤
close() -> None
清除 Cookie 和连接池
Source code in zzupy/aio/app/eas/undergrad.py
465 466 467 468 469 470 | |
ecard
¤
一卡通
Classes:
-
ECardClient–一卡通客户端
ECardClient
¤
ECardClient(cas_client: ICASClient)
一卡通客户端
Parameters:
-
(cas_client¤ICASClient) –已登录的 CASClient 实例
Methods:
-
login–登录到校园卡系统
-
get_default_room–获取账户默认房间
-
recharge_energy–为 room 充值电费
-
get_balance–获取校园卡余额
-
get_room_dict–获取房间的字典
-
get_remaining_energy–获取剩余电量
-
logout–登出账户,清除 Cookie 但保留连接池
-
close–清除 Cookie 和连接池
Source code in zzupy/aio/app/ecard.py
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 | |
login
async
¤
login() -> None
登录到校园卡系统
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/ecard.py
146 147 148 149 150 151 152 153 154 155 156 157 158 | |
get_default_room
async
¤
get_default_room() -> str
获取账户默认房间
Returns:
-
str–默认的房间
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/ecard.py
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 | |
recharge_energy
async
¤
为 room 充值电费
Parameters:
-
(payment_password¤str) –支付密码
-
(amt¤int) –充值金额
-
(room¤str) –房间 ID 。格式应为 'areaid-buildingid--unitid-roomid',可通过
get_room_dict()获取
Raises:
-
InvalidArgumentError–如果金额或房间参数不合法。
-
OperationError–如果充值失败。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/ecard.py
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 | |
get_balance
async
¤
get_balance() -> float
获取校园卡余额
Returns:
-
float–校园卡余额
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/ecard.py
464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 | |
get_room_dict
async
¤
获取房间的字典
Parameters:
Returns:
-
dict–对应的字典
Raises:
-
InvalidArgumentError–如果参数格式不正确。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/ecard.py
530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 | |
get_remaining_energy
async
¤
获取剩余电量
Parameters:
-
(room¤str | None, default:None) –房间 ID 。格式应为 'areaid-buildingid--unitid-roomid',可通过
get_room_dict()获取
Returns:
-
float–剩余电量
Raises:
-
InvalidArgumentError–如果房间参数不合法。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/ecard.py
645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 | |
logout
¤
logout() -> None
登出账户,清除 Cookie 但保留连接池
Source code in zzupy/aio/app/ecard.py
742 743 744 745 746 747 748 749 750 751 752 753 | |
close
async
¤
close() -> None
清除 Cookie 和连接池
Source code in zzupy/aio/app/ecard.py
755 756 757 758 759 760 761 762 | |
interfaces
¤
抽象接口
zzupy.aio.app.auth¤
auth
¤
统一认证
Classes:
-
ICASClient– -
RSAPublicKey–轻量级 RSA 公钥实现
-
padding–填充方案命名空间(兼容 cryptography)
-
serialization–序列化命名空间(兼容 cryptography)
-
LoginError–登录失败。
-
ParsingError–响应解析或数据校验失败。
-
NetworkError–网络请求失败或网络环境异常。
-
NotLoggedInError–在未登录状态下调用了需要登录的方法。
-
OperationError–服务端接受请求但业务处理失败。
-
MFAError–MFA 状态错误,当前会话可能需要 MFA 验证
-
PersonalInfo–个人信息模型
-
PersonalInfoCardModel–‘我的’页中个人信息卡片 API 响应根模型
-
PersonalInfoModel–个人信息 API 响应根模型
-
CASClient–统一认证系统 (CAS) App 客户端。
Functions:
-
build_http_event_hooks–创建带脱敏能力的 HTTP 请求/响应日志钩子。
-
log_http_response_body–输出脱敏后的 HTTP 响应体日志。
-
get_jwt_expiration–读取 JWT 的过期时间。
-
require_auth–装饰器:确保调用方法前已登录
Attributes:
-
logger–
ICASClient
¤
Bases: ABC
flowchart TD
zzupy.aio.app.auth.ICASClient[ICASClient]
click zzupy.aio.app.auth.ICASClient href "" "zzupy.aio.app.auth.ICASClient"
Source code in zzupy/aio/app/interfaces.py
7 8 9 | |
RSAPublicKey
¤
轻量级 RSA 公钥实现
Parameters:
Methods:
-
encrypt–使用 PKCS#1 v1.5 填充进行 RSA 加密
-
verify_rs512–验证 RS512 (RSA-SHA512) 签名
Source code in zzupy/crypto.py
12 13 14 15 16 17 18 19 20 21 22 | |
encrypt
¤
encrypt(data: bytes, padding_scheme=None) -> bytes
使用 PKCS#1 v1.5 填充进行 RSA 加密
Parameters:
Returns:
-
bytes–加密后的字节数据
Source code in zzupy/crypto.py
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 | |
verify_rs512
¤
验证 RS512 (RSA-SHA512) 签名
Parameters:
Returns:
-
bool–签名是否有效
Source code in zzupy/crypto.py
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 | |
padding
¤
serialization
¤
序列化命名空间(兼容 cryptography)
Methods:
-
load_pem_public_key–加载 PEM 格式公钥(兼容 cryptography 接口)
load_pem_public_key
staticmethod
¤
load_pem_public_key(data: bytes) -> RSAPublicKey
加载 PEM 格式公钥(兼容 cryptography 接口)
Source code in zzupy/crypto.py
249 250 251 252 | |
LoginError
¤
LoginError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: ZZUError
flowchart TD
zzupy.aio.app.auth.LoginError[LoginError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.ZZUError --> zzupy.aio.app.auth.LoginError
click zzupy.aio.app.auth.LoginError href "" "zzupy.aio.app.auth.LoginError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
登录失败。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
ParsingError
¤
ParsingError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: ZZUError
flowchart TD
zzupy.aio.app.auth.ParsingError[ParsingError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.ZZUError --> zzupy.aio.app.auth.ParsingError
click zzupy.aio.app.auth.ParsingError href "" "zzupy.aio.app.auth.ParsingError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
响应解析或数据校验失败。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
NetworkError
¤
NetworkError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: ZZUError
flowchart TD
zzupy.aio.app.auth.NetworkError[NetworkError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.ZZUError --> zzupy.aio.app.auth.NetworkError
click zzupy.aio.app.auth.NetworkError href "" "zzupy.aio.app.auth.NetworkError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
网络请求失败或网络环境异常。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
NotLoggedInError
¤
NotLoggedInError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: ClientStateError
flowchart TD
zzupy.aio.app.auth.NotLoggedInError[NotLoggedInError]
zzupy.exception.ClientStateError[ClientStateError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.ClientStateError --> zzupy.aio.app.auth.NotLoggedInError
zzupy.exception.ZZUError --> zzupy.exception.ClientStateError
click zzupy.aio.app.auth.NotLoggedInError href "" "zzupy.aio.app.auth.NotLoggedInError"
click zzupy.exception.ClientStateError href "" "zzupy.exception.ClientStateError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
在未登录状态下调用了需要登录的方法。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
OperationError
¤
OperationError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: ZZUError
flowchart TD
zzupy.aio.app.auth.OperationError[OperationError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.ZZUError --> zzupy.aio.app.auth.OperationError
click zzupy.aio.app.auth.OperationError href "" "zzupy.aio.app.auth.OperationError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
服务端接受请求但业务处理失败。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
MFAError
¤
MFAError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: LoginError
flowchart TD
zzupy.aio.app.auth.MFAError[MFAError]
zzupy.exception.LoginError[LoginError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.LoginError --> zzupy.aio.app.auth.MFAError
zzupy.exception.ZZUError --> zzupy.exception.LoginError
click zzupy.aio.app.auth.MFAError href "" "zzupy.aio.app.auth.MFAError"
click zzupy.exception.LoginError href "" "zzupy.exception.LoginError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
MFA 状态错误,当前会话可能需要 MFA 验证
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
PersonalInfo
¤
Bases: BaseModel
flowchart TD
zzupy.aio.app.auth.PersonalInfo[PersonalInfo]
click zzupy.aio.app.auth.PersonalInfo href "" "zzupy.aio.app.auth.PersonalInfo"
个人信息模型
Attributes:
-
uid(str) –学号
-
name(str) –用户姓名
-
student_type(str) –学生类型。比如‘本科生’
-
student_type_id(str) –学生类型 ID
-
college(str) –学院
-
college_id(str) –学院 ID
-
unread_email_count(int) –邮箱未读邮件数
-
balance(float) –一卡通余额
-
research_count(int) –科研信息数量
PersonalInfoCardModel
¤
Bases: BaseModel
flowchart TD
zzupy.aio.app.auth.PersonalInfoCardModel[PersonalInfoCardModel]
click zzupy.aio.app.auth.PersonalInfoCardModel href "" "zzupy.aio.app.auth.PersonalInfoCardModel"
‘我的’页中个人信息卡片 API 响应根模型
Attributes:
PersonalInfoModel
¤
Bases: BaseModel
flowchart TD
zzupy.aio.app.auth.PersonalInfoModel[PersonalInfoModel]
click zzupy.aio.app.auth.PersonalInfoModel href "" "zzupy.aio.app.auth.PersonalInfoModel"
个人信息 API 响应根模型
Classes:
-
Data–
Data
¤
Bases: BaseModel
flowchart TD
zzupy.aio.app.auth.PersonalInfoModel.Data[Data]
click zzupy.aio.app.auth.PersonalInfoModel.Data href "" "zzupy.aio.app.auth.PersonalInfoModel.Data"
Classes:
Attributes:
Attributes
¤
Bases: BaseModel
flowchart TD
zzupy.aio.app.auth.PersonalInfoModel.Data.Attributes[Attributes]
click zzupy.aio.app.auth.PersonalInfoModel.Data.Attributes href "" "zzupy.aio.app.auth.PersonalInfoModel.Data.Attributes"
Attributes:
-
organization_id(str) –学院 ID
-
organization_name(str) –学院名
-
identity_type_name(str) –学生类型
-
identity_type_id(str) –学生类型 ID
-
user_name(str) –学生姓名
-
user_uid(str) –学号
CASClient
¤
Bases: ICASClient
flowchart TD
zzupy.aio.app.auth.CASClient[CASClient]
zzupy.aio.app.interfaces.ICASClient[ICASClient]
zzupy.aio.app.interfaces.ICASClient --> zzupy.aio.app.auth.CASClient
click zzupy.aio.app.auth.CASClient href "" "zzupy.aio.app.auth.CASClient"
click zzupy.aio.app.interfaces.ICASClient href "" "zzupy.aio.app.interfaces.ICASClient"
统一认证系统 (CAS) App 客户端。
Parameters:
Classes:
-
MFAClient–统一认证 MFA 异步辅助客户端。
Methods:
-
set_token–设置统一认证 Token。
-
set_device–设置认证请求使用的设备标识。
-
login–登录统一认证。
-
get_user_info–获取当前用户的聚合个人信息。
-
logout–登出账户,清除 Cookie 但保留连接池
-
close–清除 Cookie 和连接池
Attributes:
-
user_token(str | None) –当前会话的
userToken,约一个月有效期 -
refresh_token(str | None) –当前会话的
refreshToken,约两个月有效期 -
logged_in(bool) –当前会话是否已登录
Source code in zzupy/aio/app/auth.py
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 | |
MFAClient
¤
统一认证 MFA 异步辅助客户端。
本客户端由 CASClient 自动创建,通常通过
[CASClient.mfa][zzupy.aio.app.auth.CASClient.mfa] 访问。它负责检测 MFA
状态、发送手机号验证码并校验验证码。
Parameters:
Methods:
-
reset–清除当前 MFA 流程状态。
-
is_required–检测当前环境是否需要 MFA 验证。
-
request_sms_code–发送 MFA 短信验证码。
-
send_sms–request_sms_code()的别名。 -
verify_sms_code–校验 MFA 短信验证码。
-
verify_sms–verify_sms_code()的别名。
Source code in zzupy/aio/app/auth.py
217 218 219 220 221 222 223 224 225 226 227 228 229 230 | |
reset
¤
reset() -> None
清除当前 MFA 流程状态。
Source code in zzupy/aio/app/auth.py
232 233 234 235 236 237 238 239 | |
is_required
async
¤
is_required() -> bool
检测当前环境是否需要 MFA 验证。
Returns:
-
bool–是否需要 MFA 验证。
Raises:
-
OperationError–如果检测失败。
-
ParsingError–如果服务器响应无法解析。
-
NetworkError–如果出现网络错误。
Source code in zzupy/aio/app/auth.py
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 | |
request_sms_code
async
¤
request_sms_code() -> None
发送 MFA 短信验证码。
如果尚未初始化手机号 MFA,会自动调用内部初始化流程。
Raises:
-
LoginError–如果当前登录不需要 MFA 验证。
-
OperationError–如果短信发送失败。
-
ParsingError–如果服务器响应无法解析。
-
NetworkError–如果出现网络错误。
Source code in zzupy/aio/app/auth.py
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 | |
send_sms
async
¤
send_sms() -> None
request_sms_code() 的别名。
Source code in zzupy/aio/app/auth.py
478 479 480 | |
verify_sms_code
async
¤
校验 MFA 短信验证码。
调用前必须先发送 MFA 短信验证码。
校验成功后,CASClient.login()
会使用当前 MFA state 完成登录。
Parameters:
Returns:
-
str–可用于登录的 MFA state。
Raises:
-
MFAError–如果尚未发送 MFA 短信验证码。
-
LoginError–如果验证码校验失败。
-
OperationError–如果服务器返回失败状态。
-
ParsingError–如果服务器响应无法解析。
-
NetworkError–如果出现网络错误。
Source code in zzupy/aio/app/auth.py
482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 | |
verify_sms
async
¤
verify_sms_code() 的别名。
Source code in zzupy/aio/app/auth.py
565 566 567 | |
set_token
¤
set_token(user_token: str, refresh_token: str) -> None
设置统一认证 Token。
Parameters:
-
(user_token¤str) –userToken。对豫见郑大 APP 抓包获取,或账密登录后访问user_token获取 -
(refresh_token¤str) –refreshToken。对豫见郑大 APP 抓包获取,或账密登录后访问refresh_token获取
Source code in zzupy/aio/app/auth.py
76 77 78 79 80 81 82 83 84 | |
set_device
¤
login
async
¤
login(force_login: bool = False) -> None
登录统一认证。
成功后,userToken 和 refreshToken 会被存储在实例中.
若 user_token 和 refresh_token 已通过 set_token 设置且有效,则会跳过账密登录。
Parameters:
Raises:
-
MFAError–如果当前登录需要 MFA 但尚未完成验证。
-
LoginError–如果登录失败。
-
ParsingError–如果服务器响应无法解析。
-
NetworkError–如果出现网络错误。
Source code in zzupy/aio/app/auth.py
569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 | |
get_user_info
async
¤
get_user_info() -> PersonalInfo
获取当前用户的聚合个人信息。
返回学号、姓名、身份类型、学院、邮箱未读数、一卡通余额和科研信息数量。
Returns:
-
PersonalInfo–当前用户的个人信息
Raises:
-
NotLoggedInError–如果当前认证状态缺少 userToken。
-
OperationError–如果服务端返回失败结果。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/auth.py
671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 | |
logout
¤
logout() -> None
登出账户,清除 Cookie 但保留连接池
Source code in zzupy/aio/app/auth.py
797 798 799 800 801 802 803 804 805 806 807 808 | |
close
async
¤
close() -> None
清除 Cookie 和连接池
Source code in zzupy/aio/app/auth.py
810 811 812 813 814 | |
build_http_event_hooks
¤
创建带脱敏能力的 HTTP 请求/响应日志钩子。
Source code in zzupy/logging.py
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 | |
log_http_response_body
¤
log_http_response_body(url: str | URL, text: str, *, content_type: str | None = None, level: str = 'TRACE') -> None
输出脱敏后的 HTTP 响应体日志。
Source code in zzupy/logging.py
156 157 158 159 160 161 162 163 164 165 166 167 168 169 | |
get_jwt_expiration
¤
读取 JWT 的过期时间。
Parameters:
Returns:
-
datetime–JWT
exp对应的本地时间。
Raises:
-
ValueError–如果 Token 无效或缺少有效的
exp。
Source code in zzupy/utils.py
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 | |
require_auth
¤
require_auth(func)
装饰器:确保调用方法前已登录
Raises:
-
NotLoggedInError–如果未登录
Source code in zzupy/utils.py
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 | |
zzupy.aio.app.eas¤
eas
¤
Modules:
-
undergrad–140w 教务
Classes:
Attributes:
-
__all__–
UndergradEASClient
¤
UndergradEASClient(cas_client: ICASClient)
Methods:
-
login–登录到新本科教务系统
-
get_teaching_week–获取 {semester_id} 号学期的第 {week_index} 教学周
-
get_teaching_weeks–获取 {semester_id} 号学期的全部教学周
-
get_week_index–获取指定日期的教学周序数
-
get_semesters–获取所有学期数据
-
logout–登出账户,清除 Cookie 但保留连接池
-
close–清除 Cookie 和连接池
Source code in zzupy/aio/app/eas/undergrad.py
51 52 53 54 55 56 57 58 59 60 61 62 63 | |
login
async
¤
login() -> None
登录到新本科教务系统
Raises:
-
OperationError–如果登录失败。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
get_teaching_week
async
¤
get_teaching_week(week: int, semester_id: int | None = None) -> TeachingWeek
获取 {semester_id} 号学期的第 {week_index} 教学周 Args: week: 教学周序数 semester_id: 学期 ID。不填写则为本学期。
Returns:
-
TeachingWeek(TeachingWeek) –教学周
Raises:
-
ParsingError–如果响应解析失败
-
NetworkError–如果网络请求失败
-
InvalidArgumentError–如果教学周序数不正确。
-
OperationError–如果服务器发生异常。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
get_teaching_weeks
async
¤
get_teaching_weeks(semester_id: int | None = None) -> TeachingWeeks
获取 {semester_id} 号学期的全部教学周 Args: semester_id: 学期 ID。不填写则为本学期。
Returns:
-
TeachingWeeks(TeachingWeeks) –由一个学期的全部教学周组成的列表模型。
Raises:
-
ParsingError–如果响应解析失败
-
NetworkError–如果网络请求失败
-
DataNotFoundError–如果学期不存在。
-
OperationError–如果服务器发生异常。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
get_week_index
async
¤
get_week_index(date: Date) -> int | None
获取指定日期的教学周序数
Returns:
-
int | None–int | None: 教学周序数
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
-
OperationError–如果服务器发生异常。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
get_semesters
async
¤
获取所有学期数据
Returns:
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
-
OperationError–如果服务器发生异常。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
logout
¤
logout() -> None
登出账户,清除 Cookie 但保留连接池
Source code in zzupy/aio/app/eas/undergrad.py
456 457 458 459 460 461 462 463 | |
close
async
¤
close() -> None
清除 Cookie 和连接池
Source code in zzupy/aio/app/eas/undergrad.py
465 466 467 468 469 470 | |
undergrad
¤
140w 教务
Classes:
UndergradEASClient
¤
UndergradEASClient(cas_client: ICASClient)
Methods:
-
login–登录到新本科教务系统
-
get_teaching_week–获取 {semester_id} 号学期的第 {week_index} 教学周
-
get_teaching_weeks–获取 {semester_id} 号学期的全部教学周
-
get_week_index–获取指定日期的教学周序数
-
get_semesters–获取所有学期数据
-
logout–登出账户,清除 Cookie 但保留连接池
-
close–清除 Cookie 和连接池
Source code in zzupy/aio/app/eas/undergrad.py
51 52 53 54 55 56 57 58 59 60 61 62 63 | |
login
async
¤
login() -> None
登录到新本科教务系统
Raises:
-
OperationError–如果登录失败。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
get_teaching_week
async
¤
get_teaching_week(week: int, semester_id: int | None = None) -> TeachingWeek
获取 {semester_id} 号学期的第 {week_index} 教学周 Args: week: 教学周序数 semester_id: 学期 ID。不填写则为本学期。
Returns:
-
TeachingWeek(TeachingWeek) –教学周
Raises:
-
ParsingError–如果响应解析失败
-
NetworkError–如果网络请求失败
-
InvalidArgumentError–如果教学周序数不正确。
-
OperationError–如果服务器发生异常。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
get_teaching_weeks
async
¤
get_teaching_weeks(semester_id: int | None = None) -> TeachingWeeks
获取 {semester_id} 号学期的全部教学周 Args: semester_id: 学期 ID。不填写则为本学期。
Returns:
-
TeachingWeeks(TeachingWeeks) –由一个学期的全部教学周组成的列表模型。
Raises:
-
ParsingError–如果响应解析失败
-
NetworkError–如果网络请求失败
-
DataNotFoundError–如果学期不存在。
-
OperationError–如果服务器发生异常。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
get_week_index
async
¤
get_week_index(date: Date) -> int | None
获取指定日期的教学周序数
Returns:
-
int | None–int | None: 教学周序数
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
-
OperationError–如果服务器发生异常。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
get_semesters
async
¤
获取所有学期数据
Returns:
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
-
OperationError–如果服务器发生异常。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
logout
¤
logout() -> None
登出账户,清除 Cookie 但保留连接池
Source code in zzupy/aio/app/eas/undergrad.py
456 457 458 459 460 461 462 463 | |
close
async
¤
close() -> None
清除 Cookie 和连接池
Source code in zzupy/aio/app/eas/undergrad.py
465 466 467 468 469 470 | |
zzupy.aio.app.eas.undergrad¤
undergrad
¤
140w 教务
Classes:
-
ICASClient– -
DataNotFoundError–请求的数据不存在或当前上下文中无法找到。
-
InvalidArgumentError–调用参数不合法。
-
NetworkError–网络请求失败或网络环境异常。
-
NotLoggedInError–在未登录状态下调用了需要登录的方法。
-
OperationError–服务端接受请求但业务处理失败。
-
ParsingError–响应解析或数据校验失败。
-
Lesson–课表中的一节课
-
TeachingWeek–教学周课表,7 天 × 10 节的网格
-
LessonModel–课程表查询 API 响应根模型
-
SemesterModel–获取全部学期数据 API 响应根模型
-
Semester–单个学期
-
WeekIndexModel–获取某日期的教学周序数 API 响应根模型
-
CurrentSemesterModel–获取当前学期数据 API 响应根模型
-
TeachingWeeks– -
UndergradEASClient–
Functions:
-
build_http_event_hooks–创建带脱敏能力的 HTTP 请求/响应日志钩子。
-
log_http_response_body–输出脱敏后的 HTTP 响应体日志。
-
require_auth–装饰器:确保调用方法前已登录
Attributes:
-
logger–
ICASClient
¤
Bases: ABC
flowchart TD
zzupy.aio.app.eas.undergrad.ICASClient[ICASClient]
click zzupy.aio.app.eas.undergrad.ICASClient href "" "zzupy.aio.app.eas.undergrad.ICASClient"
Source code in zzupy/aio/app/interfaces.py
7 8 9 | |
DataNotFoundError
¤
DataNotFoundError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: OperationError, LookupError
flowchart TD
zzupy.aio.app.eas.undergrad.DataNotFoundError[DataNotFoundError]
zzupy.exception.OperationError[OperationError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.OperationError --> zzupy.aio.app.eas.undergrad.DataNotFoundError
zzupy.exception.ZZUError --> zzupy.exception.OperationError
click zzupy.aio.app.eas.undergrad.DataNotFoundError href "" "zzupy.aio.app.eas.undergrad.DataNotFoundError"
click zzupy.exception.OperationError href "" "zzupy.exception.OperationError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
请求的数据不存在或当前上下文中无法找到。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
InvalidArgumentError
¤
InvalidArgumentError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: ZZUError, ValueError
flowchart TD
zzupy.aio.app.eas.undergrad.InvalidArgumentError[InvalidArgumentError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.ZZUError --> zzupy.aio.app.eas.undergrad.InvalidArgumentError
click zzupy.aio.app.eas.undergrad.InvalidArgumentError href "" "zzupy.aio.app.eas.undergrad.InvalidArgumentError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
调用参数不合法。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
NetworkError
¤
NetworkError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: ZZUError
flowchart TD
zzupy.aio.app.eas.undergrad.NetworkError[NetworkError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.ZZUError --> zzupy.aio.app.eas.undergrad.NetworkError
click zzupy.aio.app.eas.undergrad.NetworkError href "" "zzupy.aio.app.eas.undergrad.NetworkError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
网络请求失败或网络环境异常。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
NotLoggedInError
¤
NotLoggedInError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: ClientStateError
flowchart TD
zzupy.aio.app.eas.undergrad.NotLoggedInError[NotLoggedInError]
zzupy.exception.ClientStateError[ClientStateError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.ClientStateError --> zzupy.aio.app.eas.undergrad.NotLoggedInError
zzupy.exception.ZZUError --> zzupy.exception.ClientStateError
click zzupy.aio.app.eas.undergrad.NotLoggedInError href "" "zzupy.aio.app.eas.undergrad.NotLoggedInError"
click zzupy.exception.ClientStateError href "" "zzupy.exception.ClientStateError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
在未登录状态下调用了需要登录的方法。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
OperationError
¤
OperationError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: ZZUError
flowchart TD
zzupy.aio.app.eas.undergrad.OperationError[OperationError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.ZZUError --> zzupy.aio.app.eas.undergrad.OperationError
click zzupy.aio.app.eas.undergrad.OperationError href "" "zzupy.aio.app.eas.undergrad.OperationError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
服务端接受请求但业务处理失败。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
ParsingError
¤
ParsingError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: ZZUError
flowchart TD
zzupy.aio.app.eas.undergrad.ParsingError[ParsingError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.ZZUError --> zzupy.aio.app.eas.undergrad.ParsingError
click zzupy.aio.app.eas.undergrad.ParsingError href "" "zzupy.aio.app.eas.undergrad.ParsingError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
响应解析或数据校验失败。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
Lesson
¤
Bases: BaseModel
flowchart TD
zzupy.aio.app.eas.undergrad.Lesson[Lesson]
click zzupy.aio.app.eas.undergrad.Lesson href "" "zzupy.aio.app.eas.undergrad.Lesson"
课表中的一节课
Attributes:
TeachingWeek
¤
Bases: BaseModel
flowchart TD
zzupy.aio.app.eas.undergrad.TeachingWeek[TeachingWeek]
click zzupy.aio.app.eas.undergrad.TeachingWeek href "" "zzupy.aio.app.eas.undergrad.TeachingWeek"
教学周课表,7 天 × 10 节的网格
Methods:
-
set–设置某天某节的课程
-
get–获取某天某节的课程
-
get_day–获取某天的全部课程
-
get_unit–获取某节 7 天的课程
-
to_calendar–将教学周的课表转换为符合 RFC 5545 的 Calendar 对象。
Attributes:
-
lessons(dict[tuple[int, int], Lesson]) –内部存储:仅存储非空课程,key 为 (weekday, unit),value 为 Lesson
-
grid(list[list[Lesson | None]]) –网格形式的课表,仅在访问时动态生成
lessons
class-attribute
instance-attribute
¤
内部存储:仅存储非空课程,key 为 (weekday, unit),value 为 Lesson
set
¤
设置某天某节的课程
Parameters:
Raises:
-
IndexError–如果 {weekday} 或 {unit} 超出范围
Source code in zzupy/model/eas.py
449 450 451 452 453 454 455 456 457 458 459 460 461 | |
get
¤
获取某天某节的课程
Parameters:
Returns:
-
Lesson | None–Lesson | None: 对应课程或 None
Raises:
-
IndexError–如果 {weekday} 或 {unit} 超出范围
Source code in zzupy/model/eas.py
463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 | |
get_day
¤
获取某天的全部课程
Parameters:
Returns:
Raises:
-
IndexError–如果 {weekday} 超出范围
Source code in zzupy/model/eas.py
479 480 481 482 483 484 485 486 487 488 489 490 491 492 | |
get_unit
¤
获取某节 7 天的课程
Parameters:
Returns:
Raises:
-
IndexError–如果 {unit} 超出范围
Source code in zzupy/model/eas.py
494 495 496 497 498 499 500 501 502 503 504 505 506 507 | |
to_calendar
¤
将教学周的课表转换为符合 RFC 5545 的 Calendar 对象。 可以使用以下代码将其写入 .ics 或对它做你想做的任何事
with open('my_schedule.ics', 'wb') as f:
f.write(aTeachingWeek.to_calendar().to_ical())
Parameters:
Returns:
-
Calendar–Calendar 对象。
Source code in zzupy/model/eas.py
517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 | |
LessonModel
¤
Bases: BaseModel
flowchart TD
zzupy.aio.app.eas.undergrad.LessonModel[LessonModel]
click zzupy.aio.app.eas.undergrad.LessonModel href "" "zzupy.aio.app.eas.undergrad.LessonModel"
课程表查询 API 响应根模型
Attributes:
SemesterModel
¤
Bases: BaseModel
flowchart TD
zzupy.aio.app.eas.undergrad.SemesterModel[SemesterModel]
click zzupy.aio.app.eas.undergrad.SemesterModel href "" "zzupy.aio.app.eas.undergrad.SemesterModel"
获取全部学期数据 API 响应根模型
Attributes:
Semester
¤
Bases: BaseModel
flowchart TD
zzupy.aio.app.eas.undergrad.Semester[Semester]
click zzupy.aio.app.eas.undergrad.Semester href "" "zzupy.aio.app.eas.undergrad.Semester"
单个学期
WeekIndexModel
¤
Bases: BaseModel
flowchart TD
zzupy.aio.app.eas.undergrad.WeekIndexModel[WeekIndexModel]
click zzupy.aio.app.eas.undergrad.WeekIndexModel href "" "zzupy.aio.app.eas.undergrad.WeekIndexModel"
获取某日期的教学周序数 API 响应根模型
Attributes:
CurrentSemesterModel
¤
Bases: BaseModel
flowchart TD
zzupy.aio.app.eas.undergrad.CurrentSemesterModel[CurrentSemesterModel]
click zzupy.aio.app.eas.undergrad.CurrentSemesterModel href "" "zzupy.aio.app.eas.undergrad.CurrentSemesterModel"
获取当前学期数据 API 响应根模型
Attributes:
TeachingWeeks
¤
Bases: RootModel
flowchart TD
zzupy.aio.app.eas.undergrad.TeachingWeeks[TeachingWeeks]
click zzupy.aio.app.eas.undergrad.TeachingWeeks href "" "zzupy.aio.app.eas.undergrad.TeachingWeeks"
Methods:
-
to_calendar–将教学周的课表转换为符合 RFC 5545 的 Calendar 对象。
to_calendar
¤
将教学周的课表转换为符合 RFC 5545 的 Calendar 对象。 可以使用以下代码将其写入 .ics 或对它做你想做的任何事
with open('my_schedule.ics', 'wb') as f:
f.write(aTeachingWeek.to_calendar().to_ical())
Parameters:
Returns:
-
Calendar–Calendar 对象。
Source code in zzupy/model/eas.py
610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 | |
UndergradEASClient
¤
UndergradEASClient(cas_client: ICASClient)
Methods:
-
login–登录到新本科教务系统
-
get_teaching_week–获取 {semester_id} 号学期的第 {week_index} 教学周
-
get_teaching_weeks–获取 {semester_id} 号学期的全部教学周
-
get_week_index–获取指定日期的教学周序数
-
get_semesters–获取所有学期数据
-
logout–登出账户,清除 Cookie 但保留连接池
-
close–清除 Cookie 和连接池
Source code in zzupy/aio/app/eas/undergrad.py
51 52 53 54 55 56 57 58 59 60 61 62 63 | |
login
async
¤
login() -> None
登录到新本科教务系统
Raises:
-
OperationError–如果登录失败。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
get_teaching_week
async
¤
get_teaching_week(week: int, semester_id: int | None = None) -> TeachingWeek
获取 {semester_id} 号学期的第 {week_index} 教学周 Args: week: 教学周序数 semester_id: 学期 ID。不填写则为本学期。
Returns:
-
TeachingWeek(TeachingWeek) –教学周
Raises:
-
ParsingError–如果响应解析失败
-
NetworkError–如果网络请求失败
-
InvalidArgumentError–如果教学周序数不正确。
-
OperationError–如果服务器发生异常。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
get_teaching_weeks
async
¤
get_teaching_weeks(semester_id: int | None = None) -> TeachingWeeks
获取 {semester_id} 号学期的全部教学周 Args: semester_id: 学期 ID。不填写则为本学期。
Returns:
-
TeachingWeeks(TeachingWeeks) –由一个学期的全部教学周组成的列表模型。
Raises:
-
ParsingError–如果响应解析失败
-
NetworkError–如果网络请求失败
-
DataNotFoundError–如果学期不存在。
-
OperationError–如果服务器发生异常。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
get_week_index
async
¤
get_week_index(date: Date) -> int | None
获取指定日期的教学周序数
Returns:
-
int | None–int | None: 教学周序数
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
-
OperationError–如果服务器发生异常。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
get_semesters
async
¤
获取所有学期数据
Returns:
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
-
OperationError–如果服务器发生异常。
Source code in zzupy/aio/app/eas/undergrad.py
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 | |
logout
¤
logout() -> None
登出账户,清除 Cookie 但保留连接池
Source code in zzupy/aio/app/eas/undergrad.py
456 457 458 459 460 461 462 463 | |
close
async
¤
close() -> None
清除 Cookie 和连接池
Source code in zzupy/aio/app/eas/undergrad.py
465 466 467 468 469 470 | |
build_http_event_hooks
¤
创建带脱敏能力的 HTTP 请求/响应日志钩子。
Source code in zzupy/logging.py
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 | |
log_http_response_body
¤
log_http_response_body(url: str | URL, text: str, *, content_type: str | None = None, level: str = 'TRACE') -> None
输出脱敏后的 HTTP 响应体日志。
Source code in zzupy/logging.py
156 157 158 159 160 161 162 163 164 165 166 167 168 169 | |
require_auth
¤
require_auth(func)
装饰器:确保调用方法前已登录
Raises:
-
NotLoggedInError–如果未登录
Source code in zzupy/utils.py
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 | |
zzupy.aio.app.ecard¤
ecard
¤
一卡通
Classes:
-
ICASClient– -
InvalidArgumentError–调用参数不合法。
-
NetworkError–网络请求失败或网络环境异常。
-
NotLoggedInError–在未登录状态下调用了需要登录的方法。
-
OperationError–服务端接受请求但业务处理失败。
-
ParsingError–响应解析或数据校验失败。
-
ECardAccountModel–一卡通账户 API 响应根模型
-
ECardClient–一卡通客户端
Functions:
-
build_http_event_hooks–创建带脱敏能力的 HTTP 请求/响应日志钩子。
-
log_http_headers–输出脱敏后的 HTTP 头日志。
-
log_http_response_body–输出脱敏后的 HTTP 响应体日志。
-
sm4_decrypt_ecb–SM4 解密,ECB模式
-
require_auth–装饰器:确保调用方法前已登录
Attributes:
-
logger–
ICASClient
¤
Bases: ABC
flowchart TD
zzupy.aio.app.ecard.ICASClient[ICASClient]
click zzupy.aio.app.ecard.ICASClient href "" "zzupy.aio.app.ecard.ICASClient"
Source code in zzupy/aio/app/interfaces.py
7 8 9 | |
InvalidArgumentError
¤
InvalidArgumentError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: ZZUError, ValueError
flowchart TD
zzupy.aio.app.ecard.InvalidArgumentError[InvalidArgumentError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.ZZUError --> zzupy.aio.app.ecard.InvalidArgumentError
click zzupy.aio.app.ecard.InvalidArgumentError href "" "zzupy.aio.app.ecard.InvalidArgumentError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
调用参数不合法。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
NetworkError
¤
NetworkError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: ZZUError
flowchart TD
zzupy.aio.app.ecard.NetworkError[NetworkError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.ZZUError --> zzupy.aio.app.ecard.NetworkError
click zzupy.aio.app.ecard.NetworkError href "" "zzupy.aio.app.ecard.NetworkError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
网络请求失败或网络环境异常。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
NotLoggedInError
¤
NotLoggedInError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: ClientStateError
flowchart TD
zzupy.aio.app.ecard.NotLoggedInError[NotLoggedInError]
zzupy.exception.ClientStateError[ClientStateError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.ClientStateError --> zzupy.aio.app.ecard.NotLoggedInError
zzupy.exception.ZZUError --> zzupy.exception.ClientStateError
click zzupy.aio.app.ecard.NotLoggedInError href "" "zzupy.aio.app.ecard.NotLoggedInError"
click zzupy.exception.ClientStateError href "" "zzupy.exception.ClientStateError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
在未登录状态下调用了需要登录的方法。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
OperationError
¤
OperationError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: ZZUError
flowchart TD
zzupy.aio.app.ecard.OperationError[OperationError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.ZZUError --> zzupy.aio.app.ecard.OperationError
click zzupy.aio.app.ecard.OperationError href "" "zzupy.aio.app.ecard.OperationError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
服务端接受请求但业务处理失败。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
ParsingError
¤
ParsingError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: ZZUError
flowchart TD
zzupy.aio.app.ecard.ParsingError[ParsingError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.ZZUError --> zzupy.aio.app.ecard.ParsingError
click zzupy.aio.app.ecard.ParsingError href "" "zzupy.aio.app.ecard.ParsingError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
响应解析或数据校验失败。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
ECardAccountModel
¤
Bases: BaseModel
flowchart TD
zzupy.aio.app.ecard.ECardAccountModel[ECardAccountModel]
click zzupy.aio.app.ecard.ECardAccountModel href "" "zzupy.aio.app.ecard.ECardAccountModel"
一卡通账户 API 响应根模型
ECardClient
¤
ECardClient(cas_client: ICASClient)
一卡通客户端
Parameters:
-
(cas_client¤ICASClient) –已登录的 CASClient 实例
Methods:
-
login–登录到校园卡系统
-
get_default_room–获取账户默认房间
-
recharge_energy–为 room 充值电费
-
get_balance–获取校园卡余额
-
get_room_dict–获取房间的字典
-
get_remaining_energy–获取剩余电量
-
logout–登出账户,清除 Cookie 但保留连接池
-
close–清除 Cookie 和连接池
Source code in zzupy/aio/app/ecard.py
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 | |
login
async
¤
login() -> None
登录到校园卡系统
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/ecard.py
146 147 148 149 150 151 152 153 154 155 156 157 158 | |
get_default_room
async
¤
get_default_room() -> str
获取账户默认房间
Returns:
-
str–默认的房间
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/ecard.py
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 | |
recharge_energy
async
¤
为 room 充值电费
Parameters:
-
(payment_password¤str) –支付密码
-
(amt¤int) –充值金额
-
(room¤str) –房间 ID 。格式应为 'areaid-buildingid--unitid-roomid',可通过
get_room_dict()获取
Raises:
-
InvalidArgumentError–如果金额或房间参数不合法。
-
OperationError–如果充值失败。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/ecard.py
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 | |
get_balance
async
¤
get_balance() -> float
获取校园卡余额
Returns:
-
float–校园卡余额
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/ecard.py
464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 | |
get_room_dict
async
¤
获取房间的字典
Parameters:
Returns:
-
dict–对应的字典
Raises:
-
InvalidArgumentError–如果参数格式不正确。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/ecard.py
530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 | |
get_remaining_energy
async
¤
获取剩余电量
Parameters:
-
(room¤str | None, default:None) –房间 ID 。格式应为 'areaid-buildingid--unitid-roomid',可通过
get_room_dict()获取
Returns:
-
float–剩余电量
Raises:
-
InvalidArgumentError–如果房间参数不合法。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/aio/app/ecard.py
645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 | |
logout
¤
logout() -> None
登出账户,清除 Cookie 但保留连接池
Source code in zzupy/aio/app/ecard.py
742 743 744 745 746 747 748 749 750 751 752 753 | |
close
async
¤
close() -> None
清除 Cookie 和连接池
Source code in zzupy/aio/app/ecard.py
755 756 757 758 759 760 761 762 | |
build_http_event_hooks
¤
创建带脱敏能力的 HTTP 请求/响应日志钩子。
Source code in zzupy/logging.py
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 | |
log_http_headers
¤
输出脱敏后的 HTTP 头日志。
Source code in zzupy/logging.py
146 147 148 149 150 151 152 153 | |
log_http_response_body
¤
log_http_response_body(url: str | URL, text: str, *, content_type: str | None = None, level: str = 'TRACE') -> None
输出脱敏后的 HTTP 响应体日志。
Source code in zzupy/logging.py
156 157 158 159 160 161 162 163 164 165 166 167 168 169 | |
sm4_decrypt_ecb
¤
sm4_decrypt_ecb(ciphertext: bytes, key: bytes) -> str
SM4 解密,ECB模式
Parameters:
Returns:
-
str–明文 Hex
Source code in zzupy/utils.py
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 | |
require_auth
¤
require_auth(func)
装饰器:确保调用方法前已登录
Raises:
-
NotLoggedInError–如果未登录
Source code in zzupy/utils.py
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 | |
zzupy.aio.app.interfaces¤
interfaces
¤
抽象接口
Classes:
zzupy.aio.web¤
web
¤
Web API 客户端模块
Modules:
-
network–校园网模块
Classes:
-
EPortalClient–Portal 认证客户端 / 校园网认证客户端
-
SelfServiceSystem–自助服务系统
Functions:
-
discover_portal_info–自动发现校园网Portal认证信息
Attributes:
-
__all__–
EPortalClient
¤
EPortalClient(base_url: str, bind_address: str | None = None, force_bind: bool = False)
Portal 认证客户端 / 校园网认证客户端
Parameters:
-
(base_url¤str) –Portal 服务器的 Base URL
-
(bind_address¤str | None, default:None) –绑定的本地 IP
-
(force_bind¤bool, default:False) –即便 IP 绑定失败也在请求参数中使用该 IP。
如果你在路由器后使用本方法,则需要把
bind_address填写为路由器分配的内网 IP 并启用force_bind
Methods:
-
portal_auth–auth()的底层实现,允许完全自定义账户 -
auth–进行 Portal 认证
Source code in zzupy/aio/web/network.py
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 | |
portal_auth
async
¤
auth() 的底层实现,允许完全自定义账户
Parameters:
Returns:
-
AuthResult(AuthResult) –认证结果
Raises:
-
ParsingError–如果无法解析 API 响应。
-
NetworkError–如果发生网络错误。
Source code in zzupy/aio/web/network.py
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 | |
auth
async
¤
auth(account: str, password: str, isp_suffix: str | None = None, encrypt: bool = False) -> AuthResult
进行 Portal 认证
Parameters:
-
(account¤str) –账户
-
(password¤str) –密码
-
(isp_suffix¤str | None, default:None) –运营商后缀
-
(encrypt¤bool, default:False) –是否启用加密
Returns:
-
AuthResult(AuthResult) –认证结果
Source code in zzupy/aio/web/network.py
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 | |
SelfServiceSystem
¤
SelfServiceSystem(base_url: str)
自助服务系统
Methods:
-
login–登录
-
get_online_devices–获取当前在线设备
-
kick_device–将设备踢下线
-
logout–登出
Source code in zzupy/aio/web/network.py
293 294 295 | |
login
async
¤
登录
Parameters:
Raises:
-
LoginError–如果登录失败。
-
ParsingError–如果无法解析登录页面。
-
NetworkError–如果发生网络错误。
Source code in zzupy/aio/web/network.py
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 | |
get_online_devices
async
¤
get_online_devices() -> List[OnlineDevice]
获取当前在线设备
Returns:
-
List[OnlineDevice]–List[OnlineDevice]: 在线设备列表
Raises:
-
NotLoggedInError–如果未登录。
-
ParsingError–如果无法解析 API 返回数据。
-
NetworkError–如果发生网络错误。
Source code in zzupy/aio/web/network.py
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 | |
kick_device
async
¤
kick_device(session_id: str)
将设备踢下线
Parameters:
Raises:
-
NotLoggedInError–如果未登录
Source code in zzupy/aio/web/network.py
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 | |
logout
async
¤
logout()
登出
Raises:
-
NotLoggedInError–如果未登录
Source code in zzupy/aio/web/network.py
435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 | |
discover_portal_info
async
¤
discover_portal_info() -> PortalInfo
自动发现校园网Portal认证信息
Returns:
-
PortalInfo(PortalInfo) –Portal信息
Raises:
-
NetworkError–如果网络错误,或当前环境无法检测到 Portal 信息
-
ParsingError–如果响应格式异常
Source code in zzupy/aio/web/network.py
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 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 | |
network
¤
校园网模块
Classes:
-
EPortalClient–Portal 认证客户端 / 校园网认证客户端
-
SelfServiceSystem–自助服务系统
Functions:
-
discover_portal_info–自动发现校园网Portal认证信息
EPortalClient
¤
EPortalClient(base_url: str, bind_address: str | None = None, force_bind: bool = False)
Portal 认证客户端 / 校园网认证客户端
Parameters:
-
(base_url¤str) –Portal 服务器的 Base URL
-
(bind_address¤str | None, default:None) –绑定的本地 IP
-
(force_bind¤bool, default:False) –即便 IP 绑定失败也在请求参数中使用该 IP。
如果你在路由器后使用本方法,则需要把
bind_address填写为路由器分配的内网 IP 并启用force_bind
Methods:
-
portal_auth–auth()的底层实现,允许完全自定义账户 -
auth–进行 Portal 认证
Source code in zzupy/aio/web/network.py
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 | |
portal_auth
async
¤
auth() 的底层实现,允许完全自定义账户
Parameters:
Returns:
-
AuthResult(AuthResult) –认证结果
Raises:
-
ParsingError–如果无法解析 API 响应。
-
NetworkError–如果发生网络错误。
Source code in zzupy/aio/web/network.py
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 | |
auth
async
¤
auth(account: str, password: str, isp_suffix: str | None = None, encrypt: bool = False) -> AuthResult
进行 Portal 认证
Parameters:
-
(account¤str) –账户
-
(password¤str) –密码
-
(isp_suffix¤str | None, default:None) –运营商后缀
-
(encrypt¤bool, default:False) –是否启用加密
Returns:
-
AuthResult(AuthResult) –认证结果
Source code in zzupy/aio/web/network.py
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 | |
SelfServiceSystem
¤
SelfServiceSystem(base_url: str)
自助服务系统
Methods:
-
login–登录
-
get_online_devices–获取当前在线设备
-
kick_device–将设备踢下线
-
logout–登出
Source code in zzupy/aio/web/network.py
293 294 295 | |
login
async
¤
登录
Parameters:
Raises:
-
LoginError–如果登录失败。
-
ParsingError–如果无法解析登录页面。
-
NetworkError–如果发生网络错误。
Source code in zzupy/aio/web/network.py
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 | |
get_online_devices
async
¤
get_online_devices() -> List[OnlineDevice]
获取当前在线设备
Returns:
-
List[OnlineDevice]–List[OnlineDevice]: 在线设备列表
Raises:
-
NotLoggedInError–如果未登录。
-
ParsingError–如果无法解析 API 返回数据。
-
NetworkError–如果发生网络错误。
Source code in zzupy/aio/web/network.py
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 | |
kick_device
async
¤
kick_device(session_id: str)
将设备踢下线
Parameters:
Raises:
-
NotLoggedInError–如果未登录
Source code in zzupy/aio/web/network.py
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 | |
logout
async
¤
logout()
登出
Raises:
-
NotLoggedInError–如果未登录
Source code in zzupy/aio/web/network.py
435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 | |
discover_portal_info
async
¤
discover_portal_info() -> PortalInfo
自动发现校园网Portal认证信息
Returns:
-
PortalInfo(PortalInfo) –Portal信息
Raises:
-
NetworkError–如果网络错误,或当前环境无法检测到 Portal 信息
-
ParsingError–如果响应格式异常
Source code in zzupy/aio/web/network.py
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 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 | |
zzupy.aio.web.network¤
network
¤
校园网模块
Classes:
-
LoginError–登录失败。
-
NetworkError–网络请求失败或网络环境异常。
-
OperationError–服务端接受请求但业务处理失败。
-
ParsingError–响应解析或数据校验失败。
-
ZZUError–项目异常基类。
-
AuthResult–Portal 认证结果
-
OnlineDevice–在线设备信息
-
PortalInfo–探测出的 Portal 认证信息
-
JsonPParser–JsonP 格式数据解析器
-
XorCipher–一个使用异或 (XOR) 算法进行简单加密和解密的类。
-
EPortalClient–Portal 认证客户端 / 校园网认证客户端
-
SelfServiceSystem–自助服务系统
Functions:
-
extract_first_html_attr–提取第一个匹配 HTML 标签的属性值。
-
get_local_ip–获取用于连接到特定目标IP的本地IP地址。
-
require_auth–装饰器:确保调用方法前已登录
-
discover_portal_info–自动发现校园网Portal认证信息
Attributes:
-
logger–
LoginError
¤
LoginError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: ZZUError
flowchart TD
zzupy.aio.web.network.LoginError[LoginError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.ZZUError --> zzupy.aio.web.network.LoginError
click zzupy.aio.web.network.LoginError href "" "zzupy.aio.web.network.LoginError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
登录失败。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
NetworkError
¤
NetworkError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: ZZUError
flowchart TD
zzupy.aio.web.network.NetworkError[NetworkError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.ZZUError --> zzupy.aio.web.network.NetworkError
click zzupy.aio.web.network.NetworkError href "" "zzupy.aio.web.network.NetworkError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
网络请求失败或网络环境异常。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
OperationError
¤
OperationError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: ZZUError
flowchart TD
zzupy.aio.web.network.OperationError[OperationError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.ZZUError --> zzupy.aio.web.network.OperationError
click zzupy.aio.web.network.OperationError href "" "zzupy.aio.web.network.OperationError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
服务端接受请求但业务处理失败。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
ParsingError
¤
ParsingError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: ZZUError
flowchart TD
zzupy.aio.web.network.ParsingError[ParsingError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.ZZUError --> zzupy.aio.web.network.ParsingError
click zzupy.aio.web.network.ParsingError href "" "zzupy.aio.web.network.ParsingError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
响应解析或数据校验失败。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
ZZUError
¤
ZZUError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: Exception
flowchart TD
zzupy.aio.web.network.ZZUError[ZZUError]
click zzupy.aio.web.network.ZZUError href "" "zzupy.aio.web.network.ZZUError"
项目异常基类。
除了人类可读的错误消息外,还会保留额外上下文,便于调用方记录日志、 序列化或调试。
Parameters:
-
(message¤str | None, default:None) –错误消息。
-
(context¤Mapping[str, Any] | None, default:None) –结构化上下文信息。
-
(error_code¤str | None, default:None) –可选错误代码。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
AuthResult
¤
Bases: BaseModel
flowchart TD
zzupy.aio.web.network.AuthResult[AuthResult]
click zzupy.aio.web.network.AuthResult href "" "zzupy.aio.web.network.AuthResult"
Portal 认证结果
Attributes:
OnlineDevice
¤
Bases: BaseModel
flowchart TD
zzupy.aio.web.network.OnlineDevice[OnlineDevice]
click zzupy.aio.web.network.OnlineDevice href "" "zzupy.aio.web.network.OnlineDevice"
在线设备信息
Methods:
-
dump_json–格式化为JSON字符串
Attributes:
-
brasid(str) –BRAS ID
-
down_flow(str) –下行流量
-
host_name(str) –主机名
-
ip(str) –IP地址
-
login_time(str) –登录时间,格式为YYYY-MM-DD HH:MM:SS
-
mac(str) –MAC地址
-
session_id(str) –会话ID
-
terminal_type(str) –终端类型
-
up_flow(str) –上行流量
-
use_time(str) –使用时间(秒)
-
user_id(int) –用户ID
PortalInfo
¤
Bases: BaseModel
flowchart TD
zzupy.aio.web.network.PortalInfo[PortalInfo]
click zzupy.aio.web.network.PortalInfo href "" "zzupy.aio.web.network.PortalInfo"
探测出的 Portal 认证信息
Attributes:
JsonPParser
¤
JsonPParser(text: str)
JsonP 格式数据解析器
Source code in zzupy/utils.py
283 284 285 286 287 | |
XorCipher
¤
XorCipher(key_string: str = '')
一个使用异或 (XOR) 算法进行简单加密和解密的类。
Methods:
Source code in zzupy/utils.py
223 224 | |
encrypt
¤
将明文与实例密钥进行异或运算,并转为十六进制字符串。
Parameters:
Source code in zzupy/utils.py
238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 | |
decrypt
¤
decrypt(hex_string: str) -> str
将十六进制字符串解密回原始密码。
Parameters:
Raises:
-
ValueError–如果十六进制字符串格式错误
Source code in zzupy/utils.py
255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 | |
EPortalClient
¤
EPortalClient(base_url: str, bind_address: str | None = None, force_bind: bool = False)
Portal 认证客户端 / 校园网认证客户端
Parameters:
-
(base_url¤str) –Portal 服务器的 Base URL
-
(bind_address¤str | None, default:None) –绑定的本地 IP
-
(force_bind¤bool, default:False) –即便 IP 绑定失败也在请求参数中使用该 IP。
如果你在路由器后使用本方法,则需要把
bind_address填写为路由器分配的内网 IP 并启用force_bind
Methods:
-
portal_auth–auth()的底层实现,允许完全自定义账户 -
auth–进行 Portal 认证
Source code in zzupy/aio/web/network.py
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 | |
portal_auth
async
¤
auth() 的底层实现,允许完全自定义账户
Parameters:
Returns:
-
AuthResult(AuthResult) –认证结果
Raises:
-
ParsingError–如果无法解析 API 响应。
-
NetworkError–如果发生网络错误。
Source code in zzupy/aio/web/network.py
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 | |
auth
async
¤
auth(account: str, password: str, isp_suffix: str | None = None, encrypt: bool = False) -> AuthResult
进行 Portal 认证
Parameters:
-
(account¤str) –账户
-
(password¤str) –密码
-
(isp_suffix¤str | None, default:None) –运营商后缀
-
(encrypt¤bool, default:False) –是否启用加密
Returns:
-
AuthResult(AuthResult) –认证结果
Source code in zzupy/aio/web/network.py
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 | |
SelfServiceSystem
¤
SelfServiceSystem(base_url: str)
自助服务系统
Methods:
-
login–登录
-
get_online_devices–获取当前在线设备
-
kick_device–将设备踢下线
-
logout–登出
Source code in zzupy/aio/web/network.py
293 294 295 | |
login
async
¤
登录
Parameters:
Raises:
-
LoginError–如果登录失败。
-
ParsingError–如果无法解析登录页面。
-
NetworkError–如果发生网络错误。
Source code in zzupy/aio/web/network.py
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 | |
get_online_devices
async
¤
get_online_devices() -> List[OnlineDevice]
获取当前在线设备
Returns:
-
List[OnlineDevice]–List[OnlineDevice]: 在线设备列表
Raises:
-
NotLoggedInError–如果未登录。
-
ParsingError–如果无法解析 API 返回数据。
-
NetworkError–如果发生网络错误。
Source code in zzupy/aio/web/network.py
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 | |
kick_device
async
¤
kick_device(session_id: str)
将设备踢下线
Parameters:
Raises:
-
NotLoggedInError–如果未登录
Source code in zzupy/aio/web/network.py
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 | |
logout
async
¤
logout()
登出
Raises:
-
NotLoggedInError–如果未登录
Source code in zzupy/aio/web/network.py
435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 | |
extract_first_html_attr
¤
extract_first_html_attr(html_content: str, tag: str, attr: str, match_attrs: dict[str, str] | None = None) -> str | None
提取第一个匹配 HTML 标签的属性值。
Source code in zzupy/utils.py
111 112 113 114 115 116 117 118 119 120 121 | |
get_local_ip
¤
获取用于连接到特定目标IP的本地IP地址。
Parameters:
Returns:
Source code in zzupy/utils.py
200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 | |
require_auth
¤
require_auth(func)
装饰器:确保调用方法前已登录
Raises:
-
NotLoggedInError–如果未登录
Source code in zzupy/utils.py
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 | |
discover_portal_info
async
¤
discover_portal_info() -> PortalInfo
自动发现校园网Portal认证信息
Returns:
-
PortalInfo(PortalInfo) –Portal信息
Raises:
-
NetworkError–如果网络错误,或当前环境无法检测到 Portal 信息
-
ParsingError–如果响应格式异常
Source code in zzupy/aio/web/network.py
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 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 | |
zzupy.app¤
app
¤
移动应用 API 抽象层
Modules:
-
auth–统一认证
-
eas– -
ecard–一卡通
-
interfaces–抽象接口
Classes:
-
CASClient–统一认证系统 (CAS) App 客户端。
-
ECardClient–一卡通客户端
-
UndergradEASClient–
Attributes:
-
__all__–
CASClient
¤
Bases: ICASClient
flowchart TD
zzupy.app.CASClient[CASClient]
zzupy.app.interfaces.ICASClient[ICASClient]
zzupy.app.interfaces.ICASClient --> zzupy.app.CASClient
click zzupy.app.CASClient href "" "zzupy.app.CASClient"
click zzupy.app.interfaces.ICASClient href "" "zzupy.app.interfaces.ICASClient"
统一认证系统 (CAS) App 客户端。
Parameters:
Classes:
-
MFAClient–统一认证 MFA 辅助客户端。
Methods:
-
set_token–设置统一认证 Token。
-
set_device–设置认证请求使用的设备标识。
-
login–登录统一认证。
-
get_user_info–获取当前用户的聚合个人信息。
-
logout–登出账户,清除 Cookie 但保留连接池
-
close–清除 Cookie 和连接池
Attributes:
-
user_token(str | None) –当前会话的
userToken,约一个月有效期 -
refresh_token(str | None) –当前会话的
refreshToken,约两个月有效期 -
logged_in(bool) –当前会话是否已登录
Source code in zzupy/app/auth.py
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 | |
MFAClient
¤
统一认证 MFA 辅助客户端。
本客户端由 CASClient 自动创建,通常通过
[CASClient.mfa][zzupy.app.auth.CASClient.mfa] 访问。它负责检测 MFA
状态、发送手机号验证码并校验验证码。
Parameters:
Methods:
-
reset–清除当前 MFA 流程状态。
-
is_required–检测当前环境是否需要 MFA 验证
-
request_sms_code–发送 MFA 短信验证码。
-
send_sms–request_sms_code()的别名。 -
verify_sms_code–校验 MFA 短信验证码。
-
verify_sms–verify_sms_code()的别名。
Source code in zzupy/app/auth.py
218 219 220 221 222 223 224 225 226 227 228 229 230 231 | |
reset
¤
reset() -> None
清除当前 MFA 流程状态。
Source code in zzupy/app/auth.py
233 234 235 236 237 238 239 240 | |
is_required
¤
is_required() -> bool
检测当前环境是否需要 MFA 验证
Returns:
-
bool–是否需要 MFA 验证
Raises:
-
OperationError–如果检测失败。
-
ParsingError–如果服务器响应无法解析。
-
NetworkError–如果出现网络错误。
Source code in zzupy/app/auth.py
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 | |
request_sms_code
¤
request_sms_code() -> None
发送 MFA 短信验证码。
如果尚未初始化手机号 MFA,会自动调用内部初始化流程。
Raises:
-
LoginError–如果当前登录不需要 MFA 验证。
-
OperationError–如果短信发送失败。
-
ParsingError–如果服务器响应无法解析。
-
NetworkError–如果出现网络错误。
Source code in zzupy/app/auth.py
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 | |
send_sms
¤
send_sms() -> None
request_sms_code() 的别名。
Source code in zzupy/app/auth.py
481 482 483 | |
verify_sms_code
¤
校验 MFA 短信验证码。
调用前必须先发送 MFA 短信验证码。
校验成功后,CASClient.login()
会使用当前 MFA state 完成登录。
Parameters:
Returns:
-
str–可用于登录的 MFA state。
Raises:
-
MFAError–如果尚未发送 MFA 短信验证码。
-
LoginError–如果验证码校验失败。
-
OperationError–如果服务器返回失败状态。
-
ParsingError–如果服务器响应无法解析。
-
NetworkError–如果出现网络错误。
Source code in zzupy/app/auth.py
485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 | |
verify_sms
¤
verify_sms_code() 的别名。
Source code in zzupy/app/auth.py
568 569 570 | |
set_token
¤
set_token(user_token: str, refresh_token: str) -> None
设置统一认证 Token。
Parameters:
-
(user_token¤str) –userToken。对豫见郑大 APP 抓包获取,或账密登录后访问user_token获取 -
(refresh_token¤str) –refreshToken。对豫见郑大 APP 抓包获取,或账密登录后访问refresh_token获取
Source code in zzupy/app/auth.py
74 75 76 77 78 79 80 81 82 | |
set_device
¤
login
¤
login(force_login: bool = False) -> None
登录统一认证。
成功后,userToken 和 refreshToken 会被存储在实例中.
若 user_token 和 refresh_token 已通过 set_token 设置且有效,则会跳过账密登录。
Parameters:
Raises:
-
MFAError–如果当前登录需要 MFA 但尚未完成验证。
-
LoginError–如果登录失败。
-
ParsingError–如果服务器响应无法解析。
-
NetworkError–如果出现网络错误。
Source code in zzupy/app/auth.py
572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 | |
get_user_info
¤
get_user_info() -> PersonalInfo
获取当前用户的聚合个人信息。
返回学号、姓名、身份类型、学院、邮箱未读数、一卡通余额和科研信息数量。
Returns:
-
PersonalInfo–当前用户的个人信息
Raises:
-
NotLoggedInError–如果当前认证状态缺少 userToken。
-
OperationError–如果服务端返回失败结果。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/app/auth.py
672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 | |
logout
¤
logout() -> None
登出账户,清除 Cookie 但保留连接池
Source code in zzupy/app/auth.py
798 799 800 801 802 803 804 805 806 807 808 809 | |
close
¤
close() -> None
清除 Cookie 和连接池
Source code in zzupy/app/auth.py
811 812 813 814 815 | |
ECardClient
¤
ECardClient(cas_client: ICASClient)
一卡通客户端
Parameters:
-
(cas_client¤ICASClient) –已登录的 CASClient 实例
Methods:
-
login–登录到校园卡系统
-
get_default_room–获取账户默认房间
-
recharge_energy–为 room 充值电费
-
get_balance–获取校园卡余额
-
get_room_dict–获取房间的字典
-
get_remaining_energy–获取剩余电量
-
logout–登出账户,清除 Cookie 但保留连接池
-
close–清除 Cookie 和连接池
Source code in zzupy/app/ecard.py
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 | |
login
¤
login() -> None
登录到校园卡系统
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/app/ecard.py
144 145 146 147 148 149 150 151 152 153 154 155 156 | |
get_default_room
¤
get_default_room() -> str
获取账户默认房间
Returns:
-
str–默认的房间
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/app/ecard.py
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 | |
recharge_energy
¤
为 room 充值电费
Parameters:
-
(payment_password¤str) –支付密码
-
(amt¤int) –充值金额
-
(room¤str) –房间 ID 。格式应为 'areaid-buildingid--unitid-roomid',可通过
get_room_dict()获取
Raises:
-
InvalidArgumentError–如果金额或房间参数不合法。
-
OperationError–如果充值失败。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/app/ecard.py
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 | |
get_balance
¤
get_balance() -> float
获取校园卡余额
Returns:
-
float–校园卡余额
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/app/ecard.py
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 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 | |
get_room_dict
¤
获取房间的字典
Parameters:
Returns:
-
dict–对应的字典
Raises:
-
InvalidArgumentError–如果参数格式不正确。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/app/ecard.py
520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 | |
get_remaining_energy
¤
获取剩余电量
Parameters:
-
(room¤str | None, default:None) –房间 ID 。格式应为 'areaid-buildingid--unitid-roomid',可通过
get_room_dict()获取
Returns:
-
float–剩余电量
Raises:
-
InvalidArgumentError–如果房间参数不合法。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/app/ecard.py
635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 | |
logout
¤
logout() -> None
登出账户,清除 Cookie 但保留连接池
Source code in zzupy/app/ecard.py
732 733 734 735 736 737 738 739 740 741 742 743 744 745 | |
close
¤
close() -> None
清除 Cookie 和连接池
Source code in zzupy/app/ecard.py
747 748 749 750 751 752 753 754 755 756 | |
UndergradEASClient
¤
UndergradEASClient(cas_client: ICASClient)
Methods:
-
login–登录到新本科教务系统
-
get_teaching_week–获取 {semester_id} 号学期的第 {week_index} 教学周
-
get_teaching_weeks–获取 {semester_id} 号学期的全部教学周
-
get_week_index–获取指定日期的教学周序数
-
get_semesters–获取所有学期数据
-
logout–登出账户,清除 Cookie 但保留连接池
-
close–清除 Cookie 和连接池
Source code in zzupy/app/eas/undergrad.py
51 52 53 54 55 56 57 58 59 60 61 | |
login
¤
login() -> None
登录到新本科教务系统
Raises:
-
OperationError–如果登录失败。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/app/eas/undergrad.py
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 | |
get_teaching_week
¤
get_teaching_week(week: int, semester_id: int | None = None) -> TeachingWeek
获取 {semester_id} 号学期的第 {week_index} 教学周 Args: week: 教学周序数 semester_id: 学期 ID。不填写则为本学期。
Returns:
-
TeachingWeek(TeachingWeek) –教学周
Raises:
-
ParsingError–如果响应解析失败
-
NetworkError–如果网络请求失败
-
InvalidArgumentError–如果教学周序数不正确。
-
OperationError–如果服务器发生异常。
Source code in zzupy/app/eas/undergrad.py
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 | |
get_teaching_weeks
¤
get_teaching_weeks(semester_id: int | None = None) -> TeachingWeeks
获取 {semester_id} 号学期的全部教学周 Args: semester_id: 学期 ID。不填写则为本学期。
Returns:
-
TeachingWeeks(TeachingWeeks) –由一个学期的全部教学周组成的列表模型。
Raises:
-
ParsingError–如果响应解析失败
-
NetworkError–如果网络请求失败
-
DataNotFoundError–如果学期不存在。
-
OperationError–如果服务器发生异常。
Source code in zzupy/app/eas/undergrad.py
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 | |
get_week_index
¤
get_week_index(date: Date) -> int | None
获取指定日期的教学周序数
Returns:
-
int | None–int | None: 教学周序数
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
-
OperationError–如果服务器发生异常。
Source code in zzupy/app/eas/undergrad.py
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 | |
get_semesters
¤
获取所有学期数据
Returns:
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
-
OperationError–如果服务器发生异常。
Source code in zzupy/app/eas/undergrad.py
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 | |
logout
¤
logout() -> None
登出账户,清除 Cookie 但保留连接池
Source code in zzupy/app/eas/undergrad.py
454 455 456 457 458 459 460 461 | |
close
¤
close() -> None
清除 Cookie 和连接池
Source code in zzupy/app/eas/undergrad.py
463 464 465 466 467 468 | |
auth
¤
统一认证
Classes:
-
CASClient–统一认证系统 (CAS) App 客户端。
CASClient
¤
Bases: ICASClient
flowchart TD
zzupy.app.auth.CASClient[CASClient]
zzupy.app.interfaces.ICASClient[ICASClient]
zzupy.app.interfaces.ICASClient --> zzupy.app.auth.CASClient
click zzupy.app.auth.CASClient href "" "zzupy.app.auth.CASClient"
click zzupy.app.interfaces.ICASClient href "" "zzupy.app.interfaces.ICASClient"
统一认证系统 (CAS) App 客户端。
Parameters:
Classes:
-
MFAClient–统一认证 MFA 辅助客户端。
Methods:
-
set_token–设置统一认证 Token。
-
set_device–设置认证请求使用的设备标识。
-
login–登录统一认证。
-
get_user_info–获取当前用户的聚合个人信息。
-
logout–登出账户,清除 Cookie 但保留连接池
-
close–清除 Cookie 和连接池
Attributes:
-
user_token(str | None) –当前会话的
userToken,约一个月有效期 -
refresh_token(str | None) –当前会话的
refreshToken,约两个月有效期 -
logged_in(bool) –当前会话是否已登录
Source code in zzupy/app/auth.py
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 | |
MFAClient
¤
统一认证 MFA 辅助客户端。
本客户端由 CASClient 自动创建,通常通过
[CASClient.mfa][zzupy.app.auth.CASClient.mfa] 访问。它负责检测 MFA
状态、发送手机号验证码并校验验证码。
Parameters:
Methods:
-
reset–清除当前 MFA 流程状态。
-
is_required–检测当前环境是否需要 MFA 验证
-
request_sms_code–发送 MFA 短信验证码。
-
send_sms–request_sms_code()的别名。 -
verify_sms_code–校验 MFA 短信验证码。
-
verify_sms–verify_sms_code()的别名。
Source code in zzupy/app/auth.py
218 219 220 221 222 223 224 225 226 227 228 229 230 231 | |
reset
¤
reset() -> None
清除当前 MFA 流程状态。
Source code in zzupy/app/auth.py
233 234 235 236 237 238 239 240 | |
is_required
¤
is_required() -> bool
检测当前环境是否需要 MFA 验证
Returns:
-
bool–是否需要 MFA 验证
Raises:
-
OperationError–如果检测失败。
-
ParsingError–如果服务器响应无法解析。
-
NetworkError–如果出现网络错误。
Source code in zzupy/app/auth.py
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 | |
request_sms_code
¤
request_sms_code() -> None
发送 MFA 短信验证码。
如果尚未初始化手机号 MFA,会自动调用内部初始化流程。
Raises:
-
LoginError–如果当前登录不需要 MFA 验证。
-
OperationError–如果短信发送失败。
-
ParsingError–如果服务器响应无法解析。
-
NetworkError–如果出现网络错误。
Source code in zzupy/app/auth.py
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 | |
send_sms
¤
send_sms() -> None
request_sms_code() 的别名。
Source code in zzupy/app/auth.py
481 482 483 | |
verify_sms_code
¤
校验 MFA 短信验证码。
调用前必须先发送 MFA 短信验证码。
校验成功后,CASClient.login()
会使用当前 MFA state 完成登录。
Parameters:
Returns:
-
str–可用于登录的 MFA state。
Raises:
-
MFAError–如果尚未发送 MFA 短信验证码。
-
LoginError–如果验证码校验失败。
-
OperationError–如果服务器返回失败状态。
-
ParsingError–如果服务器响应无法解析。
-
NetworkError–如果出现网络错误。
Source code in zzupy/app/auth.py
485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 | |
verify_sms
¤
verify_sms_code() 的别名。
Source code in zzupy/app/auth.py
568 569 570 | |
set_token
¤
set_token(user_token: str, refresh_token: str) -> None
设置统一认证 Token。
Parameters:
-
(user_token¤str) –userToken。对豫见郑大 APP 抓包获取,或账密登录后访问user_token获取 -
(refresh_token¤str) –refreshToken。对豫见郑大 APP 抓包获取,或账密登录后访问refresh_token获取
Source code in zzupy/app/auth.py
74 75 76 77 78 79 80 81 82 | |
set_device
¤
login
¤
login(force_login: bool = False) -> None
登录统一认证。
成功后,userToken 和 refreshToken 会被存储在实例中.
若 user_token 和 refresh_token 已通过 set_token 设置且有效,则会跳过账密登录。
Parameters:
Raises:
-
MFAError–如果当前登录需要 MFA 但尚未完成验证。
-
LoginError–如果登录失败。
-
ParsingError–如果服务器响应无法解析。
-
NetworkError–如果出现网络错误。
Source code in zzupy/app/auth.py
572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 | |
get_user_info
¤
get_user_info() -> PersonalInfo
获取当前用户的聚合个人信息。
返回学号、姓名、身份类型、学院、邮箱未读数、一卡通余额和科研信息数量。
Returns:
-
PersonalInfo–当前用户的个人信息
Raises:
-
NotLoggedInError–如果当前认证状态缺少 userToken。
-
OperationError–如果服务端返回失败结果。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/app/auth.py
672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 | |
logout
¤
logout() -> None
登出账户,清除 Cookie 但保留连接池
Source code in zzupy/app/auth.py
798 799 800 801 802 803 804 805 806 807 808 809 | |
close
¤
close() -> None
清除 Cookie 和连接池
Source code in zzupy/app/auth.py
811 812 813 814 815 | |
eas
¤
Modules:
-
undergrad–140w 教务
Classes:
UndergradEASClient
¤
UndergradEASClient(cas_client: ICASClient)
Methods:
-
login–登录到新本科教务系统
-
get_teaching_week–获取 {semester_id} 号学期的第 {week_index} 教学周
-
get_teaching_weeks–获取 {semester_id} 号学期的全部教学周
-
get_week_index–获取指定日期的教学周序数
-
get_semesters–获取所有学期数据
-
logout–登出账户,清除 Cookie 但保留连接池
-
close–清除 Cookie 和连接池
Source code in zzupy/app/eas/undergrad.py
51 52 53 54 55 56 57 58 59 60 61 | |
login
¤
login() -> None
登录到新本科教务系统
Raises:
-
OperationError–如果登录失败。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/app/eas/undergrad.py
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 | |
get_teaching_week
¤
get_teaching_week(week: int, semester_id: int | None = None) -> TeachingWeek
获取 {semester_id} 号学期的第 {week_index} 教学周 Args: week: 教学周序数 semester_id: 学期 ID。不填写则为本学期。
Returns:
-
TeachingWeek(TeachingWeek) –教学周
Raises:
-
ParsingError–如果响应解析失败
-
NetworkError–如果网络请求失败
-
InvalidArgumentError–如果教学周序数不正确。
-
OperationError–如果服务器发生异常。
Source code in zzupy/app/eas/undergrad.py
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 | |
get_teaching_weeks
¤
get_teaching_weeks(semester_id: int | None = None) -> TeachingWeeks
获取 {semester_id} 号学期的全部教学周 Args: semester_id: 学期 ID。不填写则为本学期。
Returns:
-
TeachingWeeks(TeachingWeeks) –由一个学期的全部教学周组成的列表模型。
Raises:
-
ParsingError–如果响应解析失败
-
NetworkError–如果网络请求失败
-
DataNotFoundError–如果学期不存在。
-
OperationError–如果服务器发生异常。
Source code in zzupy/app/eas/undergrad.py
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 | |
get_week_index
¤
get_week_index(date: Date) -> int | None
获取指定日期的教学周序数
Returns:
-
int | None–int | None: 教学周序数
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
-
OperationError–如果服务器发生异常。
Source code in zzupy/app/eas/undergrad.py
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 | |
get_semesters
¤
获取所有学期数据
Returns:
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
-
OperationError–如果服务器发生异常。
Source code in zzupy/app/eas/undergrad.py
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 | |
logout
¤
logout() -> None
登出账户,清除 Cookie 但保留连接池
Source code in zzupy/app/eas/undergrad.py
454 455 456 457 458 459 460 461 | |
close
¤
close() -> None
清除 Cookie 和连接池
Source code in zzupy/app/eas/undergrad.py
463 464 465 466 467 468 | |
undergrad
¤
140w 教务
Classes:
UndergradEASClient
¤
UndergradEASClient(cas_client: ICASClient)
Methods:
-
login–登录到新本科教务系统
-
get_teaching_week–获取 {semester_id} 号学期的第 {week_index} 教学周
-
get_teaching_weeks–获取 {semester_id} 号学期的全部教学周
-
get_week_index–获取指定日期的教学周序数
-
get_semesters–获取所有学期数据
-
logout–登出账户,清除 Cookie 但保留连接池
-
close–清除 Cookie 和连接池
Source code in zzupy/app/eas/undergrad.py
51 52 53 54 55 56 57 58 59 60 61 | |
login
¤
login() -> None
登录到新本科教务系统
Raises:
-
OperationError–如果登录失败。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/app/eas/undergrad.py
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 | |
get_teaching_week
¤
get_teaching_week(week: int, semester_id: int | None = None) -> TeachingWeek
获取 {semester_id} 号学期的第 {week_index} 教学周 Args: week: 教学周序数 semester_id: 学期 ID。不填写则为本学期。
Returns:
-
TeachingWeek(TeachingWeek) –教学周
Raises:
-
ParsingError–如果响应解析失败
-
NetworkError–如果网络请求失败
-
InvalidArgumentError–如果教学周序数不正确。
-
OperationError–如果服务器发生异常。
Source code in zzupy/app/eas/undergrad.py
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 | |
get_teaching_weeks
¤
get_teaching_weeks(semester_id: int | None = None) -> TeachingWeeks
获取 {semester_id} 号学期的全部教学周 Args: semester_id: 学期 ID。不填写则为本学期。
Returns:
-
TeachingWeeks(TeachingWeeks) –由一个学期的全部教学周组成的列表模型。
Raises:
-
ParsingError–如果响应解析失败
-
NetworkError–如果网络请求失败
-
DataNotFoundError–如果学期不存在。
-
OperationError–如果服务器发生异常。
Source code in zzupy/app/eas/undergrad.py
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 | |
get_week_index
¤
get_week_index(date: Date) -> int | None
获取指定日期的教学周序数
Returns:
-
int | None–int | None: 教学周序数
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
-
OperationError–如果服务器发生异常。
Source code in zzupy/app/eas/undergrad.py
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 | |
get_semesters
¤
获取所有学期数据
Returns:
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
-
OperationError–如果服务器发生异常。
Source code in zzupy/app/eas/undergrad.py
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 | |
logout
¤
logout() -> None
登出账户,清除 Cookie 但保留连接池
Source code in zzupy/app/eas/undergrad.py
454 455 456 457 458 459 460 461 | |
close
¤
close() -> None
清除 Cookie 和连接池
Source code in zzupy/app/eas/undergrad.py
463 464 465 466 467 468 | |
ecard
¤
一卡通
Classes:
-
ECardClient–一卡通客户端
ECardClient
¤
ECardClient(cas_client: ICASClient)
一卡通客户端
Parameters:
-
(cas_client¤ICASClient) –已登录的 CASClient 实例
Methods:
-
login–登录到校园卡系统
-
get_default_room–获取账户默认房间
-
recharge_energy–为 room 充值电费
-
get_balance–获取校园卡余额
-
get_room_dict–获取房间的字典
-
get_remaining_energy–获取剩余电量
-
logout–登出账户,清除 Cookie 但保留连接池
-
close–清除 Cookie 和连接池
Source code in zzupy/app/ecard.py
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 | |
login
¤
login() -> None
登录到校园卡系统
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/app/ecard.py
144 145 146 147 148 149 150 151 152 153 154 155 156 | |
get_default_room
¤
get_default_room() -> str
获取账户默认房间
Returns:
-
str–默认的房间
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/app/ecard.py
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 | |
recharge_energy
¤
为 room 充值电费
Parameters:
-
(payment_password¤str) –支付密码
-
(amt¤int) –充值金额
-
(room¤str) –房间 ID 。格式应为 'areaid-buildingid--unitid-roomid',可通过
get_room_dict()获取
Raises:
-
InvalidArgumentError–如果金额或房间参数不合法。
-
OperationError–如果充值失败。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/app/ecard.py
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 | |
get_balance
¤
get_balance() -> float
获取校园卡余额
Returns:
-
float–校园卡余额
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/app/ecard.py
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 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 | |
get_room_dict
¤
获取房间的字典
Parameters:
Returns:
-
dict–对应的字典
Raises:
-
InvalidArgumentError–如果参数格式不正确。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/app/ecard.py
520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 | |
get_remaining_energy
¤
获取剩余电量
Parameters:
-
(room¤str | None, default:None) –房间 ID 。格式应为 'areaid-buildingid--unitid-roomid',可通过
get_room_dict()获取
Returns:
-
float–剩余电量
Raises:
-
InvalidArgumentError–如果房间参数不合法。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/app/ecard.py
635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 | |
logout
¤
logout() -> None
登出账户,清除 Cookie 但保留连接池
Source code in zzupy/app/ecard.py
732 733 734 735 736 737 738 739 740 741 742 743 744 745 | |
close
¤
close() -> None
清除 Cookie 和连接池
Source code in zzupy/app/ecard.py
747 748 749 750 751 752 753 754 755 756 | |
interfaces
¤
抽象接口
zzupy.app.auth¤
auth
¤
统一认证
Classes:
-
ICASClient– -
RSAPublicKey–轻量级 RSA 公钥实现
-
padding–填充方案命名空间(兼容 cryptography)
-
serialization–序列化命名空间(兼容 cryptography)
-
LoginError–登录失败。
-
ParsingError–响应解析或数据校验失败。
-
NetworkError–网络请求失败或网络环境异常。
-
NotLoggedInError–在未登录状态下调用了需要登录的方法。
-
OperationError–服务端接受请求但业务处理失败。
-
MFAError–MFA 状态错误,当前会话可能需要 MFA 验证
-
PersonalInfo–个人信息模型
-
PersonalInfoModel–个人信息 API 响应根模型
-
PersonalInfoCardModel–‘我的’页中个人信息卡片 API 响应根模型
-
CASClient–统一认证系统 (CAS) App 客户端。
Functions:
-
build_http_event_hooks–创建带脱敏能力的 HTTP 请求/响应日志钩子。
-
log_http_response_body–输出脱敏后的 HTTP 响应体日志。
-
get_jwt_expiration–读取 JWT 的过期时间。
-
require_auth–装饰器:确保调用方法前已登录
Attributes:
-
logger–
ICASClient
¤
Bases: ABC
flowchart TD
zzupy.app.auth.ICASClient[ICASClient]
click zzupy.app.auth.ICASClient href "" "zzupy.app.auth.ICASClient"
Source code in zzupy/app/interfaces.py
7 8 9 | |
RSAPublicKey
¤
轻量级 RSA 公钥实现
Parameters:
Methods:
-
encrypt–使用 PKCS#1 v1.5 填充进行 RSA 加密
-
verify_rs512–验证 RS512 (RSA-SHA512) 签名
Source code in zzupy/crypto.py
12 13 14 15 16 17 18 19 20 21 22 | |
encrypt
¤
encrypt(data: bytes, padding_scheme=None) -> bytes
使用 PKCS#1 v1.5 填充进行 RSA 加密
Parameters:
Returns:
-
bytes–加密后的字节数据
Source code in zzupy/crypto.py
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 | |
verify_rs512
¤
验证 RS512 (RSA-SHA512) 签名
Parameters:
Returns:
-
bool–签名是否有效
Source code in zzupy/crypto.py
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 | |
padding
¤
serialization
¤
序列化命名空间(兼容 cryptography)
Methods:
-
load_pem_public_key–加载 PEM 格式公钥(兼容 cryptography 接口)
load_pem_public_key
staticmethod
¤
load_pem_public_key(data: bytes) -> RSAPublicKey
加载 PEM 格式公钥(兼容 cryptography 接口)
Source code in zzupy/crypto.py
249 250 251 252 | |
LoginError
¤
LoginError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: ZZUError
flowchart TD
zzupy.app.auth.LoginError[LoginError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.ZZUError --> zzupy.app.auth.LoginError
click zzupy.app.auth.LoginError href "" "zzupy.app.auth.LoginError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
登录失败。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
ParsingError
¤
ParsingError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: ZZUError
flowchart TD
zzupy.app.auth.ParsingError[ParsingError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.ZZUError --> zzupy.app.auth.ParsingError
click zzupy.app.auth.ParsingError href "" "zzupy.app.auth.ParsingError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
响应解析或数据校验失败。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
NetworkError
¤
NetworkError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: ZZUError
flowchart TD
zzupy.app.auth.NetworkError[NetworkError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.ZZUError --> zzupy.app.auth.NetworkError
click zzupy.app.auth.NetworkError href "" "zzupy.app.auth.NetworkError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
网络请求失败或网络环境异常。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
NotLoggedInError
¤
NotLoggedInError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: ClientStateError
flowchart TD
zzupy.app.auth.NotLoggedInError[NotLoggedInError]
zzupy.exception.ClientStateError[ClientStateError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.ClientStateError --> zzupy.app.auth.NotLoggedInError
zzupy.exception.ZZUError --> zzupy.exception.ClientStateError
click zzupy.app.auth.NotLoggedInError href "" "zzupy.app.auth.NotLoggedInError"
click zzupy.exception.ClientStateError href "" "zzupy.exception.ClientStateError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
在未登录状态下调用了需要登录的方法。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
OperationError
¤
OperationError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: ZZUError
flowchart TD
zzupy.app.auth.OperationError[OperationError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.ZZUError --> zzupy.app.auth.OperationError
click zzupy.app.auth.OperationError href "" "zzupy.app.auth.OperationError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
服务端接受请求但业务处理失败。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
MFAError
¤
MFAError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: LoginError
flowchart TD
zzupy.app.auth.MFAError[MFAError]
zzupy.exception.LoginError[LoginError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.LoginError --> zzupy.app.auth.MFAError
zzupy.exception.ZZUError --> zzupy.exception.LoginError
click zzupy.app.auth.MFAError href "" "zzupy.app.auth.MFAError"
click zzupy.exception.LoginError href "" "zzupy.exception.LoginError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
MFA 状态错误,当前会话可能需要 MFA 验证
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
PersonalInfo
¤
Bases: BaseModel
flowchart TD
zzupy.app.auth.PersonalInfo[PersonalInfo]
click zzupy.app.auth.PersonalInfo href "" "zzupy.app.auth.PersonalInfo"
个人信息模型
Attributes:
-
uid(str) –学号
-
name(str) –用户姓名
-
student_type(str) –学生类型。比如‘本科生’
-
student_type_id(str) –学生类型 ID
-
college(str) –学院
-
college_id(str) –学院 ID
-
unread_email_count(int) –邮箱未读邮件数
-
balance(float) –一卡通余额
-
research_count(int) –科研信息数量
PersonalInfoModel
¤
Bases: BaseModel
flowchart TD
zzupy.app.auth.PersonalInfoModel[PersonalInfoModel]
click zzupy.app.auth.PersonalInfoModel href "" "zzupy.app.auth.PersonalInfoModel"
个人信息 API 响应根模型
Classes:
-
Data–
Data
¤
Bases: BaseModel
flowchart TD
zzupy.app.auth.PersonalInfoModel.Data[Data]
click zzupy.app.auth.PersonalInfoModel.Data href "" "zzupy.app.auth.PersonalInfoModel.Data"
Classes:
Attributes:
Attributes
¤
Bases: BaseModel
flowchart TD
zzupy.app.auth.PersonalInfoModel.Data.Attributes[Attributes]
click zzupy.app.auth.PersonalInfoModel.Data.Attributes href "" "zzupy.app.auth.PersonalInfoModel.Data.Attributes"
Attributes:
-
organization_id(str) –学院 ID
-
organization_name(str) –学院名
-
identity_type_name(str) –学生类型
-
identity_type_id(str) –学生类型 ID
-
user_name(str) –学生姓名
-
user_uid(str) –学号
PersonalInfoCardModel
¤
Bases: BaseModel
flowchart TD
zzupy.app.auth.PersonalInfoCardModel[PersonalInfoCardModel]
click zzupy.app.auth.PersonalInfoCardModel href "" "zzupy.app.auth.PersonalInfoCardModel"
‘我的’页中个人信息卡片 API 响应根模型
Attributes:
CASClient
¤
Bases: ICASClient
flowchart TD
zzupy.app.auth.CASClient[CASClient]
zzupy.app.interfaces.ICASClient[ICASClient]
zzupy.app.interfaces.ICASClient --> zzupy.app.auth.CASClient
click zzupy.app.auth.CASClient href "" "zzupy.app.auth.CASClient"
click zzupy.app.interfaces.ICASClient href "" "zzupy.app.interfaces.ICASClient"
统一认证系统 (CAS) App 客户端。
Parameters:
Classes:
-
MFAClient–统一认证 MFA 辅助客户端。
Methods:
-
set_token–设置统一认证 Token。
-
set_device–设置认证请求使用的设备标识。
-
login–登录统一认证。
-
get_user_info–获取当前用户的聚合个人信息。
-
logout–登出账户,清除 Cookie 但保留连接池
-
close–清除 Cookie 和连接池
Attributes:
-
user_token(str | None) –当前会话的
userToken,约一个月有效期 -
refresh_token(str | None) –当前会话的
refreshToken,约两个月有效期 -
logged_in(bool) –当前会话是否已登录
Source code in zzupy/app/auth.py
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 | |
MFAClient
¤
统一认证 MFA 辅助客户端。
本客户端由 CASClient 自动创建,通常通过
[CASClient.mfa][zzupy.app.auth.CASClient.mfa] 访问。它负责检测 MFA
状态、发送手机号验证码并校验验证码。
Parameters:
Methods:
-
reset–清除当前 MFA 流程状态。
-
is_required–检测当前环境是否需要 MFA 验证
-
request_sms_code–发送 MFA 短信验证码。
-
send_sms–request_sms_code()的别名。 -
verify_sms_code–校验 MFA 短信验证码。
-
verify_sms–verify_sms_code()的别名。
Source code in zzupy/app/auth.py
218 219 220 221 222 223 224 225 226 227 228 229 230 231 | |
reset
¤
reset() -> None
清除当前 MFA 流程状态。
Source code in zzupy/app/auth.py
233 234 235 236 237 238 239 240 | |
is_required
¤
is_required() -> bool
检测当前环境是否需要 MFA 验证
Returns:
-
bool–是否需要 MFA 验证
Raises:
-
OperationError–如果检测失败。
-
ParsingError–如果服务器响应无法解析。
-
NetworkError–如果出现网络错误。
Source code in zzupy/app/auth.py
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 | |
request_sms_code
¤
request_sms_code() -> None
发送 MFA 短信验证码。
如果尚未初始化手机号 MFA,会自动调用内部初始化流程。
Raises:
-
LoginError–如果当前登录不需要 MFA 验证。
-
OperationError–如果短信发送失败。
-
ParsingError–如果服务器响应无法解析。
-
NetworkError–如果出现网络错误。
Source code in zzupy/app/auth.py
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 | |
send_sms
¤
send_sms() -> None
request_sms_code() 的别名。
Source code in zzupy/app/auth.py
481 482 483 | |
verify_sms_code
¤
校验 MFA 短信验证码。
调用前必须先发送 MFA 短信验证码。
校验成功后,CASClient.login()
会使用当前 MFA state 完成登录。
Parameters:
Returns:
-
str–可用于登录的 MFA state。
Raises:
-
MFAError–如果尚未发送 MFA 短信验证码。
-
LoginError–如果验证码校验失败。
-
OperationError–如果服务器返回失败状态。
-
ParsingError–如果服务器响应无法解析。
-
NetworkError–如果出现网络错误。
Source code in zzupy/app/auth.py
485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 | |
verify_sms
¤
verify_sms_code() 的别名。
Source code in zzupy/app/auth.py
568 569 570 | |
set_token
¤
set_token(user_token: str, refresh_token: str) -> None
设置统一认证 Token。
Parameters:
-
(user_token¤str) –userToken。对豫见郑大 APP 抓包获取,或账密登录后访问user_token获取 -
(refresh_token¤str) –refreshToken。对豫见郑大 APP 抓包获取,或账密登录后访问refresh_token获取
Source code in zzupy/app/auth.py
74 75 76 77 78 79 80 81 82 | |
set_device
¤
login
¤
login(force_login: bool = False) -> None
登录统一认证。
成功后,userToken 和 refreshToken 会被存储在实例中.
若 user_token 和 refresh_token 已通过 set_token 设置且有效,则会跳过账密登录。
Parameters:
Raises:
-
MFAError–如果当前登录需要 MFA 但尚未完成验证。
-
LoginError–如果登录失败。
-
ParsingError–如果服务器响应无法解析。
-
NetworkError–如果出现网络错误。
Source code in zzupy/app/auth.py
572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 | |
get_user_info
¤
get_user_info() -> PersonalInfo
获取当前用户的聚合个人信息。
返回学号、姓名、身份类型、学院、邮箱未读数、一卡通余额和科研信息数量。
Returns:
-
PersonalInfo–当前用户的个人信息
Raises:
-
NotLoggedInError–如果当前认证状态缺少 userToken。
-
OperationError–如果服务端返回失败结果。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/app/auth.py
672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 | |
logout
¤
logout() -> None
登出账户,清除 Cookie 但保留连接池
Source code in zzupy/app/auth.py
798 799 800 801 802 803 804 805 806 807 808 809 | |
close
¤
close() -> None
清除 Cookie 和连接池
Source code in zzupy/app/auth.py
811 812 813 814 815 | |
build_http_event_hooks
¤
创建带脱敏能力的 HTTP 请求/响应日志钩子。
Source code in zzupy/logging.py
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 | |
log_http_response_body
¤
log_http_response_body(url: str | URL, text: str, *, content_type: str | None = None, level: str = 'TRACE') -> None
输出脱敏后的 HTTP 响应体日志。
Source code in zzupy/logging.py
156 157 158 159 160 161 162 163 164 165 166 167 168 169 | |
get_jwt_expiration
¤
读取 JWT 的过期时间。
Parameters:
Returns:
-
datetime–JWT
exp对应的本地时间。
Raises:
-
ValueError–如果 Token 无效或缺少有效的
exp。
Source code in zzupy/utils.py
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 | |
require_auth
¤
require_auth(func)
装饰器:确保调用方法前已登录
Raises:
-
NotLoggedInError–如果未登录
Source code in zzupy/utils.py
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 | |
zzupy.app.eas¤
eas
¤
Modules:
-
undergrad–140w 教务
Classes:
Attributes:
-
__all__–
UndergradEASClient
¤
UndergradEASClient(cas_client: ICASClient)
Methods:
-
login–登录到新本科教务系统
-
get_teaching_week–获取 {semester_id} 号学期的第 {week_index} 教学周
-
get_teaching_weeks–获取 {semester_id} 号学期的全部教学周
-
get_week_index–获取指定日期的教学周序数
-
get_semesters–获取所有学期数据
-
logout–登出账户,清除 Cookie 但保留连接池
-
close–清除 Cookie 和连接池
Source code in zzupy/app/eas/undergrad.py
51 52 53 54 55 56 57 58 59 60 61 | |
login
¤
login() -> None
登录到新本科教务系统
Raises:
-
OperationError–如果登录失败。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/app/eas/undergrad.py
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 | |
get_teaching_week
¤
get_teaching_week(week: int, semester_id: int | None = None) -> TeachingWeek
获取 {semester_id} 号学期的第 {week_index} 教学周 Args: week: 教学周序数 semester_id: 学期 ID。不填写则为本学期。
Returns:
-
TeachingWeek(TeachingWeek) –教学周
Raises:
-
ParsingError–如果响应解析失败
-
NetworkError–如果网络请求失败
-
InvalidArgumentError–如果教学周序数不正确。
-
OperationError–如果服务器发生异常。
Source code in zzupy/app/eas/undergrad.py
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 | |
get_teaching_weeks
¤
get_teaching_weeks(semester_id: int | None = None) -> TeachingWeeks
获取 {semester_id} 号学期的全部教学周 Args: semester_id: 学期 ID。不填写则为本学期。
Returns:
-
TeachingWeeks(TeachingWeeks) –由一个学期的全部教学周组成的列表模型。
Raises:
-
ParsingError–如果响应解析失败
-
NetworkError–如果网络请求失败
-
DataNotFoundError–如果学期不存在。
-
OperationError–如果服务器发生异常。
Source code in zzupy/app/eas/undergrad.py
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 | |
get_week_index
¤
get_week_index(date: Date) -> int | None
获取指定日期的教学周序数
Returns:
-
int | None–int | None: 教学周序数
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
-
OperationError–如果服务器发生异常。
Source code in zzupy/app/eas/undergrad.py
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 | |
get_semesters
¤
获取所有学期数据
Returns:
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
-
OperationError–如果服务器发生异常。
Source code in zzupy/app/eas/undergrad.py
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 | |
logout
¤
logout() -> None
登出账户,清除 Cookie 但保留连接池
Source code in zzupy/app/eas/undergrad.py
454 455 456 457 458 459 460 461 | |
close
¤
close() -> None
清除 Cookie 和连接池
Source code in zzupy/app/eas/undergrad.py
463 464 465 466 467 468 | |
undergrad
¤
140w 教务
Classes:
UndergradEASClient
¤
UndergradEASClient(cas_client: ICASClient)
Methods:
-
login–登录到新本科教务系统
-
get_teaching_week–获取 {semester_id} 号学期的第 {week_index} 教学周
-
get_teaching_weeks–获取 {semester_id} 号学期的全部教学周
-
get_week_index–获取指定日期的教学周序数
-
get_semesters–获取所有学期数据
-
logout–登出账户,清除 Cookie 但保留连接池
-
close–清除 Cookie 和连接池
Source code in zzupy/app/eas/undergrad.py
51 52 53 54 55 56 57 58 59 60 61 | |
login
¤
login() -> None
登录到新本科教务系统
Raises:
-
OperationError–如果登录失败。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/app/eas/undergrad.py
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 | |
get_teaching_week
¤
get_teaching_week(week: int, semester_id: int | None = None) -> TeachingWeek
获取 {semester_id} 号学期的第 {week_index} 教学周 Args: week: 教学周序数 semester_id: 学期 ID。不填写则为本学期。
Returns:
-
TeachingWeek(TeachingWeek) –教学周
Raises:
-
ParsingError–如果响应解析失败
-
NetworkError–如果网络请求失败
-
InvalidArgumentError–如果教学周序数不正确。
-
OperationError–如果服务器发生异常。
Source code in zzupy/app/eas/undergrad.py
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 | |
get_teaching_weeks
¤
get_teaching_weeks(semester_id: int | None = None) -> TeachingWeeks
获取 {semester_id} 号学期的全部教学周 Args: semester_id: 学期 ID。不填写则为本学期。
Returns:
-
TeachingWeeks(TeachingWeeks) –由一个学期的全部教学周组成的列表模型。
Raises:
-
ParsingError–如果响应解析失败
-
NetworkError–如果网络请求失败
-
DataNotFoundError–如果学期不存在。
-
OperationError–如果服务器发生异常。
Source code in zzupy/app/eas/undergrad.py
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 | |
get_week_index
¤
get_week_index(date: Date) -> int | None
获取指定日期的教学周序数
Returns:
-
int | None–int | None: 教学周序数
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
-
OperationError–如果服务器发生异常。
Source code in zzupy/app/eas/undergrad.py
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 | |
get_semesters
¤
获取所有学期数据
Returns:
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
-
OperationError–如果服务器发生异常。
Source code in zzupy/app/eas/undergrad.py
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 | |
logout
¤
logout() -> None
登出账户,清除 Cookie 但保留连接池
Source code in zzupy/app/eas/undergrad.py
454 455 456 457 458 459 460 461 | |
close
¤
close() -> None
清除 Cookie 和连接池
Source code in zzupy/app/eas/undergrad.py
463 464 465 466 467 468 | |
zzupy.app.eas.undergrad¤
undergrad
¤
140w 教务
Classes:
-
ICASClient– -
DataNotFoundError–请求的数据不存在或当前上下文中无法找到。
-
InvalidArgumentError–调用参数不合法。
-
NetworkError–网络请求失败或网络环境异常。
-
NotLoggedInError–在未登录状态下调用了需要登录的方法。
-
OperationError–服务端接受请求但业务处理失败。
-
ParsingError–响应解析或数据校验失败。
-
Lesson–课表中的一节课
-
TeachingWeek–教学周课表,7 天 × 10 节的网格
-
LessonModel–课程表查询 API 响应根模型
-
SemesterModel–获取全部学期数据 API 响应根模型
-
Semester–单个学期
-
WeekIndexModel–获取某日期的教学周序数 API 响应根模型
-
CurrentSemesterModel–获取当前学期数据 API 响应根模型
-
TeachingWeeks– -
UndergradEASClient–
Functions:
-
build_http_event_hooks–创建带脱敏能力的 HTTP 请求/响应日志钩子。
-
log_http_response_body–输出脱敏后的 HTTP 响应体日志。
-
require_auth–装饰器:确保调用方法前已登录
Attributes:
-
logger–
ICASClient
¤
Bases: ABC
flowchart TD
zzupy.app.eas.undergrad.ICASClient[ICASClient]
click zzupy.app.eas.undergrad.ICASClient href "" "zzupy.app.eas.undergrad.ICASClient"
Source code in zzupy/app/interfaces.py
7 8 9 | |
DataNotFoundError
¤
DataNotFoundError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: OperationError, LookupError
flowchart TD
zzupy.app.eas.undergrad.DataNotFoundError[DataNotFoundError]
zzupy.exception.OperationError[OperationError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.OperationError --> zzupy.app.eas.undergrad.DataNotFoundError
zzupy.exception.ZZUError --> zzupy.exception.OperationError
click zzupy.app.eas.undergrad.DataNotFoundError href "" "zzupy.app.eas.undergrad.DataNotFoundError"
click zzupy.exception.OperationError href "" "zzupy.exception.OperationError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
请求的数据不存在或当前上下文中无法找到。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
InvalidArgumentError
¤
InvalidArgumentError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: ZZUError, ValueError
flowchart TD
zzupy.app.eas.undergrad.InvalidArgumentError[InvalidArgumentError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.ZZUError --> zzupy.app.eas.undergrad.InvalidArgumentError
click zzupy.app.eas.undergrad.InvalidArgumentError href "" "zzupy.app.eas.undergrad.InvalidArgumentError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
调用参数不合法。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
NetworkError
¤
NetworkError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: ZZUError
flowchart TD
zzupy.app.eas.undergrad.NetworkError[NetworkError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.ZZUError --> zzupy.app.eas.undergrad.NetworkError
click zzupy.app.eas.undergrad.NetworkError href "" "zzupy.app.eas.undergrad.NetworkError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
网络请求失败或网络环境异常。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
NotLoggedInError
¤
NotLoggedInError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: ClientStateError
flowchart TD
zzupy.app.eas.undergrad.NotLoggedInError[NotLoggedInError]
zzupy.exception.ClientStateError[ClientStateError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.ClientStateError --> zzupy.app.eas.undergrad.NotLoggedInError
zzupy.exception.ZZUError --> zzupy.exception.ClientStateError
click zzupy.app.eas.undergrad.NotLoggedInError href "" "zzupy.app.eas.undergrad.NotLoggedInError"
click zzupy.exception.ClientStateError href "" "zzupy.exception.ClientStateError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
在未登录状态下调用了需要登录的方法。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
OperationError
¤
OperationError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: ZZUError
flowchart TD
zzupy.app.eas.undergrad.OperationError[OperationError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.ZZUError --> zzupy.app.eas.undergrad.OperationError
click zzupy.app.eas.undergrad.OperationError href "" "zzupy.app.eas.undergrad.OperationError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
服务端接受请求但业务处理失败。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
ParsingError
¤
ParsingError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: ZZUError
flowchart TD
zzupy.app.eas.undergrad.ParsingError[ParsingError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.ZZUError --> zzupy.app.eas.undergrad.ParsingError
click zzupy.app.eas.undergrad.ParsingError href "" "zzupy.app.eas.undergrad.ParsingError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
响应解析或数据校验失败。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
Lesson
¤
Bases: BaseModel
flowchart TD
zzupy.app.eas.undergrad.Lesson[Lesson]
click zzupy.app.eas.undergrad.Lesson href "" "zzupy.app.eas.undergrad.Lesson"
课表中的一节课
Attributes:
TeachingWeek
¤
Bases: BaseModel
flowchart TD
zzupy.app.eas.undergrad.TeachingWeek[TeachingWeek]
click zzupy.app.eas.undergrad.TeachingWeek href "" "zzupy.app.eas.undergrad.TeachingWeek"
教学周课表,7 天 × 10 节的网格
Methods:
-
set–设置某天某节的课程
-
get–获取某天某节的课程
-
get_day–获取某天的全部课程
-
get_unit–获取某节 7 天的课程
-
to_calendar–将教学周的课表转换为符合 RFC 5545 的 Calendar 对象。
Attributes:
-
lessons(dict[tuple[int, int], Lesson]) –内部存储:仅存储非空课程,key 为 (weekday, unit),value 为 Lesson
-
grid(list[list[Lesson | None]]) –网格形式的课表,仅在访问时动态生成
lessons
class-attribute
instance-attribute
¤
内部存储:仅存储非空课程,key 为 (weekday, unit),value 为 Lesson
set
¤
设置某天某节的课程
Parameters:
Raises:
-
IndexError–如果 {weekday} 或 {unit} 超出范围
Source code in zzupy/model/eas.py
449 450 451 452 453 454 455 456 457 458 459 460 461 | |
get
¤
获取某天某节的课程
Parameters:
Returns:
-
Lesson | None–Lesson | None: 对应课程或 None
Raises:
-
IndexError–如果 {weekday} 或 {unit} 超出范围
Source code in zzupy/model/eas.py
463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 | |
get_day
¤
获取某天的全部课程
Parameters:
Returns:
Raises:
-
IndexError–如果 {weekday} 超出范围
Source code in zzupy/model/eas.py
479 480 481 482 483 484 485 486 487 488 489 490 491 492 | |
get_unit
¤
获取某节 7 天的课程
Parameters:
Returns:
Raises:
-
IndexError–如果 {unit} 超出范围
Source code in zzupy/model/eas.py
494 495 496 497 498 499 500 501 502 503 504 505 506 507 | |
to_calendar
¤
将教学周的课表转换为符合 RFC 5545 的 Calendar 对象。 可以使用以下代码将其写入 .ics 或对它做你想做的任何事
with open('my_schedule.ics', 'wb') as f:
f.write(aTeachingWeek.to_calendar().to_ical())
Parameters:
Returns:
-
Calendar–Calendar 对象。
Source code in zzupy/model/eas.py
517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 | |
LessonModel
¤
Bases: BaseModel
flowchart TD
zzupy.app.eas.undergrad.LessonModel[LessonModel]
click zzupy.app.eas.undergrad.LessonModel href "" "zzupy.app.eas.undergrad.LessonModel"
课程表查询 API 响应根模型
Attributes:
SemesterModel
¤
Bases: BaseModel
flowchart TD
zzupy.app.eas.undergrad.SemesterModel[SemesterModel]
click zzupy.app.eas.undergrad.SemesterModel href "" "zzupy.app.eas.undergrad.SemesterModel"
获取全部学期数据 API 响应根模型
Attributes:
Semester
¤
Bases: BaseModel
flowchart TD
zzupy.app.eas.undergrad.Semester[Semester]
click zzupy.app.eas.undergrad.Semester href "" "zzupy.app.eas.undergrad.Semester"
单个学期
WeekIndexModel
¤
Bases: BaseModel
flowchart TD
zzupy.app.eas.undergrad.WeekIndexModel[WeekIndexModel]
click zzupy.app.eas.undergrad.WeekIndexModel href "" "zzupy.app.eas.undergrad.WeekIndexModel"
获取某日期的教学周序数 API 响应根模型
Attributes:
CurrentSemesterModel
¤
Bases: BaseModel
flowchart TD
zzupy.app.eas.undergrad.CurrentSemesterModel[CurrentSemesterModel]
click zzupy.app.eas.undergrad.CurrentSemesterModel href "" "zzupy.app.eas.undergrad.CurrentSemesterModel"
获取当前学期数据 API 响应根模型
Attributes:
TeachingWeeks
¤
Bases: RootModel
flowchart TD
zzupy.app.eas.undergrad.TeachingWeeks[TeachingWeeks]
click zzupy.app.eas.undergrad.TeachingWeeks href "" "zzupy.app.eas.undergrad.TeachingWeeks"
Methods:
-
to_calendar–将教学周的课表转换为符合 RFC 5545 的 Calendar 对象。
to_calendar
¤
将教学周的课表转换为符合 RFC 5545 的 Calendar 对象。 可以使用以下代码将其写入 .ics 或对它做你想做的任何事
with open('my_schedule.ics', 'wb') as f:
f.write(aTeachingWeek.to_calendar().to_ical())
Parameters:
Returns:
-
Calendar–Calendar 对象。
Source code in zzupy/model/eas.py
610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 | |
UndergradEASClient
¤
UndergradEASClient(cas_client: ICASClient)
Methods:
-
login–登录到新本科教务系统
-
get_teaching_week–获取 {semester_id} 号学期的第 {week_index} 教学周
-
get_teaching_weeks–获取 {semester_id} 号学期的全部教学周
-
get_week_index–获取指定日期的教学周序数
-
get_semesters–获取所有学期数据
-
logout–登出账户,清除 Cookie 但保留连接池
-
close–清除 Cookie 和连接池
Source code in zzupy/app/eas/undergrad.py
51 52 53 54 55 56 57 58 59 60 61 | |
login
¤
login() -> None
登录到新本科教务系统
Raises:
-
OperationError–如果登录失败。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/app/eas/undergrad.py
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 | |
get_teaching_week
¤
get_teaching_week(week: int, semester_id: int | None = None) -> TeachingWeek
获取 {semester_id} 号学期的第 {week_index} 教学周 Args: week: 教学周序数 semester_id: 学期 ID。不填写则为本学期。
Returns:
-
TeachingWeek(TeachingWeek) –教学周
Raises:
-
ParsingError–如果响应解析失败
-
NetworkError–如果网络请求失败
-
InvalidArgumentError–如果教学周序数不正确。
-
OperationError–如果服务器发生异常。
Source code in zzupy/app/eas/undergrad.py
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 | |
get_teaching_weeks
¤
get_teaching_weeks(semester_id: int | None = None) -> TeachingWeeks
获取 {semester_id} 号学期的全部教学周 Args: semester_id: 学期 ID。不填写则为本学期。
Returns:
-
TeachingWeeks(TeachingWeeks) –由一个学期的全部教学周组成的列表模型。
Raises:
-
ParsingError–如果响应解析失败
-
NetworkError–如果网络请求失败
-
DataNotFoundError–如果学期不存在。
-
OperationError–如果服务器发生异常。
Source code in zzupy/app/eas/undergrad.py
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 | |
get_week_index
¤
get_week_index(date: Date) -> int | None
获取指定日期的教学周序数
Returns:
-
int | None–int | None: 教学周序数
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
-
OperationError–如果服务器发生异常。
Source code in zzupy/app/eas/undergrad.py
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 | |
get_semesters
¤
获取所有学期数据
Returns:
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
-
OperationError–如果服务器发生异常。
Source code in zzupy/app/eas/undergrad.py
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 | |
logout
¤
logout() -> None
登出账户,清除 Cookie 但保留连接池
Source code in zzupy/app/eas/undergrad.py
454 455 456 457 458 459 460 461 | |
close
¤
close() -> None
清除 Cookie 和连接池
Source code in zzupy/app/eas/undergrad.py
463 464 465 466 467 468 | |
build_http_event_hooks
¤
创建带脱敏能力的 HTTP 请求/响应日志钩子。
Source code in zzupy/logging.py
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 | |
log_http_response_body
¤
log_http_response_body(url: str | URL, text: str, *, content_type: str | None = None, level: str = 'TRACE') -> None
输出脱敏后的 HTTP 响应体日志。
Source code in zzupy/logging.py
156 157 158 159 160 161 162 163 164 165 166 167 168 169 | |
require_auth
¤
require_auth(func)
装饰器:确保调用方法前已登录
Raises:
-
NotLoggedInError–如果未登录
Source code in zzupy/utils.py
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 | |
zzupy.app.ecard¤
ecard
¤
一卡通
Classes:
-
ICASClient– -
InvalidArgumentError–调用参数不合法。
-
NetworkError–网络请求失败或网络环境异常。
-
NotLoggedInError–在未登录状态下调用了需要登录的方法。
-
OperationError–服务端接受请求但业务处理失败。
-
ParsingError–响应解析或数据校验失败。
-
ECardAccountModel–一卡通账户 API 响应根模型
-
ECardClient–一卡通客户端
Functions:
-
build_http_event_hooks–创建带脱敏能力的 HTTP 请求/响应日志钩子。
-
log_http_headers–输出脱敏后的 HTTP 头日志。
-
log_http_response_body–输出脱敏后的 HTTP 响应体日志。
-
sm4_decrypt_ecb–SM4 解密,ECB模式
-
require_auth–装饰器:确保调用方法前已登录
Attributes:
-
logger–
ICASClient
¤
Bases: ABC
flowchart TD
zzupy.app.ecard.ICASClient[ICASClient]
click zzupy.app.ecard.ICASClient href "" "zzupy.app.ecard.ICASClient"
Source code in zzupy/app/interfaces.py
7 8 9 | |
InvalidArgumentError
¤
InvalidArgumentError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: ZZUError, ValueError
flowchart TD
zzupy.app.ecard.InvalidArgumentError[InvalidArgumentError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.ZZUError --> zzupy.app.ecard.InvalidArgumentError
click zzupy.app.ecard.InvalidArgumentError href "" "zzupy.app.ecard.InvalidArgumentError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
调用参数不合法。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
NetworkError
¤
NetworkError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: ZZUError
flowchart TD
zzupy.app.ecard.NetworkError[NetworkError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.ZZUError --> zzupy.app.ecard.NetworkError
click zzupy.app.ecard.NetworkError href "" "zzupy.app.ecard.NetworkError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
网络请求失败或网络环境异常。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
NotLoggedInError
¤
NotLoggedInError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: ClientStateError
flowchart TD
zzupy.app.ecard.NotLoggedInError[NotLoggedInError]
zzupy.exception.ClientStateError[ClientStateError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.ClientStateError --> zzupy.app.ecard.NotLoggedInError
zzupy.exception.ZZUError --> zzupy.exception.ClientStateError
click zzupy.app.ecard.NotLoggedInError href "" "zzupy.app.ecard.NotLoggedInError"
click zzupy.exception.ClientStateError href "" "zzupy.exception.ClientStateError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
在未登录状态下调用了需要登录的方法。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
OperationError
¤
OperationError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: ZZUError
flowchart TD
zzupy.app.ecard.OperationError[OperationError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.ZZUError --> zzupy.app.ecard.OperationError
click zzupy.app.ecard.OperationError href "" "zzupy.app.ecard.OperationError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
服务端接受请求但业务处理失败。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
ParsingError
¤
ParsingError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: ZZUError
flowchart TD
zzupy.app.ecard.ParsingError[ParsingError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.ZZUError --> zzupy.app.ecard.ParsingError
click zzupy.app.ecard.ParsingError href "" "zzupy.app.ecard.ParsingError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
响应解析或数据校验失败。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
ECardAccountModel
¤
Bases: BaseModel
flowchart TD
zzupy.app.ecard.ECardAccountModel[ECardAccountModel]
click zzupy.app.ecard.ECardAccountModel href "" "zzupy.app.ecard.ECardAccountModel"
一卡通账户 API 响应根模型
ECardClient
¤
ECardClient(cas_client: ICASClient)
一卡通客户端
Parameters:
-
(cas_client¤ICASClient) –已登录的 CASClient 实例
Methods:
-
login–登录到校园卡系统
-
get_default_room–获取账户默认房间
-
recharge_energy–为 room 充值电费
-
get_balance–获取校园卡余额
-
get_room_dict–获取房间的字典
-
get_remaining_energy–获取剩余电量
-
logout–登出账户,清除 Cookie 但保留连接池
-
close–清除 Cookie 和连接池
Source code in zzupy/app/ecard.py
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 | |
login
¤
login() -> None
登录到校园卡系统
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/app/ecard.py
144 145 146 147 148 149 150 151 152 153 154 155 156 | |
get_default_room
¤
get_default_room() -> str
获取账户默认房间
Returns:
-
str–默认的房间
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/app/ecard.py
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 | |
recharge_energy
¤
为 room 充值电费
Parameters:
-
(payment_password¤str) –支付密码
-
(amt¤int) –充值金额
-
(room¤str) –房间 ID 。格式应为 'areaid-buildingid--unitid-roomid',可通过
get_room_dict()获取
Raises:
-
InvalidArgumentError–如果金额或房间参数不合法。
-
OperationError–如果充值失败。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/app/ecard.py
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 | |
get_balance
¤
get_balance() -> float
获取校园卡余额
Returns:
-
float–校园卡余额
Raises:
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/app/ecard.py
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 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 | |
get_room_dict
¤
获取房间的字典
Parameters:
Returns:
-
dict–对应的字典
Raises:
-
InvalidArgumentError–如果参数格式不正确。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/app/ecard.py
520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 | |
get_remaining_energy
¤
获取剩余电量
Parameters:
-
(room¤str | None, default:None) –房间 ID 。格式应为 'areaid-buildingid--unitid-roomid',可通过
get_room_dict()获取
Returns:
-
float–剩余电量
Raises:
-
InvalidArgumentError–如果房间参数不合法。
-
ParsingError–如果响应解析失败。
-
NetworkError–如果网络请求失败。
Source code in zzupy/app/ecard.py
635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 | |
logout
¤
logout() -> None
登出账户,清除 Cookie 但保留连接池
Source code in zzupy/app/ecard.py
732 733 734 735 736 737 738 739 740 741 742 743 744 745 | |
close
¤
close() -> None
清除 Cookie 和连接池
Source code in zzupy/app/ecard.py
747 748 749 750 751 752 753 754 755 756 | |
build_http_event_hooks
¤
创建带脱敏能力的 HTTP 请求/响应日志钩子。
Source code in zzupy/logging.py
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 | |
log_http_headers
¤
输出脱敏后的 HTTP 头日志。
Source code in zzupy/logging.py
146 147 148 149 150 151 152 153 | |
log_http_response_body
¤
log_http_response_body(url: str | URL, text: str, *, content_type: str | None = None, level: str = 'TRACE') -> None
输出脱敏后的 HTTP 响应体日志。
Source code in zzupy/logging.py
156 157 158 159 160 161 162 163 164 165 166 167 168 169 | |
sm4_decrypt_ecb
¤
sm4_decrypt_ecb(ciphertext: bytes, key: bytes) -> str
SM4 解密,ECB模式
Parameters:
Returns:
-
str–明文 Hex
Source code in zzupy/utils.py
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 | |
require_auth
¤
require_auth(func)
装饰器:确保调用方法前已登录
Raises:
-
NotLoggedInError–如果未登录
Source code in zzupy/utils.py
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 | |
zzupy.app.interfaces¤
interfaces
¤
zzupy.crypto¤
crypto
¤
纯 Python 实现的轻量级 RSA 加密
Classes:
-
RSAPublicKey–轻量级 RSA 公钥实现
-
padding–填充方案命名空间(兼容 cryptography)
-
serialization–序列化命名空间(兼容 cryptography)
Functions:
-
load_pem_public_key–从 PEM 格式加载 RSA 公钥
-
_parse_der_public_key–解析 DER 编码的 RSA 公钥
RSAPublicKey
¤
轻量级 RSA 公钥实现
Parameters:
Methods:
-
encrypt–使用 PKCS#1 v1.5 填充进行 RSA 加密
-
verify_rs512–验证 RS512 (RSA-SHA512) 签名
Source code in zzupy/crypto.py
12 13 14 15 16 17 18 19 20 21 22 | |
encrypt
¤
encrypt(data: bytes, padding_scheme=None) -> bytes
使用 PKCS#1 v1.5 填充进行 RSA 加密
Parameters:
Returns:
-
bytes–加密后的字节数据
Source code in zzupy/crypto.py
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 | |
verify_rs512
¤
验证 RS512 (RSA-SHA512) 签名
Parameters:
Returns:
-
bool–签名是否有效
Source code in zzupy/crypto.py
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 | |
padding
¤
serialization
¤
序列化命名空间(兼容 cryptography)
Methods:
-
load_pem_public_key–加载 PEM 格式公钥(兼容 cryptography 接口)
load_pem_public_key
staticmethod
¤
load_pem_public_key(data: bytes) -> RSAPublicKey
加载 PEM 格式公钥(兼容 cryptography 接口)
Source code in zzupy/crypto.py
249 250 251 252 | |
load_pem_public_key
¤
load_pem_public_key(pem_data: bytes) -> RSAPublicKey
从 PEM 格式加载 RSA 公钥
Parameters:
Returns:
-
RSAPublicKey–RSAPublicKey 对象
Source code in zzupy/crypto.py
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 | |
_parse_der_public_key
¤
解析 DER 编码的 RSA 公钥
支持两种格式: 1. PKCS#1 RSAPublicKey (常见于 OpenSSL) 2. X.509 SubjectPublicKeyInfo (标准格式)
Parameters:
Returns:
Source code in zzupy/crypto.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 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 | |
zzupy.exception¤
exception
¤
异常处理模块。
Classes:
-
ZZUError–项目异常基类。
-
ClientStateError–客户端状态错误。
-
InvalidArgumentError–调用参数不合法。
-
NetworkError–网络请求失败或网络环境异常。
-
LoginError–登录失败。
-
ParsingError–响应解析或数据校验失败。
-
NotLoggedInError–在未登录状态下调用了需要登录的方法。
-
AuthenticationError–认证失败。
-
OperationError–服务端接受请求但业务处理失败。
-
DataNotFoundError–请求的数据不存在或当前上下文中无法找到。
-
MFAError–MFA 状态错误,当前会话可能需要 MFA 验证
Attributes:
-
__all__–
__all__
module-attribute
¤
__all__ = ['AuthenticationError', 'ClientStateError', 'DataNotFoundError', 'InvalidArgumentError', 'LoginError', 'NetworkError', 'NotLoggedInError', 'OperationError', 'ParsingError', 'ZZUError', 'MFAError']
ZZUError
¤
ZZUError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: Exception
flowchart TD
zzupy.exception.ZZUError[ZZUError]
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
项目异常基类。
除了人类可读的错误消息外,还会保留额外上下文,便于调用方记录日志、 序列化或调试。
Parameters:
-
(message¤str | None, default:None) –错误消息。
-
(context¤Mapping[str, Any] | None, default:None) –结构化上下文信息。
-
(error_code¤str | None, default:None) –可选错误代码。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
ClientStateError
¤
ClientStateError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: ZZUError, RuntimeError
flowchart TD
zzupy.exception.ClientStateError[ClientStateError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.ZZUError --> zzupy.exception.ClientStateError
click zzupy.exception.ClientStateError href "" "zzupy.exception.ClientStateError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
客户端状态错误。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
InvalidArgumentError
¤
InvalidArgumentError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: ZZUError, ValueError
flowchart TD
zzupy.exception.InvalidArgumentError[InvalidArgumentError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.ZZUError --> zzupy.exception.InvalidArgumentError
click zzupy.exception.InvalidArgumentError href "" "zzupy.exception.InvalidArgumentError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
调用参数不合法。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
NetworkError
¤
NetworkError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: ZZUError
flowchart TD
zzupy.exception.NetworkError[NetworkError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.ZZUError --> zzupy.exception.NetworkError
click zzupy.exception.NetworkError href "" "zzupy.exception.NetworkError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
网络请求失败或网络环境异常。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
LoginError
¤
LoginError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: ZZUError
flowchart TD
zzupy.exception.LoginError[LoginError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.ZZUError --> zzupy.exception.LoginError
click zzupy.exception.LoginError href "" "zzupy.exception.LoginError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
登录失败。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
ParsingError
¤
ParsingError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: ZZUError
flowchart TD
zzupy.exception.ParsingError[ParsingError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.ZZUError --> zzupy.exception.ParsingError
click zzupy.exception.ParsingError href "" "zzupy.exception.ParsingError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
响应解析或数据校验失败。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
NotLoggedInError
¤
NotLoggedInError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: ClientStateError
flowchart TD
zzupy.exception.NotLoggedInError[NotLoggedInError]
zzupy.exception.ClientStateError[ClientStateError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.ClientStateError --> zzupy.exception.NotLoggedInError
zzupy.exception.ZZUError --> zzupy.exception.ClientStateError
click zzupy.exception.NotLoggedInError href "" "zzupy.exception.NotLoggedInError"
click zzupy.exception.ClientStateError href "" "zzupy.exception.ClientStateError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
在未登录状态下调用了需要登录的方法。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
AuthenticationError
¤
AuthenticationError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: ClientStateError
flowchart TD
zzupy.exception.AuthenticationError[AuthenticationError]
zzupy.exception.ClientStateError[ClientStateError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.ClientStateError --> zzupy.exception.AuthenticationError
zzupy.exception.ZZUError --> zzupy.exception.ClientStateError
click zzupy.exception.AuthenticationError href "" "zzupy.exception.AuthenticationError"
click zzupy.exception.ClientStateError href "" "zzupy.exception.ClientStateError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
认证失败。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
OperationError
¤
OperationError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: ZZUError
flowchart TD
zzupy.exception.OperationError[OperationError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.ZZUError --> zzupy.exception.OperationError
click zzupy.exception.OperationError href "" "zzupy.exception.OperationError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
服务端接受请求但业务处理失败。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
DataNotFoundError
¤
DataNotFoundError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: OperationError, LookupError
flowchart TD
zzupy.exception.DataNotFoundError[DataNotFoundError]
zzupy.exception.OperationError[OperationError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.OperationError --> zzupy.exception.DataNotFoundError
zzupy.exception.ZZUError --> zzupy.exception.OperationError
click zzupy.exception.DataNotFoundError href "" "zzupy.exception.DataNotFoundError"
click zzupy.exception.OperationError href "" "zzupy.exception.OperationError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
请求的数据不存在或当前上下文中无法找到。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
MFAError
¤
MFAError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: LoginError
flowchart TD
zzupy.exception.MFAError[MFAError]
zzupy.exception.LoginError[LoginError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.LoginError --> zzupy.exception.MFAError
zzupy.exception.ZZUError --> zzupy.exception.LoginError
click zzupy.exception.MFAError href "" "zzupy.exception.MFAError"
click zzupy.exception.LoginError href "" "zzupy.exception.LoginError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
MFA 状态错误,当前会话可能需要 MFA 验证
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
zzupy.logging¤
logging
¤
zzupy 日志工具。
Functions:
-
_normalize_key– -
_is_sensitive_key– -
_truncate_text– -
_sanitize_value– -
sanitize_http_headers–脱敏并标准化 HTTP 头,便于安全输出到日志。
-
sanitize_http_url–脱敏 URL 查询参数。
-
sanitize_http_body–按内容类型对 HTTP Body 做脱敏与截断。
-
log_http_headers–输出脱敏后的 HTTP 头日志。
-
log_http_response_body–输出脱敏后的 HTTP 响应体日志。
-
build_http_event_hooks–创建带脱敏能力的 HTTP 请求/响应日志钩子。
Attributes:
-
logger– -
_REDACTED– -
_MAX_BODY_LENGTH– -
_DEFAULT_HANDLER_ID– -
_TEXT_CONTENT_TYPES– -
_SENSITIVE_KEYS–
_TEXT_CONTENT_TYPES
module-attribute
¤
_TEXT_CONTENT_TYPES = ('application/json', 'application/x-www-form-urlencoded', 'application/xml', 'application/javascript', 'text/')
_SENSITIVE_KEYS
module-attribute
¤
_SENSITIVE_KEYS = frozenset({'access_token', 'accesstoken', 'authorization', 'clientid', 'cookie', 'deviceid', 'password', 'refresh_token', 'refreshtoken', 'set-cookie', 'token', 'user_token', 'usertoken', 'username'})
_normalize_key
¤
Source code in zzupy/logging.py
43 44 | |
_is_sensitive_key
¤
Source code in zzupy/logging.py
47 48 | |
_truncate_text
¤
_truncate_text(text: str, limit: int = _MAX_BODY_LENGTH) -> str
Source code in zzupy/logging.py
51 52 53 54 | |
_sanitize_value
¤
Source code in zzupy/logging.py
57 58 59 60 61 62 63 64 65 66 67 | |
sanitize_http_headers
¤
脱敏并标准化 HTTP 头,便于安全输出到日志。
Source code in zzupy/logging.py
70 71 72 73 74 75 | |
sanitize_http_url
¤
脱敏 URL 查询参数。
Source code in zzupy/logging.py
78 79 80 81 82 83 84 85 86 87 88 89 90 91 | |
sanitize_http_body
¤
sanitize_http_body(body: bytes | str | None, *, content_type: str | None = None, limit: int = _MAX_BODY_LENGTH) -> str
按内容类型对 HTTP Body 做脱敏与截断。
Source code in zzupy/logging.py
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 | |
log_http_headers
¤
输出脱敏后的 HTTP 头日志。
Source code in zzupy/logging.py
146 147 148 149 150 151 152 153 | |
log_http_response_body
¤
log_http_response_body(url: str | URL, text: str, *, content_type: str | None = None, level: str = 'TRACE') -> None
输出脱敏后的 HTTP 响应体日志。
Source code in zzupy/logging.py
156 157 158 159 160 161 162 163 164 165 166 167 168 169 | |
build_http_event_hooks
¤
创建带脱敏能力的 HTTP 请求/响应日志钩子。
Source code in zzupy/logging.py
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 | |
zzupy.model¤
model
¤
Modules:
auth
¤
Classes:
-
PersonalInfoCardModel–‘我的’页中个人信息卡片 API 响应根模型
-
PersonalInfo–个人信息模型
-
PersonalInfoModel–个人信息 API 响应根模型
PersonalInfoCardModel
¤
Bases: BaseModel
flowchart TD
zzupy.model.auth.PersonalInfoCardModel[PersonalInfoCardModel]
click zzupy.model.auth.PersonalInfoCardModel href "" "zzupy.model.auth.PersonalInfoCardModel"
‘我的’页中个人信息卡片 API 响应根模型
Attributes:
PersonalInfo
¤
Bases: BaseModel
flowchart TD
zzupy.model.auth.PersonalInfo[PersonalInfo]
click zzupy.model.auth.PersonalInfo href "" "zzupy.model.auth.PersonalInfo"
个人信息模型
Attributes:
-
uid(str) –学号
-
name(str) –用户姓名
-
student_type(str) –学生类型。比如‘本科生’
-
student_type_id(str) –学生类型 ID
-
college(str) –学院
-
college_id(str) –学院 ID
-
unread_email_count(int) –邮箱未读邮件数
-
balance(float) –一卡通余额
-
research_count(int) –科研信息数量
PersonalInfoModel
¤
Bases: BaseModel
flowchart TD
zzupy.model.auth.PersonalInfoModel[PersonalInfoModel]
click zzupy.model.auth.PersonalInfoModel href "" "zzupy.model.auth.PersonalInfoModel"
个人信息 API 响应根模型
Classes:
-
Data–
Data
¤
Bases: BaseModel
flowchart TD
zzupy.model.auth.PersonalInfoModel.Data[Data]
click zzupy.model.auth.PersonalInfoModel.Data href "" "zzupy.model.auth.PersonalInfoModel.Data"
Classes:
Attributes:
Attributes
¤
Bases: BaseModel
flowchart TD
zzupy.model.auth.PersonalInfoModel.Data.Attributes[Attributes]
click zzupy.model.auth.PersonalInfoModel.Data.Attributes href "" "zzupy.model.auth.PersonalInfoModel.Data.Attributes"
Attributes:
-
organization_id(str) –学院 ID
-
organization_name(str) –学院名
-
identity_type_name(str) –学生类型
-
identity_type_id(str) –学生类型 ID
-
user_name(str) –学生姓名
-
user_uid(str) –学号
eas
¤
Classes:
-
Campus–校区信息
-
CultivateType–培养类型,如主修、辅修等
-
PeriodInfo–课时详情,描述一门课程各类学时的分配情况
-
Course–课程基本信息
-
OpenDepartment–开课院系
-
CourseType–课程类型,如必修课、选修课等
-
DateTimeText–上课时间的文字描述
-
DateTimePlaceText–上课时间与地点的文字描述,如「1~16周 星期四 3~4节 主校区 北3_111」
-
DateTimePlacePersonText–上课时间、地点与教师的文字描述,如「1~16周 星期四 3~4节 主校区 北3_111 王艳玲」
-
ScheduleText–教学班排课的综合文字描述,聚合了三个层次的描述信息
-
ScheduleGroup–排课组,将一个教学班的多次课归入同一组
-
Building–楼栋信息
-
Room–教室信息
-
Schedule–单次课程的具体排课记录
-
Datum–教学班信息,包含课程、排课等完整数据
-
LessonModel–课程表查询 API 响应根模型
-
Lesson–课表中的一节课
-
TeachingWeek–教学周课表,7 天 × 10 节的网格
-
TeachingWeeks– -
Semester–单个学期
-
SemesterModel–获取全部学期数据 API 响应根模型
-
CurrentSemesterModel–获取当前学期数据 API 响应根模型
-
WeekIndexModel–获取某日期的教学周序数 API 响应根模型
Campus
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.Campus[Campus]
click zzupy.model.eas.Campus href "" "zzupy.model.eas.Campus"
校区信息
Attributes:
CultivateType
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.CultivateType[CultivateType]
click zzupy.model.eas.CultivateType href "" "zzupy.model.eas.CultivateType"
培养类型,如主修、辅修等
Attributes:
PeriodInfo
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.PeriodInfo[PeriodInfo]
click zzupy.model.eas.PeriodInfo href "" "zzupy.model.eas.PeriodInfo"
课时详情,描述一门课程各类学时的分配情况
Attributes:
-
total(int) –总学时
-
weeks(int) –开课周数
-
theory(int | None) –理论学时数
-
theory_unit(str | None) –理论学时单位
-
require_theory(int | None) –要求完成的理论学时数
-
experiment(int | None) –实验学时数
-
experiment_unit(str | None) –实验学时单位
-
require_experiment(int | None) –要求完成的实验学时数
-
periods_per_week(int) –每周课时数
Course
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.Course[Course]
click zzupy.model.eas.Course href "" "zzupy.model.eas.Course"
课程基本信息
Attributes:
-
code(str) –课程编号
-
name_zh(str) –课程中文名
-
name_en(str | None) –课程英文名
-
credits(float) –学分
-
period_info(PeriodInfo) –课时详情
-
theory(bool) –是否含理论课
-
experiment(bool) –是否含实验课
-
practice(bool) –是否含实践课
-
test(bool) –是否含考试课时
-
machine(bool) –是否含上机课
-
design(bool) –是否含设计课
-
extra(bool) –是否含其他课时类型
OpenDepartment
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.OpenDepartment[OpenDepartment]
click zzupy.model.eas.OpenDepartment href "" "zzupy.model.eas.OpenDepartment"
开课院系
Attributes:
CourseType
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.CourseType[CourseType]
click zzupy.model.eas.CourseType href "" "zzupy.model.eas.CourseType"
课程类型,如必修课、选修课等
Attributes:
DateTimeText
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.DateTimeText[DateTimeText]
click zzupy.model.eas.DateTimeText href "" "zzupy.model.eas.DateTimeText"
上课时间的文字描述
Attributes:
DateTimePlaceText
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.DateTimePlaceText[DateTimePlaceText]
click zzupy.model.eas.DateTimePlaceText href "" "zzupy.model.eas.DateTimePlaceText"
上课时间与地点的文字描述,如「1~16周 星期四 3~4节 主校区 北3_111」
Attributes:
DateTimePlacePersonText
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.DateTimePlacePersonText[DateTimePlacePersonText]
click zzupy.model.eas.DateTimePlacePersonText href "" "zzupy.model.eas.DateTimePlacePersonText"
上课时间、地点与教师的文字描述,如「1~16周 星期四 3~4节 主校区 北3_111 王艳玲」
Attributes:
ScheduleText
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.ScheduleText[ScheduleText]
click zzupy.model.eas.ScheduleText href "" "zzupy.model.eas.ScheduleText"
教学班排课的综合文字描述,聚合了三个层次的描述信息
Attributes:
-
date_time_text(DateTimeText) –仅时间描述
-
date_time_place_text(DateTimePlaceText) –时间+地点描述
-
date_time_place_person_text(DateTimePlacePersonText) –时间+地点+教师描述
date_time_place_person_text
instance-attribute
¤
date_time_place_person_text: DateTimePlacePersonText
时间+地点+教师描述
ScheduleGroup
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.ScheduleGroup[ScheduleGroup]
click zzupy.model.eas.ScheduleGroup href "" "zzupy.model.eas.ScheduleGroup"
排课组,将一个教学班的多次课归入同一组
Attributes:
Building
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.Building[Building]
click zzupy.model.eas.Building href "" "zzupy.model.eas.Building"
楼栋信息
Attributes:
Room
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.Room[Room]
click zzupy.model.eas.Room href "" "zzupy.model.eas.Room"
教室信息
Attributes:
Schedule
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.Schedule[Schedule]
click zzupy.model.eas.Schedule href "" "zzupy.model.eas.Schedule"
单次课程的具体排课记录
Attributes:
-
schedule_group_id(int) –所属排课组 ID,关联 ScheduleGroup.id
-
date(Date) –上课日期,格式 "YYYY-MM-DD"
-
original_date(None | str) –原始日期
-
weekday(int) –星期几,1=周一,4=周四,7=周日
-
start_time(ZonedDateTime) –开始时间,格式 HHMM,如 1010 表示 10:10
-
end_time(ZonedDateTime) –结束时间,格式 HHMM,如 1150 表示 11:50
-
teacher_name(str) –授课教师中文姓名
-
teacher_name_en(str | None) –授课教师英文姓名
-
custom_place(None | str) –自定义上课地点
-
room(Room | None) –教室信息
-
start_unit(int) –开始节次,如 3(第3节)
-
end_unit(int) –结束节次,如 4(第4节)
-
state(str) –课程状态
-
week_index(int) –本次课所在教学周,如 1 表示第1周
-
lesson_type(str) –课时类型,如 "THEORY"(理论课)
-
periods(int) –本次课课时数,如 2
-
real_start_time(ZonedDateTime) –实际开始时间,格式同 startTime
-
real_end_time(ZonedDateTime) –实际结束时间,格式同 endTime
Datum
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.Datum[Datum]
click zzupy.model.eas.Datum href "" "zzupy.model.eas.Datum"
教学班信息,包含课程、排课等完整数据
Attributes:
-
id(int) –教学班 ID
-
biz_type_id(int) –业务类型 ID
-
campus(Campus) –开课校区
-
cultivate_type(CultivateType) –培养类型
-
code(str) –教学班编号
-
course(Course) –课程基本信息
-
remark(None | str) –备注
-
schedule_state(str) –排课状态
-
std_count(int) –选课学生人数
-
open_department(OpenDepartment) –开课院系
-
course_type(CourseType) –课程类型
-
teacher_assignment_list(list[str]) –授课教师中文姓名列表
-
teacher_assignment_en_list(list[str | None]) –授课教师英文姓名列表
-
schedule_text(ScheduleText) –排课文字描述(时间/地点/教师)
-
schedule_groups(list[ScheduleGroup]) –排课组列表
-
schedules(list[Schedule]) –每次课的具体排课记录列表
-
students(list[Any]) –学生列表
-
time_table_layout_assoc(int) –关联的课表布局 ID
-
suggest_schedule_weeks_info(None) –建议排课周信息
teacher_assignment_en_list
instance-attribute
¤
授课教师英文姓名列表
LessonModel
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.LessonModel[LessonModel]
click zzupy.model.eas.LessonModel href "" "zzupy.model.eas.LessonModel"
课程表查询 API 响应根模型
Attributes:
Lesson
¤
TeachingWeek
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.TeachingWeek[TeachingWeek]
click zzupy.model.eas.TeachingWeek href "" "zzupy.model.eas.TeachingWeek"
教学周课表,7 天 × 10 节的网格
Methods:
-
set–设置某天某节的课程
-
get–获取某天某节的课程
-
get_day–获取某天的全部课程
-
get_unit–获取某节 7 天的课程
-
to_calendar–将教学周的课表转换为符合 RFC 5545 的 Calendar 对象。
Attributes:
-
lessons(dict[tuple[int, int], Lesson]) –内部存储:仅存储非空课程,key 为 (weekday, unit),value 为 Lesson
-
grid(list[list[Lesson | None]]) –网格形式的课表,仅在访问时动态生成
lessons
class-attribute
instance-attribute
¤
内部存储:仅存储非空课程,key 为 (weekday, unit),value 为 Lesson
set
¤
设置某天某节的课程
Parameters:
Raises:
-
IndexError–如果 {weekday} 或 {unit} 超出范围
Source code in zzupy/model/eas.py
449 450 451 452 453 454 455 456 457 458 459 460 461 | |
get
¤
获取某天某节的课程
Parameters:
Returns:
-
Lesson | None–Lesson | None: 对应课程或 None
Raises:
-
IndexError–如果 {weekday} 或 {unit} 超出范围
Source code in zzupy/model/eas.py
463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 | |
get_day
¤
获取某天的全部课程
Parameters:
Returns:
Raises:
-
IndexError–如果 {weekday} 超出范围
Source code in zzupy/model/eas.py
479 480 481 482 483 484 485 486 487 488 489 490 491 492 | |
get_unit
¤
获取某节 7 天的课程
Parameters:
Returns:
Raises:
-
IndexError–如果 {unit} 超出范围
Source code in zzupy/model/eas.py
494 495 496 497 498 499 500 501 502 503 504 505 506 507 | |
to_calendar
¤
将教学周的课表转换为符合 RFC 5545 的 Calendar 对象。 可以使用以下代码将其写入 .ics 或对它做你想做的任何事
with open('my_schedule.ics', 'wb') as f:
f.write(aTeachingWeek.to_calendar().to_ical())
Parameters:
Returns:
-
Calendar–Calendar 对象。
Source code in zzupy/model/eas.py
517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 | |
TeachingWeeks
¤
Bases: RootModel
flowchart TD
zzupy.model.eas.TeachingWeeks[TeachingWeeks]
click zzupy.model.eas.TeachingWeeks href "" "zzupy.model.eas.TeachingWeeks"
Methods:
-
to_calendar–将教学周的课表转换为符合 RFC 5545 的 Calendar 对象。
to_calendar
¤
将教学周的课表转换为符合 RFC 5545 的 Calendar 对象。 可以使用以下代码将其写入 .ics 或对它做你想做的任何事
with open('my_schedule.ics', 'wb') as f:
f.write(aTeachingWeek.to_calendar().to_ical())
Parameters:
Returns:
-
Calendar–Calendar 对象。
Source code in zzupy/model/eas.py
610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 | |
Semester
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.Semester[Semester]
click zzupy.model.eas.Semester href "" "zzupy.model.eas.Semester"
单个学期
SemesterModel
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.SemesterModel[SemesterModel]
click zzupy.model.eas.SemesterModel href "" "zzupy.model.eas.SemesterModel"
获取全部学期数据 API 响应根模型
Attributes:
CurrentSemesterModel
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.CurrentSemesterModel[CurrentSemesterModel]
click zzupy.model.eas.CurrentSemesterModel href "" "zzupy.model.eas.CurrentSemesterModel"
获取当前学期数据 API 响应根模型
Attributes:
WeekIndexModel
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.WeekIndexModel[WeekIndexModel]
click zzupy.model.eas.WeekIndexModel href "" "zzupy.model.eas.WeekIndexModel"
获取某日期的教学周序数 API 响应根模型
Attributes:
ecard
¤
Classes:
-
ECardTemplate–一卡通模板项
-
ECardAccountData–一卡通账户数据
-
ECardAccountModel–一卡通账户 API 响应根模型
ECardTemplate
¤
Bases: BaseModel
flowchart TD
zzupy.model.ecard.ECardTemplate[ECardTemplate]
click zzupy.model.ecard.ECardTemplate href "" "zzupy.model.ecard.ECardTemplate"
一卡通模板项
ECardAccountData
¤
Bases: BaseModel
flowchart TD
zzupy.model.ecard.ECardAccountData[ECardAccountData]
click zzupy.model.ecard.ECardAccountData href "" "zzupy.model.ecard.ECardAccountData"
一卡通账户数据
ECardAccountModel
¤
Bases: BaseModel
flowchart TD
zzupy.model.ecard.ECardAccountModel[ECardAccountModel]
click zzupy.model.ecard.ECardAccountModel href "" "zzupy.model.ecard.ECardAccountModel"
一卡通账户 API 响应根模型
network
¤
Classes:
-
OnlineDevice–在线设备信息
-
AuthResult–Portal 认证结果
-
PortalInfo–探测出的 Portal 认证信息
OnlineDevice
¤
Bases: BaseModel
flowchart TD
zzupy.model.network.OnlineDevice[OnlineDevice]
click zzupy.model.network.OnlineDevice href "" "zzupy.model.network.OnlineDevice"
在线设备信息
Methods:
-
dump_json–格式化为JSON字符串
Attributes:
-
brasid(str) –BRAS ID
-
down_flow(str) –下行流量
-
host_name(str) –主机名
-
ip(str) –IP地址
-
login_time(str) –登录时间,格式为YYYY-MM-DD HH:MM:SS
-
mac(str) –MAC地址
-
session_id(str) –会话ID
-
terminal_type(str) –终端类型
-
up_flow(str) –上行流量
-
use_time(str) –使用时间(秒)
-
user_id(int) –用户ID
AuthResult
¤
Bases: BaseModel
flowchart TD
zzupy.model.network.AuthResult[AuthResult]
click zzupy.model.network.AuthResult href "" "zzupy.model.network.AuthResult"
Portal 认证结果
Attributes:
PortalInfo
¤
Bases: BaseModel
flowchart TD
zzupy.model.network.PortalInfo[PortalInfo]
click zzupy.model.network.PortalInfo href "" "zzupy.model.network.PortalInfo"
探测出的 Portal 认证信息
Attributes:
zzupy.model.auth¤
auth
¤
Classes:
-
PersonalInfoCardModel–‘我的’页中个人信息卡片 API 响应根模型
-
PersonalInfo–个人信息模型
-
PersonalInfoModel–个人信息 API 响应根模型
PersonalInfoCardModel
¤
Bases: BaseModel
flowchart TD
zzupy.model.auth.PersonalInfoCardModel[PersonalInfoCardModel]
click zzupy.model.auth.PersonalInfoCardModel href "" "zzupy.model.auth.PersonalInfoCardModel"
‘我的’页中个人信息卡片 API 响应根模型
Attributes:
PersonalInfo
¤
Bases: BaseModel
flowchart TD
zzupy.model.auth.PersonalInfo[PersonalInfo]
click zzupy.model.auth.PersonalInfo href "" "zzupy.model.auth.PersonalInfo"
个人信息模型
Attributes:
-
uid(str) –学号
-
name(str) –用户姓名
-
student_type(str) –学生类型。比如‘本科生’
-
student_type_id(str) –学生类型 ID
-
college(str) –学院
-
college_id(str) –学院 ID
-
unread_email_count(int) –邮箱未读邮件数
-
balance(float) –一卡通余额
-
research_count(int) –科研信息数量
PersonalInfoModel
¤
Bases: BaseModel
flowchart TD
zzupy.model.auth.PersonalInfoModel[PersonalInfoModel]
click zzupy.model.auth.PersonalInfoModel href "" "zzupy.model.auth.PersonalInfoModel"
个人信息 API 响应根模型
Classes:
-
Data–
Data
¤
Bases: BaseModel
flowchart TD
zzupy.model.auth.PersonalInfoModel.Data[Data]
click zzupy.model.auth.PersonalInfoModel.Data href "" "zzupy.model.auth.PersonalInfoModel.Data"
Classes:
Attributes:
Attributes
¤
Bases: BaseModel
flowchart TD
zzupy.model.auth.PersonalInfoModel.Data.Attributes[Attributes]
click zzupy.model.auth.PersonalInfoModel.Data.Attributes href "" "zzupy.model.auth.PersonalInfoModel.Data.Attributes"
Attributes:
-
organization_id(str) –学院 ID
-
organization_name(str) –学院名
-
identity_type_name(str) –学生类型
-
identity_type_id(str) –学生类型 ID
-
user_name(str) –学生姓名
-
user_uid(str) –学号
zzupy.model.eas¤
eas
¤
Classes:
-
Campus–校区信息
-
CultivateType–培养类型,如主修、辅修等
-
PeriodInfo–课时详情,描述一门课程各类学时的分配情况
-
Course–课程基本信息
-
OpenDepartment–开课院系
-
CourseType–课程类型,如必修课、选修课等
-
DateTimeText–上课时间的文字描述
-
DateTimePlaceText–上课时间与地点的文字描述,如「1~16周 星期四 3~4节 主校区 北3_111」
-
DateTimePlacePersonText–上课时间、地点与教师的文字描述,如「1~16周 星期四 3~4节 主校区 北3_111 王艳玲」
-
ScheduleText–教学班排课的综合文字描述,聚合了三个层次的描述信息
-
ScheduleGroup–排课组,将一个教学班的多次课归入同一组
-
Building–楼栋信息
-
Room–教室信息
-
Schedule–单次课程的具体排课记录
-
Datum–教学班信息,包含课程、排课等完整数据
-
LessonModel–课程表查询 API 响应根模型
-
Lesson–课表中的一节课
-
TeachingWeek–教学周课表,7 天 × 10 节的网格
-
TeachingWeeks– -
Semester–单个学期
-
SemesterModel–获取全部学期数据 API 响应根模型
-
CurrentSemesterModel–获取当前学期数据 API 响应根模型
-
WeekIndexModel–获取某日期的教学周序数 API 响应根模型
Campus
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.Campus[Campus]
click zzupy.model.eas.Campus href "" "zzupy.model.eas.Campus"
校区信息
Attributes:
CultivateType
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.CultivateType[CultivateType]
click zzupy.model.eas.CultivateType href "" "zzupy.model.eas.CultivateType"
培养类型,如主修、辅修等
Attributes:
PeriodInfo
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.PeriodInfo[PeriodInfo]
click zzupy.model.eas.PeriodInfo href "" "zzupy.model.eas.PeriodInfo"
课时详情,描述一门课程各类学时的分配情况
Attributes:
-
total(int) –总学时
-
weeks(int) –开课周数
-
theory(int | None) –理论学时数
-
theory_unit(str | None) –理论学时单位
-
require_theory(int | None) –要求完成的理论学时数
-
experiment(int | None) –实验学时数
-
experiment_unit(str | None) –实验学时单位
-
require_experiment(int | None) –要求完成的实验学时数
-
periods_per_week(int) –每周课时数
Course
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.Course[Course]
click zzupy.model.eas.Course href "" "zzupy.model.eas.Course"
课程基本信息
Attributes:
-
code(str) –课程编号
-
name_zh(str) –课程中文名
-
name_en(str | None) –课程英文名
-
credits(float) –学分
-
period_info(PeriodInfo) –课时详情
-
theory(bool) –是否含理论课
-
experiment(bool) –是否含实验课
-
practice(bool) –是否含实践课
-
test(bool) –是否含考试课时
-
machine(bool) –是否含上机课
-
design(bool) –是否含设计课
-
extra(bool) –是否含其他课时类型
OpenDepartment
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.OpenDepartment[OpenDepartment]
click zzupy.model.eas.OpenDepartment href "" "zzupy.model.eas.OpenDepartment"
开课院系
Attributes:
CourseType
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.CourseType[CourseType]
click zzupy.model.eas.CourseType href "" "zzupy.model.eas.CourseType"
课程类型,如必修课、选修课等
Attributes:
DateTimeText
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.DateTimeText[DateTimeText]
click zzupy.model.eas.DateTimeText href "" "zzupy.model.eas.DateTimeText"
上课时间的文字描述
Attributes:
DateTimePlaceText
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.DateTimePlaceText[DateTimePlaceText]
click zzupy.model.eas.DateTimePlaceText href "" "zzupy.model.eas.DateTimePlaceText"
上课时间与地点的文字描述,如「1~16周 星期四 3~4节 主校区 北3_111」
Attributes:
DateTimePlacePersonText
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.DateTimePlacePersonText[DateTimePlacePersonText]
click zzupy.model.eas.DateTimePlacePersonText href "" "zzupy.model.eas.DateTimePlacePersonText"
上课时间、地点与教师的文字描述,如「1~16周 星期四 3~4节 主校区 北3_111 王艳玲」
Attributes:
ScheduleText
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.ScheduleText[ScheduleText]
click zzupy.model.eas.ScheduleText href "" "zzupy.model.eas.ScheduleText"
教学班排课的综合文字描述,聚合了三个层次的描述信息
Attributes:
-
date_time_text(DateTimeText) –仅时间描述
-
date_time_place_text(DateTimePlaceText) –时间+地点描述
-
date_time_place_person_text(DateTimePlacePersonText) –时间+地点+教师描述
date_time_place_person_text
instance-attribute
¤
date_time_place_person_text: DateTimePlacePersonText
时间+地点+教师描述
ScheduleGroup
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.ScheduleGroup[ScheduleGroup]
click zzupy.model.eas.ScheduleGroup href "" "zzupy.model.eas.ScheduleGroup"
排课组,将一个教学班的多次课归入同一组
Attributes:
Building
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.Building[Building]
click zzupy.model.eas.Building href "" "zzupy.model.eas.Building"
楼栋信息
Attributes:
Room
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.Room[Room]
click zzupy.model.eas.Room href "" "zzupy.model.eas.Room"
教室信息
Attributes:
Schedule
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.Schedule[Schedule]
click zzupy.model.eas.Schedule href "" "zzupy.model.eas.Schedule"
单次课程的具体排课记录
Attributes:
-
schedule_group_id(int) –所属排课组 ID,关联 ScheduleGroup.id
-
date(Date) –上课日期,格式 "YYYY-MM-DD"
-
original_date(None | str) –原始日期
-
weekday(int) –星期几,1=周一,4=周四,7=周日
-
start_time(ZonedDateTime) –开始时间,格式 HHMM,如 1010 表示 10:10
-
end_time(ZonedDateTime) –结束时间,格式 HHMM,如 1150 表示 11:50
-
teacher_name(str) –授课教师中文姓名
-
teacher_name_en(str | None) –授课教师英文姓名
-
custom_place(None | str) –自定义上课地点
-
room(Room | None) –教室信息
-
start_unit(int) –开始节次,如 3(第3节)
-
end_unit(int) –结束节次,如 4(第4节)
-
state(str) –课程状态
-
week_index(int) –本次课所在教学周,如 1 表示第1周
-
lesson_type(str) –课时类型,如 "THEORY"(理论课)
-
periods(int) –本次课课时数,如 2
-
real_start_time(ZonedDateTime) –实际开始时间,格式同 startTime
-
real_end_time(ZonedDateTime) –实际结束时间,格式同 endTime
Datum
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.Datum[Datum]
click zzupy.model.eas.Datum href "" "zzupy.model.eas.Datum"
教学班信息,包含课程、排课等完整数据
Attributes:
-
id(int) –教学班 ID
-
biz_type_id(int) –业务类型 ID
-
campus(Campus) –开课校区
-
cultivate_type(CultivateType) –培养类型
-
code(str) –教学班编号
-
course(Course) –课程基本信息
-
remark(None | str) –备注
-
schedule_state(str) –排课状态
-
std_count(int) –选课学生人数
-
open_department(OpenDepartment) –开课院系
-
course_type(CourseType) –课程类型
-
teacher_assignment_list(list[str]) –授课教师中文姓名列表
-
teacher_assignment_en_list(list[str | None]) –授课教师英文姓名列表
-
schedule_text(ScheduleText) –排课文字描述(时间/地点/教师)
-
schedule_groups(list[ScheduleGroup]) –排课组列表
-
schedules(list[Schedule]) –每次课的具体排课记录列表
-
students(list[Any]) –学生列表
-
time_table_layout_assoc(int) –关联的课表布局 ID
-
suggest_schedule_weeks_info(None) –建议排课周信息
teacher_assignment_en_list
instance-attribute
¤
授课教师英文姓名列表
LessonModel
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.LessonModel[LessonModel]
click zzupy.model.eas.LessonModel href "" "zzupy.model.eas.LessonModel"
课程表查询 API 响应根模型
Attributes:
Lesson
¤
TeachingWeek
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.TeachingWeek[TeachingWeek]
click zzupy.model.eas.TeachingWeek href "" "zzupy.model.eas.TeachingWeek"
教学周课表,7 天 × 10 节的网格
Methods:
-
set–设置某天某节的课程
-
get–获取某天某节的课程
-
get_day–获取某天的全部课程
-
get_unit–获取某节 7 天的课程
-
to_calendar–将教学周的课表转换为符合 RFC 5545 的 Calendar 对象。
Attributes:
-
lessons(dict[tuple[int, int], Lesson]) –内部存储:仅存储非空课程,key 为 (weekday, unit),value 为 Lesson
-
grid(list[list[Lesson | None]]) –网格形式的课表,仅在访问时动态生成
lessons
class-attribute
instance-attribute
¤
内部存储:仅存储非空课程,key 为 (weekday, unit),value 为 Lesson
set
¤
设置某天某节的课程
Parameters:
Raises:
-
IndexError–如果 {weekday} 或 {unit} 超出范围
Source code in zzupy/model/eas.py
449 450 451 452 453 454 455 456 457 458 459 460 461 | |
get
¤
获取某天某节的课程
Parameters:
Returns:
-
Lesson | None–Lesson | None: 对应课程或 None
Raises:
-
IndexError–如果 {weekday} 或 {unit} 超出范围
Source code in zzupy/model/eas.py
463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 | |
get_day
¤
获取某天的全部课程
Parameters:
Returns:
Raises:
-
IndexError–如果 {weekday} 超出范围
Source code in zzupy/model/eas.py
479 480 481 482 483 484 485 486 487 488 489 490 491 492 | |
get_unit
¤
获取某节 7 天的课程
Parameters:
Returns:
Raises:
-
IndexError–如果 {unit} 超出范围
Source code in zzupy/model/eas.py
494 495 496 497 498 499 500 501 502 503 504 505 506 507 | |
to_calendar
¤
将教学周的课表转换为符合 RFC 5545 的 Calendar 对象。 可以使用以下代码将其写入 .ics 或对它做你想做的任何事
with open('my_schedule.ics', 'wb') as f:
f.write(aTeachingWeek.to_calendar().to_ical())
Parameters:
Returns:
-
Calendar–Calendar 对象。
Source code in zzupy/model/eas.py
517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 | |
TeachingWeeks
¤
Bases: RootModel
flowchart TD
zzupy.model.eas.TeachingWeeks[TeachingWeeks]
click zzupy.model.eas.TeachingWeeks href "" "zzupy.model.eas.TeachingWeeks"
Methods:
-
to_calendar–将教学周的课表转换为符合 RFC 5545 的 Calendar 对象。
to_calendar
¤
将教学周的课表转换为符合 RFC 5545 的 Calendar 对象。 可以使用以下代码将其写入 .ics 或对它做你想做的任何事
with open('my_schedule.ics', 'wb') as f:
f.write(aTeachingWeek.to_calendar().to_ical())
Parameters:
Returns:
-
Calendar–Calendar 对象。
Source code in zzupy/model/eas.py
610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 | |
Semester
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.Semester[Semester]
click zzupy.model.eas.Semester href "" "zzupy.model.eas.Semester"
单个学期
SemesterModel
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.SemesterModel[SemesterModel]
click zzupy.model.eas.SemesterModel href "" "zzupy.model.eas.SemesterModel"
获取全部学期数据 API 响应根模型
Attributes:
CurrentSemesterModel
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.CurrentSemesterModel[CurrentSemesterModel]
click zzupy.model.eas.CurrentSemesterModel href "" "zzupy.model.eas.CurrentSemesterModel"
获取当前学期数据 API 响应根模型
Attributes:
WeekIndexModel
¤
Bases: BaseModel
flowchart TD
zzupy.model.eas.WeekIndexModel[WeekIndexModel]
click zzupy.model.eas.WeekIndexModel href "" "zzupy.model.eas.WeekIndexModel"
获取某日期的教学周序数 API 响应根模型
Attributes:
zzupy.model.ecard¤
ecard
¤
Classes:
-
ECardTemplate–一卡通模板项
-
ECardAccountData–一卡通账户数据
-
ECardAccountModel–一卡通账户 API 响应根模型
ECardTemplate
¤
Bases: BaseModel
flowchart TD
zzupy.model.ecard.ECardTemplate[ECardTemplate]
click zzupy.model.ecard.ECardTemplate href "" "zzupy.model.ecard.ECardTemplate"
一卡通模板项
ECardAccountData
¤
Bases: BaseModel
flowchart TD
zzupy.model.ecard.ECardAccountData[ECardAccountData]
click zzupy.model.ecard.ECardAccountData href "" "zzupy.model.ecard.ECardAccountData"
一卡通账户数据
ECardAccountModel
¤
Bases: BaseModel
flowchart TD
zzupy.model.ecard.ECardAccountModel[ECardAccountModel]
click zzupy.model.ecard.ECardAccountModel href "" "zzupy.model.ecard.ECardAccountModel"
一卡通账户 API 响应根模型
zzupy.model.network¤
network
¤
Classes:
-
OnlineDevice–在线设备信息
-
AuthResult–Portal 认证结果
-
PortalInfo–探测出的 Portal 认证信息
Functions:
OnlineDevice
¤
Bases: BaseModel
flowchart TD
zzupy.model.network.OnlineDevice[OnlineDevice]
click zzupy.model.network.OnlineDevice href "" "zzupy.model.network.OnlineDevice"
在线设备信息
Methods:
-
dump_json–格式化为JSON字符串
Attributes:
-
brasid(str) –BRAS ID
-
down_flow(str) –下行流量
-
host_name(str) –主机名
-
ip(str) –IP地址
-
login_time(str) –登录时间,格式为YYYY-MM-DD HH:MM:SS
-
mac(str) –MAC地址
-
session_id(str) –会话ID
-
terminal_type(str) –终端类型
-
up_flow(str) –上行流量
-
use_time(str) –使用时间(秒)
-
user_id(int) –用户ID
AuthResult
¤
Bases: BaseModel
flowchart TD
zzupy.model.network.AuthResult[AuthResult]
click zzupy.model.network.AuthResult href "" "zzupy.model.network.AuthResult"
Portal 认证结果
Attributes:
PortalInfo
¤
Bases: BaseModel
flowchart TD
zzupy.model.network.PortalInfo[PortalInfo]
click zzupy.model.network.PortalInfo href "" "zzupy.model.network.PortalInfo"
探测出的 Portal 认证信息
Attributes:
zzupy.utils¤
utils
¤
工具函数库
Classes:
-
NotLoggedInError–在未登录状态下调用了需要登录的方法。
-
_FirstHtmlAttributeParser– -
XorCipher–一个使用异或 (XOR) 算法进行简单加密和解密的类。
-
JsonPParser–JsonP 格式数据解析器
Functions:
-
_decode_jwt_segment–解码经过 Base64URL 编码的 JWT 片段。
-
decode_jwt_payload–在不验证签名的情况下解析 JWT payload。
-
get_jwt_expiration–读取 JWT 的过期时间。
-
extract_first_html_attr–提取第一个匹配 HTML 标签的属性值。
-
get_sign–获取sign值
-
pkcs7_unpad–去除数据中的PKCS#7填充。
-
sm4_decrypt_ecb–SM4 解密,ECB模式
-
get_local_ip–获取用于连接到特定目标IP的本地IP地址。
-
require_auth–装饰器:确保调用方法前已登录
Attributes:
NotLoggedInError
¤
NotLoggedInError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: ClientStateError
flowchart TD
zzupy.utils.NotLoggedInError[NotLoggedInError]
zzupy.exception.ClientStateError[ClientStateError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.ClientStateError --> zzupy.utils.NotLoggedInError
zzupy.exception.ZZUError --> zzupy.exception.ClientStateError
click zzupy.utils.NotLoggedInError href "" "zzupy.utils.NotLoggedInError"
click zzupy.exception.ClientStateError href "" "zzupy.exception.ClientStateError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
在未登录状态下调用了需要登录的方法。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
_FirstHtmlAttributeParser
¤
Bases: HTMLParser
flowchart TD
zzupy.utils._FirstHtmlAttributeParser[_FirstHtmlAttributeParser]
click zzupy.utils._FirstHtmlAttributeParser href "" "zzupy.utils._FirstHtmlAttributeParser"
Source code in zzupy/utils.py
84 85 86 87 88 89 90 91 92 93 94 95 96 97 | |
XorCipher
¤
XorCipher(key_string: str = '')
一个使用异或 (XOR) 算法进行简单加密和解密的类。
Methods:
Source code in zzupy/utils.py
223 224 | |
encrypt
¤
将明文与实例密钥进行异或运算,并转为十六进制字符串。
Parameters:
Source code in zzupy/utils.py
238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 | |
decrypt
¤
decrypt(hex_string: str) -> str
将十六进制字符串解密回原始密码。
Parameters:
Raises:
-
ValueError–如果十六进制字符串格式错误
Source code in zzupy/utils.py
255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 | |
JsonPParser
¤
JsonPParser(text: str)
JsonP 格式数据解析器
Source code in zzupy/utils.py
283 284 285 286 287 | |
_decode_jwt_segment
¤
解码经过 Base64URL 编码的 JWT 片段。
Source code in zzupy/utils.py
22 23 24 25 26 27 28 | |
decode_jwt_payload
¤
在不验证签名的情况下解析 JWT payload。
该函数只用于读取 CAS Token 的过期时间,不应作为 Token 身份验证手段。
Parameters:
Returns:
Raises:
-
ValueError–如果 Token 过长、结构无效或 JSON 内容不正确。
Source code in zzupy/utils.py
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 | |
get_jwt_expiration
¤
读取 JWT 的过期时间。
Parameters:
Returns:
-
datetime–JWT
exp对应的本地时间。
Raises:
-
ValueError–如果 Token 无效或缺少有效的
exp。
Source code in zzupy/utils.py
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 | |
extract_first_html_attr
¤
extract_first_html_attr(html_content: str, tag: str, attr: str, match_attrs: dict[str, str] | None = None) -> str | None
提取第一个匹配 HTML 标签的属性值。
Source code in zzupy/utils.py
111 112 113 114 115 116 117 118 119 120 121 | |
get_sign
¤
get_sign(dynamic_secret: str, params: str) -> str
获取sign值
Parameters:
Returns:
-
str(str) –sign 值
Source code in zzupy/utils.py
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 | |
pkcs7_unpad
¤
pkcs7_unpad(padded_data: bytes, block_size: int) -> bytes
去除数据中的PKCS#7填充。
Parameters:
Returns:
-
bytes(bytes) –去除填充后的数据
Raises:
-
ValueError–如果填充无效
Source code in zzupy/utils.py
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 | |
sm4_decrypt_ecb
¤
sm4_decrypt_ecb(ciphertext: bytes, key: bytes) -> str
SM4 解密,ECB模式
Parameters:
Returns:
-
str–明文 Hex
Source code in zzupy/utils.py
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 | |
get_local_ip
¤
获取用于连接到特定目标IP的本地IP地址。
Parameters:
Returns:
Source code in zzupy/utils.py
200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 | |
require_auth
¤
require_auth(func)
装饰器:确保调用方法前已登录
Raises:
-
NotLoggedInError–如果未登录
Source code in zzupy/utils.py
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 | |
zzupy.web¤
web
¤
Web API 客户端模块
Modules:
-
network–校园网模块
Classes:
-
EPortalClient–Portal 认证客户端 / 校园网认证客户端
-
SelfServiceSystem–自助服务系统
Functions:
-
discover_portal_info–自动发现校园网Portal认证信息
Attributes:
-
__all__–
EPortalClient
¤
EPortalClient(base_url: str, bind_address: str | None = None, force_bind: bool = False)
Portal 认证客户端 / 校园网认证客户端
Parameters:
-
(base_url¤str) –Portal 服务器的 Base URL
-
(bind_address¤str | None, default:None) –绑定的本地 IP
-
(force_bind¤bool, default:False) –即便 IP 绑定失败也在请求参数中使用该 IP。
如果你在路由器后使用本方法,则需要把
bind_address填写为路由器分配的内网 IP 并启用force_bind
Methods:
-
portal_auth–auth()的底层实现,允许完全自定义账户 -
auth–进行 Portal 认证
Source code in zzupy/web/network.py
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 | |
portal_auth
¤
auth() 的底层实现,允许完全自定义账户
Parameters:
Returns:
-
AuthResult(AuthResult) –认证结果
Raises:
-
ParsingError–如果无法解析 API 响应。
-
NetworkError–如果发生网络错误。
Source code in zzupy/web/network.py
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 | |
auth
¤
auth(account: str, password: str, isp_suffix: str | None = None, encrypt: bool = False) -> AuthResult
进行 Portal 认证
Parameters:
-
(account¤str) –账户
-
(password¤str) –密码
-
(isp_suffix¤str | None, default:None) –运营商后缀
-
(encrypt¤bool, default:False) –是否启用加密
Returns:
-
AuthResult(AuthResult) –认证结果
Source code in zzupy/web/network.py
268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 | |
SelfServiceSystem
¤
SelfServiceSystem(base_url: str)
自助服务系统
Methods:
-
login–登录
-
get_online_devices–获取当前在线设备
-
kick_device–将设备踢下线
-
logout–登出
Source code in zzupy/web/network.py
292 293 294 | |
login
¤
登录
Parameters:
Raises:
-
LoginError–如果登录失败。
-
ParsingError–如果无法解析登录页面。
-
NetworkError–如果发生网络错误。
Source code in zzupy/web/network.py
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 | |
get_online_devices
¤
get_online_devices() -> List[OnlineDevice]
获取当前在线设备
Returns:
-
List[OnlineDevice]–List[OnlineDevice]: 在线设备列表
Raises:
-
NotLoggedInError–如果未登录。
-
ParsingError–如果无法解析 API 返回数据。
-
NetworkError–如果发生网络错误。
Source code in zzupy/web/network.py
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 | |
kick_device
¤
kick_device(session_id: str) -> None
将设备踢下线
Parameters:
Raises:
-
NotLoggedInError–如果未登录
Source code in zzupy/web/network.py
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 | |
logout
¤
logout() -> None
登出
Raises:
-
NotLoggedInError–如果未登录
Source code in zzupy/web/network.py
434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 | |
discover_portal_info
¤
discover_portal_info() -> PortalInfo
自动发现校园网Portal认证信息
Returns:
-
PortalInfo(PortalInfo) –Portal信息
Raises:
-
NetworkError–如果网络错误,或当前环境无法检测到 Portal 信息
-
ParsingError–如果响应格式异常
Source code in zzupy/web/network.py
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 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 | |
network
¤
校园网模块
Classes:
-
EPortalClient–Portal 认证客户端 / 校园网认证客户端
-
SelfServiceSystem–自助服务系统
Functions:
-
discover_portal_info–自动发现校园网Portal认证信息
EPortalClient
¤
EPortalClient(base_url: str, bind_address: str | None = None, force_bind: bool = False)
Portal 认证客户端 / 校园网认证客户端
Parameters:
-
(base_url¤str) –Portal 服务器的 Base URL
-
(bind_address¤str | None, default:None) –绑定的本地 IP
-
(force_bind¤bool, default:False) –即便 IP 绑定失败也在请求参数中使用该 IP。
如果你在路由器后使用本方法,则需要把
bind_address填写为路由器分配的内网 IP 并启用force_bind
Methods:
-
portal_auth–auth()的底层实现,允许完全自定义账户 -
auth–进行 Portal 认证
Source code in zzupy/web/network.py
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 | |
portal_auth
¤
auth() 的底层实现,允许完全自定义账户
Parameters:
Returns:
-
AuthResult(AuthResult) –认证结果
Raises:
-
ParsingError–如果无法解析 API 响应。
-
NetworkError–如果发生网络错误。
Source code in zzupy/web/network.py
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 | |
auth
¤
auth(account: str, password: str, isp_suffix: str | None = None, encrypt: bool = False) -> AuthResult
进行 Portal 认证
Parameters:
-
(account¤str) –账户
-
(password¤str) –密码
-
(isp_suffix¤str | None, default:None) –运营商后缀
-
(encrypt¤bool, default:False) –是否启用加密
Returns:
-
AuthResult(AuthResult) –认证结果
Source code in zzupy/web/network.py
268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 | |
SelfServiceSystem
¤
SelfServiceSystem(base_url: str)
自助服务系统
Methods:
-
login–登录
-
get_online_devices–获取当前在线设备
-
kick_device–将设备踢下线
-
logout–登出
Source code in zzupy/web/network.py
292 293 294 | |
login
¤
登录
Parameters:
Raises:
-
LoginError–如果登录失败。
-
ParsingError–如果无法解析登录页面。
-
NetworkError–如果发生网络错误。
Source code in zzupy/web/network.py
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 | |
get_online_devices
¤
get_online_devices() -> List[OnlineDevice]
获取当前在线设备
Returns:
-
List[OnlineDevice]–List[OnlineDevice]: 在线设备列表
Raises:
-
NotLoggedInError–如果未登录。
-
ParsingError–如果无法解析 API 返回数据。
-
NetworkError–如果发生网络错误。
Source code in zzupy/web/network.py
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 | |
kick_device
¤
kick_device(session_id: str) -> None
将设备踢下线
Parameters:
Raises:
-
NotLoggedInError–如果未登录
Source code in zzupy/web/network.py
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 | |
logout
¤
logout() -> None
登出
Raises:
-
NotLoggedInError–如果未登录
Source code in zzupy/web/network.py
434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 | |
discover_portal_info
¤
discover_portal_info() -> PortalInfo
自动发现校园网Portal认证信息
Returns:
-
PortalInfo(PortalInfo) –Portal信息
Raises:
-
NetworkError–如果网络错误,或当前环境无法检测到 Portal 信息
-
ParsingError–如果响应格式异常
Source code in zzupy/web/network.py
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 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 | |
zzupy.web.network¤
network
¤
校园网模块
Classes:
-
LoginError–登录失败。
-
NetworkError–网络请求失败或网络环境异常。
-
OperationError–服务端接受请求但业务处理失败。
-
ParsingError–响应解析或数据校验失败。
-
ZZUError–项目异常基类。
-
AuthResult–Portal 认证结果
-
OnlineDevice–在线设备信息
-
PortalInfo–探测出的 Portal 认证信息
-
JsonPParser–JsonP 格式数据解析器
-
XorCipher–一个使用异或 (XOR) 算法进行简单加密和解密的类。
-
EPortalClient–Portal 认证客户端 / 校园网认证客户端
-
SelfServiceSystem–自助服务系统
Functions:
-
extract_first_html_attr–提取第一个匹配 HTML 标签的属性值。
-
get_local_ip–获取用于连接到特定目标IP的本地IP地址。
-
require_auth–装饰器:确保调用方法前已登录
-
discover_portal_info–自动发现校园网Portal认证信息
Attributes:
-
logger–
LoginError
¤
LoginError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: ZZUError
flowchart TD
zzupy.web.network.LoginError[LoginError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.ZZUError --> zzupy.web.network.LoginError
click zzupy.web.network.LoginError href "" "zzupy.web.network.LoginError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
登录失败。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
NetworkError
¤
NetworkError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: ZZUError
flowchart TD
zzupy.web.network.NetworkError[NetworkError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.ZZUError --> zzupy.web.network.NetworkError
click zzupy.web.network.NetworkError href "" "zzupy.web.network.NetworkError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
网络请求失败或网络环境异常。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
OperationError
¤
OperationError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: ZZUError
flowchart TD
zzupy.web.network.OperationError[OperationError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.ZZUError --> zzupy.web.network.OperationError
click zzupy.web.network.OperationError href "" "zzupy.web.network.OperationError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
服务端接受请求但业务处理失败。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
ParsingError
¤
ParsingError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: ZZUError
flowchart TD
zzupy.web.network.ParsingError[ParsingError]
zzupy.exception.ZZUError[ZZUError]
zzupy.exception.ZZUError --> zzupy.web.network.ParsingError
click zzupy.web.network.ParsingError href "" "zzupy.web.network.ParsingError"
click zzupy.exception.ZZUError href "" "zzupy.exception.ZZUError"
响应解析或数据校验失败。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
ZZUError
¤
ZZUError(message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None)
Bases: Exception
flowchart TD
zzupy.web.network.ZZUError[ZZUError]
click zzupy.web.network.ZZUError href "" "zzupy.web.network.ZZUError"
项目异常基类。
除了人类可读的错误消息外,还会保留额外上下文,便于调用方记录日志、 序列化或调试。
Parameters:
-
(message¤str | None, default:None) –错误消息。
-
(context¤Mapping[str, Any] | None, default:None) –结构化上下文信息。
-
(error_code¤str | None, default:None) –可选错误代码。
Methods:
-
to_dict–将异常转换为便于日志记录或序列化的字典。
-
from_exception–基于底层异常构造项目异常。
-
from_http_status–基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
24 25 26 27 28 29 30 31 32 33 34 | |
to_dict
¤
将异常转换为便于日志记录或序列化的字典。
Source code in zzupy/exception.py
45 46 47 48 49 50 51 52 53 54 55 56 | |
from_exception
classmethod
¤
from_exception(exc: Exception, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于底层异常构造项目异常。
Source code in zzupy/exception.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
from_http_status
classmethod
¤
from_http_status(exc: HTTPStatusError, message: str | None = None, *, context: Mapping[str, Any] | None = None, error_code: str | None = None) -> Self
基于 HTTP 状态错误构造项目异常。
Source code in zzupy/exception.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
AuthResult
¤
Bases: BaseModel
flowchart TD
zzupy.web.network.AuthResult[AuthResult]
click zzupy.web.network.AuthResult href "" "zzupy.web.network.AuthResult"
Portal 认证结果
Attributes:
OnlineDevice
¤
Bases: BaseModel
flowchart TD
zzupy.web.network.OnlineDevice[OnlineDevice]
click zzupy.web.network.OnlineDevice href "" "zzupy.web.network.OnlineDevice"
在线设备信息
Methods:
-
dump_json–格式化为JSON字符串
Attributes:
-
brasid(str) –BRAS ID
-
down_flow(str) –下行流量
-
host_name(str) –主机名
-
ip(str) –IP地址
-
login_time(str) –登录时间,格式为YYYY-MM-DD HH:MM:SS
-
mac(str) –MAC地址
-
session_id(str) –会话ID
-
terminal_type(str) –终端类型
-
up_flow(str) –上行流量
-
use_time(str) –使用时间(秒)
-
user_id(int) –用户ID
PortalInfo
¤
Bases: BaseModel
flowchart TD
zzupy.web.network.PortalInfo[PortalInfo]
click zzupy.web.network.PortalInfo href "" "zzupy.web.network.PortalInfo"
探测出的 Portal 认证信息
Attributes:
JsonPParser
¤
JsonPParser(text: str)
JsonP 格式数据解析器
Source code in zzupy/utils.py
283 284 285 286 287 | |
XorCipher
¤
XorCipher(key_string: str = '')
一个使用异或 (XOR) 算法进行简单加密和解密的类。
Methods:
Source code in zzupy/utils.py
223 224 | |
encrypt
¤
将明文与实例密钥进行异或运算,并转为十六进制字符串。
Parameters:
Source code in zzupy/utils.py
238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 | |
decrypt
¤
decrypt(hex_string: str) -> str
将十六进制字符串解密回原始密码。
Parameters:
Raises:
-
ValueError–如果十六进制字符串格式错误
Source code in zzupy/utils.py
255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 | |
EPortalClient
¤
EPortalClient(base_url: str, bind_address: str | None = None, force_bind: bool = False)
Portal 认证客户端 / 校园网认证客户端
Parameters:
-
(base_url¤str) –Portal 服务器的 Base URL
-
(bind_address¤str | None, default:None) –绑定的本地 IP
-
(force_bind¤bool, default:False) –即便 IP 绑定失败也在请求参数中使用该 IP。
如果你在路由器后使用本方法,则需要把
bind_address填写为路由器分配的内网 IP 并启用force_bind
Methods:
-
portal_auth–auth()的底层实现,允许完全自定义账户 -
auth–进行 Portal 认证
Source code in zzupy/web/network.py
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 | |
portal_auth
¤
auth() 的底层实现,允许完全自定义账户
Parameters:
Returns:
-
AuthResult(AuthResult) –认证结果
Raises:
-
ParsingError–如果无法解析 API 响应。
-
NetworkError–如果发生网络错误。
Source code in zzupy/web/network.py
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 | |
auth
¤
auth(account: str, password: str, isp_suffix: str | None = None, encrypt: bool = False) -> AuthResult
进行 Portal 认证
Parameters:
-
(account¤str) –账户
-
(password¤str) –密码
-
(isp_suffix¤str | None, default:None) –运营商后缀
-
(encrypt¤bool, default:False) –是否启用加密
Returns:
-
AuthResult(AuthResult) –认证结果
Source code in zzupy/web/network.py
268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 | |
SelfServiceSystem
¤
SelfServiceSystem(base_url: str)
自助服务系统
Methods:
-
login–登录
-
get_online_devices–获取当前在线设备
-
kick_device–将设备踢下线
-
logout–登出
Source code in zzupy/web/network.py
292 293 294 | |
login
¤
登录
Parameters:
Raises:
-
LoginError–如果登录失败。
-
ParsingError–如果无法解析登录页面。
-
NetworkError–如果发生网络错误。
Source code in zzupy/web/network.py
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 | |
get_online_devices
¤
get_online_devices() -> List[OnlineDevice]
获取当前在线设备
Returns:
-
List[OnlineDevice]–List[OnlineDevice]: 在线设备列表
Raises:
-
NotLoggedInError–如果未登录。
-
ParsingError–如果无法解析 API 返回数据。
-
NetworkError–如果发生网络错误。
Source code in zzupy/web/network.py
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 | |
kick_device
¤
kick_device(session_id: str) -> None
将设备踢下线
Parameters:
Raises:
-
NotLoggedInError–如果未登录
Source code in zzupy/web/network.py
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 | |
logout
¤
logout() -> None
登出
Raises:
-
NotLoggedInError–如果未登录
Source code in zzupy/web/network.py
434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 | |
extract_first_html_attr
¤
extract_first_html_attr(html_content: str, tag: str, attr: str, match_attrs: dict[str, str] | None = None) -> str | None
提取第一个匹配 HTML 标签的属性值。
Source code in zzupy/utils.py
111 112 113 114 115 116 117 118 119 120 121 | |
get_local_ip
¤
获取用于连接到特定目标IP的本地IP地址。
Parameters:
Returns:
Source code in zzupy/utils.py
200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 | |
require_auth
¤
require_auth(func)
装饰器:确保调用方法前已登录
Raises:
-
NotLoggedInError–如果未登录
Source code in zzupy/utils.py
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 | |
discover_portal_info
¤
discover_portal_info() -> PortalInfo
自动发现校园网Portal认证信息
Returns:
-
PortalInfo(PortalInfo) –Portal信息
Raises:
-
NetworkError–如果网络错误,或当前环境无法检测到 Portal 信息
-
ParsingError–如果响应格式异常
Source code in zzupy/web/network.py
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 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 | |