YaH3C 开源项目教程

1. 项目的目录结构及介绍

YaH3C 是一个用于校园网认证的 Python 脚本，其目录结构相对简单。以下是项目的目录结构及其介绍：

YaH3C/
├── README.md
├── YaH3C.py
├── config.py
├── requirements.txt
└── utils.py

• README.md: 项目说明文档，包含项目的基本信息和使用说明。
• YaH3C.py: 项目的主启动文件，包含主要的认证逻辑。
• config.py: 配置文件，用于存储用户的相关配置信息。
• requirements.txt: 项目依赖文件，列出了运行该项目所需的 Python 包。
• utils.py: 工具文件，包含一些辅助函数和工具类。

2. 项目的启动文件介绍

项目的启动文件是 YaH3C.py，它是整个项目的入口点。以下是 YaH3C.py 的主要功能和结构：

import sys
import getpass
from config import Config
from utils import login, logout

def main():
    config = Config()
    username = input("请输入用户名: ")
    password = getpass.getpass("请输入密码: ")
    config.set_user(username, password)

    if len(sys.argv) > 1 and sys.argv[1] == 'logout':
        logout(config)
    else:
        login(config)

if __name__ == "__main__":
    main()

• 导入模块: 导入了 sys, getpass, config 和 utils 模块。
• main 函数: 定义了主函数 main，用于处理用户输入和调用登录或登出功能。
• 用户输入: 通过 input 和 getpass 获取用户名和密码。
• 配置设置: 使用 Config 类设置用户信息。
• 登录和登出: 根据命令行参数调用 login 或 logout 函数。

3. 项目的配置文件介绍

配置文件 config.py 用于存储用户的相关配置信息。以下是 config.py 的主要内容和结构：

class Config:
    def __init__(self):
        self.username = None
        self.password = None

    def set_user(self, username, password):
        self.username = username
        self.password = password

    def get_user(self):
        return self.username, self.password

• Config 类: 定义了一个 Config 类，用于管理用户配置。
• 初始化方法: __init__ 方法初始化用户名和密码为 None。
• 设置用户信息: set_user 方法用于设置用户名和密码。
• 获取用户信息: get_user 方法用于获取用户名和密码。

通过以上介绍，您可以更好地理解和使用 YaH3C 开源项目。希望这份教程对您有所帮助。