QB 开源项目使用教程

QB 开源项目使用教程

qbZero-configuration build system to very quickly build C/C++ projects.项目地址:https://gitcode.com/gh_mirrors/qb3/qb

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

qb/
├── docs/
│   ├── README.md
│   └── CONTRIBUTING.md
├── src/
│   ├── main.py
│   ├── config.py
│   ├── utils/
│   │   ├── helper.py
│   │   └── logger.py
│   └── modules/
│       ├── module1.py
│       └── module2.py
├── tests/
│   ├── test_main.py
│   └── test_config.py
├── .gitignore
├── LICENSE
└── requirements.txt

目录结构介绍

• docs/: 存放项目的文档文件，包括README.md和CONTRIBUTING.md。
• src/: 项目的源代码目录，包含主要的Python文件和模块。
  • main.py: 项目的启动文件。
  • config.py: 项目的配置文件。
  • utils/: 存放工具类和辅助函数的目录。
  • modules/: 存放项目的主要功能模块。
• tests/: 存放项目的测试文件。
• .gitignore: Git忽略文件，指定哪些文件或目录不需要被Git管理。
• LICENSE: 项目的开源许可证文件。
• requirements.txt: 项目依赖的Python包列表。

2. 项目的启动文件介绍

src/main.py

main.py 是项目的启动文件，负责初始化项目并启动主要功能。以下是该文件的主要内容和功能：

import config
from modules import module1, module2
from utils import logger

def main():
    logger.info("项目启动")
    config.load_config()
    module1.run()
    module2.run()

if __name__ == "__main__":
    main()

功能介绍

• 导入模块: 导入了配置文件 config 和两个主要模块 module1 和 module2，以及日志工具 logger。
• main() 函数: 项目的入口函数，负责加载配置、启动模块并记录日志。
• if __name__ == "__main__":: 确保只有在直接运行 main.py 时才会执行 main() 函数。

3. 项目的配置文件介绍

src/config.py

config.py 是项目的配置文件，负责加载和管理项目的配置参数。以下是该文件的主要内容和功能：

import json

CONFIG_FILE = "config.json"

def load_config():
    with open(CONFIG_FILE, "r") as file:
        config = json.load(file)
    return config

def get_config():
    return load_config()

功能介绍

• CONFIG_FILE: 配置文件的路径，通常是一个JSON文件。
• load_config() 函数: 加载配置文件并返回配置字典。
• get_config() 函数: 返回加载的配置字典，方便其他模块调用。

配置文件示例 (config.json)

{
    "database": {
        "host": "localhost",
        "port": 3306,
        "user": "root",
        "password": "password"
    },
    "logging": {
        "level": "INFO",
        "file": "app.log"
    }
}

配置文件说明

• database: 数据库连接配置，包括主机、端口、用户名和密码。
• logging: 日志配置，包括日志级别和日志文件路径。

通过以上介绍，您可以更好地理解和使用 QB 开源项目。

qbZero-configuration build system to very quickly build C/C++ projects.项目地址:https://gitcode.com/gh_mirrors/qb3/qb