编写干净、高效且可维护的代码 - Python 作为用例

php中文网 2024-10-15 11:30:20

编写干净、高效且可维护的代码 - python 作为用例。
如果您已经成为开发人员一段时间，您可能会理解正确编码的重要性，而不是急于编写有效的东西。这对您来说最大的挫折之一是，当您需要检查代码时，您很少能理解您想要做什么，而对于其他人来说，他们很难阅读您的代码。

我最近一直在审查一些代码，我认为强调干净、高效的代码的必要性很重要。

编码指南和风格的一些历史

在 1970 年代初，当 c 编程语言越来越流行时，编码风格成为了一个讨论的问题，围绕这个问题的两个著名名字是 brian kernighan 和 dennis ritchie。

有趣的是，ada 语言在 20 世纪 80 年代后期实施了严格的编码指南和标准。 1990 年中期，python 和 java 从初始阶段就带有强大的编码约定，python 增强提案 (pep 8) 被广泛采用，至今仍然是有效的编码约定。

pep 8 代码样式指南：我时常使用这个指南，并且我看到其他程序员也采用这个指南。

vs code 的 flake8 代码 linting 扩展是我使用的一个不错的选择。
指导方针是：
缩进：每个缩进级别使用 4 个空格。
行长度：将所有行限制为最多 79 个字符。
命名约定：函数和变量名使用蛇形命名法，类名使用驼峰命名法。

例如：

`# defining variables using snake_case

total_price = 100
customer_email = "customer@example.com"

# defining functions using snake_case
def calculate_total_price():
    pass

class ordermanager:
    pass`

2。有意义的注释和文档： docstrings 帮助开发人员理解函数/方法的目的、参数和返回值。一般来说，介绍它们并撰写评论来澄清复杂的逻辑或决定是一种很好的做法
例如：

def calculate_total_price(price: float, quantity: int) -&gt; float:
    """
    calculate the total price of items.

    args:
        price (float): the price of a single item.
        quantity (int): the number of items purchased.

    returns:
        float: the total price.
    """
    return price * quantity

**3。代码重复：**作为一个简单的经验法则，避免重复已经实现的代码，而是通过创建可重用的函数来遵循 dry 原则。需要注意的是，当新开发人员实现更改时，开发人员可能不知道有重复的代码被遗漏，并且由于此错误可能会造成很多混乱。

立即学习“Python免费学习笔记（深入）”；

例如，您有一个函数，通过将价格与数量相乘来计算电子商务商店的总价。

total_price_laptops = 1000 * 2
total_price_phones = 500 * 3
this, is easily done with reusable functions like this:
def calculate_total(price, quantity):
    return price * quantity

total_price_laptops = calculate_total(1000, 2)
total_price_phones = calculate_total(500, 3)

4。类型提示： python 是动态类型语言，类型提示可以提高代码的可读性并尽早捕获错误。更容易理解期望的数据类型。

例如：

def get_discounted_price(price: float, discount: float) -&gt; float:
    return price - (price * discount)

**5。编写测试： **测试验证代码的功能。像unittest或pytest这样的流行框架使编写和运行测试变得简单。测试断言您的代码行为符合预期，从而降低了在进行更改或重构时引入错误的风险。

def test_calculate_total_price():
    assert calculate_total_price(100, 2) == 200

6。例外： 当生产代码向客户端用户打印出无意义的代码行，甚至更糟糕的是，输出环境变量时，可能会很尴尬。通过异常 try/ except/finally 处理来管理可预测的错误并确保您的应用程序不会意外崩溃，可以更轻松地避免这种情况。

try:
    value = int(input("Enter a number: "))
except ValueError:
    print("That's not a valid number!")
finally:
    print('Thank you!')

7。代码模块化： 没有任何规则规定要将代码保存在一个文件中。将大块代码分解为更小的、可重用的模块，并将它们导入到需要的应用程序中。更容易测试和更新。

8。版本控制： 像 git 这样的版本控制系统是现代开发中的基本最佳实践。其他还有 beanstalk、perforce、apache subversion。版本控制可以跟踪变更，很大程度上减少协作过程中的人为错误和意外后果。

通过遵循最佳实践，例如遵守 pep 8、保持代码干燥、编写有意义的文档以及优雅地处理异常，您可以确保您的 python 项目专业、可扩展且易于维护。
从今天开始实施这些技巧，您将看到代码质量的显着提高。

以上就是编写干净、高效且可维护的代码 - Python 作为用例的详细内容，更多请关注php中文网其它相关文章！

本文地址： http://www.ipsmc.com/be/5993.html