• Python 开发规范


    开发规范

    我们在开发一些程序时(终端运行),应该遵循一些结构的规范,让你的系统更加专业。

    1. 单文件程序

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

    """
    文件注释
    """
    import sys # 内置
    import re
    import random 
    
    import requests #第三方
    
    from test import aaa #自定义
    
    DB = "XXX" # 全局变量或者常量大写
    
    
    def do_something(): #函数命名规范&函数功能注释
        """ 函数注释 """
    
        # TODO 待完成时,下一期实现xxx功能
        for i in range(10):
            pass
    
    
    def run():
        """ 函数注释 """
    
        # 对功能代码进行注释
        text = input(">>>")
        print(text)
    
    
    if __name__ == '__main__':
        run()
    
    image-20210105160728297

    2. 单可执行文件

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

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

    image-20210105163335127

    3. 多可执行文件

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

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

    image-20210105164740583

    开发使用,开发规范可以极大的提高交流效率。

    继续努力,终成大器!

  • 相关阅读:
    Wx-小程序-使用canvas截图保存
    Wx-小程序-图片预览、保存
    CSS-文本溢出省略号表示
    Wx-小程序-长按复制文本
    Vue-组件通信
    JS-禁用浏览器前进后退
    JS-内置对象和方法
    JS-冒泡排序
    JS-常用方法合集
    Wx-小程序-组件式开发之Vant
  • 原文地址:https://www.cnblogs.com/Blogwj123/p/16185487.html
Copyright © 2020-2023  润新知