src.util package

Submodules

src.util.config module

src.util.config_helper module

class src.util.config_helper.ConfigHelper(config_path, username, password, system_root_path)

基类：object

处理软件系统设置相关的文件存储与读取类

data_load()

从本地的配置文件加载数据

data_write()

向给定的配置文件地址写入数据

get_password()

获取网络学堂的的密码

get_root_path()

获取软件中文件系统对应的地址字典，文件系统名字为键，文件系统根目录绝对路径为值

get_username()

获取网络学堂的的用户名

src.util.database_helper module

class src.util.database_helper.DatabaseHelper(datapath_path)

基类：object

数据库操作类，用于存储tag信息

node_tag_write(node)

指定节点，将其tag存储至数据库中

参数

node (FileNode) – 需要存储的文件节点

tag_search(tag)

指定需要搜索的tag, 在数据库中进行搜索并返回搜索结果列表

参数

tag (String) – 给定的搜索tag名称

tree_tag_write(tree)

指定文件树，将其tag存储至数据库中

参数

tree (FileTree) – 需要存储的文件树

src.util.error_helper module

class src.util.error_helper.ErrorHelprt

基类：object

error_handler()

处理错误信息

src.util.file_node module

class src.util.file_node.FileNode(file_name)

基类：node.Node

继承Node，作为FileNode的节点

参数

Node ([type]) – [description]

get_relative_path()

获取文件node的路径，在当前文件系统下的相对路径，可以是磁盘上的，也可以是网络上的

返回

相对于文件系统下的相对路径(“./A/B/C/”)

返回类型

String

get_tag()

获取当前文件node的tag列表

返回

node的tag列表

返回类型

List

src.util.file_tree module

class src.util.file_tree.FileTree(file_node, file_system_path)

基类：tree.Tree

文件系统管理相关的树

参数

Tree (Tree) – 继承于Tree的抽象基类

fetch_file_tree()

通过Pipe获取文件树，需要依据文件系统类型选取管道

fetch文件系统存储位置(本地/网上)获取到的文件树

返回

fetch操作过程返回的状态

返回类型

STATUS

src.util.net_helper module

class src.util.net_helper.NetHelper(username, password)

基类：object

download_selected_courses_files(courses, file_storage_destination)

给定下载课程列表，下载至file_storage_destination处

参数

• courses (List) – 课表

• file_storage_destination (String) – 下载存储路径

get_course_file_tree_node()

遍历学期列表，返回对应的文件树的根节点

get_course_files(course)

get_course_name(course)

get_course_semester(course)

get_courses(semesters)

给定学期，获得这个学期的课表

参数

semesters (String) – 学期号列表，如[‘2019-2020-1’,’2020-2021-1’]

返回

课表list

返回类型

List

class src.util.net_helper.TqdmUpTo(*_, **__)

基类：tqdm.std.tqdm

update_to(b=1, bsize=1, tsize=None)

src.util.net_helper.append_hw_csv(fname, stu)

src.util.net_helper.build_discuss(s)

src.util.net_helper.build_notify(s)

src.util.net_helper.clear(args)

src.util.net_helper.dfs_clean(d)

src.util.net_helper.download(uri, name)

src.util.net_helper.escape(s)

src.util.net_helper.get_args()

src.util.net_helper.get_courses(args)

src.util.net_helper.get_json(uri, values={})

src.util.net_helper.get_page(uri, values={})

src.util.net_helper.gethash(fname)

src.util.net_helper.login(username, password)

src.util.net_helper.open_page(uri, values={})

src.util.net_helper.sync_discuss(c)

src.util.net_helper.sync_file(c)

src.util.net_helper.sync_hw(c)

src.util.net_helper.sync_info(c)

src.util.net_helper.sync_notify(c)

src.util.node module

class src.util.node.Node(file_name)

基类：object

定义逻辑上的树操作的节点

file_name

这个节点文件(文件夹)的名字

father_node

这个节点的父亲节点，至多存在一个

child_node

这个节点的儿子节点，可以存在多个，因此是一个列表

add_child(node)

为当前节点添加子节点

参数

node (Node) – 子节点

binary_search(file_name)

给定文件名，查找对应子节点,存在返回index，不存在返回-1

参数

(String） 待查找的文件名 (file_name) –

返回

需要查找的文件名index，存在返回index，不存在返回-1

返回类型

int

delete_child(file_name)

在当前节点中的子节点里删除file_name对应的子节点

参数

file_name (String) – 想要删除的子节点文件名

get_child()

获取当前节点的子节点

返回

这个节点的子节点列表

返回类型

Node

get_father()

获取当前节点的父亲节点

返回

这个节点的父亲节点

返回类型

Node

search_left(file_name)

给定文件名，查找对应子节点,返回最接近的位置的左边index

返回的插入点 i 可以将列表分成两部分。左侧是 all(val < x for val in a[lo:i]) ，右侧是 all(val >= x for val in a[i:hi]) 。

参数

(String） 待查找的文件名 (file_name) –

返回

需要查找的文件名index(左边)

返回类型

int

set_father(node)

给当前节点设置父亲节点

参数

node (Node) – 想要设置的父亲节点

show(layer=0)

打印当前节点下的子树

参数

layer (int) – 首节点前的空格. Defaults to 0.

src.util.string_helper module

class src.util.string_helper.StringHelper

基类：object

辅助操作字符串的类

提供字符串排序功能等等

Attributes:

chinese_string_sort(chinese_string_list)

对于中文字符串按照拼音顺序进行排序

参数

chinese_string_list (List[String]) – 待排序的中文字符串列表

返回

排序后的中文字符串列表

返回类型

chinese_string_list_sorted (List[String])

get_string_pinyin(string)

获取一个字符串的拼音表示字符串

如果是中文，比如’张荣侨’，返回’zhangrongqiao’; 如果是英文或者数字，比如’randolf0210ppp’, 返回原值，’randolf0210ppp’ 如果中英文夹杂，返回对应的排列，如’randolf0210张荣侨ppp’，返回值，’randolf0210zhangrongqiaoppp’ 如果含有特殊字符，比如’_’，比如’rand_olf张荣侨ppp’, 返回: ‘rand_olfzhangrongqiaoppp’

参数

string ([type]) – [description]

返回

[description]

返回类型

[type]

src.util.tree module

class src.util.tree.Tree(node)

基类：object

定义逻辑上的树

get_subtree_node(relative_dir)

给定相对路径，返回相对路径下的子节点

参数

relative_dir (String) – 相对根目录的路径

返回

相对根目录下的子树节点

返回类型

Node

print_tree()

打印整棵树

src.util.xml_helper module

class src.util.xml_helper.XmlHelper

基类：object

add_node(node, father)

给定一个node节点和一个父亲节点，将node插入到父亲节点下

参数

• node (Node) – 一个需要插入的节点，将在XML文件中其插入到父亲节点(father)下

• father (Node) – 文件树中待插入的节点

parse_xml(file_path, file_name)

给定xml文件地址以及xml文件名，解析这个文件为一棵树

参数

• file_path (String) – xml文件的地址

• file_name (String) – xml文件的文件名

返回

xml树(未处理为文件树)

返回类型

ElementTree

xml_generate(file_name, file_path)

给定文件名生成一个xml文件，用于存储UI树结构或者File 树结构

参数

• file_name (String) – 生成的XML文件文件名

• file_path (String) – 生成的XML文件文件绝对路径

Module contents