综述
本项目综述
zhixuewang
是一个Python版的智学网API。它支持(包括但不限于):查询分数,查看作业情况,查看阅卷情况等。
tip
智学网移除了一些接口,所以本项目可能有一些代码会永久性报错(不排除后续修复的可能性)
你也可以加群(862767072)来进行讨论(备注“智学网”),如果是一些比较冷门的需求,请向zxext
包提交代码(同样也是加这个群)
问题反馈
请截图报错内容,然后在Github Issues内开新issue。
编码规范
如果你想要向我们贡献代码,请遵循如下原则:
- 默认情况下,所有python函数均以小写开头,遵循驼峰式或下划线命名法。
例如:
# 推荐这么做
def get_something_by_sth():
pass
# 或者...
def getSomethingBySth():
pass
- 对于参数,推荐使用指名参数,必须对参数限定类型,同时不建议出现毫无意义的参数名称。
caution
毫无意义的参数名不仅起不到提示的作用,反而可能会误导其他开发者!
对于同样的参数,例如默认用户名,我们推荐像是defaultUserName
或defaultUser
我们不推荐default
,user
或类似moren_yonghu
之类的参数名.
如:
# 推荐这么做
def get_sth_by_sth(examId: str, someoneUserName: str, someoneId: int):
pass
# 不推荐这么做
def get_sth_by_sth(id: str, user: str, id_1: str):
pass
# 错误示范
def get_sth_by_sth(id, user, id1):
pass