Python开发-025_终端程序项目开发规范

现阶段我们的开发主要是在运行在pycharm中,而实际代码上线并不可能如此,为了保证终端程序运行顺畅和代码阅读的便利,我们应该遵循一些结构的规范,让系统更加的专业

  • 注意:
    • 本规范是终端程序代码规范
    • 并不通适用于Web等程序开发

1 单文件应用

当程序只有一个.py文件的时候适用于以下规范

"""
1.文件注释
"""

import re
import random
													# 2.倒入模块顺序(内置、第三方、自定义模块)
import requests
from openpyxl import load_workbook

DB = "XXX" # 3.全局变量大写

def do_something():
    """ 函数注释 """      # 4.函数名命名规范 & 函数功能注释
    # TODO 待完成时,下一期实现xxx功能			# 5.TODO信息
    for i in range(10):
        pass

def run(demo1,demo2):
    '''
    函数功能注释
    :param demo1: 参数注释
    :param demo2: 参数注释
    :return: 返回值注释
    '''
    # 对功能代码进行注释				# 6. 功能代码注释
    text = input(">>>")
    return text

if __name__ == '__main__':
    run()											# 7.主文件格式

2 单可执行文件

程序单一执行入口项目的规范,目录结构通常是

# 假设项目名称 crm,可以创建如下文件和文件夹来存放代码和数据

crm
├── app.py        文件,程序的主文件(尽量精简)
├── config.py     文件,配置文件(放相关配置信息,代码中读取配置信息,如果想要修改配置,即可以在此修改,不用再去代码中逐一修改了)
├── db            文件夹,存放数据
├── files         文件夹,存放文件
├── src           包,业务处理的代码
└── utils         包,公共功能

3 多可执行文件

# 假设项目名称 killer,可以创建如下文件和文件夹来存放代码和数据

killer
├── bin					文件夹,存放多个主文件(可运行)
│?? ├── app1.py
│?? └── app2.py
├── config              包,配置文件
│?? ├── __init__.py
│?? └── settings.py
├── db                  文件夹,存放数据
├── files               文件夹,存放文件
├── src                 包,业务代码
│?? └── __init__.py
└── utils               包,公共功能
    └── __init__.py

Python开发-025_终端程序项目开发规范
http://localhost:8080/archives/ud070Yqk
作者
kinght
发布于
2024年11月11日
更新于
2024年11月11日
许可协议