WhyNot 开源项目教程-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00185/article/details/142196327

WhyNot 开源项目教程

whynot A Python sandbox for decision making in dynamics 项目地址: https://gitcode.com/gh_mirrors/wh/whynot

1. 项目目录结构及介绍

WhyNot 项目的目录结构如下：

whynot/
├── README.md
├── setup.py
├── whynot/
│   ├── __init__.py
│   ├── config.py
│   ├── main.py
│   ├── utils/
│   │   ├── __init__.py
│   │   ├── helper.py
│   │   └── logger.py
│   └── tests/
│       ├── __init__.py
│       ├── test_config.py
│       └── test_main.py
└── docs/
    ├── index.md
    └── installation.md

目录结构介绍

README.md: 项目的介绍文件，包含项目的基本信息、安装步骤和使用说明。
setup.py: 项目的安装脚本，用于安装项目的依赖库。
whynot/: 项目的主目录，包含项目的核心代码。
- init.py: 初始化文件，使 whynot 成为一个 Python 包。
- config.py: 项目的配置文件，包含项目的各种配置参数。
- main.py: 项目的启动文件，包含项目的入口函数。
- utils/: 工具模块目录，包含项目的辅助函数和工具类。
  - init.py: 初始化文件，使 utils 成为一个 Python 包。
  - helper.py: 辅助函数文件，包含一些常用的辅助函数。
  - logger.py: 日志记录文件，包含日志记录的相关函数。
- tests/: 测试模块目录，包含项目的单元测试代码。
  - init.py: 初始化文件，使 tests 成为一个 Python 包。
  - test_config.py: 配置文件的单元测试代码。
  - test_main.py: 启动文件的单元测试代码。
docs/: 项目的文档目录，包含项目的详细文档。
- index.md: 文档的索引文件，包含文档的目录结构。
- installation.md: 安装指南文件，包含项目的安装步骤。

2. 项目启动文件介绍

项目的启动文件是 whynot/main.py，该文件包含了项目的入口函数 main()，用于启动整个项目。

main.py 文件内容

import logging
from whynot.config import load_config
from whynot.utils.logger import setup_logger

def main():
    # 加载配置文件
    config = load_config()
    
    # 设置日志记录
    setup_logger(config.log_level)
    
    # 启动项目
    logging.info("项目启动成功")

if __name__ == "__main__":
    main()

启动文件介绍

导入模块: 启动文件首先导入了 logging 模块用于日志记录，load_config 函数用于加载配置文件，setup_logger 函数用于设置日志记录。
main 函数: main() 函数是项目的入口函数，负责加载配置文件、设置日志记录并启动项目。
配置文件加载: load_config() 函数从 config.py 文件中加载项目的配置参数。
日志记录设置: setup_logger() 函数根据配置文件中的日志级别设置日志记录。
项目启动: 最后，日志记录器输出“项目启动成功”的消息，表示项目已经成功启动。

3. 项目配置文件介绍

项目的配置文件是 whynot/config.py，该文件包含了项目的各种配置参数，如日志级别、数据库连接信息等。

config.py 文件内容

import os
from typing import NamedTuple

class Config(NamedTuple):
    log_level: str = "INFO"
    database_url: str = os.getenv("DATABASE_URL", "sqlite:///default.db")

def load_config() -> Config:
    return Config()

配置文件介绍

Config 类: Config 类是一个命名元组，用于存储项目的配置参数。
- log_level: 日志级别，默认为 "INFO"。
- database_url: 数据库连接 URL，默认从环境变量 DATABASE_URL 中获取，如果没有设置则使用默认值 "sqlite:///default.db"。
load_config 函数: load_config() 函数返回一个 Config 实例，用于加载项目的配置参数。