编写整洁的Python代码(第2版)

第 1章 简介、代码格式设置和工具 1 1.1 简介 1 1.1.1 整洁代码的含义 2 1.1.2 整洁代码的重要性 2 1.1.3 一些例外情况 4 1.2 设置代码的格式 4 1.3 文档 7 1.3.1 代码注释 7 1.3.2 文档字符串 8 1.3.3 注解 10 1.3.4 注解是否会取代文档字符串 13 1.4 配置和使用工具 15 1.4.1 类型一致性检查 15 1.4.2 一般性代码验证 17 1.4.3 自动设置格式 18 1.4.4 自动检查设置 20 1.5 小结 21 1.6 参考资料 22 第 2章 符合Python语言习惯的代码 23 2.1 索引和切片 24 2.2 上下文管理器 26 2.3 推导式和赋值表达式 31 2.4 对象的特性、属性及各种方法 34 2.4.1 Python中的下划线 34 2.4.2 特性 36 2.4.3 使用更紧凑的语法创建类 38 2.4.4 可迭代对象 41 2.4.5 容器对象 46 2.4.6 对象的动态属性 47 2.4.7 可调用对象 49 2.4.8 魔法方法小结 50 2.5 Python注意事项 51 2.5.1 可变的默认参数 51 2.5.2 扩展内置类型 52 2.6 异步代码简介 54 2.7 小结 56 2.8 参考资料 56 第3章 优质代码的通用特征 57 3.1 契约式设计 58 3.1.1 前置条件 59 3.1.2 后置条件 60 3.1.3 Python契约 60 3.1.4 契约式设计小结 60 3.2 防御式编程 61 3.2.1 错误处理 61 3.2.2 在Python中使用断言 69 3.3 关注点分离 70 3.4 常见缩略语 71 3.4.1 DRY/OAOO 72 3.4.2 YAGNI 73 3.4.3 KIS 74 3.4.4 EAFP/LBYL 76 3.5 Python中的继承 77 3.5.1 什么情况下使用继承是个好主意 77 3.5.2 反模式的继承 78 3.5.3 Python中的多继承 81 3.6 函数和方法中的参数 83 3.6.1 Python中函数参数的工作原理 84 3.6.2 函数的参数数量 91 3.7 有关软件设计*佳实践的*后说明 94 3.7.1 软件中的正交性 94 3.7.2 结构化代码 95 3.8 小结 96 3.9 参考资料 97 第4章 SOLID原则 98 4.1 单一职责原则 98 4.1.1 一个职责过多的类 99 4.1.2 分配职责 100 4.2 开/闭原则 101 4.2.1 因未遵循OCP而带来可维护性问题的示例 102 4.2.2 重构事件系统以提高可扩展性 104 4.2.3 扩展事件系统 106 4.2.4 OCP小结 107 4.3 里氏替换原则 108 4.3.1 使用工具找出LSP问题 109 4.3.2 更微妙的LSP违反情形 111 4.3.3 LSP小结 113 4.4 接口分离 114 4.4.1 一个提供了太多功能的接口 115 4.4.2 接口越小越好 115 4.4.3 接口应多小 117 4.5 依赖倒置 117 4.5.1 一个刚性依赖案例 118 4.5.2 倒置依赖 118 4.5.3 依赖注入 119 4.6 小结 121 4.7 参考资料 122 第5章 使用装饰器改善代码 123 5.1 Python装饰器是什么 123 5.1.1 函数装饰器 124 5.1.2 类装饰器 125 5.1.3 其他类型的装饰器 129 5.2 高级装饰器 129 5.2.1 向装饰器传递参数 129 5.2.2 指定了参数默认值的装饰器 133 5.2.3 协程装饰器 135 5.2.4 扩展的装饰器语法 137 5.3 充分利用装饰器 138 5.3.1 调整函数的签名 139 5.3.2 验证参数 140 5.3.3 跟踪代码 140 5.4 有效的装饰器：避免常见错误 140 5.4.1 保留被包装的原始对象的数据 140 5.4.2 在装饰器中处理副作用 143 5.4.3 创建在任何情况下都管用的装饰器 146 5.5 装饰器与整洁的代码 149 5.5.1 组合胜过继承 149 5.5.2 DRY原则与装饰器 152 5.5.3 装饰器与关注点分离 153 5.5.4 分析优良的装饰器 154 5.6 小结 155 5.7 参考资料 156 第6章 使用描述符更充分地利用对象 157 6.1 初识描述符 157 6.1.1 描述符背后的机制 157 6.1.2 探讨描述符协议中的各个方法 160 6.2 描述符类型 167 6.2.1 非数据描述符 167 6.2.2 数据描述符 169 6.3 使用描述符 171 6.3.1 描述符的一种用途 171 6.3.2 各种描述符实现方式 175 6.3.3 使用描述符时需要考虑的其他方面 178 6.4 分析描述符 182 6.4.1 Python如何在内部使用描述符 182 6.4.2 在装饰器中实现描述符 187 6.5 描述符结语 188 6.5.1 描述符的接口 188 6.5.2 描述符的面向对象设计 188 6.5.3 描述符中的类型注解 188 6.6 小结 189 6.7 参考资料 189 第7章 生成器、迭代器和异步编程 190 7.1 技术要求 190 7.2 创建生成器 190 7.2.1 初识生成器 191 7.2.2 生成器表达式 193 7.3 以惯用法迭代 195 7.4 协程 205 7.4.1 生成器接口中的方法 205 7.4.2 高级协程 210 7.5 异步编程 216 7.5.1 异步魔法方法 217 7.5.2 异步迭代 219 7.5.3 异步生成器 221 7.6 小结 222 7.7 参考资料 223 第8章 单元测试和重构 224 8.1 设计原则与单元测试 224 8.1.1 其他形式的自动测试 225 8.1.2 单元测试与敏捷软件开发 226 8.1.3 单元测试与软件设计 227 8.1.4 确定测试范围 230 8.2 测试工具 230 8.3 重构 248 8.3.1 代码演进 249 8.3.2 需要演进的并非只有生产代码 251 8.4 再谈测试 252 8.4.1 基于属性的测试 252 8.4.2 变异测试 253 8.4.3 常见的测试概念 255 8.4.4 测试驱动开发简介 256 8.5 小结 257 8.6 参考资料 257 第9章 常见设计模式 259 9.1 在Python中使用设计模式时需要注意的事项 260 9.2 设计模式实战 261 9.2.1 创建型模式 261 9.2.2 结构型模式 267 9.2.3 行为型模式 273 9.3 空对象模式 283 9.4 设计模式结语 284 9.4.1 模式对设计的影响 285 9.4.2 作为理论的设计模式 286 9.4.3 模型中的名称 286 9.5 小结 286 9.6 参考资料 287 第 10章 整洁的架构 288 10.1 从整洁代码到整洁架构 288 10.1.1 关注点分离 289 10.1.2 大一统的应用程序和微服务 290 10.1.3 抽象 291 10.2 软件组件 292 10.2.1 包 292 10.2.2 Docker容器 298 10.2.3 用例 299 10.2.4 服务 303 10.3 小结 308 10.4 参考资料 309 结语 310