小白学 Python
AI 编程指南
© 2026 小白学 Python · 基于 walter201230/Python 教程
课程目录关于本站联系方式隐私政策GitHub

全部课程

  1. 00为什么学 Python
  2. 01Python 安装与第一个程序
  3. 02基本数据类型与变量
  4. 03List 与 Tuple
  5. 04Dict 与 Set
  6. 05条件与循环
  7. 06函数
  8. 07迭代
  9. 08面向对象
  10. 09模块
  11. 10魔法方法
  12. 11枚举类
  13. 12元类 metaclass
  14. 13线程与进程
  15. 14正则表达式
  16. 15闭包
  17. 16装饰器
  18. 17代码可读性
  19. 18pathlib:现代化路径处理
  20. 19异常处理
  21. 20dataclass
  22. 21上下文管理器(with)
  23. 22async / await
  24. 23pyproject.toml + uv
  25. 24ruff:一站式代码检查
  26. 25pytest:测试框架
  27. 26日志 logging
  28. 27打包发布到 PyPI
  29. 28学完之后
Python 环境加载中…

代码可读性

4 道练习题·预计 145 分钟·做对一题解锁下一段

完整通读本章 →

教学 01 / 20· 已读

前言

本来不应该把这个章节放在那面前面的,因为还没进行学习之前,直接看这个章节,会感觉有很多莫名其妙的东西。

但是把这个章节放在前面的用意,只是让大家预览一下,有个印象,而且在以后的学习中,也方便大家查阅。

目录

  • 一、简明概述
    • 1、编码
    • 2、代码格式
      • 2.1、缩进
      • 2.2、行宽
      • 2.3、引号
      • 2.4、空行
      • 2.5、编码
    • 3、import 语句
    • 4、空格
    • 5、换行
    • 6、docstring
  • 二、注释
    • 1、注释
      • 1.1、块注释
      • 1.2、行注释
      • 1.3、建议
    • 2、文档注释(Docstring)
  • 三、命名规范
    • 1、模块
    • 2、类名
    • 3、函数
    • 4、变量名
    • 5、常量
教学 02 / 20· 已读

一、简明概述

1、编码

  • 如无特殊情况, 文件一律使用 UTF-8 编码
  • 如无特殊情况, 文件头部必须加入#-*-coding:utf-8-*-标识

2、代码格式

2.1、缩进

  • 统一使用 4 个空格进行缩进

2.2、行宽

每行代码尽量不超过 80 个字符(在特殊情况下可以略微超过 80 ,但最长不得超过 120)

理由:

  • 这在查看 side-by-side 的 diff 时很有帮助
  • 方便在控制台下查看代码
  • 太长可能是设计有缺陷

2.3、引号

简单说,自然语言使用双引号,机器标示使用单引号,因此 代码里 多数应该使用 单引号

  • 自然语言 使用双引号 "..."
    例如错误信息;很多情况还是 unicode,使用u"你好世界"
  • 机器标识 使用单引号 '...' 例如 dict 里的 key
  • 正则表达式 使用原生的双引号 r"..."
  • 文档字符串 (docstring) 使用三个双引号 """......"""

2.4、空行

  • 模块级函数和类定义之间空两行;
  • 类成员函数之间空一行;
Python· 结合前文阅读
class A:

    def __init__(self):
        pass

    def hello(self):
        pass


def main():
    pass   
  • 可以使用多个空行分隔多组相关的函数
  • 函数中可以使用空行分隔出逻辑相关的代码

3、import 语句

  • import 语句应该分行书写
Python· 在本地运行
# 正确的写法
import os
import sys

# 不推荐的写法
import sys,os

# 正确的写法
from subprocess import Popen, PIPE
  • import语句应该使用 absolute import
Python· 结合前文阅读
# 正确的写法
from foo.bar import Bar

# 不推荐的写法
from ..bar import Bar
  • import语句应该放在文件头部,置于模块说明及docstring之后,于全局变量之前;
  • import语句应该按照顺序排列,每组之间用一个空行分隔
Python· 在本地运行
import os
import sys

import msgpack
import zmq

import foo
  • 导入其他模块的类定义时,可以使用相对导入
Python· 结合前文阅读
from myclass import MyClass
  • 如果发生命名冲突,则可使用命名空间
Python· 结合前文阅读
import bar
import foo.bar

bar.Bar()
foo.bar.Bar()

4、空格

  • 在二元运算符两边各空一格[=,-,+=,==,>,in,is not, and]:
Python· 结合前文阅读
# 正确的写法
i = i + 1
submitted += 1
x = x * 2 - 1
hypot2 = x * x + y * y
c = (a + b) * (a - b)

# 不推荐的写法
i=i+1
submitted +=1
x = x*2 - 1
hypot2 = x*x + y*y
c = (a+b) * (a-b)
  • 函数的参数列表中,,之后要有空格
Python· 结合前文阅读
# 正确的写法
def complex(real, imag):
    pass

# 不推荐的写法
def complex(real,imag):
    pass
  • 函数的参数列表中,默认值等号两边不要添加空格
Python· 结合前文阅读
# 正确的写法
def complex(real, imag=0.0):
    pass

# 不推荐的写法
def complex(real, imag = 0.0):
    pass
  • 左括号之后,右括号之前不要加多余的空格
Python· 结合前文阅读
# 正确的写法
spam(ham[1], {eggs: 2})

# 不推荐的写法
spam( ham[1], { eggs : 2 } )
  • 字典对象的左括号之前不要多余的空格
Python· 结合前文阅读
# 正确的写法
dict['key'] = list[index]

# 不推荐的写法
dict ['key'] = list [index]
  • 不要为对齐赋值语句而使用的额外空格
Python· 结合前文阅读
# 正确的写法
x = 1
y = 2
long_variable = 3

# 不推荐的写法
x             = 1
y             = 2
long_variable = 3

5、换行

Python 支持括号内的换行。这时有两种情况。

  1. 第二行缩进到括号的起始处
Python· 结合前文阅读
foo = long_function_name(var_one, var_two,
                         var_three, var_four)
  1. 第二行缩进 4 个空格,适用于起始括号就换行的情形
Python· 结合前文阅读
def long_function_name(
        var_one, var_two, var_three,
        var_four):
    print(var_one)

使用反斜杠\换行,二元运算符+ .等应出现在行末;长字符串也可以用此法换行

Python· 语法示意
session.query(MyTable).\
        filter_by(id=1).\
        one()

print 'Hello, '\
      '%s %s!' %\
      ('Harry', 'Potter')

禁止复合语句,即一行中包含多个语句:

Python· 结合前文阅读
# 正确的写法
do_first()
do_second()
do_third()

# 不推荐的写法
do_first();do_second();do_third();

if/for/while一定要换行:

Python· 结合前文阅读
# 正确的写法
if foo == 'blah':
    do_blah_thing()

# 不推荐的写法
if foo == 'blah': do_blash_thing()

6、docstring

docstring 的规范中最其本的两点:

  1. 所有的公共模块、函数、类、方法,都应该写 docstring 。私有方法不一定需要,但应该在 def 后提供一个块注释来说明。
  2. docstring 的结束"""应该独占一行,除非此 docstring 只有一行。
Python· 结合前文阅读
"""Return a foobar
Optional plotz says to frobnicate the bizbaz first.
"""

"""Oneline docstring"""
教学 03 / 20· 已读

二、注释

1、注释

1.1、块注释

“#”号后空一格,段落件用空行分开(同样需要“#”号)

Python· 结合前文阅读
# 块注释
# 块注释
#
# 块注释
# 块注释

1.2、行注释

至少使用两个空格和语句分开,注意不要使用无意义的注释

Python· 结合前文阅读
# 正确的写法
x = x + 1  # 边框加粗一个像素

# 不推荐的写法(无意义的注释)
x = x + 1 # x加1

1.3、建议

  • 在代码的关键部分(或比较复杂的地方), 能写注释的要尽量写注释

  • 比较重要的注释段, 使用多个等号隔开, 可以更加醒目, 突出重要性

Python· 结合前文阅读
app = create_app(name, options)


# =====================================
# 请勿在此处添加 get post等app路由行为 !!!
# =====================================


if __name__ == '__main__':
    app.run()

2、文档注释(Docstring)

作为文档的Docstring一般出现在模块头部、函数和类的头部,这样在python中可以通过对象的__doc__对象获取文档. 编辑器和IDE也可以根据Docstring给出自动提示.

  • 文档注释以 """ 开头和结尾, 首行不换行, 如有多行, 末行必需换行, 以下是Google的docstring风格示例
Python· 结合前文阅读
# -*- coding: utf-8 -*-
"""Example docstrings.

This module demonstrates documentation as specified by the `Google Python
Style Guide`_. Docstrings may extend over multiple lines. Sections are created
with a section header and a colon followed by a block of indented text.

Example:
    Examples can be given using either the ``Example`` or ``Examples``
    sections. Sections support any reStructuredText formatting, including
    literal blocks::

        $ python example_google.py

Section breaks are created by resuming unindented text. Section breaks
are also implicitly created anytime a new section starts.
"""
  • 不要在文档注释复制函数定义原型, 而是具体描述其具体内容, 解释具体参数和返回值等
Python· 语法示意
#  不推荐的写法(不要写函数原型等废话)
def function(a, b):
    """function(a, b) -> list"""
    ... ...


#  正确的写法
def function(a, b):
    """计算并返回a到b范围内数据的平均值"""
    ... ...
  • 对函数参数、返回值等的说明采用numpy标准, 如下所示
Python· 结合前文阅读
def func(arg1, arg2):
    """在这里写函数的一句话总结(如: 计算平均值).

    这里是具体描述.

    参数
    ----------
    arg1 : int
        arg1的具体描述
    arg2 : int
        arg2的具体描述

    返回值
    -------
    int
        返回值的具体描述

    参看
    --------
    otherfunc : 其它关联函数等...

    示例
    --------
    示例使用doctest格式, 在`>>>`后的代码可以被文档测试工具作为测试用例自动运行

    >>> a=[1,2,3]
    >>> print [x + 3 for x in a]
    [4, 5, 6]
    """
  • 文档注释不限于中英文, 但不要中英文混用

  • 文档注释不是越长越好, 通常一两句话能把情况说清楚即可

  • 模块、公有类、公有方法, 能写文档注释的, 应该尽量写文档注释

教学 04 / 20· 已读

三、命名规范

1、模块

  • 模块尽量使用小写命名,首字母保持小写,尽量不要用下划线(除非多个单词,且数量不多的情况)
Python· 结合前文阅读
# 正确的模块名
import decoder
import html_parser

# 不推荐的模块名
import Decoder

2、类名

  • 类名使用驼峰(CamelCase)命名风格,首字母大写,私有类可用一个下划线开头
Python· 结合前文阅读
class Farm():
    pass

class AnimalFarm(Farm):
    pass

class _PrivateFarm(Farm):
    pass
  • 将相关的类和顶级函数放在同一个模块里. 不像Java, 没必要限制一个类一个模块.

3、函数

  • 函数名一律小写,如有多个单词,用下划线隔开
Python· 结合前文阅读
def run():
    pass

def run_with_env():
    pass
  • 私有函数在函数前加一个下划线_
Python· 结合前文阅读
class Person():

    def _private_func():
        pass

4、变量名

  • 变量名尽量小写, 如有多个单词,用下划线隔开
Python· 结合前文阅读
if __name__ == '__main__':
    count = 0
    school_name = ''
  • 常量采用全大写,如有多个单词,使用下划线隔开
Python· 结合前文阅读
MAX_CLIENT = 100
MAX_CONNECTION = 1000
CONNECTION_TIMEOUT = 600

5、常量

  • 常量使用以下划线分隔的大写命名
Python· 结合前文阅读
MAX_OVERFLOW = 100

class FooBar:

    def foo_bar(self, print_):
        print(print_)
教学 05 / 20

二、早返回(Early Return)

来看下面这段「校验登录」的代码:

Python· 结合前文阅读
def login(user, password):
    if user is not None:
        if user.is_active:
            if user.check_password(password):
                if not user.is_locked:
                    return '登录成功'
                else:
                    return '账户已锁定'
            else:
                return '密码错误'
        else:
            return '账户未激活'
    else:
        return '用户不存在'

四层嵌套——读到第三层 if 时,你已经记不清第一层的条件是什么了。

早返回:把异常情况先送走

「先处理边界情况,主流程才能放在最外层」——这就是早返回的核心思想。

Python· 结合前文阅读
def login(user, password):
    if user is None:
        return '用户不存在'
    if not user.is_active:
        return '账户未激活'
    if not user.check_password(password):
        return '密码错误'
    if user.is_locked:
        return '账户已锁定'
    return '登录成功'

变化看出来了吗?

  • 没有 else
  • 没有嵌套
  • 每个失败条件只占一行
  • 最后一行是「成功路径」——一眼就能找到

通用模式

凡是看到这种结构:

Python· 语法示意
if 条件成立:
    # 主流程一大段
    ...
else:
    return 错误

都可以改写成:

Python· 语法示意
if not 条件成立:
    return 错误
# 主流程一大段(无缩进)
...

主流程从 1 层缩进退回到 0 层。多个条件叠加时效果尤为明显。

什么时候不用早返回

不是所有 if 都该早返回。如果两个分支地位平等——比如「奇数返回 X、偶数返回 Y」——那就老老实实写 if/else,没必要硬塞进早返回。

Python· 结合前文阅读
def parity(n):
    if n % 2 == 0:
        return '偶数'
    else:
        return '奇数'

这样反而清楚。早返回是为了摊平错误处理,不是为了消灭所有 else。

练习 1 / 4·用早返回重写嵌套 if题目有问题?

下面这段函数 check(score) 用了三层嵌套——请用早返回重写一个函数 check(score),逻辑保持一致:

  • score < 0 或 score > 100:返回 '非法分数'
  • score >= 90:返回 '优秀'
  • score >= 60:返回 '及格'
  • 其他:返回 '不及格'

然后依次调用 print(check(95))、print(check(72))、print(check(40))、print(check(150))。

输出应该是:

文本
优秀
及格
不及格
非法分数

提示:「早返回」就是先把异常情况 return 掉,把主流程留在最外层,不写 else、不嵌套。

main.py
可编辑
🔒做对当前题解锁下一段 ·0/4

推荐一个,全网最全最友好的中文 AI 编程指南: coding.stormzhang.ai

← 上一章16 · 装饰器
代码可读性
下一章 →18 · pathlib:现代化路径处理
本章目录

代码可读性

  1. 教学 01前言
  2. 教学 02一、简明概述
  3. 教学 03二、注释
  4. 教学 04三、命名规范
  5. 教学 05二、早返回(Early Return)
  6. 练习 1用早返回重写嵌套 if
  7. 教学 06 🔒三、推导式(Comprehension)
  8. 练习 2 🔒列表推导式:挑出正数并平方
  9. 练习 3 🔒字典推导式:把所有价格翻倍
  10. 教学 07 🔒类型注解
  11. 教学 08 🔒最简单的注解
  12. 练习 4 🔒写一个带类型注解的函数
  13. 教学 09 🔒常用的几个基础类型
  14. 教学 10 🔒函数可能返回 None 怎么办
  15. 教学 11 🔒容器类型怎么注解
  16. 教学 12 🔒变量也能加注解
  17. 教学 13 🔒Callable 和 Any——两个特殊角色
  18. 教学 14 🔒类型起得太长?给它起个别名
  19. 教学 15 🔒类的属性怎么注解
  20. 教学 16 🔒Protocol——类型注解版的 duck typing
  21. 教学 17 🔒写完注解,怎么真的检查类型
  22. 教学 18 🔒一些常见疑问
  23. 教学 19 🔒小结
  24. 教学 20 🔒注解写上了,输入就一定正确吗

学习目录