python-代码编程规范

命名

常用简写

名称相关

# 信息
information: info
# 功能
function : func

# 数量
quantity:qty

# 元素uiautomatr
id_
text_
des_
class_

PYQT相关

button : btn_
checkbox : chkbox_
combobox : cmbox_
dateEdit : dedit_
lineEdit : ledit_
textBrowser:txtbrw_
spinbox：spinbox_

文件相关变量

file_path:文件路径
dir_path:文件夹路径
file_name:文件名称
dir_name:文件夹名称

src_file_path:源文件
dst_file_path:目标文件
src_dir_path:源文件夹
dst_dir_path:目标文件夹

prefix:前缀
suffix:后缀

sht_name: sheet页名称

手机相关

app_name:app名称
package_name:包名
times:次数
inter:等待时间

类名

大驼峰命名法：所有单词的第一个字母大写

class AnimalFarm(Farm):
    pass

函数名 变量名

字母、数字、下划线

def get_full_name_1():
    first_name = 'dang'

对于私有函数或变量，在前面加单下划线_
如_private_function，_private_variable

常量名

字母大写，如有多个单词，用下划线隔开

PI = 3.14
MAX_LENGTH = 100

空格

不要在逗号，分号，冒号前加空格，但就在它们后面加（除了在行尾）；
在二元操作符两边都加一个空格，比如赋值（=），比较（==，<）；

if x == 4:
  print x, y

库导入

按以下顺序导入库：

1. Python自带库
2. 第三方库
3. 自己定义的类

# python自带库
import os
# 第三方库
from PyQt5.QtWidgets import QMainWindow
# 自定义类
import CommonUtils

块分隔

1、库引入部分与实际程序间 空两行
2、两个class间 空两行
3、类中 变量、方法、内部类中，相互间 空一行

import os


class QtForm1:
    def __init__(self):
        pass

    def get_1(self):
        pass

    def get_2(self):
        pass


class QtForm2:
    pass

注释

pycharm在生成py文件时，自动生成注释：
pycharm菜单栏找File -> settings -> Editor -> File and Code Templates -> Python Script，找到后编辑

# _*_ coding: utf-8 _*_
# @Time : ${DATE} ${TIME}
# @Author : nova
# @Version：V 0.1
# @File : ${NAME}.py
# @desc :

typing模块

常用类型

• int,long,float: 整型,长整形,浮点型
• bool,str: 布尔型，字符串类型
• List, Tuple, Dict, Set:列表，元组，字典, 集合
• Iterable,Iterator:可迭代类型，迭代器类型
• Generator：生成器类型

def test(a: int, b: str) -> str
    print(a,b)
    return "aha"