Python 代码规范

最新推荐文章于 2024-07-25 10:20:53 发布

IT_狂奔者

最新推荐文章于 2024-07-25 10:20:53 发布

阅读量240

点赞数 1

分类专栏： Python 文章标签： python 编程语言

本文链接：https://blog.csdn.net/chj_1224365967/article/details/116237460

版权

Python 专栏收录该内容

27 篇文章 7 订阅

订阅专栏

本文介绍了Python编程中关于命名、注释、代码结构和效率的规范与最佳实践。包括文件和变量命名规则，使用#TODO注释，避免深条件嵌套，优化循环结构，以及代码效率提升的技巧。示例代码展示了如何处理商品列表并交互选择商品。

摘要由CSDN通过智能技术生成

Python 代码规范

1.名称

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

文件夹，小写&小写下划线连接，例如： commands、data_utils等
文件，小写&小写下划线连接，例如：status.py、db_conver.py等
变量
- 全局变量，大写&大写下划线连接，例如：NAME = “Bertram”、BASE_NAME = 25
- 局部变量，小写&小写下划线连接，例如：data = [11, 12, 13]、`user_passwd = "123"等

2.注释

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

文件夹
文件注释

"""
这个文件主要提供工具和转换功能
例如：
    ……
    ……

"""

代码注释

name = "Bertram"
# 在名称后面添加一个字符串
data = name + "Bertram"
print(data)**

3.#TODO注释技巧

TODO 自然表示需要做而未做的一些待完成的事项，有助于事后的检索，以及对整体项目做进一步的修改迭代。
在这里插入图片描述

4.条件嵌套

写条件语句一定要减少嵌套的层级（做多不超过3层）

5.简单逻辑先处理

示例1:

goods = [
    {"name": "电脑", "price": "1999"},
    {"name": "鼠标", "price": "239"},
    {"name": "洗衣机", "price": "424"},
    {"name": "背包", "price": "529"}
]
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": "239"},
    {"name": "洗衣机", "price": "424"},
    {"name": "背包", "price": "529"}
]
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"])

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)
print(key_list, value_list)

key_list = []
value_list = []
info = {'k1': 'v1', 'k2': 'v2', 'k3': 'v3'}

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