项目开发规范

规范目录

1，配置starts文件

• 配置启动文件：将项目的启动执行命令放置在starts.py文件中，运行starts.py文件就可以成功启动项目

• bin\starts.py

  • import os
    import sys
    os.path.dirname(__file__)  ##获取上级目录
    os.path.dirname(os.path.dirname(__file__))##获取父级目录
    BASE_PATH = os.path.dirname(os.path.dirname(__file__))
    REJISTER_PATH = sys.path.append(BASE_PATH)
    if __name__ = '__main__':##此作用是防止其他地方调用starts模块
    	run()				##只能是自己调用
    

2，配置settings文件

• 配置文件中，放置一些项目中需要的静态参数，比如文件路径，数据库配置，软件的默认设置等等，在这里面要应用到很重要的路径拼接（os.path.join）

• conf\settings.py

  • import os
    BASE_PATH = os.path.dirname(os.path.dirname(__file__))
    REGISTER_PATH = os.path.join(BASE_PATH,'db','register')
    FROZEN_PATH =os.path.join(BASE_PATH,'db','frozen')
    COMMENT_PATH = os.path.join(BASE_PATH,'db','comment')
    

3，配置src文件

• 文件中主要存放的是核心逻辑功能，即核心功能函数

• core\src.py

  • import json
    from conf import setting
    from lib import common
    settint.REGISTER_PATH
    setting.FROZEN_PATH
    common.COMMENT_PATH
    

4，配置register文件

• 项目中用到的注册表，文本数据库，单独设置这样的文件，来与系统进行交互
• db\register|frozen|comment

5，配置common文件

• 公共组件文件，装饰器就是公共组件的工具

• lib\common

  • from core import src
    def auth(func):...
    	def inner():
    		if not src.CURRENT_USER:
    

6，配置log 文件

• log 文件：储存log日志的文件。日志主要是供开发人员使用，例如排bug
• log\access.log