让你的代码大放异彩的 Python 技巧！ ✨

wufei123 2025-01-26 阅读:71 评论:0

编写整洁的Python代码是构建易于维护和扩展的应用程序的关键。Python强调可读性，因此，编写干净的代码至关重要。本文将分享19个技巧，帮助您编写更简洁、更高效、更易维护的Python代码，提升代码可读性。 1. 使用有意义的变量和函...

让你的代码大放异彩的 python 技巧！ ✨

编写整洁的Python代码是构建易于维护和扩展的应用程序的关键。Python强调可读性，因此，编写干净的代码至关重要。本文将分享19个技巧，帮助您编写更简洁、更高效、更易维护的Python代码，提升代码可读性。

1. 使用有意义的变量和函数名

变量名应清晰地反映其用途。避免使用单字符变量或含糊不清的名称。

不良示例：

PHP

x = 10

良好示例：

PHP

item_count = 10

2. 保持函数简洁且专注

每个函数应只执行一个特定任务。

不良示例：

PHP

def process_data():
    fetch_data()
    validate_data()
    save_data()

良好示例：

PHP

def fetch_data():
    pass

def validate_data():
    pass

def save_data():
    pass

3. 保持一致的代码格式

严格遵守4个空格的缩进规范（PEP 8标准）。一致的代码风格增强可读性。

不良示例：

PHP

if x:
    print("hello")
else:
print("goodbye")

良好示例：

PHP

if x:
    print("hello")
else:
    print("goodbye")

4. 避免使用魔术数字

使用具有描述性名称的常量代替直接在代码中使用任意数字。

不良示例：

PHP

area = 3.14 * radius * radius

良好示例：

PHP

PI = 3.14
area = PI * radius * radius

5. 使用默认参数

利用默认参数值减少条件语句，使函数更简洁。

不良示例：

PHP

def greet(name):
    if not name:
        name = 'guest'
    print(f"hello {name}")

良好示例：

PHP

def greet(name="guest"):
    print(f"hello {name}")

6. 减少嵌套循环和条件语句

过多的嵌套会降低代码可读性。使用提前返回或将逻辑分解成更小的函数来减少嵌套。

不良示例：

PHP

if x:
    if y:
        if z:
            print("condition met!")

良好示例：

PHP

if not x or not y or not z:
    return
print("condition met!")

7. 利用Python内置函数

充分利用Python强大的内置函数和库，避免重复造轮子。

不良示例：

PHP

squared_numbers = []
for num in range(1, 6):
    squared_numbers.append(num ** 2)

良好示例：

PHP

squared_numbers = [num ** 2 for num in range(1, 6)]

8. 避免使用全局变量

全局变量可能导致意外行为和调试困难。尽量将变量限制在函数内部，或使用类进行封装。

不良示例：

PHP

counter = 0
def increment():
    global counter
    counter += 1

良好示例：

PHP

class Counter:
    def __init__(self):
        self.counter = 0

    def increment(self):
        self.counter += 1

9. 使用列表推导式

列表推导式提供了一种简洁高效的创建列表的方式。

不良示例：

PHP

numbers = []
for i in range(1, 6):
    if i % 2 == 0:
        numbers.append(i)

良好示例：

PHP

numbers = [i for i in range(1, 6) if i % 2 == 0]

10. 编写清晰的注释和文档字符串

使用文档字符串描述函数和类，并在逻辑复杂的地方添加注释。

不良示例：

PHP

# increment counter
counter += 1

良好示例：

PHP

def increment_counter(counter):
    """Increments the counter by 1.

    Args:
        counter: The current count to be incremented.
    """
    return counter + 1

11. 正确处理异常

使用try...except块处理潜在的错误，避免程序崩溃。

不良示例：

PHP

num = int(input("enter a number: "))
print(10 / num)

良好示例：

PHP

try:
    num = int(input("enter a number: "))
    print(10 / num)
except ValueError:
    print("Invalid input, please enter an integer.")
except ZeroDivisionError:
    print("Cannot divide by zero!")

*12. 谨慎使用`args和kwargs`

避免不必要地使用*args和**kwargs，以免使函数调用变得混乱。

不良示例：

PHP

def add_numbers(*args):
    return sum(args)

良好示例：

PHP

def add_numbers(a, b):
    return a + b

13. 使用类型提示

类型提示增强代码可读性，并有助于静态分析工具提供更好的支持。

不良示例：

PHP

def add_numbers(a, b):
    return a + b

良好示例：

PHP

def add_numbers(a: int, b: int) -> int:
    return a + b

14. 限制函数副作用

尽量减少函数的副作用（例如修改全局变量或对象状态），以提高代码的可理解性和可测试性。

不良示例：

PHP

x = 10

def add_ten():
    global x
    x += 10

add_ten()

良好示例：

PHP

def add_ten(x: int) -> int:
    return x + 10

x = 10
x = add_ten(x)

15. 使用with语句管理资源

使用with语句确保资源（例如文件、数据库连接）得到正确关闭。

不良示例：

PHP

file = open('example.txt', 'r')
data = file.read()
file.close()

良好示例：

PHP

with open('example.txt', 'r') as file:
    data = file.read()

16. 避免使用eval()

eval()存在安全风险，应尽量避免使用。

不良示例：

PHP

user_input = input("enter a python expression: ")
result = eval(user_input)
print(result)

良好示例： (根据输入类型进行安全处理)

PHP

user_input = input("enter a number: ")
try:
    result = int(user_input)
    print(result)
except ValueError:
    print("Invalid input, please enter a valid number.")

17. 遵循DRY原则（Don't Repeat Yourself）

避免代码重复，使用函数、类或其他抽象机制来重用代码。

不良示例： (重复计算PI)

PHP

def calculate_area(radius):
    return 3.14 * radius * radius

def calculate_circumference(radius):
    return 2 * 3.14 * radius

良好示例：

PHP

PI = 3.14

def calculate_area(radius):
    return PI * radius * radius

def calculate_circumference(radius):
    return 2 * PI * radius

18. 使用enumerate()迭代列表

使用enumerate()函数同时获取索引和元素，避免手动管理索引。

不良示例：

PHP

for i in range(len(my_list)):
    print(i, my_list[i])

良好示例：

PHP

for i, item in enumerate(my_list):
    print(i, item)

19. 将相关代码分组到类中

将相关的函数和数据封装到类中，提高代码组织性和可维护性。

不良示例： (分散的函数)

PHP

def calculate_area(radius):
    return 3.14 * radius * radius

def calculate_circumference(radius):
    return 2 * 3.14 * radius

良好示例：

PHP

class Circle:
    PI = 3.14

    def __init__(self, radius):
        self.radius = radius

    def calculate_area(self):
        return self.PI * self.radius * self.radius

    def calculate_circumference(self):
        return 2 * self.PI * self.radius