项目结构

项目结构#

基本结构#

文件夹:

  • 代码文件夹:存放正式代码。

  • 示例代码文件夹examples:在编写正式代码前,会先用Jupyter Notebook编写示例代码,以便直观查看使用Pandas等代码的效果。

  • 文档文件夹docs:存放用户文档。

  • 单元测试文件夹tests:存放单元测试,与代码模块一一对应。

  • 集成测试文件夹integrated_tests:存放集成测试,与代码模块一一对应,运行集成测试可对代码进行相关测试。

文件:

  • 配置文件pyproject.toml:Python项目的配置文件,类似于Node的package.json

  • 版本日志CHANGELOG.md:在发布版本时记录。

代码文件夹#

  • __init__.py模块:在Python 3.3之后不是必须的,但推荐保留。可用于存放导入信息,维护导入相关内容,同时符合大家使用Python的习惯。

  • 入口模块__main__.py:若项目以包的形式对外调用,特别是在命令行中使用时,该模块有重要作用。