代码规范

news2024/11/15 22:39:44

一、代码规范

程序员写代码，不仅仅是实现功能

1. 名称

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

文件夹，小写 & 小写下划线连接，例如：commands、data_utils等。
文件，小写 & 小写下划线连接，例如：page.py、db_convert.py等。
变量
- 全局变量，大写 & 大写下划线连接，例如：NAME = "张三" 、BASE_NAME = 18
- 局部变量，小写 & 小写下划线连接，例如：data = [11,22,33]、user_parent_id = 9等。

2. 注释

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

文件夹
文件注释

在文件的顶端注释，使用三引号引起来：

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


....

代码注释

【1】单行注释，一般添加在代码的上边一行

name = "张三"
# 在名称后面添加一个123
data = name + "123" 
print(data)

【2】多行注释，可使用三引号引起来

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

3. todo

基于注释可以实现todo注释的效果（比如下个版本要实现的内容），例如：
在这里插入图片描述

4. 嵌套条件

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

4. 简单逻辑优先处理

示例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'])

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())

7. 变量和值

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

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

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

python代码规范：PEP8规范。
或者pycharm此处可以规范代码：
在这里插入图片描述

知识补充

1. pass

一般Python的代码块是基于 : 和缩进来实现，Python中规定代码块中必须要有代码才算完整，在没有代码的情况下为了保证语法的完整性可以用pass代替，例如：

# 其他编程语言
if 提交{
    ...
}else{
    ....
}

if 条件 :
    pass
else:
    pass

for i in range(xxx):
    pass

2. is 比较

is 和 ==的区别是什么？

==，用于比较两个值是否相等。
is，用于表示内存地址是否一致。

# 示例1
v1 = []
v2 = []

print( v1 == v2 )  # True，两个值相当
print( v1 is v2 )  # False，不属于同一块内存。

# 示例2
v1 = []
v2 = v1

print( v1 == v2 )  # True，两个值相当
print( v1 is v2 )  # True，属于同一块内存。

# 示例3
v1 = None
v2 = None

print(v1 == v2)  # True，两个值相当
print(v1 is v2)  # True，属于同一块内存。

3. 位运算

计算机底层本质上都是二进制，我们平时在计算机中做的很多操作底层都会转换为二进制的操作，位运算就是对二进制的操作。

【1】`&`，与（都为1）

二进制之间位与位的运算：

a = 60            # 60 = 0011 1100 
b = 13            # 13 = 0000 1101 

c = a & b         # 12 = 0000 1100   对应的位置进行比较，若是上下两位都为1 ，则为1

【2】`|`，或（只要有一个为1）

a = 60            # 60 = 0011 1100 
b = 13            # 13 = 0000 1101 

c = a | b         # 61 = 0011 1101    上下位有一个为1，则为1

【3】``^`，异或（值不同）

a = 60            # 60 = 0011 1100 
b = 13            # 13 = 0000 1101 

c = a ^ b         # 49 = 0011 0001    上下两位不一样，则为1

【4】``~`，取反

a = 60            #  60 = 0011 1100 

c = ~a;           # -61 = 1100 0011   对二进制取反，0改成1,1改成0

【5】`<<`，左移动

a = 60            #  60 = 0011 1100
c = a << 2;       # 240 = 1111 0000   让a的二进制向左移动两位

【6】`>>`，右移动

a = 60            # 60 = 0011 1101 
c = a >> 2;       # 15 = 0000 1111

平时在开发中，二进制的位运算几乎很好少使用，在计算机底层或网络协议底层用的会比较多，例如：

计算 2**n

2**0    1 << 0   1     1
2**1    1 << 1   10    2
2**2    1 << 2   100   4
2**3    1 << 3   1000  8
...

计算一个数的一半【面试题】

v1 = 10 >> 1 
print(v1) # 值为5

v2 = 20 >> 1
print(v2) # 值为 10

网络传输数据，文件太大还未传完（websocket源码为例）。

     第1个字节         第2个字节         ... 
 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-------+-+-------------+-------------------------------+
|F|R|R|R| opcode|M| Payload len |    Extended payload length    |
|I|S|S|S|  (4)  |A|     (7)     |             (16/64)           |
|N|V|V|V|       |S|             |   (if payload len==126/127)   |
| |1|2|3|       |K|             |                               |
+-+-+-+-+-------+-+-------------+ - - - - - - - - - - - - - - - +

FIN位置是0，表示这是一部分数据，后续还有数据。
FIN位置是1，表示这是最后数据，已发送完毕。

# 例如：接收到的第一个字节的值为245（11110101），让v的二进制和 1000 0000 做 & 与运算。

v = 245   # 245 11110101
          # 128 10000000
                10000000
    
data = v & 128
if data == 0:
    print("还有数据")
else:
    print("已完毕")