0-0-02 项目开发规范-终端运行

现阶段，我们在开发一些程序时（终端运行）

2.1 单文件应用

当基于python开发简单应用时（一个py文件就能搞定），需要注意如下几点。

"""
文件注释
"""

import re
import random

import requests
from openpyxl import load_workbook

DB = "XXX"


def do_something():
    """ 函数注释 """

    # TODO 待完成时，下一期实现xxx功能
    for i in range(10):
        pass


def run():
    """ 函数注释 """

    # 对功能代码进行注释
    text = input(">>>")
    print(text)


if __name__ == '__main__':
    run()

2.2 单可执行文件

新创建一个项目，假设名字叫 【crm】，可以创建如下文件和文件夹来存放代码和数据。

crm
├── app.py        文件，程序的主文件（尽量精简）
├── config.py     文件，配置文件（放相关配置信息，代码中读取配置信息，如果想要修改配置，即可以在此修改，不用再去代码中逐一修改了）
├── db            文件夹，存放数据
├── files         文件夹，存放文件--文件依赖的信息，比如存放txt , excel文件
├── src           包，业务处理的代码--业务逻辑    handler.py，用来放业务代码，比如你要实现登录，注册，那登录注册就是业务代码，里面包含各种业务逻辑
└── utils         包，公共功能--工具，（发邮件、发文件）你可以认为是工具包，比如你要检查手机号 
                           或者邮箱是否是一 
                               个正常的值，你可以写一个匹配规则，这个函数可以在很多地方用， 
                                登录和注册都可以使用到，那就可以放这里面

2.3 多可执行文件

新创建项目，假设名称叫【killer】，可以创建如下文件和文件夹来存放代码和数据。

killer
├── bin					文件夹，存放多个主文件（可运行）
│   ├── app1.py
│   └── app2.py
├── config              包，配置文件
│   ├── __init__.py
│   └── settings.py
├── db                  文件夹，存放数据
├── files               文件夹，存放文件，比如存放txt , excel文件
├── src                 包，业务代码，用来放业务代码，比如你要实现登录，注册，那登录注册就是 
                              业务代码，里面包含各种业务逻辑
│   └── __init__.py
└── utils               包，公共功能，你可以认为是工具包，比如你要检查手机号或者邮箱是否是一 
                               个正常的值，你可以写一个匹配规则，这个函数可以在很多地方用， 
                                登录和注册都可以使用到，那就可以放这里面
    └── __init__.py