Rick and Morty Info 项目教程

1. 项目目录结构及介绍

rick-and-morty-info/
├── README.md
├── src/
│   ├── main.py
│   ├── config.py
│   ├── utils/
│   │   ├── helper.py
│   │   └── logger.py
│   └── data/
│       ├── characters.json
│       └── episodes.json
└── requirements.txt

• README.md: 项目说明文件，包含项目的基本信息和使用指南。
• src/: 项目源代码目录。
  • main.py: 项目的启动文件。
  • config.py: 项目的配置文件。
  • utils/: 工具函数目录，包含一些辅助函数和日志记录功能。
    • helper.py: 辅助函数文件。
    • logger.py: 日志记录配置文件。
  • data/: 数据文件目录，包含项目所需的数据文件。
    • characters.json: 角色数据文件。
    • episodes.json: 剧集数据文件。
• requirements.txt: 项目依赖文件，列出了项目所需的Python包。

2. 项目启动文件介绍

src/main.py

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

import config
from utils.logger import setup_logger
from utils.helper import load_data

def main():
    # 初始化日志
    logger = setup_logger()
    logger.info("项目启动")
    
    # 加载配置
    cfg = config.load_config()
    
    # 加载数据
    characters = load_data('data/characters.json')
    episodes = load_data('data/episodes.json')
    
    # 执行主要功能
    # ...

if __name__ == "__main__":
    main()

• setup_logger(): 初始化日志记录器。
• load_config(): 加载配置文件。
• load_data(): 加载数据文件。

3. 项目配置文件介绍

src/config.py

config.py 是项目的配置文件，负责管理项目的各种配置参数。以下是该文件的主要内容：

import json

def load_config():
    with open('config.json', 'r') as f:
        config = json.load(f)
    return config

def save_config(config):
    with open('config.json', 'w') as f:
        json.dump(config, f, indent=4)

• load_config(): 从 config.json 文件中加载配置参数。
• save_config(): 将配置参数保存到 config.json 文件中。

config.json

config.json 文件是项目的配置文件，包含项目的各种配置参数。以下是一个示例：

{
    "log_level": "INFO",
    "data_path": "data/",
    "api_url": "https://rickandmortyapi.com/api/"
}

• log_level: 日志级别，控制日志输出的详细程度。
• data_path: 数据文件路径。
• api_url: 外部API的URL。

通过以上内容，您可以了解 Rick and Morty Info 项目的基本结构、启动文件和配置文件的使用方法。