工作中，我曾阅读过很多才华横溢的开发者编写的代码，但有些代码仍然会让我停下来思考： “等等……这里发生了什么？”有时候这种停顿代价高昂。可读性高并非意味着编写更少的代码，而是意味着编写清晰易懂的代码。这种代码无需注释、无需 Slack 消息就能自行解释，也无需六个月后重新打开文件才能明白是谁搞的鬼。

以下是我每天都会用到的 10 个提高代码可读性的技巧 ——大多数 Python 开发人员都知道这些技巧，但真正能正确应用的人却很少。

1. 将布尔标志替换为枚举类对象布尔标志会严重破坏可读性，能不用就别用。

def process(data, fast=True, safe=False):

    ...

现在请在不看后面答案的前提下回答下面这个问题：

fast=True, safe=False 是什么意思 ？不知道吧！相反，应该使用能够揭示意图的对象：

class Mode:

    FAST = "fast"

    SAFE = "safe"

    DEBUG = "debug"

def process(data, mode: str):

    ...

process(data, mode=Mode.FAST)

你的大脑解读的是文字 ，而不是布尔值。这可以立即消除认知负荷。

2. 使用守卫子句简化逻辑嵌套条件语句会降低可读性。

不好的：

def save(user):

    if user:

        if user.is_active:

            if user.has_permission:

                persist(user)

好的（可读性强）：

def save(user):

    if not user:

        return

    if not user.is_active:

        return

    if not user.has_permission:

        return

    persist(user)

扁平化代码才是可读性强的代码。你的眼睛不需要地图就能看懂执行过程。

3. 优先使用早期变量命名而非行内表达式内联逻辑很巧妙，但难以阅读。

if request.user.profile.settings.preferences.theme.color == "dark":

    ...

可读代码引入语义检查点：

preferences = request.user.profile.settings.preferences

theme_color = preferences.theme.color

if theme_color == "dark":

    ...

你没有添加任何行。但却补充了关键信息，增强了代码可读性。

4. 使用 _ 表示“这东西存在，但我不在乎”Python 的下划线不是装饰，而是交流。

for _, filename in os.walk(directory):

    process(filename)

或者，用在拆包过程中：user_id, _, email = get_user_data()

这告诉未来的读者：“是的，这里面有值。但并不重要，因为 I don't care!”诚实很重要。

5. 用函数提取替换注释如果你想解释某个代码块的作用，请将其提取出来。

不好的：

# Check if user can access dashboard

if user.is_authenticated and user.is_active and not user.is_banned:

    ...

好的（可读性强）：def can_access_dashboard(user):

    return (

        user.is_authenticated

        and user.is_active

        and not user.is_banned

    )

if can_access_dashboard(user):

    ...

现在你的代码读起来就像英文一样——注释也就变得可有可无了。

6. 对于结构化返回值，请使用命名元组（而非字典）。字典会隐藏字符串背后的含义。

return {

    "min": min_value,

    "max": max_value,

    "avg": average

}

替代方案（可读性强）：

from collections import namedtuple

Stats = namedtuple("Stats", "min max avg")

return Stats(min_value, max_value, average)

现在自动补齐功能正常了，重构也更安全了，同时读者朋友们也了解其结构，可谓是一举多得。

7. 使用垂直间距作为逻辑分隔符空格并非装饰性的——它是语法的一部分。validate_input(data)

normalize(data)

save(data)

notify_user()

log_event()

可读版本：

validate_input(data)

normalize(data)

save(data)

notify_user()

log_event()

每个空白行都表示逻辑中的一个阶段转换。你的大脑本能地就能理解这一点。

8. 用域常量替换魔法数字魔法数字会让代码说谎。

if retries > 3:

    abort()

3是什么？为什么是3？

MAX_RETRIES = 3

if retries > MAX_RETRIES:

    abort()

关键不在于常量，而在于它能讲述数字背后的故事。

9. 若非必要尽量少用 elifelif 会隐藏决策树。

if status  "pending":

    ...

elif status  "approved":

    ...

elif status == "rejected":

    ...

逻辑变多时可读性更强的替代方案：

handlers = {

    "pending": handle_pending,

    "approved": handle_approved,

    "rejected": handle_rejected,

}

handlers[status]()

现在，行为是由数据驱动的，而不是由条件驱动的。

10. 根据变量的作用而非类型命名变量。类型会变，但角色却不会。

不好的：

list_of_users = []

dict_of_settings = {}

好的（可读性强）：

users = []

settings = {}

或者更好的：

active_users = []

feature_flags = {}

你的变量名应该回答以下问题：“它存在的意义是什么？”而不是 “那是什么？”

更多相关技术内容咨询欢迎前往并持续关注好学星城论坛了解详情。

想高效系统的学习Python编程语言，推荐大家关注一个微信公众号：Python编程学习圈。每天分享行业资讯、技术干货供大家阅读，关注即可免费领取整套Python入门到进阶的学习资料以及教程，感兴趣的小伙伴赶紧行动起来吧。