AutoScriptBase 项目使用教程

AutoScriptBase 项目使用教程

AutoScriptBaseAutoJS项目框架，用于快速构建自动化项目项目地址:https://gitcode.com/gh_mirrors/au/AutoScriptBase

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

AutoScriptBase 项目的目录结构如下：

AutoScriptBase/
├── README.md
├── src/
│   ├── main.py
│   ├── config.yaml
│   └── utils/
│       ├── helper.py
│       └── logger.py
└── tests/
    ├── test_main.py
    └── test_utils.py

目录结构介绍

• README.md: 项目说明文件，包含项目的基本信息和使用指南。
• src/: 源代码目录，包含项目的主要代码文件。
  • main.py: 项目的启动文件。
  • config.yaml: 项目的配置文件。
  • utils/: 工具模块目录，包含辅助函数和日志记录等工具。
    • helper.py: 辅助函数模块。
    • logger.py: 日志记录模块。
• tests/: 测试代码目录，包含项目的测试文件。
  • test_main.py: 针对 main.py 的测试文件。
  • test_utils.py: 针对 utils/ 目录下的模块的测试文件。

2. 项目的启动文件介绍

项目的启动文件是 src/main.py。该文件负责初始化项目并启动主程序。以下是 main.py 的基本结构：

import yaml
from utils.logger import setup_logger
from utils.helper import load_config

def main():
    # 加载配置文件
    config = load_config('config.yaml')
    
    # 设置日志
    logger = setup_logger(config['log_level'])
    
    # 主程序逻辑
    logger.info("项目启动成功")

if __name__ == "__main__":
    main()

启动文件功能介绍

• import yaml: 导入 yaml 模块，用于解析配置文件。
• from utils.logger import setup_logger: 导入日志设置函数。
• from utils.helper import load_config: 导入配置文件加载函数。
• main(): 主函数，负责加载配置、设置日志并启动主程序逻辑。
• if __name__ == "__main__":: 确保脚本在直接运行时执行 main() 函数。

3. 项目的配置文件介绍

项目的配置文件是 src/config.yaml。该文件采用 YAML 格式，用于存储项目的配置信息。以下是 config.yaml 的基本内容：

log_level: INFO
database:
  host: localhost
  port: 3306
  user: root
  password: root

配置文件内容介绍

• log_level: 日志级别，可选值包括 DEBUG, INFO, WARNING, ERROR, CRITICAL。
• database: 数据库配置信息。
  • host: 数据库主机地址。
  • port: 数据库端口号。
  • user: 数据库用户名。
  • password: 数据库密码。

通过以上配置文件，项目可以灵活地调整日志级别和数据库连接参数，以适应不同的运行环境。

AutoScriptBaseAutoJS项目框架，用于快速构建自动化项目项目地址:https://gitcode.com/gh_mirrors/au/AutoScriptBase