scu-api 0.0.1

An api provide for Sichuan University

scu-api

提供与四川大学相关的信息接口

Usage

获取本科生用户U_Student实例:

import scu_api

my_student = scu_api.get_u_student()

U_Student内置方法(目前为止)：

@abstractmethod
def set_baseinfo(self, stid: str, passwd: str, hashed: bool = False):
    '''
    @stid(str)    学号
    @passwd(str)  密码
    @hashed(bool) 密码是否已经过md5加密 default=False
    '''

@abstractmethod
def session_valid(self) -> bool:
    '''
    @brief 返回网站会话是否有效，在有效的情况下才可以获取个人信息
            如果session过期，则需要获取验证码重新登陆
    @param[out] valid(bool)  网站会话是否有效
    '''

@abstractmethod
def get_captcha(self, filepath: str = None) -> Tuple[bool, str]:
    '''
    @brief 获取验证码
    @param[in]  filepath(str)  [可选的] 存储验证码图像的全路径，使用**.jpg**格式
    @param[out] success(bool)  操作是否成功
    @param[out] str(bool)      验证码图像base64编码
    '''

@abstractmethod
def login(self, catpcha: str, remember_me: bool) -> Tuple[bool, ]:
    '''
    @brief 模拟登陆
    @param[in] captcha(str) 通过get_captcha获取的验证码识别后的字符串
    @param[in] remember_me(bool) 是否开启两周内快速登录
    @param[out] success(bool) 是否登录成功
    '''

@abstractmethod
def get_student_name(self) -> Tuple[bool, str]:
    '''
    @brief 获取学生姓名
    @param[out] success(bool) 是否获取成功
    @param[out] student_name(str) 学生姓名/失败反馈内容
    '''

@abstractmethod
def get_student_pic(self, filepath: str = None) -> Tuple[bool, str]:
    '''
    @brief 获取学生照片
    @param[in]  filepath(str) 存储图片的全路径，使用**.jpg**格式
    @param[out] success(bool) 是否获取成功
    @param[out] student_pic(str) 图片的base64编码
    '''

@session_valid_required
@abstractmethod
def get_all_term_scores(self, pagesize: int = -1) -> dict:
    '''
    @brief 获取学生所有学期的成绩
    @param[in]  pagesize(int) 最近多少门课的成绩，默认-1为取全部课成绩
    @param[out] 获取的原始数据 json=>dict
    '''

Example

import scu_api

u_student = scu_api.get_u_student()

u_student.set_baseinfo(
    'student_id',
    'password',
    False # set True when password already encrypted by md5
)

# save current captcha image in `captcha.jpg`
success, _ = u_student.get_captcha(filepath='captcha.jpg')

# you can only handle captcha manually for now
captcha_str = input('please type captcha string: ')

# login scu with `remember_me on`
success, _ = u_student.login(captcha_str, True)

# get student name.
success, std_name = u_student.get_student_name()

print('姓名:', std_name)

# save student picture in `student.jpg` which is shown in scu official
success, std_pic = u_student.get_student_pic('student.jpg')

success, scores = u_student.get_all_term_scores()

print(scores)