即使您是初学者,如何编写可读的 Python 函数

编写可读的 Python 函数并不一定很困难。本指南展示了适合初学者的简单技术,使您的代码清晰、一致且易于其他人理解。

来源:KDnuggets
作者图片

# 简介

#

您已经编写了第一个 Python 函数。有用。你运行它,它会产生正确的输出,你会感受到成就感的冲击。两周后你再次查看它并想:“这到底有什么作用?”

Python

编写可读的 Python 函数并不意味着聪明或先进。它是关于编写能够清楚地传达他们的意图、干净地处理他们的职责并使下一个人的工作更容易的函数。

让我们学习如何编写读起来像好散文的函数,而不是读者难以理解的神秘谜题。

🔗 您可以在 GitHub 上找到代码。

您可以在 GitHub 上找到代码

# 1. 像向朋友解释一样命名您的函数

函数名称是人们首先阅读的内容。一个好的名称可以准确地告诉您该函数的功能,而无需您阅读其中的代码。

错误示例:

def proc(d):
    返回 sum(d) / len(d)

很好的例子:

def 计算平均值(数字):
    返回 sum(数字) / len(数字)

函数名称calculate_average 使用一个动词(“计算”)告诉您它执行一个操作,后面跟着它计算的内容(“平均值”)。参数编号清楚地表明它需要一组数值。

计算平均值

函数体使用 sum(numbers) 将所有值相加,并使用 len(numbers) 对它们进行计数,然后除以得到平均值。任何阅读此代码的人都会立即理解它的作用,而无需注释或文档。

sum(数字) len(数字)

# 2. 使用描述性参数名称

单字母变量可能会节省打字时间,但需要理解。参数是函数的输入,因此要清楚地表明您的期望。

def 折扣(p, r):
    返回 p * (1 - r)
def apply_discount(original_price,discount_rate):
    返回原始价格 * (1 - 折扣率)
apply_discount(100, 0.2)

# 3. 保持功能简短且重点突出

流程顺序

# 4. 添加文档字符串来解释目的

# 5. 在函数内使用清晰的变量名称

tmp x 体重指数 用户名