• 首页
  • 让你的Python代码更出色的技巧！✨

让你的Python代码更出色的技巧！✨

干净的代码对于使Python应用程序可管理和可扩展至关重要。Python重视可读性，因此编写干净的代码极为重要。在这篇文章中，我将介绍十个编写更清晰Python代码的想法，同时提升可读性、效率和可维护性。让我们开始吧：

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

在Python中，变量名称应反映其用途。避免使用单字符变量或模糊的名称。

  • 不良实践：
x = 10
    • 良好实践：
item_count = 10

2. 保持函数小而专注

Python 允许灵活性，但最佳实践是保持函数小而专注。每个函数应该只做一件事。

  • 不良实践：
def process_data():
    fetch_data()
    validate_data()
    save_data()
  • 良好实践：
def fetch_data():
    pass

def validate_data():
    pass

def save_data():
    pass

3. 使用一致的格式

在Python中，缩进至关重要，因为它定义了代码块。每个缩进级别应保持4个空格（PEP 8标准）。一致的风格使您的代码更易于理解。

  • 不良实践：
if x:
    print("Hello")
else:
print("Goodbye")
    • 良好实践：
if x:
    print("Hello")
else:
    print("Goodbye")

4. 避免魔法数字

避免在代码中直接使用任意数字。相反，使用具有描述性名称的常量。

  • 不良实践：
area = 3.14 * radius * radius
  • 良好实践：
PI = 3.14
area = PI * radius * radius

5. 使用默认参数

Python 允许函数参数使用默认值。这减少了对条件语句的需求，使您的函数更加简洁。

  • 不好的实践：
def greet(name):
    if not name:
        name = 'Guest'
    print(f"Hello {name}")
  • 好的实践：
def greet(name="Guest"):
    print(f"Hello {name}")

6. 最小化嵌套循环和条件语句

Python 的可读性会因为过多的嵌套而受到影响。通过提前返回或将逻辑拆分为更小的函数来减少嵌套。

  • 不良实践：
if x:
    if y:
        if z:
            print("条件满足！")
  • 良好实践：
if not x or not y or not z:
    return
print("条件满足！")

7. 利用Python的内置函数

Python提供了强大的内置函数和库。对于常见任务，使用这些内置工具，而不是自己编写逻辑。

    • 不好的做法：
squared_numbers = []
for num in range(1, 6):
    squared_numbers.append(num ** 2)
  • 好的做法：
squared_numbers = [num ** 2 for num in range(1, 6)]

8. 避免使用全局变量

在Python中，全局变量可能导致意想不到的行为，并使调试变得困难。应将变量保持在函数内部，必要时使用类。

  • 不良实践：
counter = 0
def increment():
    global counter
    counter += 1
  • 良好实践：
class Counter:
    def __init__(self):
        self.counter = 0

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

9. 使用列表推导式

列表推导式是创建列表的一种 Pythonic 方式。它们简洁、易读，并且比使用循环更高效。

    • 不好的实践：
numbers = []
for i in range(1, 6):
    if i % 2 == 0:
        numbers.append(i)
  • 好的实践：
numbers = [i for i in range(1, 6) if i % 2 == 0]

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

Python 开发者依赖文档字符串和注释来进行文档说明。虽然代码本身应该是自解释的，但使用文档字符串来描述函数和类，并在逻辑复杂时添加注释。

    • 不良实践：
# 增加计数器
counter += 1
  • 良好实践：
def increment_counter(counter):
    """
    将计数器增加1。

    参数：
    counter -- 当前需要增加的计数。
    """
    return counter + 1

11. 正确处理异常

与其让程序在出现问题时崩溃，不如正确处理异常。这可以提高代码的稳定性。

  • 不良实践：
num = int(input("请输入一个数字："))
print(10 / num)
  • 良好实践：
try:
    num = int(input("请输入一个数字："))
    print(10 / num)
except ValueError:
    print("输入无效，请输入一个整数。")
except ZeroDivisionError:
    print("不能除以零！")

12. 避免不必要地使用 args 和 *kwargs

虽然 *args 和 **kwargs 功能强大，但应谨慎使用。不必要的使用会使函数调用变得混乱。

  • 不良实践：
def add_numbers(*args):
    return sum(args)
  • 良好实践：
def add_numbers(a, b):
    return a + b

13. 使用类型提示

添加类型提示使代码更易于理解，并帮助像代码检查工具和集成开发环境（IDE）这样的工具提供更好的支持。

  • 不良实践：
def add_numbers(a, b):
    return a + b
  • 良好实践
def add_numbers(a: int, b: int) -> int:
    return a + b

14. 限制函数中的副作用

副作用（例如，修改全局变量或对象的状态）会使代码更难以理解。尽量减少副作用，并在可能的情况下保持函数的纯粹性。

  • 不良实践：
x = 10

def add_ten():
    global x
    x += 10

add_ten()
  • 良好实践：
def add_ten(x: int) -> int:
    return x + 10

x = 10
x = add_ten(x)

15. 使用 Python 的 with 语句进行资源管理

管理文件、数据库或网络连接等资源时，使用 with 语句可以确保它们被正确关闭或清理。

  • 不良实践：
file = open('example.txt', 'r')
data = file.read()
file.close()
  • 良好实践：
with open('example.txt', 'r') as file:
    data = file.read()

16. 避免使用 eval()

eval() 可能是危险的，因为它会执行任意代码。通常情况下，这是不必要的，并且出于安全原因应当避免使用。

  • 不良实践：
user_input = input("请输入一个 Python 表达式：")
result = eval(user_input)
print(result)
  • 良好实践：
user_input = input("请输入一个数字：")
try:
    result = int(user_input)
    print(result)
except ValueError:
    print("输入无效，请输入一个有效的数字。")

17. 避免重复（DRY原则）

不要重复自己（DRY）是一个原则，鼓励使用函数、类或其他抽象来避免冗余代码。

  • 不良实践：
def calculate_area(radius):
    return 3.14 * radius * radius

def calculate_circumference(radius):
    return 2 * 3.14 * radius
    • 良好实践：
PI = 3.14

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

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

18. 使用 Enumerate 而不是 Range

在遍历列表并需要同时获取索引和项时，使用 enumerate() 来避免手动索引。

  • 不良实践：
for i in range(len(my_list)):
    print(i, my_list[i])
  • 良好实践：
for i, item in enumerate(my_list):
    print(i, item)

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

如果你的代码中有相关的函数，将它们分组到类中通常是个好主意。这可以封装相关的行为，使代码更加有序。

    • 不好的实践：
def calculate_area(radius):
    return 3.14 * radius * radius

def calculate_circumference(radius):
    return 2 * 3.14 * radius
  • 良好实践：
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

更多

Weibo Weixin

京ICP备17072685号-4 © 2024 QPython.