[Python知识库]开发规范以及逻辑

简单程序的开发规范以及逻辑

1.单文件简单情况的代码结构

• 脚本注释(文件注释)

• 导入模块（内置，第三方，自定义）

• 定义全局变量（大写）

• 定义功能函数，注意函数命名规范

• 定义run函数（部分功能代码注释）

• 主文件

  def run():
  	pass
  
  if __name__ == '__main__':
    run()
  

2.单可执行文件

• app.py

  from src.xx import start
  
  if __name__ == '__main__':
    start()
  

  程序的入口文件

• config.py 用于存储该文件的配置文件（参数）

  以便于之后修改程序参数的便利性

• utils 工具包，用来存放一些公共功能

  • __init__.py
  • xx.py 一些公共功能

• src

  • __init__.py

  • __handler.py__ 用于存放业务代码

    import config # 导入配置文件（参数）
    from utils.xx import xx
    

3.多可执行文件

• bin 存放不止一个入口文件
  • app1.py
  • app2.py
• config 单可执行文件中config是一个py文件，在多可执行文件中config是一个包（文件夹）
  • setting1.py
  • setting2.py

其他结构与单可执行文件的结构相同

4.总结

在开发过程中，有序整洁的逻辑与分类十分重要。

以上是本人总结的对于简单应用的文件管理办法。