Python代码基础编码规范

为了是代码的可读性变好，便于协同工作，我们需要遵守一定编码规范。

1. 代码规范

程序员写代码是有规范的，不只是实现功能而已。

1.1 名称

在Python开发过程中会创建文件夹/文件/变量等，这些在命名有一些潜规则（编写代码时也要注意pep8规范）。

• 文件夹，小写 & 小写下划线连接，例如：commands、data_utils等。

• 文件，小写 & 小写下划线连接，例如：page.py、db_convert.py等。

• 变量

  • 全局变量，大写 & 大写下划线连接，例如：NAME = "武沛齐" 、BASE_NAME = 18
  • 局部变量，小写 & 小写下划线连接，例如：data = [11,22,33]、user_parent_id = 9等。

1.2 注释

作为程序员，写代码注释是非常基础且有用的技能，方便以后对代码进行维护和理解。

文件注释

"""
这个文件主要为项目提供工具和转换的功能，初次之外还有日志....
例如：
    ...
    ...
    ...
"""
....

代码注释

name = "alex"
# 在名称后面添加一个大烧饼
data = name + "dsb" 
print(data)

name = "alex"
"""
在名称后面添加一个大烧饼，内部的实现机制：
    1. xxx
    2. xxx
    3. xx
"""
data = name + "dsb" 
print(data)

1.3 todo

基于注释可以实现todo注释的效果，例如：

1.4 条件嵌套

以后写条件语句一定要想办法减少嵌套的层级（最好不要超过3层）。

1.5 简单逻辑先处理

示例1：

goods = [
    {"name": "电脑", "price": 1999},
    {"name": "鼠标", "price": 10},
    {"name": "游艇", "price": 20},
    {"name": "美女", "price": 998}
]
for index in range(len(goods)):
    item = goods[index]
    print(index + 1, item['name'], item['price'])

while True:
    num = input("请输入要选择的商品序号(Q/q)：")  # "1"
    if num.upper() == "Q":
        break
    if num.isdecimal():
        num = int(num)
        if 0 < num < 5:
            target_index = num - 1
            choice_item = goods[target_index]
            print(choice_item["name"], choice_item['price'])
        else:
            print("序号范围选择错误")
    else:
        print("用户输入的序号格式错误")

示例2：

goods = [
    {"name": "电脑", "price": 1999},
    {"name": "鼠标", "price": 10},
    {"name": "游艇", "price": 20},
    {"name": "美女", "price": 998}
]
for index in range(len(goods)):
    item = goods[index]
    print(index + 1, item['name'], item['price'])

while True:
    num = input("请输入要选择的商品序号(Q/q)：")  # "1"
    if num.upper() == "Q":
        break
    if not num.isdecimal():
        print("用输入的格式错误")
        break
    num = int(num)

    if num > 4 or num < 0:
        print("范围选择错误")
        break
    target_index = num - 1
    choice_item = goods[target_index]
    print(choice_item["name"], choice_item['price'])

1.6 循环

尽量少循环多干事，提高代码效率。

key_list = []
value_list = []

info = {'k1': 'v1', 'k2': 'v2', 'k3': 'v3'}

for key, value in info.items():
    key_list.append(key)
    value_list.append(value)

info = {'k1': 'v1', 'k2': 'v2', 'k3': 'v3'}

key_list = list(info.keys())
value_list = list(info.values())

1.7 变量和值

# 推荐
name = "武沛齐"
age = 19

# 不推荐
name="武沛齐"
age= 18

可以基于Pycharm的格式化工具来实现自动处理。

python代码规范：PEP8规范。